xref: /utopia/UTPA2-700.0.x/modules/vdec_v1/hal/M7821/vpu/halVPU.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_VPU_H_
96 #define _HAL_VPU_H_
97 
98 
99 //-------------------------------------------------------------------------------------------------
100 //  Macro and Define
101 //-------------------------------------------------------------------------------------------------
102 #if defined(REDLION_LINUX_KERNEL_ENVI)
103 #define ENABLE_VPU_MUTEX_PROTECTION     0
104 #define VPU_DEFAULT_MUTEX_TIMEOUT       0xFFFFFFFFUL
105 #else
106 #define ENABLE_VPU_MUTEX_PROTECTION     1
107 #define VPU_DEFAULT_MUTEX_TIMEOUT       MSOS_WAIT_FOREVER
108 #endif
109 
110 #define VPU_CLOCK_216MHZ                BITS(3:2,0)
111 #define VPU_CLOCK_192MHZ               BITS(3:2,1)
112 #define VPU_CLOCK_160MHZ                BITS(3:2,2)
113 #define VPU_CLOCK_144MHZ                BITS(3:2,3)
114 #define VPU_CLOCK_NOTSUPPORT            BITS(3:2,0)
115 
116 #define VPU_HI_MBOX0        0
117 #define VPU_HI_MBOX1        1
118 #define VPU_RISC_MBOX0      2
119 #define VPU_RISC_MBOX1      3
120 
121 #define VPU_Timer_delay_ms(x)            \
122     do {                                                            \
123         volatile MS_U32 ticks=0;                                         \
124         while( ticks < ( ((MS_U32)(x)) <<13) )      \
125         {                                                               \
126             ticks++;                                                \
127         }                                                               \
128     } while(0)
129 //-------------------------------------------------------------------------------------------------
130 //  Type and Structure
131 //-------------------------------------------------------------------------------------------------
132 typedef enum
133 {
134     E_VPU_DECODER_NONE = 0,
135     E_VPU_DECODER_MVD,
136     E_VPU_DECODER_HVD,
137     E_VPU_DECODER_MJPEG,
138     E_VPU_DECODER_RVD,
139 } VPU_DecoderType;
140 
141 typedef enum
142 {
143     E_VPU_CLOCK_216MHZ=VPU_CLOCK_216MHZ,
144     E_VPU_CLOCK_192MHZ=VPU_CLOCK_192MHZ,
145     E_VPU_CLOCK_160MHZ=VPU_CLOCK_160MHZ,
146     E_VPU_CLOCK_144MHZ=VPU_CLOCK_144MHZ,
147     E_VPU_CLOCK_123MHZ=VPU_CLOCK_NOTSUPPORT,
148     E_VPU_CLOCK_108MHZ=VPU_CLOCK_NOTSUPPORT,
149     E_VPU_CLOCK_96MHZ=VPU_CLOCK_NOTSUPPORT,
150     E_VPU_CLOCK_86MHZ=VPU_CLOCK_NOTSUPPORT,
151     E_VPU_CLOCK_72MHZ=VPU_CLOCK_NOTSUPPORT,
152 } VPU_Clock_Speed;
153 
154 
155 typedef struct
156 {
157     VPU_Clock_Speed eClockSpeed;
158     MS_BOOL  bClockInv;
159     MS_S32  s32VPUMutexID;
160     MS_U32  u32VPUMutexTimeout;
161     MS_BOOL bInMIU1;
162     VPU_DecoderType eDecodertype;
163 } VPU_Init_Params;
164 
165 //-------------------------------------------------------------------------------------------------
166 //  Function and Variable
167 //-------------------------------------------------------------------------------------------------
168 void HAL_VPU_InitRegBase(MS_U32 u32RegBase);
169 MS_BOOL HAL_VPU_IsNeedReload(VPU_DecoderType eDecoder);
170 void HAL_VPU_SetFWDecoder(VPU_DecoderType eDecoder);
171 VPU_DecoderType HAL_VPU_GetFWDecoder(void);
172 
173 MS_BOOL HAL_VPU_Init(VPU_Init_Params* InitParams);
174 MS_BOOL HAL_VPU_DeInit(void);
175 void HAL_VPU_PowerCtrl(MS_BOOL bEnable);
176 void HAL_VPU_ClockSpeed(MS_U32 u32type);
177 void HAL_VPU_ClockInv(MS_BOOL bEnable);
178 void HAL_VPU_MIU_RW_Protect(MS_BOOL bEnable);
179 MS_BOOL HAL_VPU_CPUSetting(MS_U32 u32StAddr);
180 MS_BOOL HAL_VPU_SwRst(void);
181 void HAL_VPU_SwRstRelse(void);
182 void HAL_VPU_SwRelseMAU(void);
183 MS_U32 HAL_VPU_MemRead(MS_U32 u32Address);
184 MS_BOOL HAL_VPU_MemWrite(MS_U32 u32Address, MS_U32 u32Value);
185 MS_BOOL HAL_VPU_MBoxRdy(MS_U32 u32type);
186 MS_BOOL HAL_VPU_MBoxRead(MS_U32 u32type, MS_U32 *u32Msg);
187 void HAL_VPU_MBoxClear(MS_U32 u32type);
188 MS_BOOL HAL_VPU_MBoxSend(MS_U32 u32type, MS_U32 u32Msg);
189 MS_U32 HAL_VPU_GetProgCnt(void);
190 MS_BOOL HAL_VPU_MAU_IDLE(void);
191 
192 #endif // _HAL_VPU_H_
193 
194