xref: /utopia/UTPA2-700.0.x/mxlib/include/apiDAC_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 ///
97 /// @file   apiDAC_v2.h
98 /// @brief  MStar Graphics Output Path API
99 /// @author MStar Semiconductor Inc.
100 ///////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _DAC_V2_H_
103 #define _DAC_V2_H_
104 
105 #ifdef __cplusplus
106 extern "C"
107 {
108 #endif
109 #include "UFO.h"
110 //-------------------------------------------------------------------------------------------------
111 //  Macro and Define
112 //-------------------------------------------------------------------------------------------------
113 
114 /// DAC CMD
115 typedef enum
116 {
117     //DAC command
118     E_DAC_GET_LIBVER,
119     E_DAC_GET_INFO,
120     E_DAC_GET_STATUS,
121     E_DAC_SET_DBG_LEVEL,
122     E_DAC_INIT,
123     E_DAC_ENABLE,
124     E_DAC_SET_CLKINV,
125     E_DAC_SET_YPBPR_OUTPUTTIMING,
126     E_DAC_SET_OUTPUT_SOURCE,
127     E_DAC_SET_OUTPUT_LEVEL,
128     E_DAC_SET_OUTPUT_SWAPSEL,
129     E_DAC_ONOFF_SD,
130     E_DAC_ONOFF_HD,
131     E_DAC_CLKSEL,
132     E_DAC_DUMP_TABLE,
133     E_DAC_EXIT,
134     E_DAC_SET_IHALF_OUTPUT,
135     E_DAC_SET_QUART_OUTPUT,
136     E_DAC_SET_DAC_STATE,
137     E_DAC_HOTPLUG_DETECT,
138     E_DAC_SET_POWER_STATE,
139     E_DAC_GET_GETOUTPUTINTERLACETIMING,
140     E_DAC_SET_WSSONOFF,
141     E_DAC_RESET_WSSDATA,
142     E_DAC_SET_WSSOUTPUT,
143     E_DAC_GET_SD_STATUS,
144     E_DAC_GET_HD_STATUS,
145     E_DAC_GET_WSSSTATUS,
146     E_DAC_ENABLE_ICT,
147     E_DAC_SET_VGA_HSYNCVSYNC,
148 }E_DAC_IOCTL_CMDS;;
149 
150 typedef struct DLL_PACKED
151 {
152     const MSIF_Version **ppVersion;
153     APIDAC_Result eReturnValue;
154 } stDAC_GET_LIBVER,*pstDAC_GET_LIBVER;
155 
156 typedef struct DLL_PACKED
157 {
158     const DAC_ApiInfo* stReturnValue;
159 } stDAC_GET_INFO, *pstDAC_GET_INFO;
160 
161 #ifdef UFO_XC_GETOUTPUTINTELACETIMING
162 typedef struct
163 {
164     MS_BOOL bReturnValue;
165 } stDAC_GET_OUTPUTINTERLACETIMING, *pstDAC_GET_OUTPUTINTERLACETIMING;
166 #endif
167 
168 typedef struct DLL_PACKED
169 {
170     DAC_ApiStatus* pDacStatus;
171     MS_BOOL bReturnValue;
172 } stDAC_GET_STATUS,*pstDAC_GET_STATUS;
173 
174 typedef struct
175 {
176     MS_U16 u16DbgSwitch;
177     MS_BOOL bReturnValue;
178 } stDAC_SET_DBG_LEVEL,*pstDAC_SET_DBG_LEVEL;
179 
180 typedef struct
181 {
182     MS_BOOL bReturnValue;
183 } stDAC_INIT,*pstDAC_INIT;
184 
185 typedef struct
186 {
187     MS_BOOL bEnable;
188     MS_BOOL bIsYPbPr;
189 } stDAC_ENABLE, *pstDAC_ENABLE;
190 
191 typedef struct
192 {
193     MS_BOOL bEnable;
194     MS_BOOL bIsYPbPr;
195 } stDAC_SET_CLKINV, *pstDAC_SET_CLKINV;
196 
197 typedef struct
198 {
199     E_OUTPUT_VIDEO_TIMING_TYPE eTiming;
200 } stDAC_SET_YPBPR_OUTPUTTIMING,*pstDAC_SET_YPBPR_OUTPUTTIMING;
201 
202 typedef struct
203 {
204     E_DAC_OUTPUT_TYPE enOutputType;
205     MS_BOOL bIsYPbPr;
206 } stDAC_SET_OUTPUT_SOURCE,*pstDAC_SET_OUTPUT_SOURCE;
207 
208 typedef struct
209 {
210     E_DAC_MAX_OUTPUT_LEVEL enLevel;
211     MS_BOOL bIsYPbPr;
212 } stXC_SET_OUTPUT_LEVEL, *pstXC_SET_OUTPUT_LEVEL;
213 
214 typedef struct
215 {
216     E_DAC_MAX_OUTPUT_LEVEL enLevel;
217     MS_BOOL bIsYPbPr;
218 } stDAC_SET_OUTPUT_LEVEL, *pstDAC_SET_OUTPUT_LEVEL;
219 
220 typedef struct
221 {
222     E_DAC_SWAP_SEL enSwap;
223     MS_BOOL bIsYPbPr;
224 } stDAC_SET_OUTPUT_SWAPSEL, *pstDAC_SET_OUTPUT_SWAPSEL;
225 
226 typedef struct
227 {
228     E_DAC_SD_ENABLE_CTRL enBit;
229 } stDAC_ONOFF_SD,*pstDAC_ONOFF_SD;
230 
231 typedef struct
232 {
233     E_DAC_SD_ENABLE_CTRL enBit;
234 } stDAC_GET_SD_STATUS,*pstDAC_GET_SD_STATUS;
235 
236 typedef struct
237 {
238     E_DAC_HD_ENABLE_CTRL enBit;
239 } stDAC_ONOFF_HD, *pstDAC_ONOFF_HD;
240 
241 typedef struct
242 {
243     E_DAC_HD_ENABLE_CTRL enBit;
244 } stDAC_GET_HD_STATUS,*pstDAC_GET_HD_STATUS;
245 
246 typedef struct
247 {
248     E_OUTPUT_VIDEO_TIMING_TYPE eTiming;
249     E_OUTPUT_BIT_TYPE ebits;
250 } stDAC_CLKSEL, *pstDAC_CLKSEL;
251 
252 typedef struct DLL_PACKED
253 {
254     MS_U8 *pDACTable;
255     MS_U8 u8DACtype;
256 } stDAC_DUMP_TABLE, *pstDAC_DUMP_TABLE;
257 
258 typedef struct
259 {
260     MS_BOOL bEnable;
261     MS_BOOL bIsYPbPr;
262 } stDAC_SET_IHALF_OUTPUT, *pstDAC_SET_IHALF_OUTPUT;
263 
264 typedef struct
265 {
266     MS_BOOL bEnable;
267     MS_BOOL bIsYPbPr;
268 } stDAC_SET_QUART_OUTPUT, *pstDAC_SET_QUART_OUTPUT;
269 
270 typedef struct
271 {
272     MS_BOOL bEnabled;
273     MS_BOOL bIsYPbPr;
274 } stDAC_SET_DAC_STATE, *pstDAC_SET_DAC_STATE;
275 
276 typedef struct DLL_PACKED
277 {
278     E_DAC_DETECT SelDAC;
279     E_DAC_DETECT_TYPE DetectType;
280     MS_BOOL *State;
281     MS_BOOL bReturnValue;
282 } stDAC_HOTPLUG_DETECT, *pstDAC_HOTPLUG_DETECT;
283 
284 typedef struct
285 {
286     E_DAC_POWER_MODE ePowerState;
287     MS_U32 stReturnValue;
288 } stDAC_POWER_MODE, *pstDAC_POWER_MODE;
289 
290 typedef struct
291 {
292     MS_BOOL bEnable;
293     MS_BOOL bIsYPbPr;
294     MS_BOOL bReturnValue;
295 } stDAC_SET_WSSONOFF, *pstDAC_SET_WSSONOFF;
296 
297 typedef struct
298 {
299     MS_BOOL bIsYPbPr;
300     MS_BOOL *pEnable;
301     DAC_SETWSS_INFO *pSetWSS_Data;
302     MS_BOOL bReturnValue;
303 } stDAC_GET_WSSSTATUS, *pstDAC_GET_WSSSTATUS;
304 
305 typedef struct
306 {
307     MS_BOOL bIsYPbPr;
308     MS_BOOL bReturnValue;
309 } stDAC_RESET_WSSDATA, *pstDAC_RESET_WSSDATA;
310 
311 typedef struct
312 {
313     MS_BOOL bEnable;
314     MS_BOOL bIsYPbPr;
315     DAC_SETWSS_INFO SetWSS_Data;
316     MS_BOOL bReturnValue;
317 } stDAC_SET_WSSOUTPUT, *pstDAC_SET_WSSOUTPUT;
318 
319 typedef struct
320 {
321     MS_BOOL bEnable;
322     MS_BOOL bReturnValue;
323 } stDAC_ENABLE_ICT, *pstDAC_ENABLE_ICT;
324 
325 typedef struct
326 {
327     MS_BOOL bEnable;
328 } stDAC_SET_VGA_HsyncVsync, *pstDAC_SET_VGA_HSYNCVSYNC;
329 
330 
331 #ifdef __cplusplus
332 }
333 #endif
334 
335 #endif // _API_DAC_H_
336 
337