PDK API Guide for J721E
|
MailboxP interface
Files | |
file | MailboxP.h |
Mailbox module for the RTOS Porting Interface. | |
Data Structures | |
struct | MailboxP_Params |
Basic MailboxP Parameters. More... | |
Functions | |
void | MailboxP_Params_init (MailboxP_Params *params) |
Initialize params structure to default values. More... | |
MailboxP_Handle | MailboxP_create (const MailboxP_Params *params) |
Function to create a mailbox. More... | |
MailboxP_Status | MailboxP_delete (MailboxP_Handle handle) |
Function to delete a mailbox. More... | |
MailboxP_Status | MailboxP_post (MailboxP_Handle handle, void *msg, uint32_t timeout) |
Function to post an message to the mailbox. More... | |
MailboxP_Status | MailboxP_pend (MailboxP_Handle handle, void *msg, uint32_t timeout) |
Function to pend on a message for the mailbox. More... | |
int32_t | MailboxP_getNumPendingMsgs (MailboxP_Handle handle) |
Function to return the count of the pending messages. More... | |
Typedefs | |
typedef void * | MailboxP_Handle |
Opaque client reference to an instance of a MailboxP. More... | |
Enumerations | |
enum | MailboxP_Status { MailboxP_OK = 0, MailboxP_FAILURE = (-(int32_t)1), MailboxP_TIMEOUT = (-(int32_t)2) } |
Status codes for MailboxP APIs. More... | |
Macros | |
#define | MailboxP_WAIT_FOREVER (~((uint32_t)0U)) |
Wait forever define. More... | |
#define | MailboxP_NO_WAIT ((uint32_t)0U) |
No wait define. More... | |
#define MailboxP_WAIT_FOREVER (~((uint32_t)0U)) |
Wait forever define.
#define MailboxP_NO_WAIT ((uint32_t)0U) |
No wait define.
typedef void* MailboxP_Handle |
Opaque client reference to an instance of a MailboxP.
A MailboxP_Handle returned from the MailboxP_create represents that instance and is used in the other instance based functions
enum MailboxP_Status |
void MailboxP_Params_init | ( | MailboxP_Params * | params | ) |
Initialize params structure to default values.
params | Pointer to the instance configuration parameters. |
MailboxP_Handle MailboxP_create | ( | const MailboxP_Params * | params | ) |
Function to create a mailbox.
params | Pointer to the instance configuration parameters. |
MailboxP_Status MailboxP_delete | ( | MailboxP_Handle | handle | ) |
Function to delete a mailbox.
handle | A MailboxP_Handle returned from MailboxP_create |
MailboxP_Status MailboxP_post | ( | MailboxP_Handle | handle, |
void * | msg, | ||
uint32_t | timeout | ||
) |
Function to post an message to the mailbox.
handle | A MailboxP_Handle returned from MailboxP_create |
msg | The message to post |
timeout | Timeout (in milliseconds) to wait for post a message to the mailbox. |
MailboxP_Status MailboxP_pend | ( | MailboxP_Handle | handle, |
void * | msg, | ||
uint32_t | timeout | ||
) |
Function to pend on a message for the mailbox.
handle | A MailboxP_Handle returned from MailboxP_create |
msg | The message to pend |
timeout | Timeout (in milliseconds) to wait for pend on a message to the mailbox. |
int32_t MailboxP_getNumPendingMsgs | ( | MailboxP_Handle | handle | ) |
Function to return the count of the pending messages.
handle | A MailboxP_Handle returned from MailboxP_create |