xref: /utopia/UTPA2-700.0.x/modules/dmx/hal/maserati/tso/halTSO.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) 20011-20013 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 // file   halTSO.h
97 // @brief  TS I/O (TSO) HAL
98 // @author MStar Semiconductor,Inc.
99 ////////////////////////////////////////////////////////////////////////////////////////////////////
100 #ifndef __HAL_TSO_H__
101 #define __HAL_TSO_H__
102 
103 #include "MsCommon.h"
104 
105 #include "regTSO.h"
106 
107 //--------------------------------------------------------------------------------------------------
108 //  Driver Compiler Option
109 //--------------------------------------------------------------------------------------------------
110 
111 //--------------------------------------------------------------------------------------------------
112 //  TSP Hardware Abstraction Layer
113 //--------------------------------------------------------------------------------------------------
114 
115 #define _TsoPid                      ((REG_Pid*)(REG_PIDFLT_BASE))
116 
117 //--------------------------------------------------------------------------------------------------
118 //  Macro of bit operations
119 //--------------------------------------------------------------------------------------------------
120 
121 
122 ////////////////////////////////////////////////
123 // HAL API
124 ////////////////////////////////////////////////
125 
126 // TSO in mux select
127 #define HAL_TSOIN_MUX_TS0                       0x0000UL
128 #define HAL_TSOIN_MUX_TS1                       0x0001UL
129 #define HAL_TSOIN_MUX_TS2                       0x0002UL
130 #define HAL_TSOIN_MUX_TS3                       0x0003UL
131 #define HAL_TSOIN_MUX_TS4                       0x0004UL
132 #define HAL_TSOIN_MUX_TS5                       0x0005UL
133 #define HAL_TSOIN_MUX_TSCB                      0xFFFFUL   //not supported
134 #define HAL_TSOIN_MUX_TSDEMOD0                  0x0007UL
135 #define HAL_TSOIN_MUX_TSDEMOD1                  0xFFFFUL   //not supported
136 #define HAL_TSOIN_MUX_MEM                       0x0008UL
137 #define HAL_TSOIN_MUX_MEM1                      0x0009UL
138 
139 // TSO output mux select
140 #define HAL_TSOOUT_MUX_NONE                     0x0000UL
141 #define HAL_TSOOUT_MUX_TS1                      0x0001UL
142 #define HAL_TSOOUT_MUX_TS3                      0x0003UL
143 
144 
145 // TSO In Clk select
146 #define HAL_TSO_CLKIN_TS0                       0x0000UL
147 #define HAL_TSO_CLKIN_TS1                       0x0001UL
148 #define HAL_TSO_CLKIN_TS2                       0x0002UL
149 #define HAL_TSO_CLKIN_TS3                       0x0004UL
150 #define HAL_TSO_CLKIN_TSCB                      0xFFFFUL  //not supported
151 #define HAL_TSO_CLKIN_TSDEMOD0                  0x0003UL
152 #define HAL_TSO_CLKIN_TSDEMOD1                  0xFFFFUL  //not supported
153 #define HAL_TSO_CLKIN_TS4                       0x0005UL
154 #define HAL_TSO_CLKIN_TS5                       0x0006UL
155 
156 
157 // Pre TsoOut Select
158 #define HAL_PRE_TSO_OUT_SEL_TS0IN               0x0000UL
159 #define HAL_PRE_TSO_OUT_SEL_TS1IN               0x0001UL
160 #define HAL_PRE_TSO_OUT_SEL_TS2IN               0x0002UL
161 #define HAL_PRE_TSO_OUT_SEL_TS3IN               0x0003UL
162 #define HAL_PRE_TSO_OUT_SEL_TS4IN               0x0004UL
163 #define HAL_PRE_TSO_OUT_SEL_TS5IN               0x0005UL
164 #define HAL_PRE_TSO_OUT_SEL_TSCBIN              0xFFFFUL  //not supported
165 #define HAL_PRE_TSO_OUT_SEL_TSDEMOD0            0xFFFFUL  //not supported
166 
167 // TSO ClkOut DivClk Src Select
168 #define HAL_TSO_OUT_DIV_SEL_172M_2N             0x0000UL
169 #define HAL_TSO_OUT_DIV_SEL_288M_2N             0x0800UL
170 #define HAL_TSO_OUT_DIV_SEL_216M_N              0xFFFFUL  //not supported
171 
172 // TSO ClkOut Select
173 #define HAL_TSO_OUT_SEL_TSO_OUT_DIV2N           0x0000UL
174 #define HAL_TSO_OUT_SEL_TSO_OUT_62MHz           0x0400UL
175 #define HAL_TSO_OUT_SEL_TSO_OUT_54MHz           0x0800UL
176 #define HAL_TSO_OUT_SEL_TSO_OUT_PTSOOUT         0x0C00UL
177 #define HAL_TSO_OUT_SEL_TSO_OUT_PTSOOUT_DIV8    0x1000UL
178 #define HAL_TSO_OUT_SEL_TSO_OUT_27MHz           0x1400UL
179 #define HAL_TSO_OUT_SEL_TSO_OUT_FROM_DEMOD      0x1C00UL
180 #define HAL_TSO_OUT_SEL_TSO_OUT_DIV             0xFFFFUL  //not supported
181 
182 //TSO Channel IF
183 #define HAL_TSO_TSIF_LIVE1                      1UL
184 #define HAL_TSO_TSIF_LIVE2                      5UL
185 #define HAL_TSO_TSIF_LIVE3                      6UL
186 #define HAL_TSO_TSIF_FILE1                      HAL_TSO_TSIF_LIVE2
187 #define HAL_TSO_TSIF_FILE2                      HAL_TSO_TSIF_LIVE3
188 #define HAL_TSO_TSIF_LIVE_MMT                   7UL
189 
190 
191 //TSO SVQ RX packet mode
192 #define HAL_TSO_SVQRX_MODE_OPENCABLE            0UL
193 #define HAL_TSO_SVQRX_MODE_CIP                  1UL
194 #define HAL_TSO_SVQRX_MODE_192                  2UL
195 
196 //TSO timestamp base
197 #define HAL_TSO_TIMESTAMP_90K                   0UL
198 #define HAL_TSO_TIMESTAMP_27M                   1UL
199 
200 #define MIU_BUS                                 4UL
201 
202 //TSO PVR SRC
203 #define HAL_TSO_PVR_NONE                        0UL
204 #define HAL_TSO_PVR_SVQ                         1UL
205 #define HAL_TSO_PVR_MMT                         2UL
206 
207 typedef struct stDrvTSOOutClk
208 {
209     MS_U16  u16OutClk;
210     MS_U16  u16OutDivSrc;
211     MS_U16  u16OutDivNum;
212     MS_U16  u16PreTsoOutClk;
213     MS_BOOL bClkInvert;
214     MS_BOOL bEnable;
215 }HalTSOOutClk;
216 
217 //
218 // General API
219 void        HAL_TSO_SetBank(MS_VIRT virtBankAddr);
220 void        HAL_TSO_Init(void);
221 void        HAL_TSO_Reset_All(MS_U8 u8Eng);
222 void        HAL_TSO_Reset(MS_U8 u8Eng);
223 void        HAL_TSO_Reset_SubItem(MS_U8 u8Eng, MS_U16 u16RstItem);
224 void        HAL_TSO_HWInt_Enable(MS_U8 u8Eng, MS_BOOL bEnable, MS_U16 u16init);
225 void        HAL_TSO_HWInt_Clear(MS_U8 u8Eng, MS_U16 u16Int);
226 MS_U16      HAL_TSO_HWInt_Status(MS_U8 u8Eng);
227 void        HAL_TSO_PowerCtrl(MS_BOOL bOn);
228 
229 void        HAL_TSO_Recover_TSOutMode(MS_U8 u8Eng);
230 MS_BOOL     HAL_TSO_OutPad(MS_U8 u8Eng, MS_U16* pu16OutPad, MS_BOOL bSet);
231 
232 MS_BOOL     HAL_TSO_SelPad(MS_U8 u8Eng, MS_U8 u8TsIf, MS_U16 u16InPadSel, MS_BOOL bParallel);
233 MS_BOOL     HAL_TSO_Set_InClk(MS_U8 u8Eng, MS_U8 u8TsIf, MS_U16 u16ClkSel, MS_BOOL bClkInvert, MS_BOOL bEnable);
234 MS_BOOL     HAL_TSO_GetInputTSIF_Status(MS_U8 u8Eng, MS_U8 u8TsIf, MS_U16* pu16Pad, MS_BOOL* pbClkInvert, MS_BOOL* pbExtSync, MS_BOOL* pbParl);
235 MS_BOOL     HAL_TSO_OutClk_DefSelect(MS_U8 u8Eng, MS_U16 u16PadSel, MS_BOOL bSet, HalTSOOutClk* pstOutClkSet);
236 void        HAL_TSO_OutputClk(MS_U8 u8Eng, HalTSOOutClk* pstOutClkSet, MS_BOOL bSet);
237 MS_BOOL     HAL_TSO_GetOutputClk(MS_U8 u8Eng, HalTSOOutClk* pstOutClkSet);
238 MS_BOOL     HAL_TSO_Set_TSOOut_Phase_Tune(MS_U8 u8Eng, MS_U16 u16ClkOutPhase, MS_BOOL bPhaseEnable);
239 MS_BOOL     HAL_TSO_PreTsoOutClk(MS_U8 u8Eng, MS_U16* pu16PreTsoOutSel, MS_BOOL bSet);
240 MS_BOOL     HAL_TSO_TSOOutDiv(MS_U8 u8Eng, MS_U16* pu16ClkOutDivSrcSel, MS_U16* pu16ClkOutDivNum, MS_BOOL bSet);
241 MS_BOOL     HAL_TSO_OutClk(MS_U8 u8Eng, MS_U16* pu16ClkOutSel, MS_BOOL* pbClkInvert, MS_BOOL* pbEnable, MS_BOOL bSet);
242 
243 void        HAL_TSO_Flt_SetPid(MS_U8 u8Eng, MS_U16 u16FltId, MS_U16 u16PID);
244 void        HAL_TSO_Flt_SetInputSrc(MS_U8 u8Eng, MS_U16 u16FltId, MS_U16 u16InputSrc);
245 MS_BOOL     HAL_TSO_ReplaceFlt_SetPktPid(MS_U8 u8Eng, MS_U16 u16FltId, MS_U8 u8TsIf, MS_U16 u16OldPid, MS_U16 u16NewPid);
246 MS_BOOL     HAL_TSO_ReplaceFlt_Enable(MS_U8 u8Eng, MS_U16 u16FltId, MS_BOOL bEnable);
247 
248 void        HAL_TSO_Set_Filein_ReadAddr(MS_U8 u8Eng, MS_U8 u8FileEng, MS_PHY phyAddr);
249 void        HAL_TSO_Set_Filein_ReadLen(MS_U8 u8Eng, MS_U8 u8FileEng, MS_U32 u32len);
250 MS_PHY      HAL_TSO_Get_Filein_ReadAddr(MS_U8 u8Eng, MS_U8 u8FileEng);
251 void        HAL_TSO_Set_Filein_Ctrl(MS_U8 u8Eng, MS_U8 u8FileEng, MS_U16 u16ctrl);
252 MS_U16      HAL_TSO_Get_Filein_Ctrl(MS_U8 u8Eng, MS_U8 u8FileEng);
253 MS_BOOL     HAL_TSO_Set_Filein_MOBFKey(MS_U8 u8FileEng, MS_U32 u32Key, MS_BOOL bSecured);
254 MS_BOOL     HAL_TSO_Filein_Enable(MS_U8 u8Eng, MS_U8 u8FileEng, MS_BOOL bEnable);
255 MS_BOOL     HAL_TSO_Set_Filein_MOBFKey(MS_U8 u8FileEng, MS_U32 u32Key, MS_BOOL bSecured);
256 void        HAL_TSO_FileinTimer_Enable(MS_U8 u8Eng, MS_U8 u8FileEng, MS_BOOL bEnable);
257 void        HAL_TSO_Filein_Rate(MS_U8 u8Eng, MS_U8 u8FileEng, MS_U16 u16timer);
258 void        HAL_TSO_Filein_192Mode_Enable(MS_U8 u8Eng, MS_U8 u8FileEng, MS_BOOL bEnable);
259 void        HAL_TSO_Filein_192BlockMode_Enable(MS_U8 u8Eng, MS_U8 u8FileEng, MS_BOOL bEnable);
260 MS_U16      HAL_TSO_CmdQ_FIFO_Get_WRCnt(MS_U8 u8Eng, MS_U8 u8FileEng);
261 MS_BOOL     HAL_TSO_CmdQ_FIFO_IsFull(MS_U8 u8Eng, MS_U8 u8FileEng);
262 MS_BOOL     HAL_TSO_CmdQ_FIFO_IsEmpty(MS_U8 u8Eng, MS_U8 u8FileEng);
263 MS_U8       HAL_TSO_CmdQ_FIFO_Get_WRLevel(MS_U8 u8Eng, MS_U8 u8FileEng);
264 MS_BOOL     HAL_TSO_CmdQ_Reset(MS_U8 u8Eng, MS_U8 u8FileEng);
265 
266 void        HAL_TSO_RW_ValidBlock_Count(MS_U8 u8Eng, MS_BOOL bWrite, MS_U16 *pu16ValidBlockCnt);
267 void        HAL_TSO_RW_InvalidBlock_Count(MS_U8 u8Eng, MS_BOOL bWrite, MS_U16 *pu16InvalidBlockCnt);
268 void        HAL_TSO_RW_OutputPktSize(MS_U8 u8Eng, MS_BOOL bWrite, MS_U16 *pu16PktSize);
269 
270 void        HAL_TSO_LPcr2_Set(MS_U8 u8Eng, MS_U8 u8FileEng, MS_U32 u32lpcr2);
271 MS_U32      HAL_TSO_LPcr2_Get(MS_U8 u8Eng, MS_U8 u8FileEng);
272 MS_U32      HAL_TSO_TimeStamp_Get(MS_U8 u8Eng, MS_U8 u8FileEng);
273 MS_BOOL     HAL_TSO_PktChkSize_Set(MS_U8 u8Eng, MS_U8 u8If, MS_U8 u8size);
274 void        HAL_TSO_Filein_PktChkSize_Set(MS_U8 u8Eng, MS_U8 u8FileEng, MS_U8 u8size);
275 
276 void        HAL_TSO_Cfg1_Enable(MS_U8 u8Eng, MS_U16 u16CfgItem, MS_BOOL bEnable);
277 void        HAL_TSO_Cfg4_Enable(MS_U8 u8Eng, MS_U16 u16CfgItem, MS_BOOL bEnable);
278 MS_BOOL     HAL_TSO_ChIf_Enable(MS_U8 u8Eng, MS_U8 u8ChIf, MS_BOOL bEnable);
279 MS_BOOL     HAL_TSO_ChIf_Cfg(MS_U8 u8Eng, MS_U8 u8ChIf, MS_U16 u16Cfg, MS_BOOL bEnable);
280 MS_BOOL     HAL_TSO_Get_ChIf_Cfg(MS_U8 u8Eng, MS_U8 u8ChIf, MS_U16* pu16Cfg, MS_BOOL *pbEnable);
281 MS_BOOL     HAL_TSO_SVQBuf_Set(MS_U8 u8Eng, MS_U8 u8ChIf, MS_PHY phyBufAddr, MS_U32 u32BufSize);
282 MS_BOOL     HAL_TSO_ChIf_ClrByteCnt(MS_U8 u8Eng, MS_U8 u8ChIf);
283 MS_BOOL     HAL_TSO_LocalStreamID(MS_U8 u8Eng, MS_U8 u8ChIf, MS_U8* pu8StrID, MS_BOOL beSet);
284 MS_BOOL     HAL_TSO_SVQ_TX_Reset(MS_U8 u8Eng, MS_U8 u8ChIf);
285 MS_BOOL     HAL_TSO_Set_SVQRX_MOBFKey(MS_U8 u8Eng, MS_U32 u32Key, MS_BOOL bSecured);
286 MS_BOOL     HAL_TSO_Set_SVQRX_PktMode(MS_U8 u8Eng, MS_U16 u16mode);
287 MS_BOOL     HAL_TSO_Set_SVQRX_ArbitorMode(MS_U8 u8Eng, MS_U16 u16mode, MS_U16 *pu16SvqRxPri);
288 MS_BOOL     HAL_TSO_Set_SVQ_LocalSysTimestamp(MS_U8 u8Eng, MS_U32 u32systime);
289 MS_BOOL     HAL_TSO_Get_SVQ_Status(MS_U8 u8Eng, MS_U8 u8ChIf, MS_U16* pu16Status);
290 MS_BOOL     HAL_TSO_GetDelayTime_PreHd2Output(MS_U8 u8Eng, MS_U8 u8ChIf, MS_U32 *pu32time);
291 MS_BOOL     HAL_TSO_Get_MaxDelta_ChId(MS_U8 u8Eng, MS_U8 *pu8ChIf);
292 MS_BOOL     HAL_TSO_Sel_LocalSysStampClkBase(MS_U8 u8Eng, MS_U16 u16ClkBase);
293 MS_U16      HAL_TSO_MMT_Cfg_Map(MS_U16 u16Cfg);
294 void        HAL_TSO_PVR_WaitFlush(MS_U8 u8PVRId);
295 void        HAL_TSO_PVR_SetBuffer(MS_U8 u8PVRId, MS_PHY phyBufStart0, MS_PHY phyBufStart1, MS_U32 u32BufSize0, MS_U32 u32BufSize1);
296 MS_PHY      HAL_TSO_PVR_GetBufWrite(MS_U8 u8PVRId);
297 void        HAL_TSO_PVR_Enable(MS_U8 u8PVRId, MS_BOOL bEnable);
298 void        HAL_TSO_PVR_PacketMode(MS_U8 u8PVRId, MS_BOOL bSet);
299 void        HAL_TSO_SetPVRTimeStamp(MS_U8 u8PVRId, MS_U32 u32Stamp);
300 MS_U32      HAL_TSO_GetPVRTimeStamp(MS_U8 u8PVRId);
301 void        HAL_TSO_SetPVRTimeStampClk(MS_U8 u8PVRId, MS_U32 u32ClkSrc);
302 MS_BOOL     HAL_TSO_PVR_IsEnabled(MS_U32 u32EngId);
303 void        HAL_TSO_PVR_Src(MS_U32 u32Src);
304 
305 #ifdef MSOS_TYPE_LINUX_KERNEL
306 MS_BOOL     HAL_TSO_SaveRegs(void);
307 MS_BOOL     HAL_TSO_RestoreRegs(void);
308 #endif  //MSOS_TYPE_LINUX_KERNEL
309 
310 
311 #endif // #ifndef __HAL_TSO_H__
312 
313 
314