PDK API Guide for J721E
MailboxP.h File Reference

Introduction

Mailbox module for the RTOS Porting Interface.

============================================================================


Go to the source code of this file.

Data Structures

struct  MailboxP_Params
 Basic MailboxP Parameters. More...
 

Macros

#define MailboxP_WAIT_FOREVER   (~((uint32_t)0U))
 Wait forever define. More...
 
#define MailboxP_NO_WAIT   ((uint32_t)0U)
 No wait define. 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...
 

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...