Driver Operations IPM driver operations More...

#include <zephyr/drivers/ipm.h>

Data Fields
ipm_send_t	send
	REQ Try to send a message over the IPM device.
ipm_register_callback_t	register_callback
	REQ Register a callback function for incoming messages.
ipm_max_data_size_get_t	max_data_size_get
	REQ Return the maximum number of bytes possible in an outbound message.
ipm_max_id_val_get_t	max_id_val_get
	REQ Return the maximum id value possible in an outbound message.
ipm_set_enabled_t	set_enabled
	REQ Enable interrupts and callbacks for inbound channels.
ipm_complete_t	complete
	OPT Signal asynchronous command completion.

Detailed Description

Driver Operations IPM driver operations

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

◆ complete

ipm_complete_t ipm_driver_api::complete

OPT Signal asynchronous command completion.

Attention: Available only when the following Kconfig option is enabled: CONFIG_IPM_CALLBACK_ASYNC.

◆ max_data_size_get

ipm_max_data_size_get_t ipm_driver_api::max_data_size_get

REQ Return the maximum number of bytes possible in an outbound message.

◆ max_id_val_get

ipm_max_id_val_get_t ipm_driver_api::max_id_val_get

REQ Return the maximum id value possible in an outbound message.

◆ register_callback

ipm_register_callback_t ipm_driver_api::register_callback

REQ Register a callback function for incoming messages.

◆ send

ipm_send_t ipm_driver_api::send

REQ Try to send a message over the IPM device.

◆ set_enabled

ipm_set_enabled_t ipm_driver_api::set_enabled

REQ Enable interrupts and callbacks for inbound channels.

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

zephyr/drivers/ipm.h

Data Fields