xref: /utopia/UTPA2-700.0.x/mxlib/include/apiHDMITx2.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   apiHDMITx.h
98 /// @brief  HDMITx Interface
99 /// @author MStar Semiconductor Inc.
100 ///
101 ///  CL351033++:
102 ///   Add CEC function for STB
103 ///  CL310477++:
104 ///   Open analog setting for the different board condition
105 ///  CL309397++:
106 ///   Modify apiHDMITx prototype for NDS
107 ///  CL308729++:
108 ///   Fix AVMUTE problem while HDCP is on
109 ///  CL299817++:
110 ///  i. Add I2C timeout mechanism in EDID and HDCP
111 ///  ii. Add SET_AVMUTE API to avoid transition garbage noise while timing changed ]]>
112 ///  CL288415++:
113 ///   Add SRM DSA Signature Checking function
114 ///  CL283331++:
115 ///   Fix HDMI v1.3 deep color mode output unstable problem
116 ///  CL282607++:
117 ///   i. Fix YUV422 / YUV444 bugs
118 ///   ii. Add MApi_HDMITx_GetHdcpKey() to get HDCP key from external storage.
119 ///  CL276751++:
120 ///   Modify HDMI / HDCP state mechine for NDS
121 ///  CL275230++:
122 ///   i. MApi_HDMITx_GetRxDCInfoFromEDID() to get Rx's deep color information from EDID
123 ///   ii. MApi_HDMITx_SetHDMITxMode_CD() to set output mode and deep color setting
124 ///  CL266666++:
125 ///   Add event report for NDS
126 ///  CL263961++:
127 ///   Add CEC init and checkbuffer for NDS
128 ///  CL260934++:
129 ///   Add some customized APIs for NDS
130 ///  CL259645++:
131 ///   i. Remove EDID header check. If header is wrong, force to DVI output
132 ///   ii. Add force output mode "MApi_HDMITx_ForceHDMIOutputMode()"
133 ///////////////////////////////////////////////////////////////////////////////////////////////////
134 
135 #ifndef _API_HDMITX_H_
136 #define _API_HDMITX_H_
137 
138 #include "MsTypes.h"
139 //#include "halHDMITx.h"
140 //#include "drvHDMITx.h"
141 //#include "regHDMITx.h"
142 
143 
144 
145 #ifdef __cplusplus
146 extern "C"
147 {
148 #endif
149 
150 
151 //-------------------------------------------------------------------------------------------------
152 //  Macro and Define
153 //-------------------------------------------------------------------------------------------------
154 
155 //-------------------------------------------------------------------------------------------------
156 //  Type and Structure
157 //-------------------------------------------------------------------------------------------------
158 typedef enum
159 {
160     HDMITX_RES_640x480p        =0,
161     HDMITX_RES_720x480i         = 1,
162     HDMITX_RES_720x576i         = 2,
163     HDMITX_RES_720x480p         = 3,
164     HDMITX_RES_720x576p         = 4,
165     HDMITX_RES_1280x720p_50Hz   = 5,
166     HDMITX_RES_1280x720p_60Hz   = 6,
167     HDMITX_RES_1920x1080i_50Hz  = 7,
168     HDMITX_RES_1920x1080i_60Hz  = 8,
169     HDMITX_RES_1920x1080p_24Hz  = 9,
170     HDMITX_RES_1920x1080p_25Hz  = 10,
171     HDMITX_RES_1920x1080p_30Hz  = 11,
172     HDMITX_RES_1920x1080p_50Hz  = 12,
173     HDMITX_RES_1920x1080p_60Hz  = 13,
174     HDMITX_RES_MAX              = 14,
175 } HDMITX_VIDEO_TIMING;
176 
177 //-------------------------------------------------------------------------------------------------
178 //  Function and Variable
179 //-------------------------------------------------------------------------------------------------
180 
181 //*********************//
182 //        DVI / HDMI           //
183 //*********************//
184 
185 MS_BOOL MApi_HDMITx2_Init(void);
186 
187 MS_BOOL MApi_HDMITx2_Exit(void);
188 
189 void MApi_HDMITx2_SetInitTiming(HDMITX_VIDEO_TIMING TFlag1);
190 
191 #ifdef __cplusplus
192 }
193 #endif
194 
195 
196 #endif // _API_HDMITX_H_
197 
198