IPC@CHIP Documentation - SC12 @CHIP-RTOS V1.10

Data Structures used in RTOS API - SC12 @CHIP-RTOS V1.10
IPC@CHIP Documentation Index
Data Structures
Here are the data structures used by the RTOS API. All constants and data structures are defined in the header file rtxapi.h
Notes:
Content :
● Byte alignment is required for all data structures used within the API.
● typedef_RTX_Msg
● typedef_RTX_Wait_Event
● typedef_RTX_Wait_Msg
● typedef_TaskDefBlock
● typedef_TaskList
● typedef_Task_StateData
● typedef_TimeDate_Structure
● typedef_TimerProc_Structure
RTX_Msg
Comments
typedef struct tag_rtx_msg{
unsigned int msgID; // Unique Message Exchange ID
char name[4]; // 4 characters, not null terminated
int mb0; // Numbers of message envelopes which can reside
int mb1; // in each of the four exchange mailboxes,
int mb2; // maximum 4 envelopes.
int mb3;
} RTX_Msg;
This structure is defined in the header file rtxapi.h.
Prior to making the RTX_CREATE_MSG call, the caller must set the following members of the RTX_Msg data
structure.
name
Here you can give the Message Exchange a unique four character name. This field is optional. If you plan to
use the RTX_FIND_MSGAPI then you should provide a unique name here for all Message Exchanges.
mb0 through mb3
State here the number of message envelopes for each of this Message Exchange's four priority
mailboxes. These counts are truncated to a maximum of 4 envelopes per mailbox inside this API. The
Page 236 / 400