xref: /utopia/UTPA2-700.0.x/mxlib/include/drvEMMFlt.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) 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 _DRVEMMFLT_H_
95 #define _DRVEMMFLT_H_
96 
97 ////////////////////////////////////////////////////////////////////////////////
98 /// @file drvEMMFlt.h
99 /// @author MStar Semiconductor Inc.
100 /// @brief to filter EMM packet
101 ////////////////////////////////////////////////////////////////////////////////
102 
103 ////////////////////////////////////////////////////////////////////////////////
104 // Header Files
105 ////////////////////////////////////////////////////////////////////////////////
106 #ifdef __cplusplus
107 extern "C"
108 {
109 #endif
110 
111 #include "MsTypes.h"
112 #include "UFO.h"
113 
114 ////////////////////////////////////////////////////////////////////////////////
115 // Define & data type
116 ////////////////////////////////////////////////////////////////////////////////
117 #define MSIF_EMMFLT_LIB_CODE	{'E','M','M','F'}    //Lib code
118 #define MSIF_EMMFLT_LIBVER		{'0','1'}            //LIB version
119 #define MSIF_EMMFLT_BUILDNUM    {'0','1'}            //Build Number
120 #define MSIF_EMMFLT_CHANGELIST  {'0','0','3','4','8','0','3','3'} //P4 ChangeList Number
121 
122 #define EMMRASP_SHAREINT
123 
124 #define EMMFLT_DRV_VERSION                /* Character String for DRV/API version             */  \
125     MSIF_TAG,                           /* 'MSIF'                                           */  \
126     MSIF_CLASS,                         /* '00'                                             */  \
127     MSIF_CUS,                           /* 0x0000                                           */  \
128     MSIF_MOD,                           /* 0x0000                                           */  \
129     MSIF_CHIP,                                                                                  \
130     MSIF_CPU,                                                                                   \
131     MSIF_EMMFLT_LIB_CODE,                  /* IP__                                             */  \
132     MSIF_EMMFLT_LIBVER,                    /* 0.0 ~ Z.Z                                        */  \
133     MSIF_EMMFLT_BUILDNUM,                  /* 00 ~ 99                                          */  \
134     MSIF_EMMFLT_CHANGELIST,                /* CL#                                              */  \
135     MSIF_OS
136 
137 typedef MS_U32                         EMMFLT_RESULT;
138 
139 typedef void (*EMMFLT_Notify)(MS_U32 conn, MS_U32 reason, void *pData);
140 
141 
142 #define DRV_EMMFLT_OK                   TRUE
143 #define DRV_EMMFLT_FAIL                 FALSE
144 #define DRV_EMMFLT_INVALID_REQUEST      3
145 
146 
147 
148 #define EMM_SRC_FILEIN      0
149 #define EMM_SRC_LIVEIN      1
150 
151 typedef enum
152 {
153     EMM_ENGINE = 0,
154     RASP_ENGINE,
155     MAX_ENGINE,
156 }EMMRASP_e;
157 
158 typedef enum _EMM_EVENT_
159 {
160     EMM_EVENT_ARRIVE = 0,
161     EMM_EVENT_OVERFLOW,
162 } EMM_EVENT_e;
163 
164 
165 #if defined(UFO_PUBLIC_HEADER_500_3)
166 typedef enum _EMM_SrcType_
167 {
168     EMM_SRC_TS0             = 0,
169     EMM_SRC_TS1,
170     EMM_SRC_TS2,            // 2
171     EMM_SRC_TS3,
172     EMM_SRC_TS4,
173     EMM_SRC_TS5,            // 5
174     EMM_SRC_TS6,            // 6
175     EMM_SRC_TSO,            // 7
176     EMM_SRC_INTERDEMOD_0,   // 8
177     EMM_SRC_INTERDEMOD_1,   // 9
178     EMM_SRC_MEMORY,         // 10
179 }EMM_SRCTYPE_e;
180 #else
181 typedef enum _EMM_SrcType_
182 {
183     EMM_SRC_TS0 = 0,
184     EMM_SRC_TS1,
185     EMM_SRC_TS2,
186     EMM_SRC_TS3,
187     EMM_SRC_INTERDEMOD_0,
188     EMM_SRC_INTERDEMOD_1,
189     EMM_SRC_MEMORY,
190 }EMM_SRCTYPE_e;
191 #endif
192 
193 typedef enum
194 {
195     EMM_TIDMODE_INGORE = 0x0,
196     EMM_TIDMODE_ACCEPT_ALL,
197     EMM_TIDMODE_ACCEPT_ADDRESS,
198     EMM_TIDMODE_RESERVED,
199 } EMMDRV_TIDMODE_e;
200 
201 typedef enum _EMM_OutType_
202 {
203     EMM_OUT_NORMAL = 0,
204     EMM_OUT_184BYTES,
205     EMM_OUT_PACKETNUM,
206 }EMM_OUTTYPE_e;
207 
208 typedef struct _EMMFLT_Require_
209 {
210     MS_U32 u32DstBufSize;
211     MS_U32 u32AlignBytes;
212     MS_U8  u8EMMNumber;
213 } EMMFLT_Require_t;
214 
215 
216 typedef struct _EMM_FILTER_DEF
217 {
218     MS_U8   filter_type;         //this can be set to LABEL_00, 01, 02, 03
219     MS_U8   filter_address[4];   //
220     MS_U8   filter_address_mask[4];
221 
222 } EMM_FILTER_DEF_t;
223 
224 
225 ////////////////////////////////////////////////////////////////////////////////
226 // Extern Function
227 ////////////////////////////////////////////////////////////////////////////////
228 
229 EMMFLT_RESULT MDrv_EMMFLT_Init(EMMFLT_Require_t *pRequire);
230 EMMFLT_RESULT MDrv_EMMFLT_GetHwBufCnt(MS_U32 *pHwBufCnt);
231 EMMFLT_RESULT MDrv_EMMFLT_SetDbgLevel(MS_U32 u32Level);
232 EMMFLT_RESULT MDrv_EMMFLT_SetNotify(EMMFLT_Notify Notify);
233 EMMFLT_RESULT MDrv_EMMFLT_SetEmmPID(MS_U32 connection,MS_U16 u16EmmPID);
234 EMMFLT_RESULT MDrv_EMMFLT_SetTidMode(MS_U32 connection, MS_U8 u8TidValue, EMMDRV_TIDMODE_e eTIDMODE);
235 EMMFLT_RESULT MDrv_EMMFLT_EnableEmmTID(MS_U32 connection, MS_BOOL bEnable);
236 EMMFLT_RESULT MDrv_EMMFLT_SetFilterCfg(MS_U32 connection, MS_U8 FilerIndex, EMM_FILTER_DEF_t *pFilter);
237 EMMFLT_RESULT MDrv_EMMFLT_Fire(MS_U32 connection);
238 
239 EMMFLT_RESULT MDrv_EMMFLT_SetDstBufInfo(MS_U32 x_connection, MS_U32 u32BufAddr, MS_U32 u32BufSize);
240 EMMFLT_RESULT MDrv_EMMFLT_EmmProcessingFinished(MS_U8 *emm_buf/* RPC SIZECONST(256) */);
241 EMMFLT_RESULT MDrv_EMMFLT_Deinit(void);
242 EMMFLT_RESULT MDrv_EMMFLT_SrcSelect(MS_U32 x_connection, MS_U32 u32SrcFrom, EMM_SRCTYPE_e eSrcType);
243 EMMFLT_RESULT MDrv_EMMFLT_StopEmm(MS_U32 x_connection);
244 EMMFLT_RESULT MDrv_EMMFLT_EmmProcessingFinished(MS_U8 *emm_buf/* RPC SIZECONST(256) */);
245 EMMFLT_RESULT MDrv_EMMFLT_SetOutputType(MS_U32 x_connection, EMM_OUTTYPE_e eOutType);
246 EMMFLT_RESULT MDrv_EMMFLT_ConnectCheck(MS_U32 connection);
247 
248 EMMFLT_RESULT MDrv_EMMFLT_SetExtendConfig(MS_U32 x_connection, MS_U16 type, MS_U16 extendbytes, MS_U16 syncbyte);
249 EMMFLT_RESULT MDrv_EMMFLT_InputMode(MS_U32 x_connection, MS_BOOL bSerial);
250 
251 void EMMRASP_IntAttach(EMMRASP_e eEng, MS_BOOL Enable);
252 
253 #ifdef __cplusplus
254 }
255 #endif
256 #endif//_DRVEMMFLT_H_
257 
258