SYSCON Driver Backend API

Data Structures
struct	syscon_driver_api
	Driver Operations SYSCON driver operations More...

Typedefs
typedef int(*	syscon_api_get_base) (const struct device *dev, uintptr_t *addr)
	Get the base address of the syscon region.
typedef int(*	syscon_api_read_reg) (const struct device *dev, uint16_t reg, uint32_t *val)
	Read a single register.
typedef int(*	syscon_api_write_reg) (const struct device *dev, uint16_t reg, uint32_t val)
	Write a single register.
typedef int(*	syscon_api_update_bits) (const struct device *dev, uint16_t reg, uint32_t mask, uint32_t val)
	Atomically update bits in a register.
typedef int(*	syscon_api_get_size) (const struct device *dev, size_t *size)
	Get the size of the syscon register region.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a SYSCON driver.

Typedef Documentation

syscon_api_get_base

typedef int(* syscon_api_get_base) (const struct device *dev, uintptr_t *addr)

#include <zephyr/drivers/syscon.h>

Get the base address of the syscon region.

See syscon_get_base() for argument description.

syscon_api_get_size

typedef int(* syscon_api_get_size) (const struct device *dev, size_t *size)

#include <zephyr/drivers/syscon.h>

Get the size of the syscon register region.

See syscon_get_size() for argument description.

syscon_api_read_reg

typedef int(* syscon_api_read_reg) (const struct device *dev, uint16_t reg, uint32_t *val)

#include <zephyr/drivers/syscon.h>

Read a single register.

See syscon_read_reg() for argument description.

syscon_api_update_bits

typedef int(* syscon_api_update_bits) (const struct device *dev, uint16_t reg, uint32_t mask, uint32_t val)

#include <zephyr/drivers/syscon.h>

Atomically update bits in a register.

See syscon_update_bits() for argument description.

syscon_api_write_reg

typedef int(* syscon_api_write_reg) (const struct device *dev, uint16_t reg, uint32_t val)

#include <zephyr/drivers/syscon.h>

Write a single register.

See syscon_write_reg() for argument description.