xref: /utopia/UTPA2-700.0.x/modules/mfe/hal/mustang/mfe_ex/mhal_mfe.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) 2007-2008 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 _MHAL_MFE_H_
96 #define _MHAL_MFE_H_
97 
98 #if defined(_MFE_UTOPIA_)
99 #include <stdio.h>
100 #endif
101 
102 #include "MFE_chip.h"
103 #include "drv_mfe_st.h"
104 #if defined(_MIPS_PLATFORM_)
105 #if defined(_MFE_BIG2_)
106 #include <sys/bsdtypes.h>
107 #include "shellcfg.h"   //for diag_printf
108 #elif defined(_KERNEL_MODE_)&&defined(_MFE_T8_)
109 #include "mdrv_types.h"
110 #elif defined(__MOBILE_CASE__)
111 #include "msutil/MsTypes.h"
112 #else
113 #include "MsTypes.h"
114 #endif
115 #endif
116 
117 #include "mfe_type.h"
118 #include "mfe_common.h"
119 
120 #ifdef _MFE_BIG2_
121 #define MIU_SHIFT     2//3
122 #define MIU_SIZE     4//8
123 #else
124 #define MIU_SHIFT     3
125 #define MIU_SIZE     8
126 #endif
127 
128 #if defined(_AEON_PLATFORM_) && defined(_MFE_T8_)
129 	extern U32 RIU_BASE;// = 0xA0000000;
130 	#define REG_BANK_MFE    0x111000
131 	#define __MFE_REG(reg)		(*(volatile U16 *) ( RIU_BASE + (REG_BANK_MFE + reg*2)*2) )
132 #elif defined(__MFE_G2__)
133 	#define T8_RIU_BASE u32MFERegOSBase // = 0x25000000; G2 RIU base.
134 	#define REG_BANK_MFE  0x400
135 	#define __MFE_REG(reg) (*(volatile MFE_U32 *) (void*)( T8_RIU_BASE + (reg)*4 ) )
136 #elif defined(_AEON_PLATFORM_)
137 	extern U32 RIU_BASE;// = 0xA0000000;
138 	#define REG_BANK_MFE    0x1200
139 	#define __MFE_REG(reg)		(*(volatile U16 *) ( RIU_BASE + (REG_BANK_MFE + reg)*4) )
140 //extern U8 FSwrite_ready;
141 #elif defined(_MFE_BIG2_) && defined(_MIPS_PLATFORM_)
142 	extern U32 RIU_BASE;// = 0xBF834000;
143 	#define REG_BANK_MFE    0
144 	#define __MFE_REG(reg)        (*(volatile U16 *) ( RIU_BASE + REG_BANK_MFE + (reg)*4) )
145 #elif defined(_MFE_T8_) && defined(_MIPS_PLATFORM_)&&defined(_KERNEL_MODE_)
146 	extern MFE_U32 RIU_BASE;// = 0xBF200000; //CH4
147 	#define REG_BANK_MFE    0x8800
148 	#define __MFE_REG(reg)		(*(volatile MFE_U16 *) ( RIU_BASE + (REG_BANK_MFE + reg) * 4 ) )
149 #elif defined(_MFE_T8_) && defined(_MIPS_PLATFORM_)&& defined(_MFE_UTOPIA_)
150 	#define T8_RIU_BASE u32MFERegOSBase // = 0xBF200000; //CH4
151 #ifdef _MFE_KAISER_
152 	#define REG_BANK_MFE    0x11380
153 #else
154     #define REG_BANK_MFE    0x8800
155 #endif
156 	#define __MFE_REG(reg)		(*(volatile MFE_U16 *) ( T8_RIU_BASE + (REG_BANK_MFE + reg) * 4 ) )
157     #define REG_BANK_MFE1    0x8880
158     #define __MFE_REG1(reg)		(*(volatile MFE_U16 *) ( T8_RIU_BASE + (REG_BANK_MFE1 + reg) * 4 ) )
159 #else //if defined(_WIN32)//defined(_BCB_PLATFORM_)
160     #define T8_RIU_BASE 0x0a80 // = 0xBF200000; //CH4
161 	#define REG_BANK_MFE 0x0a80 //Local FPGA
162 	#define REG_BANK_MFE1 0x0b80 //Local FPGA
163     //#define T8_RIU_BASE 0x0b80 // = 0xBF200000; //CH4
164 	//#define REG_BANK_MFE 0x0b80 //Local FPGA
165 	//#define REG_BANK_MFE1 0x01080 //Local FPGA
166 #endif
167 
168 MS_BOOL MHal_MFE_GetHWCap(MS_U16 *width, MS_U16 *height);
169 
170 #if (defined(_MFE_T8_)||defined(_MFE_M1_)) && defined(_MIPS_PLATFORM_)&& !defined(_KERNEL_MODE_)
171 void MHAL_MFE_InitRegBase(MFE_U32 u32RegBase);
172 void MHAL_MFE_CreateRegMap(MFE_REG* mfe_reg, MFE_REG1* mfe_reg1);
173 void MHAL_MFE_DelRegMap(MFE_REG* mfe_reg, MFE_REG1* mfe_reg1);
174 #endif
175 void MHal_MFE_PowerOff(MFE_U32 is_off,MFE_CLK_LEVEL clock_level);
176 MFE_U32 MHal_MFE_GetBitstreamEncodedLen(void);
177 void MHal_MFE_set_outbitsbuf(MFE_REG* mfe_reg, OutBitSBUF *bitsbuf,int outbufsize);
178 void MHal_MFE_SetIrqMask(MFE_U16 mask);
179 
180 #ifdef MFE_MIU_PROTECT
181 void MHal_MFE_Enable_MIU_Protection(int MIU_TEST_MODE,MFE_CONFIG* pConfig);
182 void MHal_MFE_Enable_MIU_Protection_Check(int MIU_TEST_MODE,int TYPE);
183 #endif
184 MFE_U32 MHal_MFE_CycleReport(void);
185 void MHal_MFE_ClearIRQ(MFE_U16 irq_bits);
186 void MHal_MFE_GetIRQ(MFE_U16 *irq_bits);
187 void MHal_MFE_SWReset(MFE_REG* mfe_reg);
188 void MHal_MFE_start(void);
189 void MHal_MFE_SetCLKCTL(MFE_REG* mfe_reg);
190 void MHal_MFE_ResetReg(MFE_REG* mfe_reg);
191 void MHal_MFE_GetCRC(MFE_U8 checksum_HW[8]);
192 #endif//_MHAL_MFE_H_
193 
194