xref: /utopia/UTPA2-700.0.x/mxlib/include/apiDMX_tsio_v2.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1 //<MStar Software>
2 //******************************************************************************
3 // MStar Software
4 // Copyright (c) 2014 - 2016 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) 2014-2016 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 //
97 //  File name: apiDMX_tsio_v2.h
98 //  Description: Demux (dmx) api header file
99 //
100 ////////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _DMX_TSIO_V2_H_
103 #define _DMX_TSIO_V2_H_
104 
105 #include "MsDevice.h"
106 
107 #ifdef __cplusplus
108 extern "C"
109 {
110 #endif
111 
112 //-------------------------------------------------------------------------------------------------
113 // Macros
114 //-------------------------------------------------------------------------------------------------
115 
116 
117 //-------------------------------------------------------------------------------------------------
118 // Type and Structure Declaration
119 //-------------------------------------------------------------------------------------------------
120 
121 typedef struct DLL_PACKED _DMX_TSIO_Service_SetDMAoutVC_PARAM
122 {
123     MS_U32              u32Res;
124     MS_U16              u16Handle;
125     TSIO_DMAOUT_SET*    eSet;
126 }DMX_TSIO_Service_SetDMAoutVC_PARAM,*PDMX_TSIO_Service_SetDMAoutVC_PARAM;
127 
128 typedef struct DLL_PACKED _DMX_TSIO_Service_DMAout_WriteGet_PARAM
129 {
130     MS_U32              u32Res;
131     MS_U16              u16Handle;
132     MS_PHY*             pphyWrite;
133 }DMX_TSIO_Service_DMAout_WriteGet_PARAM, *PDMX_TSIO_Service_DMAout_WriteGet_PARAM;
134 
135 typedef struct DLL_PACKED _DMX_TSIO_Service_SetDestination_PARAM
136 {
137     MS_U32              u32Res;
138     MS_U16              u16Handle;
139     TSIO_SERVICEDEST    eDest;
140 }DMX_TSIO_Service_SetDestination_PARAM,*PDMX_TSIO_Service_SetDestination_PARAM;
141 
142 typedef struct DLL_PACKED _DMX_TSIO_Service_DMAin_PidOpen_PARAM
143 {
144     MS_U32              u32Res;
145     MS_U16              u16Handle;
146     MS_U16              u16Pid;
147     MS_U16*             pu16FltId;
148 }DMX_TSIO_Service_DMAin_PidOpen_PARAM,*PDMX_TSIO_Service_DMAin_PidOpen_PARAM;
149 
150 typedef struct DLL_PACKED _DMX_TSIO_Service_DMAin_PidClose_PARAM
151 {
152     MS_U32              u32Res;
153     MS_U16              u16Handle;
154     MS_U16              u16FltId;
155 }DMX_TSIO_Service_DMAin_PidClose_PARAM,*PDMX_TSIO_Service_DMAin_PidClose_PARAM;
156 
157 typedef struct DLL_PACKED _DMX_TSIO_Service_SetDMAinVC_PARAM
158 {
159     MS_U32              u32Res;
160     MS_U16              u16Handle;
161     TSIO_DMAIN_SET*     eSet;
162 }DMX_TSIO_Service_SetDMAinVC_PARAM,*PDMX_TSIO_Service_SetDMAinVC_PARAM;
163 
164 typedef struct DLL_PACKED _DMX_TSIO_Service_DMAinVC_Start_PARAM
165 {
166     MS_U32              u32Res;
167     MS_U16              u16Handle;
168     MS_U32              u32Pacing;
169 }DMX_TSIO_Service_DMAinVC_Start_PARAM,*PDMX_TSIO_Service_DMAinVC_Start_PARAM;
170 
171 typedef struct DLL_PACKED _DMX_TSIO_Service_SetLocdecKey_PARAM
172 {
173     MS_U32              u32Res;
174     MS_U16              u16Handle;
175     TSIO_LOCKEY_SET*    eSet;
176 }DMX_TSIO_Service_SetLocdecKey_PARAM,*PDMX_TSIO_Service_SetLocdecKey_PARAM;
177 
178 typedef struct DLL_PACKED _DMX_TSIO_Service_LocdecKeyEnable_PARAM
179 {
180     MS_U32              u32Res;
181     MS_U16              u16Handle;
182     MS_BOOL             bEnable;
183 }DMX_TSIO_Service_LocdecKeyEnable_PARAM,*PDMX_TSIO_Service_LocdecKeyEnable_PARAM;
184 
185 typedef struct DLL_PACKED _DMX_TSIO_Service_PidOpen_PARAM
186 {
187     MS_U32              u32Res;
188     MS_U16              u16Handle;
189     DMX_TSIF            eTSOInSrc;
190     MS_U16              u16Pid;
191     MS_U16*             pu16DmxId;
192 }DMX_TSIO_Service_PidOpen_PARAM,*PDMX_TSIO_Service_PidOpen_PARAM;
193 
194 typedef struct DLL_PACKED _DMX_TSIO_Service_PidClose_PARAM
195 {
196     MS_U32              u32Res;
197     MS_U16              u16Handle;
198     MS_U16              u16DmxId;
199 }DMX_TSIO_Service_PidClose_PARAM,*PDMX_TSIO_Service_PidClose_PARAM;
200 
201 typedef struct DLL_PACKED _DMX_TSIO_Service_Alloc_PARAM
202 {
203     MS_U32              u32Res;
204     MS_U8               u8Sid;
205     MS_U16*             u16Handle;
206 }DMX_TSIO_Service_Alloc_PARAM,*PDMX_TSIO_Service_Alloc_PARAM;
207 
208 typedef struct DLL_PACKED _DMX_TSIO_Service_Free_PARAM
209 {
210     MS_U32              u32Res;
211     MS_U16              u16Handle;
212 }DMX_TSIO_Service_Free_PARAM,*PDMX_TSIO_Service_Free_PARAM;
213 
214 typedef struct DLL_PACKED _DMX_TSIO_RegisterIntCb_PARAM
215 {
216     MS_U32              u32Res;
217     TSIOIntTypeCB       efn;
218 }DMX_TSIO_RegisterIntCb_PARAM,*PDMX_TSIO_RegisterIntCb_PARAM;
219 
220 typedef struct DLL_PACKED _DMX_TSIO_Init_PARAM
221 {
222     MS_U32              u32Res;
223     TSIO_Init_Set*      eParm;
224 }DMX_TSIO_Init_PARAM,*PDMX_TSIO_Init_PARAM;
225 
226 typedef struct DLL_PACKED _DMX_TSIO_Open_PARAM
227 {
228     MS_U32              u32Res;
229     TSIO_CLK            eClk;
230 }DMX_TSIO_Open_PARAM, *PDMX_TSIO_Open_PARAM;
231 
232 typedef struct DLL_PACKED _DMX_TSIO_Cmd_PARAM
233 {
234     MS_U32              u32Res;
235     TSIO_CMD            eCmd;
236     MS_U32              u32Value;
237 }DMX_TSIO_Cmd_PARAM,*PDMX_TSIO_Cmd_PARAM;
238 
239 typedef struct DLL_PACKED _DMX_TSIO_CC_PARAM
240 {
241     MS_U32              u32Res;
242     TSIO_CC_Set*        Parm;
243     TSIO_CC_RESULT*     pResult;
244 }DMX_TSIO_CC_PARAM,*PDMX_TSIO_CC_PARAM;
245 
246 typedef struct DLL_PACKED _DMX_TSIO_GetInfo_PARAM
247 {
248     MS_U32              u32Res;
249     TSIO_INFO           eInfo;
250     MS_U32              u32Arg;
251     MS_U32*             u32Retinfo;
252 }DMX_TSIO_GetInfo_PARAM,*PDMX_TSIO_GetInfo_PARAM;
253 
254 #ifdef __cplusplus
255 }
256 #endif
257 
258 
259 #endif //_DMX_TSIO_V2_H_
260