Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
syscon_driver_api Struct Reference

Driver Operations SYSCON driver operations More...

#include <zephyr/drivers/syscon.h>

Data Fields

syscon_api_read_reg read
  OPT Read from syscon register.
syscon_api_write_reg write
  OPT Write to syscon register.
syscon_api_update_bits update_bits
  OPT Atomically update bits in a syscon register.
syscon_api_get_base get_base
  OPT Get the syscon base address.
syscon_api_get_size get_size
  OPT Get the size of the syscon register in bytes.

Detailed Description

Driver Operations SYSCON driver operations

This is the driver API structure any SYSCON driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also
DEVICE_DT_INST_DEFINE()
DEVICE_DT_DEFINE()
DEVICE_API()

Field Documentation

◆ get_base

syscon_api_get_base syscon_driver_api::get_base

OPT Get the syscon base address.

◆ get_size

syscon_api_get_size syscon_driver_api::get_size

OPT Get the size of the syscon register in bytes.

◆ read

syscon_api_read_reg syscon_driver_api::read

OPT Read from syscon register.

◆ update_bits

syscon_api_update_bits syscon_driver_api::update_bits

OPT Atomically update bits in a syscon register.

◆ write

syscon_api_write_reg syscon_driver_api::write

OPT Write to syscon register.


The documentation for this struct was generated from the following file: