xref: /utopia/UTPA2-700.0.x/modules/ojpd_vdec_v1/hal/maxim/jpd/halJPD.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 ///////////////////////////////////////////////////////////////////////////////////////////////////
96 ///
97 /// @file   halJPD.h
98 /// @brief  JPD hal interface
99 /// @author MStar Semiconductor Inc.
100 ///////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _HAL_JPD_H_
103 #define _HAL_JPD_H_
104 
105 
106 //-------------------------------------------------------------------------------------------------
107 //  Driver Capability
108 //-------------------------------------------------------------------------------------------------
109 
110 
111 //-------------------------------------------------------------------------------------------------
112 //  Macro and Define
113 //-------------------------------------------------------------------------------------------------
114 //Version
115 #define JPD_HAL_VERSION     "JPD.HAL.00117630"
116 
117 // VPU MailBox
118 #define VPU_HI_MBOX0        0
119 #define VPU_HI_MBOX1        1
120 #define VPU_RISC_MBOX0      2
121 #define VPU_RISC_MBOX1      3
122 
123 //#ifndef HAL_MIU1_BASE
124 //#define HAL_MIU1_BASE       0x10000000 // 256M
125 //#endif
126 #define JPD_MIU_ADDR_MASK   (HAL_MIU1_BASE - 1)
127 
128 //-------------------------------------------------------------------------------------------------
129 //  Type and Structure
130 //-------------------------------------------------------------------------------------------------
131 // JPD debug level enum
132 typedef enum
133 {
134     E_JPD_DEBUG_HAL_NONE = 0x0
135   , E_JPD_DEBUG_HAL_MSG  = 0x04
136   , E_JPD_DEBUG_HAL_ERR  = 0x08
137 } JPD_HalDbgLevel;
138 
139 typedef struct
140 {
141     MS_U8* pu8HalVer;
142     MS_U8* pu8FwVer;
143 }JPD_HAL_Version;
144 
145 //-------------------------------------------------------------------------------------------------
146 //  Function and Variable
147 //-------------------------------------------------------------------------------------------------
148 
149 void HAL_JPD_SetMIU(MS_U8 u8Idx);
150 void HAL_JPD_Set_S_Config(MS_U16 u16Value);
151 MS_U16 HAL_JPD_Get_S_Config(void);
152 void HAL_JPD_Set_M_Config(MS_U16 u16Value);
153 MS_U16 HAL_JPD_Get_M_Config(void);
154 void HAL_JPD_SetIntEn(MS_U16 u16Value);
155 void HAL_JPD_SetMRCBufFloorLow(MS_U16 u16Value);
156 void HAL_JPD_SetMRCBufFloorHigh(MS_U16 u16Value);
157 void HAL_JPD_SetMRCBufCeilLow(MS_U16 u16Value);
158 void HAL_JPD_SetMRCBufCeilHigh(MS_U16 u16Value);
159 void HAL_JPD_SetRCSMAddrLow(MS_U16 u16Value);
160 void HAL_JPD_SetRCSMAddrHigh(MS_U16 u16Value);
161 void HAL_JPD_SetMWCBufStAddrLow(MS_U16 u16Value);
162 void HAL_JPD_SetMWCBufStAddrHigh(MS_U16 u16Value);
163 void HAL_JPD_SetPic_H(MS_U16 u16Value);
164 void HAL_JPD_SetPic_V(MS_U16 u16Value);
165 void HAL_JPD_SetEventFlag(MS_U16 u16Value);
166 MS_U16 HAL_JPD_GetEventFlag(void);
167 void HAL_JPD_SetROI_H(MS_U16 u16Value);
168 void HAL_JPD_SetROI_V(MS_U16 u16Value);
169 void HAL_JPD_SetROIWidth(MS_U16 u16Value);
170 void HAL_JPD_SetROIHeight(MS_U16 u16Value);
171 #if 0 // Unused function
172 MS_U16 HAL_JPD_GetCurMadrLow(void);
173 MS_U16 HAL_JPD_GetCurMadrHigh(void);
174 #endif
175 void HAL_JPD_SetClock(MS_U16 u16Value);
176 MS_U16 HAL_JPD_GetClock(void);
177 void HAL_JPD_PowerOn(void);
178 void HAL_JPD_PowerOff(void);
179 void HAL_JPD_InitRegBase(void);
180 void HAL_JPD_CreateMutex(void);
181 void HAL_JPD_DeleteMutex(void);
182 void HAL_JPD_SetRSTIntv(MS_U16 u16Value);
183 MS_U16 HAL_JPD_GetCurVidx(void);
184 void HAL_JPD_Set_TID_Addr(MS_U16 u16Value);
185 void HAL_JPD_Set_TID_Dat(MS_U16 u16Value);
186 MS_U16 HAL_JPD_Get_TID_Dat(void);
187 void HAL_JPD_SetDbgLevel(MS_U8 u8DbgLevel);
188 void HAL_JPD_GetLibVer(JPD_HAL_Version *pHalVer);
189 void HAL_JPD_Rst(void);
190 void HAL_JPD_SetMWBuffLineNum(MS_U16 u16Value);
191 MS_U32 HAL_JPD_GetCurMRCAddr(void);
192 MS_U16 HAL_JPD_GetCurRow(void);
193 MS_U16 HAL_JPD_GetCurCol(void);
194 void HAL_JPD_SetWriteProtect(MS_BOOL enable);
195 void HAL_JPD_SetSpare(MS_U16 u16Value);
196 MS_U16 HAL_JPD_GetSpare(void);
197 
198 #if USE_MJPEG_FUNCTION
199 /*================================ MJPEG =====================================*/
200 void HAL_JPD_StopVPU(void);
201 MS_BOOL HAL_JPD_RstVPU(void);
202 void HAL_JPD_ReleaseVPU(void);
203 MS_BOOL HAL_JPD_IsVPUOnMiu1(void);
204 MS_U32 HAL_JPD_GetMiuBase(void);
205 MS_BOOL HAL_JPD_LoadCode(MS_PHYADDR u32Addr, MS_U32 u32Size, MS_PHYADDR u32BinAddr, MS_U8 u8FwSrcType);
206 void HAL_JPD_ConfigVPU(MS_PHYADDR u32StAddr, MS_U8 u8dlend_en);
207 MS_BOOL HAL_JPD_InitVPU(MS_BOOL bInMIU1);
208 
209 MS_BOOL HAL_JPD_IsVPUMBoxReady(MS_U8 u8MBox);
210 MS_BOOL HAL_JPD_ReadVPUMBox(MS_U8 u8MBox, MS_U32 *u32Msg);
211 MS_BOOL HAL_JPD_SendVPUMBox(MS_U8 u8MBox, MS_U32 u32Msg);
212 MS_BOOL HAL_JPD_ClearVPUMBox(MS_U8 u8MBox, MS_BOOL bFlag);
213 MJPEG_MSTAR_CHIP_ID HAL_JPD_Get_Chip_ID(void);
214 #endif
215 
216 #endif // _HAL_JPD_H_
217 
218