Zephyr Project API 4.4.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
ipm_driver_api Struct Reference

@driver_ops{IPM} More...

#include <ipm.h>

Data Fields

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

Detailed Description

@driver_ops{IPM}

Field Documentation

◆ complete

ipm_complete_t ipm_driver_api::complete

@driver_ops_optional 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

@driver_ops_mandatory 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

@driver_ops_mandatory Return the maximum id value possible in an outbound message.

◆ register_callback

ipm_register_callback_t ipm_driver_api::register_callback

@driver_ops_mandatory Register a callback function for incoming messages.

◆ send

ipm_send_t ipm_driver_api::send

@driver_ops_mandatory Try to send a message over the IPM device.

◆ set_enabled

ipm_set_enabled_t ipm_driver_api::set_enabled

@driver_ops_mandatory Enable interrupts and callbacks for inbound channels.


The documentation for this struct was generated from the following file:
  • include/zephyr/drivers/ipm.h