xref: /utopia/UTPA2-700.0.x/modules/dmx/hal/mustang/mmfi/halMMFilein.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) 20010-20012 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   halMMFilein.h
97 // @brief  Multimedia File In (MMFILEIN) HAL
98 // @author MStar Semiconductor,Inc.
99 ////////////////////////////////////////////////////////////////////////////////////////////////////
100 #ifndef __HAL_MMFILEIN_H__
101 #define __HAL_MMFILEIN_H__
102 
103 #include "regMMFilein.h"
104 
105 //#define MMFI_VER_1_0                     0x0100UL
106 //#define MMFI_VER_2_0                     0x0200UL
107 //#define MMFI_VERSION                     MMFI_VER_2_0
108 
109 //--------------------------------------------------------------------------------------------------
110 //  Driver Compiler Option
111 //--------------------------------------------------------------------------------------------------
112 
113 //--------------------------------------------------------------------------------------------------
114 //  TSP Hardware Abstraction Layer
115 //--------------------------------------------------------------------------------------------------
116 
117 //--------------------------------------------------------------------------------------------------
118 //  Macro of bit operations
119 //--------------------------------------------------------------------------------------------------
120 
121 ////////////////////////////////////////////////
122 // HAL API
123 ////////////////////////////////////////////////
124 void   HAL_MMFI_SetBank(MS_VIRT virtBank);
125 
126 //
127 // APIs
128 //
129 void        HAL_MMFI_PidFlt_Set(MS_U8 u8Eng, MS_U8 u8Idx, MS_U16 u16PID, MS_U32 u32entype);
130 void        HAL_MMFI_PidFlt_SetPid(MS_U8 u8Eng, MS_U8 u8Idx, MS_U16 u16PID);
131 void        HAL_MMFI_PidFlt_Enable(MS_U8 u8Eng, MS_U8 u8Idx, MS_U32 u32entype, MS_BOOL benable);
132 void        HAL_MMFI_PidFlt_Reset(MS_U8 u8Eng, MS_U8 u8Idx);
133 void        HAL_MMFI_Set_Filein_ReadAddr(MS_U8 u8Eng, MS_PHY phyAddr);
134 void        HAL_MMFI_Set_Filein_ReadLen(MS_U8 u8Eng, MS_U32 u32len);
135 void        HAL_MMFI_Set_Filein_Ctrl(MS_U8 u8Eng, MS_U16 u16ctrl, MS_BOOL bEnable);
136 MS_U16      HAL_MMFI_Get_Filein_Ctrl(MS_U8 u8Eng);
137 void        HAL_MMFI_Set_FileinTimer(MS_U8 u8Eng, MS_U8 u8timer);
138 MS_PHY    HAL_MMFI_Get_Filein_WriteAddr(MS_U8 u8Eng);
139 
140 MS_U16      HAL_MMFI_CmdQ_FIFO_Get_WRCnt(MS_U8 u8Eng);
141 MS_BOOL     HAL_MMFI_CmdQ_FIFO_IsFull(MS_U8 u8Eng);
142 MS_BOOL     HAL_MMFI_CmdQ_FIFO_IsEmpty(MS_U8 u8Eng);
143 MS_U16      HAL_MMFI_CmdQ_FIFO_Get_WRLevel(MS_U8 u8Eng);
144 void        HAL_MMFI_Cfg_Enable(MS_U8 u8Eng, MS_U32 u32CfgItem, MS_BOOL benable);
145 void        HAL_MMFI_Cfg_Set(MS_U8 u8Eng, MS_U32 u32CfglItem);
146 MS_U32      HAL_MMFI_Cfg_Get(MS_U8 u8Eng);
147 void        HAL_MMFI_Cfg2_Enable(MS_U8 u8Eng, MS_U16 u16CfgItem, MS_BOOL benable);
148 void        HAL_MMFI_Cfg2_Set(MS_U8 u8Eng, MS_U16 u16CfglItem);
149 MS_U16      HAL_MMFI_Cfg2_Get(MS_U8 u8Eng);
150 void        HAL_MMFI_Get_TsHeaderInfo(MS_U8 u8Eng, MS_U32 *pu32header);
151 void        HAL_MMFI_Get_APid_Status(MS_U8 u8Eng, MS_U16 *pu16pid, MS_BOOL *pbchanged);
152 void        HAL_MMFI_Get_APidB_Status(MS_U8 u8Eng, MS_U16 *pu16pid, MS_BOOL *pbchanged);
153 void        HAL_MMFI_Get_VPid_Status(MS_U8 u8Eng, MS_U16 *pu16pid, MS_BOOL *pbchanged);
154 void        HAL_MMFI_Get_VPid3D_Status(MS_U8 u8Eng, MS_U16 *pu16pid, MS_BOOL *pbchanged);
155 void        HAL_MMFI_LPcr2_Set(MS_U8 u8Eng, MS_U32 u32lpcr2);
156 MS_U32      HAL_MMFI_LPcr2_Get(MS_U8 u8Eng);
157 MS_U32      HAL_MMFI_TimeStamp_Get(MS_U8 u8Eng);
158 void        HAL_MMFI_PktChkSize_Set(MS_U8 u8Eng, MS_U16 u16size);
159 void        HAL_MMFI_MOBF_Set_FileinKey(MS_U8 u8Eng, MS_U16 u16KeyIndex);
160 void        HAL_MMFI_MOBF_Enable(MS_U8 u8Eng, MS_BOOL bEnable);
161 void        HAL_MMFI_AU_RemoveDupPkt(MS_U8 u8Eng, MS_BOOL bEnable);
162 void        HAL_MMFI_TimeStampClk_Set(MS_U8 u8Eng, MS_U32 u32ClkSrc);
163 //
164 // General API
165 void        HAL_MMFI_Reset(void);
166 void        HAL_MMFI_Reset_SubItem(MS_U16 u16RstItem);
167 void        HAL_MMFI_Reset_All(void);
168 void        HAL_MMFI_HWInt_Enable(MS_BOOL benable, MS_U16 u16init);
169 void        HAL_MMFI_HWInt_Clear(MS_U16 u16Int);
170 MS_U32      HAL_MMFI_HWInt_Status(void);
171 
172 #ifdef MSOS_TYPE_LINUX_KERNEL
173 MS_BOOL     HAL_MMFI_SaveRegs(void);
174 MS_BOOL     HAL_MMFI_RestoreRegs(void);
175 #endif //MSOS_TYPE_LINUX_KERNEL
176 
177 
178 #endif // #ifndef __HAL_MMFILEIN_H__
179 
180 
181