xref: /utopia/UTPA2-700.0.x/modules/vif/drv/vif/drvVIF_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) 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 #ifndef _DRVVIF_V2_H_
97 #define _DRVVIF_V2_H_
98 
99 #ifdef __cplusplus
100 extern "C"
101 {
102 #endif
103 
104 #include "MsCommon.h"
105 #include "MsIRQ.h"
106 #include "MsOS.h"
107 #include "MsTypes.h"
108 #include "drvVIF.h"
109 
110 //****************************************************************************
111 // Public attributes.
112 //****************************************************************************
113 
114 #ifndef BOOL
115 #define BOOL MS_BOOL
116 #endif
117 #ifndef BYTE
118 #define BYTE MS_U8
119 #endif
120 #ifndef WORD
121 #define WORD MS_U16
122 #endif
123 #ifndef DWORD
124 #define DWORD MS_U32
125 #endif
126 #ifndef U8
127 #define U8 MS_U8
128 #endif
129 #ifndef U16
130 #define U16 MS_U16
131 #endif
132 #ifndef U32
133 #define U32 MS_U32
134 #endif
135 #ifndef VIRT
136 #define VIRT MS_VIRT
137 #endif
138 
139 typedef enum
140 {
141     Drv_CMD_VIF_Version,
142     Drv_CMD_VIF_SetClock,
143     Drv_CMD_VIF_Init,
144     Drv_CMD_VIF_Exit,
145     Drv_CMD_VIF_Reset,
146     Drv_CMD_VIF_Handler,
147     Drv_CMD_VIF_SetSoundSystem,
148     Drv_CMD_VIF_SetIfFreq,
149     Drv_CMD_VIF_Read_CR_FOE,
150     Drv_CMD_VIF_Read_CR_LOCK_STATUS,
151     Drv_CMD_VIF_BypassDBBAudioFilter,
152     Drv_CMD_VIF_SetFreqBand,
153 
154     Drv_CMD_VIF_GetInputLevelIndicator,
155     Drv_CMD_VIF_SetParameter,
156     Drv_CMD_VIF_ShiftClk,
157     Drv_CMD_VIF_SetPowerState,
158     Drv_CMD_VIF_WriteByte,
159     Drv_CMD_VIF_ReadByte,
160 
161 } eVifIoctlOpt;
162 
163 typedef struct DLL_PACKED _VIF_INIT
164 {
165     VIFInitialIn *pVIF_InitData;
166     DWORD u32InitDataLen;
167 }eVIF_INIT, *PVIF_INIT;
168 
169 typedef struct DLL_PACKED _VIF_SETREGVALUE
170 {
171     U32 u32Addr;
172     U8 u8Value;
173 }VIF_SETREGVALUE, *PVIF_SETREGVALUE;
174 
175 typedef struct DLL_PACKED _VIF_SET_PARA
176 {
177     BOOL bRet;
178     VIF_PARA_GROUP ParaGroup;
179     void *pVIF_Para;
180     DWORD u32DataLen;
181 }VIF_SETPARA, *PVIF_SETPARA;
182 
183 typedef struct DLL_PACKED _VIF_COPYTOUSER
184 {
185     BOOL bEnable;
186     BYTE u8Value;
187     WORD u16Value;
188     DWORD u32Value;
189     EN_POWER_MODE u16PowerState;
190 }VIF_COPYTOUSER, *PVIF_COPYTOUSER;
191 
192 
193 #ifdef __cplusplus
194 }
195 #endif
196 
197 #endif //_DRVVIF_V2_H_
198 
199