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