xref: /utopia/UTPA2-700.0.x/modules/mbx/drv/mbx/linux/mdrv_mbx_st.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1 //<MStar Software>
2 //******************************************************************************
3 // MStar Software
4 // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
5 // All software, firmware and related documentation herein ("MStar Software") are
6 // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
7 // law, including, but not limited to, copyright law and international treaties.
8 // Any use, modification, reproduction, retransmission, or republication of all
9 // or part of MStar Software is expressly prohibited, unless prior written
10 // permission has been granted by MStar.
11 //
12 // By accessing, browsing and/or using MStar Software, you acknowledge that you
13 // have read, understood, and agree, to be bound by below terms ("Terms") and to
14 // comply with all applicable laws and regulations:
15 //
16 // 1. MStar shall retain any and all right, ownership and interest to MStar
17 //    Software and any modification/derivatives thereof.
18 //    No right, ownership, or interest to MStar Software and any
19 //    modification/derivatives thereof is transferred to you under Terms.
20 //
21 // 2. You understand that MStar Software might include, incorporate or be
22 //    supplied together with third party`s software and the use of MStar
23 //    Software may require additional licenses from third parties.
24 //    Therefore, you hereby agree it is your sole responsibility to separately
25 //    obtain any and all third party right and license necessary for your use of
26 //    such third party`s software.
27 //
28 // 3. MStar Software and any modification/derivatives thereof shall be deemed as
29 //    MStar`s confidential information and you agree to keep MStar`s
30 //    confidential information in strictest confidence and not disclose to any
31 //    third party.
32 //
33 // 4. MStar Software is provided on an "AS IS" basis without warranties of any
34 //    kind. Any warranties are hereby expressly disclaimed by MStar, including
35 //    without limitation, any warranties of merchantability, non-infringement of
36 //    intellectual property rights, fitness for a particular purpose, error free
37 //    and in conformity with any international standard.  You agree to waive any
38 //    claim against MStar for any loss, damage, cost or expense that you may
39 //    incur related to your use of MStar Software.
40 //    In no event shall MStar be liable for any direct, indirect, incidental or
41 //    consequential damages, including without limitation, lost of profit or
42 //    revenues, lost or damage of data, and unauthorized system use.
43 //    You agree that this Section 4 shall still apply without being affected
44 //    even if MStar Software has been modified by MStar in accordance with your
45 //    request or instruction for your use, except otherwise agreed by both
46 //    parties in writing.
47 //
48 // 5. If requested, MStar may from time to time provide technical supports or
49 //    services in relation with MStar Software to you for your use of
50 //    MStar Software in conjunction with your or your customer`s product
51 //    ("Services").
52 //    You understand and agree that, except otherwise agreed by both parties in
53 //    writing, Services are provided on an "AS IS" basis and the warranty
54 //    disclaimer set forth in Section 4 above shall apply.
55 //
56 // 6. Nothing contained herein shall be construed as by implication, estoppels
57 //    or otherwise:
58 //    (a) conferring any license or right to use MStar name, trademark, service
59 //        mark, symbol or any other identification;
60 //    (b) obligating MStar or any of its affiliates to furnish any person,
61 //        including without limitation, you and your customers, any assistance
62 //        of any kind whatsoever, or any information; or
63 //    (c) conferring any license or right under any intellectual property right.
64 //
65 // 7. These terms shall be governed by and construed in accordance with the laws
66 //    of Taiwan, R.O.C., excluding its conflict of law rules.
67 //    Any and all dispute arising out hereof or related hereto shall be finally
68 //    settled by arbitration referred to the Chinese Arbitration Association,
69 //    Taipei in accordance with the ROC Arbitration Law and the Arbitration
70 //    Rules of the Association by three (3) arbitrators appointed in accordance
71 //    with the said Rules.
72 //    The place of arbitration shall be in Taipei, Taiwan and the language shall
73 //    be English.
74 //    The arbitration award shall be final and binding to both parties.
75 //
76 //******************************************************************************
77 //<MStar Software>
78 ///////////////////////////////////////////////////////////////////////////////
79 //
80 // Copyright (c) 2008-2009 MStar Semiconductor, Inc.
81 // All rights reserved.
82 //
83 // Unless otherwise stipulated in writing, any and all information contained
84 // herein regardless in any format shall remain the sole proprietary of
85 // MStar Semiconductor Inc. and be kept in strict confidence
86 // ("MStar Confidential Information") by the recipient.
87 // Any unauthorized act including without limitation unauthorized disclosure,
88 // copying, use, reproduction, sale, distribution, modification, disassembling,
89 // reverse engineering and compiling of the contents of MStar Confidential
90 // Information is unlawful and strictly prohibited. MStar hereby reserves the
91 // rights to any and all damages, losses, costs and expenses resulting therefrom.
92 //
93 ///////////////////////////////////////////////////////////////////////////////
94 //////////////////////////////////////////////////////////////////////////////////////////////////
95 //
96 // @file   mdrv_mbx_st.h
97 // @brief  Mialbox KMD Driver Interface
98 // @author MStar Semiconductor Inc.
99 //
100 // Driver to initialize and access mailbox.
101 //     - Provide functions to initialize/de-initialize mailbox
102 //     - Provide mailbox functional access.
103 //////////////////////////////////////////////////////////////////////////////////////////////////
104 
105 
106 #ifndef _MDRV_MBX_ST_H
107 #define _MDRV_MBX_ST_H
108 
109 //=============================================================================
110 // Includs
111 //=============================================================================
112 
113 //=============================================================================
114 // Type and Structure Declaration
115 //=============================================================================
116 //IO Ctrl struct defines:
117 
118 typedef struct  __attribute__((packed))
119 {
120     MBX_CPU_ID eHKCPU;
121     MBX_ROLE_ID eHostRole;
122     MS_U32 u32TimeoutMillSecs;
123     MBX_Result mbxResult;
124 }MS_MBX_INIT_INFO, *PMS_MBX_INIT_INFO;
125 
126 typedef struct  __attribute__((packed))
127 {
128     MS_BOOL  bInfo;
129     MBX_Result mbxResult;
130 }MS_MBX_SET_BINFO, *PMS_MBX_SET_BINFO;
131 
132 typedef struct  __attribute__((packed))
133 {
134     MBX_Class eMsgClass;
135     MS_U16 	u16MsgQueueSize;
136     MBX_Result mbxResult;
137 }MS_MBX_REGISTER_MSG, *PMS_MBX_REGISTER_MSG;
138 
139 typedef struct  __attribute__((packed))
140 {
141     MBX_Class eMsgClass;
142     MS_BOOL bForceDiscardMsgQueue;
143     MBX_Result mbxResult;
144 }MS_MBX_UNREGISTER_MSG, *PMS_MBX_UNREGISTER_MSG;
145 
146 typedef struct  __attribute__((packed))
147 {
148     MBX_Class eMsgClass;
149     MBX_Result mbxResult;
150 }MS_MBX_CLEAR_MSG, *PMS_MBX_CLEAR_MSG;
151 
152 typedef struct  __attribute__((packed))
153 {
154     MBX_Msg *pMsg;
155     MBX_Result mbxResult;
156 }MS_MBX_SEND_MSG, *PMS_MBX_SEND_MSG;
157 
158 typedef struct  __attribute__((packed))
159 {
160     MBX_Class eTargetClass;
161     MBX_Msg *pMsg;
162     MS_U32 u32WaitMillSecs;
163     MS_U32 u32Flag;
164     MBX_Result mbxResult;
165 }MS_MBX_RECV_MSG, *PMS_MBX_RECV_MSG;
166 
167 typedef struct  __attribute__((packed))
168 {
169     MBX_Class eTargetClass;
170     MBX_MSGQ_Status *pMsgQueueStatus;
171     MBX_Result mbxResult;
172 }MS_MBX_GET_MSGQSTATUS, *PMS_MBX_GET_MSGQSTATUS;
173 
174 typedef struct  __attribute__((packed))
175 {
176     MS_BOOL bEnabled;
177     MS_S32  s32RefCnt;
178 }MS_MBX_GET_DRVSTATUS, *PMS_MBX_GET_DRVSTATUS;
179 
180 typedef struct  __attribute__((packed))
181 {
182     MBX_ROLE_ID eTargetRole;
183     MS_U8 *pU8Info;
184     MS_U8 u8Size;
185     MBX_Result mbxResult;
186 }MS_MBX_CPROSYNC_INFORMATION, *PMS_MBX_CPROSYNC_INFORMATION;
187 
188 #endif //_MDRV_MBX_ST_H
189