1 /******************************************************************************
2  *
3  * Copyright (C) 2018 The Android Open Source Project
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at:
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  *
17  *****************************************************************************
18  * Originally developed and contributed by Ittiam Systems Pvt. Ltd, Bangalore
19 */
20 
21 /*****************************************************************************/
22 /*                                                                           */
23 /*  File Name         : osal_mbox.h                                          */
24 /*                                                                           */
25 /*  Description       : This file contains OSAL Mail box handle structure    */
26 /*                      definition.                                          */
27 /*                                                                           */
28 /*  List of Functions : None                                                 */
29 /*                                                                           */
30 /*  Issues / Problems : None                                                 */
31 /*                                                                           */
32 /*  Revision History  :                                                      */
33 /*                                                                           */
34 /*         DD MM YYYY   Author(s)       Changes (Describe the changes made)  */
35 /*         26 05 2006   Ittiam          Draft                                */
36 /*                                                                           */
37 /*****************************************************************************/
38 
39 #ifndef OSAL_MBOX_H
40 #define OSAL_MBOX_H
41 
42 /*****************************************************************************/
43 /* Constant Macros                                                           */
44 /*****************************************************************************/
45 
46 /*****************************************************************************/
47 /* Structures                                                                */
48 /*****************************************************************************/
49 
50 /* Mail box handle structure. In WIN32 mail boxes are associated with each   */
51 /* Thread. So, thread id represents the mail box in question. In POSIX, name */
52 /* distinguishs the mail boxes.                                              */
53 
54 typedef struct
55 {
56     WORD32 mq_id; /* Message queue identifier               */
57     void *mmr_handle; /* Pointer to memory manager handle       */
58     osal_t *hdl; /* Associated OSAL handle                 */
59 } mbox_handle_t;
60 
61 typedef struct
62 {
63     void *mmr_handle; /* Pointer to memory manager handle                 */
64     osal_t *hdl; /* Associated OSAL handle                           */
65 
66     void *count_sem; /* Semaphore to take care of get to an empty queue  */
67     void *sync_mutex; /* Mutex to maintain sync in post msg and get msg   */
68     void *data; /* msg posted or got from the queue                 */
69 
70     UWORD32 write_count; /* Post Count                                       */
71     UWORD32 read_count; /* Get Count                                        */
72     UWORD32 msg_size; /* Size of the msg                                  */
73     UWORD32 mbox_len; /* Max number of messages the mailbox can handle    */
74 } custom_mbox_handle_t;
75 
76 #endif /* OSAL_MBOX_H */
77