PDK API Guide for AM65xx
MailboxP.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2021, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
47 #ifndef ti_osal_MailboxP__include
48 #define ti_osal_MailboxP__include
49 
50 #ifdef __cplusplus
51 extern "C" {
52 #endif
53 
54 #include <stdint.h>
55 #include <stdbool.h>
56 #include <stddef.h>
57 
61 typedef enum MailboxP_Status_e
62 {
66  MailboxP_FAILURE = (-(int32_t)1),
68  MailboxP_TIMEOUT = (-(int32_t)2)
70 
74 #define MailboxP_WAIT_FOREVER (~((uint32_t)0U))
75 
79 #define MailboxP_NO_WAIT ((uint32_t)0U)
80 
81 
88 typedef void *MailboxP_Handle;
89 
96 typedef struct MailboxP_Params_s
97 {
98  void *pErrBlk;
99  void *name;
100  uint32_t size;
101  uint32_t count;
102  uint32_t bufsize;
103  void *buf;
105 
106 
112 extern void MailboxP_Params_init(MailboxP_Params *params);
113 
121 extern MailboxP_Handle MailboxP_create(const MailboxP_Params *params);
122 
133 
150  void * msg,
151  uint32_t timeout);
152 
169  void * msg,
170  uint32_t timeout);
171 
179 extern int32_t MailboxP_getNumPendingMsgs(MailboxP_Handle handle);
180 
181 #ifdef __cplusplus
182 }
183 #endif
184 
185 #endif /* ti_osal_MailboxP__include */
186 /* @} */
uint32_t count
Definition: MailboxP.h:101
Definition: MailboxP.h:64
Definition: MailboxP.h:66
Basic MailboxP Parameters.
Definition: MailboxP.h:96
void * pErrBlk
Definition: MailboxP.h:98
void * buf
Definition: MailboxP.h:103
Definition: MailboxP.h:68
void * MailboxP_Handle
Opaque client reference to an instance of a MailboxP.
Definition: MailboxP.h:88
MailboxP_Status MailboxP_post(MailboxP_Handle handle, void *msg, uint32_t timeout)
Function to post an message to the mailbox.
int32_t MailboxP_getNumPendingMsgs(MailboxP_Handle handle)
Function to return the count of the pending messages.
uint32_t size
Definition: MailboxP.h:100
uint32_t bufsize
Definition: MailboxP.h:102
MailboxP_Status MailboxP_delete(MailboxP_Handle handle)
Function to delete a mailbox.
void * name
Definition: MailboxP.h:99
MailboxP_Handle MailboxP_create(const MailboxP_Params *params)
Function to create a mailbox.
MailboxP_Status MailboxP_pend(MailboxP_Handle handle, void *msg, uint32_t timeout)
Function to pend on a message for the mailbox.
MailboxP_Status
Status codes for MailboxP APIs.
Definition: MailboxP.h:61
void MailboxP_Params_init(MailboxP_Params *params)
Initialize params structure to default values.