Driver Operations MBOX driver operations More...

#include <zephyr/drivers/mbox.h>

Data Fields
mbox_send_t	send
	OPT Try to send a message over the MBOX device.
mbox_register_callback_t	register_callback
	OPT Register a callback function on a channel for incoming messages.
mbox_mtu_get_t	mtu_get
	OPT Return the maximum number of bytes possible in an outbound message.
mbox_max_channels_get_t	max_channels_get
	OPT Return the maximum number of channels.
mbox_set_enabled_t	set_enabled
	OPT Enable (disable) interrupts and callbacks for inbound channels.

Detailed Description

Driver Operations MBOX driver operations

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

◆ max_channels_get

mbox_max_channels_get_t mbox_driver_api::max_channels_get

OPT Return the maximum number of channels.

◆ mtu_get

mbox_mtu_get_t mbox_driver_api::mtu_get

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

◆ register_callback

mbox_register_callback_t mbox_driver_api::register_callback

OPT Register a callback function on a channel for incoming messages.

◆ send

mbox_send_t mbox_driver_api::send

OPT Try to send a message over the MBOX device.

◆ set_enabled

mbox_set_enabled_t mbox_driver_api::set_enabled

OPT Enable (disable) interrupts and callbacks for inbound channels.

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

zephyr/drivers/mbox.h