xref: /utopia/UTPA2-700.0.x/projects/tmplib/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 
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_IOCTL_CMDS;;
139 
140 typedef struct
141 {
142     const MSIF_Version **ppVersion;
143     APIDAC_Result eReturnValue;
144 } stDAC_GET_LIBVER,*pstDAC_GET_LIBVER;
145 
146 typedef struct
147 {
148     const DAC_ApiInfo* stReturnValue;
149 } stDAC_GET_INFO, *pstDAC_GET_INFO;
150 
151 typedef struct
152 {
153     DAC_ApiStatus* pDacStatus;
154     MS_BOOL bReturnValue;
155 } stDAC_GET_STATUS,*pstDAC_GET_STATUS;
156 
157 typedef struct
158 {
159     MS_U16 u16DbgSwitch;
160     MS_BOOL bReturnValue;
161 } stDAC_SET_DBG_LEVEL,*pstDAC_SET_DBG_LEVEL;
162 
163 typedef struct
164 {
165     MS_BOOL bReturnValue;
166 } stDAC_INIT,*pstDAC_INIT;
167 
168 typedef struct
169 {
170     MS_BOOL bEnable;
171     MS_BOOL bIsYPbPr;
172 } stDAC_ENABLE, *pstDAC_ENABLE;
173 
174 typedef struct
175 {
176     MS_BOOL bEnable;
177     MS_BOOL bIsYPbPr;
178 } stDAC_SET_CLKINV, *pstDAC_SET_CLKINV;
179 
180 typedef struct
181 {
182     E_OUTPUT_VIDEO_TIMING_TYPE eTiming;
183 } stDAC_SET_YPBPR_OUTPUTTIMING,*pstDAC_SET_YPBPR_OUTPUTTIMING;
184 
185 typedef struct
186 {
187     E_DAC_OUTPUT_TYPE enOutputType;
188     MS_BOOL bIsYPbPr;
189 } stDAC_SET_OUTPUT_SOURCE,*pstDAC_SET_OUTPUT_SOURCE;
190 
191 typedef struct
192 {
193     E_DAC_MAX_OUTPUT_LEVEL enLevel;
194     MS_BOOL bIsYPbPr;
195 } stXC_SET_OUTPUT_LEVEL, *pstXC_SET_OUTPUT_LEVEL;
196 
197 typedef struct
198 {
199     E_DAC_SWAP_SEL enSwap;
200     MS_BOOL bIsYPbPr;
201 } stDAC_SET_OUTPUT_SWAPSEL, *pstDAC_SET_OUTPUT_SWAPSEL;
202 
203 typedef struct
204 {
205     E_DAC_SD_ENABLE_CTRL enBit;
206 } stDAC_ONOFF_SD,*pstDAC_ONOFF_SD;
207 
208 typedef struct
209 {
210     E_DAC_HD_ENABLE_CTRL enBit;
211 } stDAC_ONOFF_HD, *pstDAC_ONOFF_HD;
212 
213 typedef struct
214 {
215     E_OUTPUT_VIDEO_TIMING_TYPE eTiming;
216     E_OUTPUT_BIT_TYPE ebits;
217 } stDAC_CLKSEL, *pstDAC_CLKSEL;
218 
219 typedef struct
220 {
221     MS_U8 *pDACTable;
222     MS_U8 u8DACtype;
223 } stDAC_DUMP_TABLE, *pstDAC_DUMP_TABLE;
224 
225 typedef struct
226 {
227     MS_BOOL bEnable;
228     MS_BOOL bIsYPbPr;
229 } stDAC_SET_IHALF_OUTPUT, *pstDAC_SET_IHALF_OUTPUT;
230 
231 typedef struct
232 {
233     MS_BOOL bEnable;
234     MS_BOOL bIsYPbPr;
235 } stDAC_SET_QUART_OUTPUT, *pstDAC_SET_QUART_OUTPUT;
236 
237 typedef struct
238 {
239     MS_BOOL bEnabled;
240     MS_BOOL bIsYPbPr;
241 } stDAC_SET_DAC_STATE, *pstDAC_SET_DAC_STATE;
242 
243 typedef struct
244 {
245     E_DAC_DETECT SelDAC;
246     E_DAC_DETECT_TYPE DetectType;
247     MS_BOOL *State;
248     MS_BOOL bReturnValue;
249 } stDAC_HOTPLUG_DETECT, *pstDAC_HOTPLUG_DETECT;
250 
251 
252 #ifdef __cplusplus
253 }
254 #endif
255 
256 #endif // _API_DAC_H_
257 
258