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 "regTSO.h" 104 105 //-------------------------------------------------------------------------------------------------- 106 // Driver Compiler Option 107 //-------------------------------------------------------------------------------------------------- 108 109 //-------------------------------------------------------------------------------------------------- 110 // TSP Hardware Abstraction Layer 111 //-------------------------------------------------------------------------------------------------- 112 113 //-------------------------------------------------------------------------------------------------- 114 // Macro of bit operations 115 //-------------------------------------------------------------------------------------------------- 116 117 //////////////////////////////////////////////// 118 // HAL API 119 //////////////////////////////////////////////// 120 121 // TSO in mux select 122 #define HAL_TSOIN_MUX_TS0 0x0000 123 #define HAL_TSOIN_MUX_TS1 0x0001 124 #define HAL_TSOIN_MUX_TS2 0x0002 125 #define HAL_TSOIN_MUX_TS3 0x0003 126 #define HAL_TSOIN_MUX_TS4 0x0004 127 #define HAL_TSOIN_MUX_TS5 0x0005 128 #define HAL_TSOIN_MUX_TS6 0x0006 129 #define HAL_TSOIN_MUX_TSDEMOD0 0x0007 130 #define HAL_TSOIN_MUX_TSDEMOD1 0xFFFF //not supported 131 #define HAL_TSOIN_MUX_MEM 0x0008 132 #define HAL_TSOIN_MUX_MEM1 0x0009 133 134 // TSO In Clk select 135 #define HAL_TSO_CLKIN_TS0 0x0000 136 #define HAL_TSO_CLKIN_TS1 0x0001 137 #define HAL_TSO_CLKIN_TS2 0xFFFF //not supported 138 #define HAL_TSO_CLKIN_TS3 0xFFFF //not supported 139 #define HAL_TSO_CLKIN_TSCB 0xFFFF //not supported 140 #define HAL_TSO_CLKIN_TSDEMOD0 0x0003 141 #define HAL_TSO_CLKIN_TSDEMOD1 0xFFFF //not supported 142 143 // Pre TsoOut Select 144 #define HAL_PRE_TSO_OUT_SEL_TS0IN 0x0000 145 #define HAL_PRE_TSO_OUT_SEL_TS1IN 0x0001 146 #define HAL_PRE_TSO_OUT_SEL_TS2IN 0x0002 147 #define HAL_PRE_TSO_OUT_SEL_TS3IN 0x0003 148 #define HAL_PRE_TSO_OUT_SEL_TS4IN 0x0004 149 #define HAL_PRE_TSO_OUT_SEL_TS5IN 0x0005 150 #define HAL_PRE_TSO_OUT_SEL_TS6IN 0x0006 151 #define HAL_PRE_TSO_OUT_SEL_TSCBIN 0xFFFF 152 153 // TSO ClkOut DivClk Src Select, only 216MHz for Div 154 #define HAL_TSO_OUT_DIV_SEL_172M_2N 0x0000 //DMPLLDIV5 155 #define HAL_TSO_OUT_DIV_SEL_288M_2N 0x0040 //DMPLLDIV3 156 #define HAL_TSO_OUT_DIV_SEL_216M_N 0xFFFF //not supported 157 158 159 // TSO ClkOut Select 160 #define HAL_TSO_OUT_SEL_TSO_OUT_27MHz 0x0000 161 #define HAL_TSO_OUT_SEL_TSO_OUT_62MHz 0x0001 162 #define HAL_TSO_OUT_SEL_TSO_OUT_108MHz 0x0002 163 #define HAL_TSO_OUT_SEL_TSO_OUT_PTSOOUT 0x0003 //live-in 164 #define HAL_TSO_OUT_SEL_TSO_OUT_PTSOOUT_DIV8 0x0004 //live-in 165 #define HAL_TSO_OUT_SEL_TSO_OUT_DIV 0x0005 166 #define HAL_TSO_OUT_SEL_TSO_OUT_86MHz 0x0006 167 #define HAL_TSO_OUT_SEL_TSO_OUT_123MHz 0x0007 168 169 #define HAL_TSO_OUT_SEL_TSO_OUT_FROM_DEMOD 0xFFFD //not supported 170 #define HAL_TSO_OUT_SEL_TSO_OUT_54MHz 0xFFFE //not supported 171 #define HAL_TSO_OUT_SEL_TSO_OUT_DIV2N 0xFFFF //not supported 172 173 //TSO Channel IF 174 #define HAL_TSO_TSIF_LIVE1 1 175 #define HAL_TSO_TSIF_LIVE2 2 176 #define HAL_TSO_TSIF_LIVE3 3 177 #define HAL_TSO_TSIF_LIVE4 4 178 #define HAL_TSO_TSIF_LIVE5 5 179 #define HAL_TSO_TSIF_LIVE6 6 180 181 #define HAL_TSO_TSIF_FILE1 HAL_TSO_TSIF_LIVE5 182 #define HAL_TSO_TSIF_FILE2 HAL_TSO_TSIF_LIVE6 183 184 //TSO SVQ RX packet mode 185 #define HAL_TSO_SVQRX_MODE_OPENCABLE 0 186 #define HAL_TSO_SVQRX_MODE_CIP 1 187 #define HAL_TSO_SVQRX_MODE_192 2 188 189 typedef struct stDrvTSOOutClk 190 { 191 MS_U16 u16OutClk; 192 MS_U16 u16OutDivSrc; 193 MS_U16 u16OutDivNum; 194 MS_U16 u16PreTsoOutClk; 195 MS_BOOL bClkInvert; 196 MS_BOOL bEnable; 197 }HalTSOOutClk; 198 199 200 // 201 // General API 202 void HAL_TSO_SetBank(MS_VIRT u32BankAddr); 203 void HAL_TSO_Init(void); 204 void HAL_TSO_Reset_All(MS_U8 u8Eng); 205 void HAL_TSO_Reset(MS_U8 u8Eng); 206 void HAL_TSO_Reset_SubItem(MS_U8 u8Eng, MS_U16 u16RstItem); 207 void HAL_TSO_HWInt_Enable(MS_U8 u8Eng, MS_BOOL benable, MS_U16 u16init); 208 void HAL_TSO_HWInt_Clear(MS_U8 u8Eng, MS_U16 u16Int); 209 MS_U16 HAL_TSO_HWInt_Status(MS_U8 u8Eng); 210 void HAL_TSO_SaveRegs(void); 211 void HAL_TSO_RestoreRegs(void); 212 void HAL_TSO_PowerCtrl(MS_BOOL bOn); 213 214 MS_BOOL HAL_TSO_3WirePadMapping(MS_U8 u8Pad3WireId, MS_U16 *u16Pad, MS_U16 *u16Clk); 215 MS_BOOL HAL_TSO_SelPad(MS_U8 u8Eng, MS_U8 u8TsIf, MS_U16 u16InPadSel, MS_BOOL bParallel); 216 MS_BOOL HAL_TSO_OutPad(MS_U8 u8Eng, MS_U16* pu16OutPad, MS_BOOL bSet); 217 MS_BOOL HAL_TSO_GetInputTSIF_Status(MS_U8 u8Eng, MS_U8 u8TsIf, MS_U16* pu16Pad, MS_BOOL* pbClkInvert, MS_BOOL* pbExtSync, MS_BOOL* pbParl); 218 MS_BOOL HAL_TSO_Set_InClk(MS_U8 u8Eng, MS_U8 u8TsIf, MS_U16 u16ClkSel, MS_BOOL bClkInvert, MS_BOOL bEnable); 219 MS_BOOL HAL_TSO_OutClk_DefSelect(MS_U8 u8Eng, MS_U16 u16PadSel, MS_BOOL bSet, HalTSOOutClk* pstOutClkSet); 220 void HAL_TSO_Set_GenOutClk(MS_U8 u8Eng); 221 222 MS_BOOL HAL_TSO_OutClk(MS_U8 u8Eng, MS_U16* pu16ClkOutSel, MS_BOOL* pbClkInvert, MS_BOOL* pbEnable, MS_BOOL bSet); 223 void HAL_TSO_OutputClk(MS_U8 u8Eng, HalTSOOutClk* pstOutClkSet, MS_BOOL bSet); 224 MS_BOOL HAL_TSO_Set_TSOOut_Phase_Tune(MS_U8 u8Eng, MS_U16 u16ClkOutPhase, MS_BOOL bPhaseEnable); 225 MS_BOOL HAL_TSO_PreTsoOutClk(MS_U8 u8Eng, MS_U16* pu16PreTsoOutSel, MS_BOOL bSet); 226 MS_BOOL HAL_TSO_Set_TSOOutDiv(MS_U8 u8Eng, MS_U16 u16ClkOutDivSrcSel, MS_U16 u16ClkOutDivNum); 227 MS_BOOL HAL_TSO_Set_OutClk(MS_U8 u8Eng, MS_U16 u16ClkOutSel, MS_BOOL bClkInvert, MS_BOOL bEnable); 228 229 230 MS_BOOL HAL_TSO_Set_PidBypass(MS_U8 u8Eng, MS_BOOL bEnable); 231 void HAL_TSO_TsioMode_En(MS_BOOL bEnable); 232 233 // 234 // File out APIs 235 // 236 void HAL_TSO_Flt_SetPid(MS_U8 u8Eng, MS_U16 u16FltId, MS_U16 u16PID); 237 void HAL_TSO_Flt_SetInputSrc(MS_U8 u8Eng, MS_U16 u16FltId, MS_U16 u16InputSrc); 238 void HAL_TSO_Flt_SetSid(MS_U8 u8Eng, MS_U16 u16FltId, MS_U8 u8Sid); 239 void HAL_TSO_Set_Filein_ReadAddr(MS_U8 u8Eng, MS_U8 u8FileEng, MS_U32 u32Addr); 240 void HAL_TSO_Set_Filein_ReadLen(MS_U8 u8Eng, MS_U8 u8FileEng, MS_U32 u32len); 241 MS_U32 HAL_TSO_Get_Filein_ReadAddr(MS_U8 u8Eng, MS_U8 u8FileEng); 242 void HAL_TSO_Set_Filein_Ctrl(MS_U8 u8Eng, MS_U8 u8FileEng, MS_U16 u16ctrl); 243 MS_U16 HAL_TSO_Get_Filein_Ctrl(MS_U8 u8Eng, MS_U8 u8FileEng); 244 MS_BOOL HAL_TSO_Filein_Enable(MS_U8 u8Eng, MS_U8 u8FileEng, MS_BOOL bEnable); 245 void HAL_TSO_FileinTimer_Enable(MS_U8 u8Eng, MS_U8 u8FileEng, MS_BOOL bEnable); 246 void HAL_TSO_Filein_Rate(MS_U8 u8Eng, MS_U8 u8FileEng, MS_U16 u16timer); 247 void HAL_TSO_Filein_192Mode_Enable(MS_U8 u8Eng, MS_U8 u8FileEng, MS_BOOL bEnable); 248 void HAL_TSO_Filein_192BlockMode_Enable(MS_U8 u8Eng, MS_U8 u8FileEng, MS_BOOL bEnable); 249 MS_U16 HAL_TSO_CmdQ_FIFO_Get_WRCnt(MS_U8 u8Eng, MS_U8 u8FileEng); 250 MS_BOOL HAL_TSO_CmdQ_FIFO_IsFull(MS_U8 u8Eng); 251 MS_BOOL HAL_TSO_CmdQ_FIFO_IsEmpty(MS_U8 u8Eng); 252 MS_U8 HAL_TSO_CmdQ_FIFO_Get_WRLevel(MS_U8 u8Eng, MS_U8 u8FileEng); 253 MS_BOOL HAL_TSO_CmdQ_Reset(MS_U8 u8Eng, MS_U8 u8FileEng); 254 void HAL_TSO_Cfg0_Enable(MS_U8 u8Eng, MS_U16 u16CfglItem, MS_BOOL benable); 255 void HAL_TSO_Cfg1_Enable(MS_U8 u8Eng, MS_U16 u16CfglItem, MS_BOOL benable); 256 void HAL_TSO_Cfg4_Enable(MS_U8 u8Eng, MS_U32 u32CfgItem, MS_BOOL benable); 257 MS_BOOL HAL_TSO_ChIf_Enable(MS_U8 u8Eng, MS_U8 u8ChIf, MS_BOOL bEnable); 258 void HAL_TSO_File_Cfg1_Enable(MS_U8 u8Eng, MS_U16 u16CfgItem, MS_BOOL benable); 259 MS_BOOL HAL_TSO_ChIf_Cfg(MS_U8 u8Eng, MS_U8 u8ChIf, MS_U16 u16Cfg, MS_BOOL bEnable); 260 MS_BOOL HAL_TSO_Get_ChIf_Cfg(MS_U8 u8Eng, MS_U8 u8ChIf, MS_U16* pu16Cfg, MS_BOOL *pbEnable); 261 void HAL_TSO_RW_ValidBlock_Count(MS_U8 u8Eng, MS_BOOL bWrite, MS_U16 *pu16ValidBlockCnt); 262 void HAL_TSO_RW_InvalidBlock_Count(MS_U8 u8Eng, MS_BOOL bWrite, MS_U16 *pu16InvalidBlockCnt); 263 void HAL_TSO_RW_OutputPKTSize(MS_U8 u8Eng, MS_BOOL bWrite, MS_U16 *pu16PktSize); 264 MS_U32 HAL_TSO_Get_TsHDInfo_CC(MS_U8 u8Eng); 265 MS_U32 HAL_TSO_Get_TsHDInfo_ADP(MS_U8 u8Eng); 266 MS_U32 HAL_TSO_Get_TsHDInfo_SCM(MS_U8 u8Eng); 267 MS_U32 HAL_TSO_Get_TsHDInfo_PID(MS_U8 u8Eng); 268 MS_U32 HAL_TSO_Get_TsHDInfo_TSPri(MS_U8 u8Eng); 269 MS_U32 HAL_TSO_Get_TsHDInfo_PSI(MS_U8 u8Eng); 270 MS_U32 HAL_TSO_Get_TsHDInfo_ErrInd(MS_U8 u8Eng); 271 void HAL_TSO_Get_Pid_Info(MS_U8 u8Eng, MS_U16 *pu16matchpid, MS_BOOL *pbchanged); 272 void HAL_TSO_LPcr2_Set(MS_U8 u8Eng, MS_U8 u8FileEng, MS_U32 u32lpcr2); 273 MS_U32 HAL_TSO_LPcr2_Get(MS_U8 u8Eng, MS_U8 u8FileEng); 274 MS_U32 HAL_TSO_TimeStamp_Get(MS_U8 u8Eng, MS_U8 u8FileEng); 275 void HAL_TSO_PktChkSize_Set(MS_U8 u8Eng, MS_U8 u8If, MS_U8 u8size); 276 void HAL_TSO_RW_OutputPktSize(MS_U8 u8Eng, MS_BOOL bWrite, MS_U16 *pu16PktSize); 277 void HAL_TSO_Filein_PktChkSize_Set(MS_U8 u8Eng, MS_U8 u8FileEng, MS_U8 u8size); 278 void HAL_TSO_Livein_PktChkSize_Set(MS_U8 u8Eng, MS_U8 u8If, MS_U8 u8size); 279 void HAL_TSO_Livein_Input_Config(MS_U8 u8Eng, MS_U8 u8PktInputMode, MS_U8 u8PktSyncByte, MS_U8 u8PktHeaderLength); 280 void HAL_TSO_Livein_3Wire(MS_U8 u8Eng, MS_U8 u8ChIf, MS_BOOL bEnable); 281 282 MS_BOOL HAL_TSO_ChIf_ClrByteCnt(MS_U8 u8Eng, MS_U8 u8ChIf); 283 MS_BOOL HAL_TSO_SVQBuf_Set(MS_U8 u8Eng, MS_U8 u8ChIf, MS_PHY phyBufAddr, MS_U32 u32BufSize); 284 MS_BOOL HAL_TSO_SVQ_TX_Reset(MS_U8 u8Eng, MS_U8 u8ChIf); 285 void HAL_TSO1_SVQ_Rx_Enable(MS_U16 u16CfgItem, MS_BOOL benable); 286 MS_BOOL HAL_TSO_Set_SVQRX_PktMode(MS_U8 u8Eng, MS_U16 u16mode); 287 MS_BOOL HAL_TSO_Get_SVQ_Status(MS_U8 u8Eng, MS_U8 u8ChIf, MS_U16* pu16Status); 288 MS_BOOL HAL_TSO_Set_SVQRX_ArbitorMode(MS_U8 u8Eng, MS_U16 u16mode, MS_U16 *pu16SvqRxPri); 289 MS_BOOL HAL_TSO_Set_SVQ_LocalSysTimestamp(MS_U8 u8Eng, MS_U32 u32systime); 290 MS_BOOL HAL_TSO_LocalStreamID(MS_U8 u8Eng, MS_U8 u8ChIf, MS_U8* pu8StrID, MS_BOOL beSet); 291 MS_BOOL HAL_TSO_ReplaceFlt_SetPktPid(MS_U8 u8Eng, MS_U16 u16FltId, MS_U8 u8TsIf, MS_U16 u16OldPid, MS_U16 u16NewPid); 292 MS_BOOL HAL_TSO_ReplaceFlt_Enable(MS_U8 u8Eng, MS_U16 u16FltId, MS_BOOL bEnable); 293 294 #endif // #ifndef __HAL_TSO_H__ 295