PDK API Guide for AM64x
Mailbox_Config Struct Reference

Detailed Description

Mailbox Configuration Parameters.

Mailbox configuration parameters are used with the Mailbox_open() call. Default values for these parameters are set as part of Mailbox_openParams_init().

Data Fields

Mailbox_Mode readMode
 Mailbox read mode. More...
 
Mailbox_Mode writeMode
 Mailbox write mode. More...
 
uint32_t readTimeout
 Timeout for read semaphore. More...
 
uint32_t writeTimeout
 Timeout for write semaphore. More...
 
Mailbox_Callback readCallback
 Pointer to read callback. More...
 
Mailbox_OpMode opMode
 Driver mode of operation. More...
 
Mailbox_DataTransferMode dataTransferMode
 Data transfer mode. More...
 
Mailbox_ChType chType
 Mailbox channel type. More...
 
Mailbox_ChID chId
 Channel ID for this instance of the driver. Used only when chType is set to MAILBOX_CHTYPE_MULTI. More...
 
bool enableVIMDirectInterrupt
 For R5F cores and select SoCs, the driver provides the ability to do direct VIM interrupt registration as a performance enhancement. Note that this is currently only supported for baremetal applications and not RTOS. This option is set to false by default. Please see the Mailbox_read documentation for further information on support for this feature. More...
 
bool enableInterrupts
 Whether to enable interrupts during interrupt registration or not. Some software may want to control when the interrupts begin coming. Defaults to TRUE (interrupts will be enabled during Mailbox_open). If set to FALSE, the application must call Mailbox_enableInterrupts() for the mailbox instance in order to enable the interrupts. The only supported value for TPR12 is TRUE. More...
 

Field Documentation

◆ readMode

Mailbox_Mode Mailbox_Config::readMode

Mailbox read mode.

◆ writeMode

Mailbox_Mode Mailbox_Config::writeMode

Mailbox write mode.

◆ readTimeout

uint32_t Mailbox_Config::readTimeout

Timeout for read semaphore.

◆ writeTimeout

uint32_t Mailbox_Config::writeTimeout

Timeout for write semaphore.

◆ readCallback

Mailbox_Callback Mailbox_Config::readCallback

Pointer to read callback.

◆ opMode

Mailbox_OpMode Mailbox_Config::opMode

Driver mode of operation.

◆ dataTransferMode

Mailbox_DataTransferMode Mailbox_Config::dataTransferMode

Data transfer mode.

◆ chType

Mailbox_ChType Mailbox_Config::chType

Mailbox channel type.

◆ chId

Mailbox_ChID Mailbox_Config::chId

Channel ID for this instance of the driver. Used only when chType is set to MAILBOX_CHTYPE_MULTI.

◆ enableVIMDirectInterrupt

bool Mailbox_Config::enableVIMDirectInterrupt

For R5F cores and select SoCs, the driver provides the ability to do direct VIM interrupt registration as a performance enhancement. Note that this is currently only supported for baremetal applications and not RTOS. This option is set to false by default. Please see the Mailbox_read documentation for further information on support for this feature.

◆ enableInterrupts

bool Mailbox_Config::enableInterrupts

Whether to enable interrupts during interrupt registration or not. Some software may want to control when the interrupts begin coming. Defaults to TRUE (interrupts will be enabled during Mailbox_open). If set to FALSE, the application must call Mailbox_enableInterrupts() for the mailbox instance in order to enable the interrupts. The only supported value for TPR12 is TRUE.