xref: /utopia/UTPA2-700.0.x/modules/hdmi/hal/curry/hdmitx/include/halHDMIUtilTx.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-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    halHDMIUtilTx.h
98 /// @author MStar Semiconductor,Inc.
99 /// @brief  HDMITx Utility HAL
100 /////////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _HAL_HDMIUTILTX_H_
103 #define _HAL_HDMIUTILTX_H_
104 
105 
106 #ifdef __cplusplus
107 extern "C"
108 {
109 #endif
110 
111 //-------------------------------------------------------------------------------------------------
112 //  Hardware Capability
113 //-------------------------------------------------------------------------------------------------
114 
115 
116 //-------------------------------------------------------------------------------------------------
117 //  Macro and Define
118 //-------------------------------------------------------------------------------------------------
119 
120 #define BIT0  0x0001U
121 #define BIT1  0x0002U
122 #define BIT2  0x0004U
123 #define BIT3  0x0008U
124 #define BIT4  0x0010U
125 #define BIT5  0x0020U
126 #define BIT6  0x0040U
127 #define BIT7  0x0080U
128 #define BIT8  0x0100U
129 #define BIT9  0x0200U
130 #define BIT10 0x0400U
131 #define BIT11 0x0800U
132 #define BIT12 0x1000U
133 #define BIT13 0x2000U
134 #define BIT14 0x4000U
135 #define BIT15 0x8000U
136 
137 //-------------------------------------------------------------------------------------------------
138 //  Type and Structure
139 //-------------------------------------------------------------------------------------------------
140 
141 typedef struct
142 {
143     MS_U32      bank;
144     MS_U16     address;
145     MS_U16     mask;
146     MS_U16     value;
147 } MSTHDMITX_REG_TYPE;
148 
149 
150 /////////////Wilson:: for Kano, HDMITX 2.0 architecture @20150702
151 typedef enum
152 {
153 	E_SCDC_SINK_VER_IDX =           0x01,
154     E_SCDC_SRC_VER_IDX =            0x02,
155     E_SCDC_UPDATE_0_IDX =           0x10,
156     E_SCDC_UPDATE_1_IDX=            0x11,
157     E_SCDC_TMDS_CONFIG_IDX =        0x20,
158     E_SCDC_SCRAMBLE_STAT_IDX =      0x21,
159     E_SCDC_CONFIG_0_IDX =           0x30,
160     E_SCDC_STATFLAG_0_IDX =         0x40,
161     E_SCDC_STATFLAG_1_IDX =         0x41,
162     E_SCDC_ERR_DET_START_IDX =      0x50,
163     E_SCDC_ERR_DET_CHKSUM_IDX =     0x56,
164     E_SCDC_TEST_CONFIG_0_IDX =      0xC0,
165     E_SCDC_MANUFACTURER_OUI_IDX =   0xD0,
166     E_SCDC_DEVICE_ID_IDX = 		    0xD3,
167     E_SCDC_MANUFACTURER_SPEC_IDX =  0xDE
168 } enMsHDMITX_SCDC_FIELD_OFFSET_LIST;
169 
170 
171 //-------------------------------------------------------------------------------------------------
172 //  Function and Variable
173 //-------------------------------------------------------------------------------------------------
174 
175 #ifdef MHAL_HDMIUTILTX_C
176 #define INTERFACE
177 #else
178 #define INTERFACE extern
179 #endif
180 
181 #if (defined(MSOS_TYPE_LINUX_KERNEL))
182 INTERFACE void MHal_HDMITx_SetIOMapBase(MS_VIRT u32Base, MS_VIRT u32PMBase, MS_VIRT u32CoproBase);
183 #else
184 INTERFACE void MHal_HDMITx_SetIOMapBase(MS_VIRT u32Base, MS_VIRT u32PMBase);
185 #endif
186 
187 INTERFACE MS_BOOL MHal_HDMITx_Rx74WriteByte(MS_U8 addr, MS_U8 value);
188 
189 INTERFACE MS_BOOL MHal_HDMITx_Rx74ReadByte(MS_U8  addr, MS_U8 *pBuf);
190 
191 INTERFACE MS_BOOL MHal_HDMITx_Rx74WriteBytes(MS_U8  addr, MS_U16  len, MS_U8  *buf);
192 
193 INTERFACE MS_BOOL MHal_HDMITx_Rx74ReadBytes(MS_U8  addr, MS_U16  len, MS_U8  *buf);
194 
195 INTERFACE MS_BOOL MHal_HDMITx_EdidReadBlock(MS_U8  num, MS_U8 *buf);
196 
197 INTERFACE MS_U16 MHal_HDMITx_Read(MS_U32 bank, MS_U16 address);
198 
199 INTERFACE void MHal_HDMITx_Write(MS_U32 bank, MS_U16 address, MS_U16 reg_data);
200 
201 INTERFACE void MHal_HDMITx_Mask_Write(MS_U32 bank, MS_U16 address, MS_U16 reg_mask, MS_U16 reg_data);
202 
203 INTERFACE void MHal_HDMITx_RegsTbl_Write(MSTHDMITX_REG_TYPE *pTable, MS_U8 num);
204 
205 INTERFACE MS_U16 MHal_HDMITxPM_Read(MS_U32 bank, MS_U16 address);
206 
207 INTERFACE void MHal_HDMITxPM_Write(MS_U32 bank, MS_U16 address, MS_U16 reg_data);
208 
209 INTERFACE void MHal_HDMITxPM_Mask_Write(MS_U32 bank, MS_U16 address, MS_U16 reg_mask, MS_U16 reg_data);
210 
211 // Read HDCP key from external EEPROM if not used internal HDCP key
212 INTERFACE MS_BOOL MHal_HDMITx_HDCPKeyReadByte(MS_U32 u32Addr, MS_U8 *pu8Buf, MS_U32 u32Size);
213 
214 INTERFACE void MHal_HDMITx_UtilDebugEnable(MS_BOOL benable);
215 
216 INTERFACE MS_U32 MHal_HDMITx_GetDDCDelayCount(void);
217 INTERFACE void MHal_HDMITx_SetDDCDelayCount(MS_U32 u32Delay);
218 INTERFACE MS_BOOL MHal_HDMITx_AdjustDDCFreq(MS_U32 u32Speed_K);
219 
220 //SCDC
221 INTERFACE void Mhal_HDMITx_SCDCSetTmdsConfig(MS_BOOL bClkRatio, MS_BOOL bScrambleEn);
222 INTERFACE MS_BOOL Mhal_HDMITx_SCDCAccessField(enMsHDMITX_SCDC_FIELD_OFFSET_LIST enField, MS_BOOL bReadAction, MS_U8* pucData, MS_U8 ucLen);
223 
224 #ifdef __cplusplus
225 }
226 #endif
227 
228 #endif // _HAL_HDMIUTILTX_H_
229 
230