xref: /utopia/UTPA2-700.0.x/modules/dmx/hal/curry/otv/halOTV.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) 2006-2007 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 // file    halOTV.h
97 // @brief  OTV HAL
98 // @author MStar Semiconductor,Inc.
99 ////////////////////////////////////////////////////////////////////////////////////////////////////
100 #ifndef __HAL_OTV_H__
101 #define __HAL_OTV_H__
102 
103 
104 //--------------------------------------------------------------------------------------------------
105 //  Driver Compiler Option
106 //--------------------------------------------------------------------------------------------------
107 
108 //--------------------------------------------------------------------------------------------------
109 //  OTV Hardware Abstraction Layer
110 //--------------------------------------------------------------------------------------------------
111 
112 // OTV define
113 
114 //#########################################################################
115 //#### Hardware Capability Macro Start
116 //#########################################################################
117 
118 #define OTV_ENG_NUM                 4
119 #define OTV_PIDFLT_START_NUM        0
120 #define OTV_PIDFLT_END_NUM          4
121 #define OTV_PIDFLT_NUM_ALL          4
122 #define OTV_EVENT_FIFO_DEPTH        32
123 
124 
125 //#########################################################################
126 //#### Hardware Capability Macro End
127 //#########################################################################
128 
129 
130 #define OTV_PID_NULL                0x1FFF
131 
132 
133 // HW characteristic
134 #define MIU(_addr_)                 ((_addr_)>>4)
135 
136 //--------------------------------------------------------------------------------------------------
137 //  Macro of bit operations
138 //--------------------------------------------------------------------------------------------------
139 
140 #if 0
141 #define HAS_FLAG(flag, bit)        ((flag) & (bit))
142 #define SET_FLAG(flag, bit)        ((flag)|= (bit))
143 #define RESET_FLAG(flag, bit)      ((flag)&= (~(bit)))
144 #define SET_FLAG1(flag, bit)       ((flag)|  (bit))
145 #define RESET_FLAG1(flag, bit)     ((flag)&  (~(bit)))
146 #endif
147 
148 #define _SET_(flag, bit)            ((flag) |   (bit) )
149 #define _CLR_(flag, bit)            ((flag) & (~(bit)))
150 
151 
152 ////////////////////////////////////////////////
153 // HAL API
154 ////////////////////////////////////////////////
155 
156 //--------------------------------------------------------------------------------------------------
157 // For MISC part
158 //--------------------------------------------------------------------------------------------------
159 void HAL_OTV_SetBank(MS_VIRT u32BankAddr);
160 
161 // OTV Init
162 void HAL_OTV_Init(MS_U32 u32OTVEng);
163 
164 // OTV Config Setting
165 void HAL_OTV_PktTimerSrcFromPVR_Enable(MS_U32 u32OTVEng, MS_BOOL bEnable);
166 void HAL_OTV_PktNumSrcFromPktDemux_Enable(MS_U32 u32OTVEng, MS_BOOL bEnable);
167 //void HAL_OTV_FirstPktTimerBase_Enable(MS_U32 u32OTVEng, MS_BOOL bEnable);
168 
169 
170 // OTV Interrupt
171 void HAL_OTV_INT_Timer_Enable(MS_U32 u32OTVEng, MS_BOOL bEnable);
172 void HAL_OTV_INT_Event_Enable(MS_U32 u32OTVEng, MS_BOOL bEnable);
173 void HAL_OTV_INT_SetEventWaterLevel(MS_U32 u32OTVEng, MS_U32 u32EventWaterLevel);
174 void HAL_OTV_INT_SetTimerWaterLevel(MS_U32 u32OTVEng, MS_U32 u32TimerWaterLevel);
175 MS_BOOL HAL_OTV_INT_GetEventHW(MS_U32 u32OTVEng);
176 MS_BOOL HAL_OTV_INT_GetTimerHW(MS_U32 u32OTVEng);
177 void HAL_OTV_INT_ClrEventHW(MS_U32 u32OTVEng);
178 void HAL_OTV_INT_ClrTimerHW(MS_U32 u32OTVEng);
179 
180 // OTV Event Queue
181 void HAL_OTV_EventQ_Enable(MS_U32 u32OTVEng, MS_BOOL bEnable);
182 void HAL_OTV_EventQ_GetEventNum(MS_U32 u32OTVEng, MS_U32 *pu32EventNum);
183 MS_BOOL HAL_OTV_EventQ_PopEvent(MS_U32 u32OTVEng);
184 void HAL_OTV_EventQ_GetEventDesciptor(MS_U32 u32OTVEng, MS_U32 *pu32EventDesciptor);
185 void HAL_OTV_EventQ_GetEventPktNum(MS_U32 u32OTVEng, MS_U32 *pu32EventPktNum);
186 void HAL_OTV_EventQ_GetEventPktTimer(MS_U32 u32OTVEng, MS_U32 *pu32EventPktTimer);
187 void HAL_OTV_EventQ_GetEventPktPCR(MS_U32 u32OTVEng, MS_U32 *pu32EventPktPCR);
188 void HAL_OTV_EventQ_GetEventPktPID(MS_U32 u32OTVEng, MS_U16 *pu16EventPktPID);
189 
190 
191 // Get OTV Current Packet Number/TimeStamp
192 void HAL_OTV_GetCurPktTimer(MS_U32 u32OTVEng, MS_U32 *pu32PktTimer);
193 void HAL_OTV_GetCurPktNum(MS_U32 u32OTVEng, MS_U32 *pu32PktNum);
194 
195 // OTV Pid Filter
196 void HAL_OTV_SetFltPid(MS_U32 u32OTVEng , MS_U32 u32FltId , MS_U16 u16Pid);
197 void HAL_OTV_GetFltPid(MS_U32 u32OTVEng , MS_U32 u32FltId , MS_U16 *pu16Pid);
198 void HAL_OTV_SetFltEvent(MS_U32 u32OTVEng , MS_U32 u32FltId, MS_U32 u32FltEvent);
199 void HAL_OTV_GetFltEvent(MS_U32 u32OTVEng , MS_U32 u32FltId, MS_U32 *pu32FltEvent);
200 void HAL_OTV_RstFltEvent(MS_U32 u32OTVEng);
201 
202 
203 
204 
205 #endif // #ifndef __HAL_OTV_H__
206