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") 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 #ifndef _HAL_EMMFLT_H_ 95 #define _HAL_EMMFLT_H_ 96 97 //////////////////////////////////////////////////////////////////////////////// 98 /// @file halEMMflt.h 99 /// @author MStar Semiconductor Inc. 100 /// @brief 101 //////////////////////////////////////////////////////////////////////////////// 102 103 //////////////////////////////////////////////////////////////////////////////// 104 // Header Files 105 //////////////////////////////////////////////////////////////////////////////// 106 #include "regEMMflt.h" 107 //////////////////////////////////////////////////////////////////////////////// 108 // Define & data type 109 //////////////////////////////////////////////////////////////////////////////// 110 111 #define EMMFLT_EMM_INT EMM_ONEPAKCET_INT 112 #define EMMFLT_EMM_OVERFLOW_INT EMM_OVERFLOW_INT 113 #define EMMFLT_STATES_GROUP (EMMFLT_EMM_INT | \ 114 EMMFLT_EMM_OVERFLOW_INT ) 115 116 #define EMM_TIDMODE_BASIC_MASK 0x101 117 118 #define NDS_EMMFLT_BUF_SIZE (256) 119 #define U01_NDS_EMMFLT_BUF_SIZE (256) 120 #define NDS_EMM_BUF_NUM (16) 121 #define MAX_EMMFLT_NUM 10 122 123 #define MAX_EMM_LIST_NUM 11 // N for N-1 slots 124 125 #define U01_MAX_EMMFLT_NUM 10 126 #define EMMENG_NUMBER 2 127 #define EMMFLT_HWBUF_NUM 10 128 129 #define EMM_COPY_PACKET_SIZE 188 130 131 #define EMMFLT_HWBUF_SIZE NDS_EMMFLT_BUF_SIZE*MAX_EMMFLT_NUM //4096 132 #define EMMFLT_BUF_ALIGNMENT 0x100 133 134 135 #define HAL_EMMFLT_OK 0 136 #define HAL_EMMFLT_FAIL 2 137 #define HAL_EMMFLT_INVALID_REQUEST 3 138 139 140 typedef enum 141 { 142 E_TIDMODE_INGORE = 0x0, 143 E_TIDMODE_ACCEPT_ALL = 0x1, 144 E_TIDMODE_ACCEPT_ADDRESS = 0x10000, 145 E_TIDMODE_RESERVED = 0x10001, 146 } EMM_TIDMODE_e; 147 148 149 #define EMM_IRD_REG_MASK 0x3 150 typedef enum 151 { 152 E_IRD_REG_DISABLE = 0, 153 E_IRD_REG_COMPARE, 154 } EMM_IRD_STATUS_e; 155 156 157 typedef enum 158 { 159 EMM_FROM_TS0 = 0, 160 EMM_FROM_TS1, 161 EMM_FROM_TS2, 162 EMM_FROM_TS3, 163 EMM_FROM_TS4, 164 EMM_FROM_TS5, 165 EMM_FROM_TS6, 166 EMM_FROM_TSO, 167 } EMM_SRC_FROM_e; 168 169 #if 0 170 typedef struct _EMMFLT_Config_ 171 { 172 MS_U16 u16EMM_PID; 173 MS_U8 u8EMM_TID; 174 MS_U16 u16EMM_CTRL_ID; 175 MS_U16 u16RingSize_TS0; 176 MS_U32 u32GeneralCtrl; 177 } EMMFLT_Config_t; 178 #endif 179 180 //////////////////////////////////////////////////////////////////////////////// 181 // Extern function 182 //////////////////////////////////////////////////////////////////////////////// 183 void HAL_EMMFLT_SetBank(MS_U32 u32Base); 184 MS_U32 HAL_EMMFLT_Init(void); 185 MS_U32 HAL_EMMFLT_GetHwBufCnt(MS_U32 *pHwBufCnt); 186 MS_U32 HAL_EMMFLT_SWReset(MS_U32 connection); 187 MS_U32 HAL_EMMFLT_SetDbgLevel(MS_U32 u32Level); 188 MS_U32 HAL_EMMFLT_Enable_Int(void); 189 MS_U32 HAL_EMMFLT_GetIntNumber(void); 190 MS_BOOL HAL_EMMFLT_GetIntMode(void); 191 MS_U32 HAL_EMMFLT_SetTidMode(MS_U32 connection, MS_U8 u8TidValue, EMM_TIDMODE_e eTIDMODE); 192 MS_U32 HAL_EMMFLT_SetIRDMode(MS_U32 connection,MS_U8 u8IRDNum, MS_U8 u8CompareMode); 193 MS_U32 HAL_EMMFLT_SetEmmDataIDx(MS_U32 connection, MS_U8 u8IRDNum, MS_U8 *pu8Data); 194 MS_U32 HAL_EMMFLT_SetEmmMaskIDx(MS_U32 connection,MS_U8 u8IRDNum, MS_U8 *pu8Data); 195 MS_U32 HAL_EMMFLT_DisableEMM(MS_U32 connection); 196 MS_U32 HAL_EMMFLT_SetEmmPID(MS_U32 connection,MS_U16 u16EmmPID); 197 MS_U32 HAL_EMMFLT_SetEmmTID(MS_U32 connection,MS_U16 u16EmmTID); 198 MS_U32 HAL_EMMFLT_EnableEmmTID(MS_U32 connection, MS_BOOL bEnable); 199 MS_U32 HAL_EMMFLT_GetIntReg(MS_U16 *pu16Data); 200 MS_U32 HAL_EMMFLT_GetIntStatus(MS_U16 *pu16EMMInt, MS_U16 *pu16IntStat, MS_U8 *pu8conflag); 201 MS_U32 HAL_EMMFLT_ReqDstBufSize(MS_U32 *p32DstBufSize, MS_U32 *p32AlignBytes, MS_U8 *p8BufBum); 202 MS_U32 HAL_EMMFLT_SetDstBufInfo(MS_U32 connection, MS_U32 u32BufAddr, MS_U32 u32BufSize, MS_U32 *p32BufAddrs); 203 MS_U32 HAL_EMMFLT_IntCtrl(MS_U8 u8En); 204 MS_U32 HAL_EMMFLT_GeneralCtrl(MS_U32 connection); 205 MS_U32 HAL_EMMFLT_GetDebugStatus(MS_U32 *pRegValue); 206 MS_U32 HAL_EMMFLT_SetDebugMode(MS_U16 u16Mode); 207 MS_U32 HAL_EMMFLT_PacketAct(MS_U32 connection); 208 MS_U32 HAL_EMMFLT_GetCurrentBufIndex(MS_U32 connection); 209 MS_U32 HAL_EMMFLT_PacketCount(MS_U32 connection,MS_U8 *pCount); 210 MS_U32 HAL_EMMFLT_SrcSelect(MS_U32 connection, MS_U32 u32SrcFrom, MS_U32 u32SrcType); 211 MS_U32 HAL_EMMFLT_ConnectCheck(MS_U32 connection); 212 MS_U32 HAL_EMMFLT_SetOutputType(MS_U32 connection, MS_U32 u32Type); 213 MS_U32 HAL_EMMFLT_ResetInt(MS_U32 connection); 214 MS_U32 HAL_EMMFLT_SetExtendConfig(MS_U32 x_connection, MS_U16 type, MS_U16 extendbytes, MS_U16 syncbyte); 215 MS_U32 HAL_EMMFLT_Bypass(void); 216 MS_U32 HAL_EMMFLT_InputMode(MS_U32 x_connection, MS_BOOL bSerial); 217 218 219 #if 0 //removed 220 MS_U32 HAL_EMMFLT_SetRingConfig(MS_U16 u16RingSize, MS_U32 RingBufStart, MS_U8 u8RingIndex); 221 #endif 222 223 MS_U32 HAL_EMMFLT_HWSimulation(void); 224 void HAL_EMMFLT_IntStatusTest(void); 225 226 #endif //_HAL_EMMFLT_H_ 227 228