xref: /utopia/UTPA2-700.0.x/projects/tmplib/include/drvMIU_v2.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) 2006-2007 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 ///
97 /// @file   drvMIU_v2.h
98 /// @brief  MIU Driver Interface
99 /// @author MStar Semiconductor Inc.
100 ///////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _DRV_MIU_V2_H_
103 #define _DRV_MIU_V2_H_
104 
105 #ifdef __cplusplus
106 extern "C"
107 {
108 #endif
109 
110 #include "MsTypes.h"
111 
112 //-------------------------------------------------------------------------------------------------
113 // Defines
114 //-------------------------------------------------------------------------------------------------
115 typedef enum _eMIUIoctlCmd
116 {
117     MDrv_CMD_MIU_Init,
118     MDrv_CMD_MIU_Mask_Req_OPM_R,
119     MDrv_CMD_MIU_Mask_Req_DNRB_R,
120     MDrv_CMD_MIU_Mask_Req_DNRB_W,
121     MDrv_CMD_MIU_Mask_Req_DNRB_RW,
122     MDrv_CMD_MIU_Mask_Req_SC_RW,
123     MDrv_CMD_MIU_Mask_Req_MVOP_R,
124     MDrv_CMD_MIU_Mask_Req_MVD_R,
125     MDrv_CMD_MIU_Mask_Req_MVD_W,
126     MDrv_CMD_MIU_Mask_Req_MVD_RW,
127     MDrv_CMD_MIU_Mask_Req_AUDIO_RW,
128     MDrv_CMD_MIU_Mask_Req,
129     MDrv_CMD_MIU_UnMask_Req,
130     MDrv_CMD_MIU_SetSsc,
131     MDrv_CMD_MIU_SetSscValue,
132     MDrv_CMD_MIU_Protect,
133     MDrv_CMD_MIU_SelMIU,
134     MDrv_CMD_MIU_GetProtectInfo,
135     MDrv_CMD_MIU_SetGroupPriority,
136     MDrv_CMD_MIU_SetHighPriority,
137 
138 }eMIUIoctlCmd;
139 
140 //-------------------------------------------------------------------------------------------------
141 // Macros
142 //-------------------------------------------------------------------------------------------------
143 
144 
145 //-------------------------------------------------------------------------------------------------
146 // Type and Structure Declaration
147 //-------------------------------------------------------------------------------------------------
148 
149 //-------------------------------------------------------------------------------------------------
150 // Extern Global Variabls
151 //-------------------------------------------------------------------------------------------------
152 
153 //-------------------------------------------------------------------------------------------------
154 // Extern Functions
155 //-------------------------------------------------------------------------------------------------
156 
157 //////////////////////////////////////////////////////////////
158 // below are for utopia20 cmd and parameters structure
159 // for below cmds
160 // MDrv_CMD_MIU_Mask_Req_OPM_R,
161 // MDrv_CMD_MIU_Mask_Req_DNRB_R,
162 // MDrv_CMD_MIU_Mask_Req_DNRB_W,
163 // MDrv_CMD_MIU_Mask_Req_DNRB_RW,
164 // MDrv_CMD_MIU_Mask_Req_SC_RW,
165 // MDrv_CMD_MIU_Mask_Req_MVOP_R,
166 // MDrv_CMD_MIU_Mask_Req_MVD_R,
167 // MDrv_CMD_MIU_Mask_Req_MVD_W,
168 // MDrv_CMD_MIU_Mask_Req_MVD_RW,
169 // MDrv_CMD_MIU_Mask_Req_AUDIO_RW,
170 typedef struct _MIU_MASK
171 {
172     MS_U8 u8Mask;
173     MS_U8 u8Miu;
174 }MIU_MIU_MASK, *PMIU_MIU_MASK;
175 
176 // for below cmds MDrv_CMD_MIU_Mask_Req, MDrv_CMD_MIU_UnMask_Req
177 typedef struct _MIU_MIUREQ_MASK
178 {
179     MS_U8 u8Miu;
180     eMIUClientID eClientID;
181 }MIU_MIUREQ_MASK, *PMIU_MIUREQ_MASK;
182 
183 // for below cmds MDrv_CMD_MIU_SetSsc
184 typedef struct _MIU_SET_SSC
185 {
186     MS_U16 u16Fmodulation;
187     MS_U16 u16FDeviation;
188     MS_BOOL bEnable;
189 }MIU_SET_SSC, *PMIU_SET_SSC;
190 
191 // for below cmds MDrv_CMD_MIU_SetSscValue
192 typedef struct _MIU_SET_SSCVALUE
193 {
194     MS_U8 u8MiuDev;
195     MS_U16 u16Fmodulation;
196     MS_U16 u16FDeviation;
197     MS_BOOL bEnable;
198 }MIU_SET_SSCVALUE, *PMIU_SET_SSCVALUE;
199 
200 // for below cmds MDrv_CMD_MIU_Protect
201 typedef struct _MIU_PROTECT
202 {
203     MS_U8 u8Blockx;
204     MS_U8 *pu8ProtectId;
205     MS_PHY phy64Start;
206     MS_PHY phy64End;
207     MS_BOOL bSetFlag;
208 }MIU_PROTECT, *PMIU_PROTECT;
209 
210 // for below cmds MDrv_CMD_MIU_SelMIU
211 typedef struct _MIU_SELMIU
212 {
213     eMIUClientID eClientID;
214     eMIU_SelType eType;
215 }MIU_SELMIU, *PMIU_SELMIU;
216 
217 // for below cmds MDrv_CMD_MIU_GetProtectInfo
218 typedef struct _MIU_GETPROTECTINFO
219 {
220     MS_U8 u8MiuDev;
221     MIU_PortectInfo *pInfo;
222 }MIU_GETPROTECTINFO, *PMIU_GETPROTECTINFO;
223 
224 // for below cmds MDrv_CMD_MIU_SetGroupPriority
225 typedef struct _MIU_SETGROUPPRIORITY
226 {
227     MS_U8 u8MiuDev;
228     MIU_GroupPriority sPriority;
229 }MIU_SETGROUPPRIORITY, *PMIU_SETGROUPPRIORITY;
230 
231 
232 // for below cmds MDrv_CMD_MIU_SetHighPriority
233 typedef struct _MIU_SETHIGHPRIORITY
234 {
235     MS_U8 u8MiuDev;
236     eMIUClientID eClientID;
237     MS_BOOL bMask;
238 }MIU_SETHIGHPRIORITY, *PMIU_SETHIGHPRIORITY;
239 
240 #ifdef __cplusplus
241 }
242 #endif
243 
244 #endif // _DRV_MIU_V2_H_
245 
246