Driver Operations SMBus driver operations More...

#include <zephyr/drivers/smbus.h>

Data Fields
smbus_api_configure_t	configure
	REQ Configure operation of an SMBus host controller.
smbus_api_get_config_t	get_config
	OPT Get configuration of an SMBus host controller.
smbus_api_quick_t	smbus_quick
	OPT Perform an SMBus Quick operation.
smbus_api_byte_write_t	smbus_byte_write
	OPT Perform an SMBus Byte Write operation.
smbus_api_byte_read_t	smbus_byte_read
	OPT Perform an SMBus Byte Read operation.
smbus_api_byte_data_write_t	smbus_byte_data_write
	OPT Perform an SMBus Byte Data Write operation.
smbus_api_byte_data_read_t	smbus_byte_data_read
	OPT Perform an SMBus Byte Data Read operation.
smbus_api_word_data_write_t	smbus_word_data_write
	OPT Perform an SMBus Word Data Write operation.
smbus_api_word_data_read_t	smbus_word_data_read
	OPT Perform an SMBus Word Data Read operation.
smbus_api_pcall_t	smbus_pcall
	OPT Perform an SMBus Process Call operation.
smbus_api_block_write_t	smbus_block_write
	OPT Perform an SMBus Block Write operation.
smbus_api_block_read_t	smbus_block_read
	OPT Perform an SMBus Block Read operation.
smbus_api_block_pcall_t	smbus_block_pcall
	OPT Perform an SMBus Block Process Call operation.
smbus_api_smbalert_cb_t	smbus_smbalert_set_cb
	OPT Add SMBALERT callback for an SMBus host controller.
smbus_api_smbalert_cb_t	smbus_smbalert_remove_cb
	OPT Remove SMBALERT callback from an SMBus host controller.
smbus_api_host_notify_cb_t	smbus_host_notify_set_cb
	OPT Add Host Notify callback for an SMBus host controller.
smbus_api_host_notify_cb_t	smbus_host_notify_remove_cb
	OPT Remove Host Notify callback from an SMBus host controller.

Detailed Description

Driver Operations SMBus driver operations

This is the driver API structure any SMBus 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

◆ configure

smbus_api_configure_t smbus_driver_api::configure

REQ Configure operation of an SMBus host controller.

◆ get_config

smbus_api_get_config_t smbus_driver_api::get_config

OPT Get configuration of an SMBus host controller.

◆ smbus_block_pcall

smbus_api_block_pcall_t smbus_driver_api::smbus_block_pcall

OPT Perform an SMBus Block Process Call operation.

◆ smbus_block_read

smbus_api_block_read_t smbus_driver_api::smbus_block_read

OPT Perform an SMBus Block Read operation.

◆ smbus_block_write

smbus_api_block_write_t smbus_driver_api::smbus_block_write

OPT Perform an SMBus Block Write operation.

◆ smbus_byte_data_read

smbus_api_byte_data_read_t smbus_driver_api::smbus_byte_data_read

OPT Perform an SMBus Byte Data Read operation.

◆ smbus_byte_data_write

smbus_api_byte_data_write_t smbus_driver_api::smbus_byte_data_write

OPT Perform an SMBus Byte Data Write operation.

◆ smbus_byte_read

smbus_api_byte_read_t smbus_driver_api::smbus_byte_read

OPT Perform an SMBus Byte Read operation.

◆ smbus_byte_write

smbus_api_byte_write_t smbus_driver_api::smbus_byte_write

OPT Perform an SMBus Byte Write operation.

◆ smbus_host_notify_remove_cb

smbus_api_host_notify_cb_t smbus_driver_api::smbus_host_notify_remove_cb

OPT Remove Host Notify callback from an SMBus host controller.

◆ smbus_host_notify_set_cb

smbus_api_host_notify_cb_t smbus_driver_api::smbus_host_notify_set_cb

OPT Add Host Notify callback for an SMBus host controller.

◆ smbus_pcall

smbus_api_pcall_t smbus_driver_api::smbus_pcall

OPT Perform an SMBus Process Call operation.

◆ smbus_quick

smbus_api_quick_t smbus_driver_api::smbus_quick

OPT Perform an SMBus Quick operation.

◆ smbus_smbalert_remove_cb

smbus_api_smbalert_cb_t smbus_driver_api::smbus_smbalert_remove_cb

OPT Remove SMBALERT callback from an SMBus host controller.

◆ smbus_smbalert_set_cb

smbus_api_smbalert_cb_t smbus_driver_api::smbus_smbalert_set_cb

OPT Add SMBALERT callback for an SMBus host controller.

◆ smbus_word_data_read

smbus_api_word_data_read_t smbus_driver_api::smbus_word_data_read

OPT Perform an SMBus Word Data Read operation.

◆ smbus_word_data_write

smbus_api_word_data_write_t smbus_driver_api::smbus_word_data_write

OPT Perform an SMBus Word Data Write operation.

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

zephyr/drivers/smbus.h

Data Fields