xref: /utopia/UTPA2-700.0.x/modules/vdec_v1/hal/M7821/hvd/halHVD.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 
95 #ifndef _HAL_HVD_H_
96 #define _HAL_HVD_H_
97 
98 //-------------------------------------------------------------------------------------------------
99 //  Macro and Define
100 //-------------------------------------------------------------------------------------------------
101 // Feature
102 #define HAL_HVD_ENABLE_MUTEX_PROTECT    HVD_ENABLE_MUTEX_PROTECT
103 #define HAL_HVD_ENABLE_MIU_PROTECT      HVD_ENABLE_MIU_RST_PROTECT
104 #define HAL_HVD_ENABLE_VPU_CMD    1
105 
106 // MBox type of FW cmd
107 #if (HAL_HVD_ENABLE_VPU_CMD)
108     #define HAL_HVD_CMD_MBOX            E_HVD_VPU_HI_0
109     #define HAL_HVD_CMD_ARG_MBOX        E_HVD_VPU_HI_1
110 #else
111     #define HAL_HVD_CMD_MBOX            E_HVD_HI_0
112     #define HAL_HVD_CMD_ARG_MBOX        E_HVD_HI_1
113 #endif
114 // MBox other usages
115 #define HAL_HVD_REG_ISR_VPU     E_HVD_VPU_RISC_1
116 #define HAL_HVD_REG_FW_STATE    E_HVD_RISC_0
117 #define HAL_HVD_REG_ISR_HVD     E_HVD_RISC_1
118 #define HAL_HVD_REG_DISP_INFO_COPYED    E_HVD_RISC_1
119 #define HAL_HVD_REG_DISP_INFO_CHANGE    E_HVD_RISC_1
120 #define HAL_HVD_REG_DISP_CTL    E_HVD_HI_0
121 
122 #if defined(CHIP_T3)
123 // patch for HW bug
124 #define HVD_MIU1_BASE_ADDRESS   0x08000000UL//0x10000000UL
125 #else // CHIP_U3
126 #define HVD_MIU1_BASE_ADDRESS   0x08000000UL
127 #endif
128 
129 #define HVD_RV_BROKENBYUS_BIT    29
130 
131 //-------------------------------------------------------------------------------------------------
132 //  Type and Structure
133 //-------------------------------------------------------------------------------------------------
134 
135 typedef enum
136 {
137     E_HVD_HI_0,
138     E_HVD_HI_1,
139     E_HVD_RISC_0,
140     E_HVD_RISC_1,
141     E_HVD_VPU_HI_0,
142     E_HVD_VPU_HI_1,
143     E_HVD_VPU_RISC_0,
144     E_HVD_VPU_RISC_1,
145 } HVD_MBOX_TYPE;
146 
147 typedef struct
148 {
149     MS_U32 u32WritePtr;
150     MS_U32 u32OffsetCnt;
151 } HVD_PTS_Table_Ctrl;
152 
153 typedef struct
154 {
155     MS_U32 u32PTS;
156     MS_U32 u32OffsetCnt;
157     MS_U32 u32ID_L;
158     MS_U32 u32ID_H;
159 } HVD_PTS_Table_Entry;
160 
161 //-------------------------------------------------------------------------------------------------
162 //  Function and Variable
163 //-------------------------------------------------------------------------------------------------
164 void        HAL_HVD_FlushMemory(void);
165 void        HAL_HVD_ReadMemory(void);
166 void        HAL_HVD_CheckMIUSel(MS_BOOL bChange);
167 MS_U32      HAL_HVD_Get_HWVersionID(void);
168 void        HAL_HVD_PowerCtrl(MS_BOOL bEnable);
169 void        HAL_HVD_InitRegBase(MS_U32 u32RegBase);
170 void        HAL_HVD_SetPreCtrlVariables(MS_U32 drvprectrl);
171 HVD_Return  HAL_HVD_InitVariables(MS_U32 drvctrl);
172 HVD_Return  HAL_HVD_InitShareMem(void);
173 HVD_Return  HAL_HVD_InitRegCPU(void);
174 HVD_Return  HAL_HVD_SetData(HVD_SetData u32type, MS_U32 u32Data);
175 MS_U32      HAL_HVD_GetData(HVD_GetData eType);
176 
177 MS_S64      HAL_HVD_GetData_EX(HVD_GetData eType);
178 HVD_Return  HAL_HVD_SetCmd(HVD_User_Cmd eUsrCmd, MS_U32 u32CmdArg);
179 HVD_Return  HAL_HVD_DeInit(void);
180 HVD_Return  HAL_HVD_PushPacket(HVD_BBU_Info *pInfo);
181 void        HAL_HVD_EnableISR(MS_BOOL bEnable);
182 void        HAL_HVD_SetForceISR(MS_BOOL bEnable);
183 void        HAL_HVD_SetClearISR(void);
184 MS_BOOL     HAL_HVD_IsISROccured(void);
185 MS_BOOL     HAL_HVD_IsEnableISR(void);
186 MS_BOOL     HAL_HVD_IsAlive(void);
187 MS_BOOL     HAL_HVD_RstPTSCtrlVariable(void);
188 MS_BOOL     HAL_HVD_FlushRstShareMem(void);
189 void        HAL_HVD_UartSwitch2FW(MS_BOOL bEnable);
190 MS_U32      HAL_HVD_GetData_Dbg(MS_U32 u32Addr);
191 void        HAL_HVD_SetData_Dbg(MS_U32 u32Addr, MS_U32 u32Data);
192 MS_U16      HAL_HVD_GetCorretClock(MS_U16 u16Clock);
193 void        HAL_HVD_UpdateESWptr_Fire(void);
194 void        HAL_HVD_MVD_PowerCtrl(MS_BOOL bEnable);
195 void        HAL_HVD_Dump_FW_Status(void);
196 void        HAL_HVD_Dump_HW_Status(MS_U32 numb);
197 void        HAL_HVD_SetMiuBurstLevel(HVD_MIU_Burst_Cnt_Ctrl eMiuBurstCntCtrl);
198 MS_BOOL     HAL_HVD_GetFrmRateIsSupported(MS_U16 u16HSize, MS_U16 u16VSize, MS_U32 u32FrmRate);
199 
200 #endif // _HAL_HVD_H_
201 
202