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!�L) 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 drvDMX_TTX.h 98 /// @brief MStar DVT TTX Driver Interface 99 /// @author MStar Semiconductor Inc. 100 /// @version 1.0 101 /////////////////////////////////////////////////////////////////////////////////////////////////// 102 103 #ifndef _DRV_DMX_TTX_H 104 #define _DRV_DMX_TTX_H 105 106 #include "MsDevice.h" 107 108 #ifdef __cplusplus 109 extern "C" 110 { 111 #endif 112 113 #define VBI_TTX_UTOPIA20 (1) 114 115 #define VBI_TTX_DATA_LENGTH 48 116 117 typedef struct 118 { 119 MS_BOOL _bTTXInit; 120 MS_BOOL _bSuspend; 121 MS_PHY bufferAddr; 122 MS_U16 packetCount; 123 MS_PHY _TTXBufAddr; 124 MS_U16 _TTXBufLen; 125 MS_U8 _FilterID; 126 } DMX_TTX_StoreInfo; 127 128 typedef enum 129 { 130 DMX_TTX_INIT, 131 DMX_TTX_EXIT, 132 DMX_TTX_SUSPEND, 133 DMX_TTX_RESUME, 134 } EN_DMX_TTX_CMD; 135 136 typedef MS_U32(*DMX_CB_FN)(MS_U8 SecFltNo); 137 //------------------------------------------------------------------------------------------------- 138 /// Reset TTX ring buffer 139 /// @ingroup TTX_Task 140 /// @return None 141 //------------------------------------------------------------------------------------------------- 142 void MDrv_DMX_TTX_RingBuffer_Reset(void); 143 //------------------------------------------------------------------------------------------------- 144 /// Initialize DMX TTX module 145 /// @ingroup TTX_General 146 /// @param bufferAddr \b IN: Set TTX ring buffer address 147 /// @param packetCount \b IN: Set TTX ring buffer size 148 /// @return TRUE : Succeed 149 /// @return FALSE : Fail 150 //------------------------------------------------------------------------------------------------- 151 MS_BOOL MDrv_DMX_TTX_Init(MS_PHY bufferAddr, MS_U16 packetCount); 152 //------------------------------------------------------------------------------------------------- 153 /// Finalize DMX TTX module 154 /// @ingroup TTX_General 155 /// @return TRUE : Succeed 156 /// @return FALSE : Fail 157 //------------------------------------------------------------------------------------------------- 158 // MS_BOOL MDrv_DMX_TTX_Exit(void); 159 160 //----------------- 161 // TTX_Task 162 //----------------- 163 //------------------------------------------------------------------------------------------------- 164 /// Set TTX callback function. 165 /// @ingroup TTX_Task 166 /// @param fn \b IN: callback sunction 167 /// @return None 168 //------------------------------------------------------------------------------------------------- 169 void MDrv_DMX_TTX_SetCB(DMX_CB_FN fn); 170 //------------------------------------------------------------------------------------------------- 171 /// Set TTX PID filter index to use callback function get the write address of section buffer. 172 /// @ingroup TTX_Task 173 /// @param fid \b IN: PID filter index 174 /// @return None 175 //------------------------------------------------------------------------------------------------- 176 void MDrv_DMX_TTX_SetFilterID(MS_U8 fid); 177 //------------------------------------------------------------------------------------------------- 178 /// Check TTX buffer is empty or not. 179 /// @ingroup TTX_Task 180 /// @return TRUE : Buffer is empty. 181 /// @return FALSE : Buffer is not empty. 182 //------------------------------------------------------------------------------------------------- 183 MS_BOOL MDrv_DMX_TTX_PacketBufferIsEmpty(void); 184 //------------------------------------------------------------------------------------------------- 185 /// Get TTX data (Get all of the packets in the TTX buffer (if the input buffer is big enough)) 186 /// @ingroup TTX_Task 187 /// @param dataAddr \b IN: Set TTX buffer address 188 /// @param length \b OUT: Get total packt length 189 /// @return TRUE : Succeed 190 /// @return FALSE : Fail 191 //------------------------------------------------------------------------------------------------- 192 // MS_BOOL MDrv_DMX_TTX_GetPackets(MS_PHY dataAddr, MS_U32 *length); 193 //------------------------------------------------------------------------------------------------- 194 /// Get TTX data (Get 1 of the packets in the TTX buffer) 195 /// @ingroup TTX_Task 196 /// @param packetAddress \b OUT: Get TTX buffer address 197 /// @return TRUE : Succeed 198 /// @return FALSE : Fail 199 //------------------------------------------------------------------------------------------------- 200 MS_BOOL MDrv_DMX_TTX_GetPacket(MS_PHY *packetAddress); 201 202 //------------------------------------------------------------------------------------------------- 203 /// Check if there is a packet buffer overflow. If there is an overflow, 204 /// the the packet buffer should be cleared from the reading task. 205 /// @ingroup TTX_Task 206 /// @return TRUE : If there is packet buffer overflow 207 /// @return FALSE : Otherwise 208 //------------------------------------------------------------------------------------------------- 209 MS_BOOL MDrv_DMX_TTX_PacketBufferIsOverflow( void ); 210 211 //------------------------------------------------------------------------------------------------- 212 /// Return the nomber of packet buffer overflows since the last reset or creation. 213 /// @ingroup TTX_Task 214 /// @return : The number of packet buffer overflows. 215 //------------------------------------------------------------------------------------------------- 216 MS_U16 MDrv_DMX_TTX_PacketBufferGetNoOfOverflows( void ); 217 218 //----------------- 219 // TTX_STR 220 //------------------------------------------------------------------------------------------------- 221 /// Save DMX_TTX driver states to DRAM. 222 /// @ingroup TTX_STR 223 /// @return TRUE : Succeed 224 /// @return FALSE : Fail 225 //------------------------------------------------------------------------------------------------- 226 // MS_BOOL MDrv_DMX_TTX_Suspend(void); 227 228 //------------------------------------------------------------------------------------------------- 229 /// Restore DMX_TTX driver states from DRAM 230 /// @ingroup TTX_STR 231 /// @return TRUE : Succeed 232 /// @return FALSE : Fail 233 //------------------------------------------------------------------------------------------------- 234 // MS_BOOL MDrv_DMX_TTX_Resume(void); 235 236 //------------------------------------------------------------------------------------------------- 237 /// Control TTX STR functions. 238 /// @ingroup TTX_STR 239 /// @param u16PowerState \b IN: STR power mode. (to control STR suspend & resume case.) 240 /// @return : Utopia status - UTOPIA_STATUS_SUCCESS (Succeed) or UTOPIA_STATUS_FAIL (Fail) 241 //------------------------------------------------------------------------------------------------- 242 // MS_U32 MDrv_DMX_TTX_SetPowerState(EN_POWER_MODE u16PowerState); 243 244 #undef INTERFACE 245 246 #ifdef __cplusplus 247 } 248 #endif 249 250 #endif 251 252