Data Fields
Mailbox_Config_t Struct Reference

Mailbox Configuration Parameters. More...

#include <drivers/mailbox/mailbox.h>

Data Fields

Mailbox_Mode readMode
 Mailbox read mode.
 
Mailbox_Mode writeMode
 Mailbox write mode.
 
uint32_t readTimeout
 Timeout for read semaphore.
 
uint32_t writeTimeout
 Timeout for write semaphore.
 
Mailbox_Callback readCallback
 Pointer to read callback.
 
Mailbox_OpMode opMode
 Driver mode of operation.
 
Mailbox_DataTransferMode dataTransferMode
 Data transfer mode.
 
Mailbox_ChType chType
 Mailbox channel type. Used only when remote endpoint is MSS or DSS. More...
 
Mailbox_ChID chId
 Channel ID for this instance of the driver. Used only when remote endpoint is MSS or DSS and when chType is set to MAILBOX_CHTYPE_MULTI. More...
 

Detailed Description

Mailbox Configuration Parameters.

Mailbox configuration parameters are used with the Mailbox_open() call. Default values for these parameters are set using Mailbox_Config_init().

See also
Mailbox_Config_init()

Field Documentation

Mailbox_ChID Mailbox_Config_t::chId

Channel ID for this instance of the driver. Used only when remote endpoint is MSS or DSS and when chType is set to MAILBOX_CHTYPE_MULTI.

Warning
On XWR14xx this field is NOT used. Application does not need to set this field in XWR14xx.
On XWR16xx/XWR18xx/XWR68xx this field is used for the communication between MSS<->DSS only and needs to be set accordingly. For MSS<->BSS or DSS<->BSS communication in XWR16xx/XWR18xx/XWR68xx application does not need to set this field.
Mailbox_ChType Mailbox_Config_t::chType

Mailbox channel type. Used only when remote endpoint is MSS or DSS.

Warning
On XWR14xx this field is NOT used. Application does not need to set this field in XWR14xx.
On XWR16xx/XWR18xx/XWR68xx this field is used for the communication between MSS<->DSS only and needs to be set accordingly. For MSS<->BSS or DSS<->BSS communication in XWR16xx/XWR18xx/XWR68xx application does not need to set this field.

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

Copyright 2018, Texas Instruments Incorporated