xref: /utopia/UTPA2-700.0.x/projects/tmplib/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 
113 ////////////////////////////////////////////////////////////////////////////////
114 // Define & data type
115 ////////////////////////////////////////////////////////////////////////////////
116 #define MSIF_EMMFLT_LIB_CODE	{'E','M','M','F'}    //Lib code
117 #define MSIF_EMMFLT_LIBVER		{'0','1'}            //LIB version
118 #define MSIF_EMMFLT_BUILDNUM    {'0','1'}            //Build Number
119 #define MSIF_EMMFLT_CHANGELIST  {'0','0','3','4','8','0','3','3'} //P4 ChangeList Number
120 
121 #define EMMFLT_DRV_VERSION                /* Character String for DRV/API version             */  \
122     MSIF_TAG,                           /* 'MSIF'                                           */  \
123     MSIF_CLASS,                         /* '00'                                             */  \
124     MSIF_CUS,                           /* 0x0000                                           */  \
125     MSIF_MOD,                           /* 0x0000                                           */  \
126     MSIF_CHIP,                                                                                  \
127     MSIF_CPU,                                                                                   \
128     MSIF_EMMFLT_LIB_CODE,                  /* IP__                                             */  \
129     MSIF_EMMFLT_LIBVER,                    /* 0.0 ~ Z.Z                                        */  \
130     MSIF_EMMFLT_BUILDNUM,                  /* 00 ~ 99                                          */  \
131     MSIF_EMMFLT_CHANGELIST,                /* CL#                                              */  \
132     MSIF_OS
133 
134 typedef MS_U32                         EMMFLT_RESULT;
135 
136 typedef void (*EMMFLT_Notify)(MS_U32 conn, MS_U32 reason, void *pData);
137 
138 
139 #define DRV_EMMFLT_OK                   TRUE
140 #define DRV_EMMFLT_FAIL                 FALSE
141 #define DRV_EMMFLT_INVALID_REQUEST      3
142 
143 
144 
145 #define EMM_SRC_FILEIN      0
146 #define EMM_SRC_LIVEIN      1
147 
148 
149 typedef enum _EMM_EVENT_
150 {
151     EMM_EVENT_ARRIVE = 0,
152     EMM_EVENT_OVERFLOW,
153 } EMM_EVENT_e;
154 
155 
156 
157 typedef enum _EMM_SrcType_
158 {
159     EMM_SRC_TS0 = 0,
160     EMM_SRC_TS1,
161     EMM_SRC_TS2,
162     EMM_SRC_TS3,
163     EMM_SRC_INTERDEMOD_0,
164     EMM_SRC_INTERDEMOD_1,
165     EMM_SRC_MEMORY,
166 }EMM_SRCTYPE_e;
167 
168 typedef enum
169 {
170     EMM_TIDMODE_INGORE = 0x0,
171     EMM_TIDMODE_ACCEPT_ALL,
172     EMM_TIDMODE_ACCEPT_ADDRESS,
173     EMM_TIDMODE_RESERVED,
174 } EMMDRV_TIDMODE_e;
175 
176 typedef enum _EMM_OutType_
177 {
178     EMM_OUT_NORMAL = 0,
179     EMM_OUT_184BYTES,
180     EMM_OUT_PACKETNUM,
181 }EMM_OUTTYPE_e;
182 
183 typedef struct _EMMFLT_Require_
184 {
185     MS_U32 u32DstBufSize;
186     MS_U32 u32AlignBytes;
187     MS_U8  u8EMMNumber;
188 } EMMFLT_Require_t;
189 
190 
191 typedef struct _EMM_FILTER_DEF
192 {
193     MS_U8   filter_type;         //this can be set to LABEL_00, 01, 02, 03
194     MS_U8   filter_address[4];   //
195     MS_U8   filter_address_mask[4];
196 
197 } EMM_FILTER_DEF_t;
198 
199 
200 ////////////////////////////////////////////////////////////////////////////////
201 // Extern Function
202 ////////////////////////////////////////////////////////////////////////////////
203 
204 EMMFLT_RESULT MDrv_EMMFLT_Init(EMMFLT_Require_t *pRequire);
205 EMMFLT_RESULT MDrv_EMMFLT_GetHwBufCnt(MS_U32 *pHwBufCnt);
206 EMMFLT_RESULT MDrv_EMMFLT_SetDbgLevel(MS_U32 u32Level);
207 EMMFLT_RESULT MDrv_EMMFLT_SetNotify(EMMFLT_Notify Notify);
208 EMMFLT_RESULT MDrv_EMMFLT_SetEmmPID(MS_U32 connection,MS_U16 u16EmmPID);
209 EMMFLT_RESULT MDrv_EMMFLT_SetTidMode(MS_U32 connection, MS_U8 u8TidValue, EMMDRV_TIDMODE_e eTIDMODE);
210 EMMFLT_RESULT MDrv_EMMFLT_EnableEmmTID(MS_U32 connection, MS_BOOL bEnable);
211 EMMFLT_RESULT MDrv_EMMFLT_SetFilterCfg(MS_U32 connection, MS_U8 FilerIndex, EMM_FILTER_DEF_t *pFilter);
212 EMMFLT_RESULT MDrv_EMMFLT_Fire(MS_U32 connection);
213 
214 EMMFLT_RESULT MDrv_EMMFLT_SetDstBufInfo(MS_U32 x_connection, MS_U32 u32BufAddr, MS_U32 u32BufSize);
215 EMMFLT_RESULT MDrv_EMMFLT_EmmProcessingFinished(MS_U8 *emm_buf/* RPC SIZECONST(256) */);
216 EMMFLT_RESULT MDrv_EMMFLT_Deinit(void);
217 EMMFLT_RESULT MDrv_EMMFLT_SrcSelect(MS_U32 x_connection, MS_U32 u32SrcFrom, EMM_SRCTYPE_e eSrcType);
218 EMMFLT_RESULT MDrv_EMMFLT_StopEmm(MS_U32 x_connection);
219 EMMFLT_RESULT MDrv_EMMFLT_EmmProcessingFinished(MS_U8 *emm_buf/* RPC SIZECONST(256) */);
220 EMMFLT_RESULT MDrv_EMMFLT_SetOutputType(MS_U32 x_connection, EMM_OUTTYPE_e eOutType);
221 EMMFLT_RESULT MDrv_EMMFLT_ConnectCheck(MS_U32 connection);
222 
223 #ifdef __cplusplus
224 }
225 #endif
226 #endif//_DRVEMMFLT_H_
227 
228