xref: /utopia/UTPA2-700.0.x/modules/graphic/hal/manhattan/ge/halGE.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_GE_H_
96 #define _HAL_GE_H_
97 
98 
99 //-------------------------------------------------------------------------------------------------
100 //  Macro and Define
101 //-------------------------------------------------------------------------------------------------
102 #define bNeedSetActiveCtrlMiu1      TRUE
103 #define GE_THRESHOLD_SETTING        0xDUL
104 #define GE_WordUnit                 32UL
105 #define GE_MAX_MIU                  2UL
106 #define GE_TABLE_REGNUM             0x80UL
107 
108 #define GE_FMT_I1                 0x0UL
109 #define GE_FMT_I2                 0x1UL
110 #define GE_FMT_I4                 0x2UL
111 #define GE_FMT_I8                 0x4UL
112 #define GE_FMT_FaBaFgBg2266       0x6UL
113 #define GE_FMT_1ABFgBg12355       0x7UL
114 #define GE_FMT_RGB565             0x8UL
115 #define GE_FMT_ARGB1555           0x9UL
116 #define GE_FMT_ARGB4444           0xAUL
117 #define GE_FMT_ARGB1555_DST       0xCUL
118 #define GE_FMT_YUV422             0xEUL
119 #define GE_FMT_ARGB8888           0xFUL
120 #define GE_FMT_RGBA5551           0x10UL
121 #define GE_FMT_ABGR1555           0x11UL
122 #define GE_FMT_BGRA5551           0x12UL
123 #define GE_FMT_RGBA4444           0x13UL
124 #define GE_FMT_ABGR4444           0x14UL
125 #define GE_FMT_BGRA4444           0x15UL
126 #define GE_FMT_BGR565             0x16UL
127 #define GE_FMT_RGBA8888           0x1DUL
128 #define GE_FMT_ABGR8888           0x1EUL
129 #define GE_FMT_BGRA8888           0x1FUL
130 #define GE_FMT_GENERIC            0xFFFFUL
131 
132 #if (GE_WordUnit==32)
133 #define GE_VQ_4K                  0x0UL
134 #define GE_VQ_8K                  0x0UL
135 #define GE_VQ_16K                 0x0UL
136 #define GE_VQ_32K                 0x1UL
137 #define GE_VQ_64K                 0x2UL
138 #define GE_VQ_128K                0x3UL
139 #define GE_VQ_256K                0x4UL
140 #define GE_VQ_512K                0x5UL
141 #define GE_VQ_1024K               0x6UL
142 #define GE_VQ_2048K               0x7UL
143 #else
144 #define GE_VQ_4K                  0x0UL
145 #define GE_VQ_8K                  0x0UL
146 #define GE_VQ_16K                 0x1UL
147 #define GE_VQ_32K                 0x2UL
148 #define GE_VQ_64K                 0x3UL
149 #define GE_VQ_128K                0x4UL
150 #define GE_VQ_256K                0x5UL
151 #define GE_VQ_512K                0x6UL
152 #define GE_VQ_1024K               0x7UL
153 #endif
154 
155 #define GE_USE_HW_SEM (0)
156 
157 //Patch
158 #define GE_PITCH_256_ALIGNED_UNDER_4P_MODE 0// For Curry/Kano, pitch must 256 algined under 4P mode
159 #define GE_VQ_MIU_HANG_PATCH      TRUE  //GE VQ need the same MIU as src and dst buffer
160 #define GE_VQADDR_LOCK_PATCH 1 // this is for the miu & riu lock problem
161 #define GE_VQADDR_ENHANCE_LOCK_TIMES 5
162 
163 //-------------------------------------------------------------------------------------------------
164 //  Type and Structure
165 //-------------------------------------------------------------------------------------------------
166 typedef struct _GE_ColorDelta
167 {
168     MS_U32                          r; // s7.12
169     MS_U32                          g;
170     MS_U32                          b;
171     MS_U16                          a; // s4.11
172 } GE_ColorDelta;
173 
174 /*the following is for parameters for shared between multiple process context*/
175 typedef struct __attribute__((packed))
176 {
177    MS_BOOL bGE_DirectToReg;
178    MS_U16 global_tagID;
179    MS_U16 u16ShareRegImage[GE_TABLE_REGNUM];
180    MS_U16 u16ShareRegImageEx[GE_TABLE_REGNUM];
181 #ifdef GE_VQ_MIU_HANG_PATCH
182    MS_U8  u8VCmdQMiu;
183 #endif
184 }GE_CTX_HAL_SHARED;
185 
186 /*the following is for parameters for used in local process context*/
187 typedef struct
188 {
189    GE_CTX_HAL_SHARED *pHALShared;
190    GE_CHIP_PROPERTY  *pGeChipPro;
191    MS_VIRT           va_mmio_base;
192    MS_VIRT           va_mmio_base2;
193    MS_U16            u16RegGETable[GE_TABLE_REGNUM];                 //Store for GE RegInfo
194    MS_U16            u16RegGETableEX[GE_TABLE_REGNUM];                 //Store for GE RegInfo
195    MS_BOOL           bIsComp;
196    MS_BOOL           bPaletteDirty;
197    MS_U32            u32Palette[GE_PALETTE_NUM];
198    MS_BOOL           bYScalingPatch;
199 }GE_CTX_HAL_LOCAL;
200 
201 //-------------------------------------------------------------------------------------------------
202 //  Function and Variable
203 //-------------------------------------------------------------------------------------------------
204 void        GE_Chip_Proprity_Init(GE_CTX_HAL_LOCAL *pGEHalLocal);
205 void        GE_ResetState(GE_CTX_HAL_LOCAL *pGEHalLocal);
206 void        GE_WaitIdle(GE_CTX_HAL_LOCAL *pGEHalLocal);
207 GE_Result   GE_Map_Share_Reg(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_U16 addr);
208 void        GE_WriteReg(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_U16 addr, MS_U16 value);
209 MS_U16      GE_ReadReg(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_U16 addr);
210 void        GE2_WriteReg(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_U16 addr, MS_U16 value);
211 MS_U16      GE2_ReadReg(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_U16 addr);
212 GE_Result   GE_InitCtxHalPalette(GE_CTX_HAL_LOCAL *pGEHalLocal);
213 void        GE_Init_HAL_Context(GE_CTX_HAL_LOCAL *pGEHalLocal, GE_CTX_HAL_SHARED *pHALShared, MS_BOOL bNeedInitShared);
214 void        GE_Init_RegImage(GE_CTX_HAL_LOCAL *pGEHalLocal);
215 void        GE_Init(GE_CTX_HAL_LOCAL *pGEHalLocal, GE_Config *cfg);
216 GE_Result   GE_SetRotate(GE_CTX_HAL_LOCAL *pGEHalLocal, GE_RotateAngle geRotAngle);
217 GE_Result   GE_SetOnePixelMode(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_BOOL enable);
218 GE_Result   GE_SetBlend(GE_CTX_HAL_LOCAL *pGEHalLocal, GE_BlendOp eBlendOp);
219 GE_Result   GE_SetAlpha(GE_CTX_HAL_LOCAL *pGEHalLocal, GE_AlphaSrc eAlphaSrc);
220 GE_Result   GE_QueryDFBBldCaps(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_U16 *pU16SupportedBldFlags);
221 GE_Result   GE_EnableDFBBld(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_BOOL enable);
222 GE_Result   GE_SetDFBBldFlags(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_U16 u16DFBBldFlags);
223 GE_Result   GE_SetDFBBldOP(GE_CTX_HAL_LOCAL *pGEHalLocal, GE_DFBBldOP geSrcBldOP, GE_DFBBldOP geDstBldOP);
224 GE_Result   GE_SetDFBBldConstColor(GE_CTX_HAL_LOCAL *pGEHalLocal, GE_RgbColor geRgbColor);
225 GE_Result   GE_SetDFBBldSrcColorMask(GE_CTX_HAL_LOCAL *pGEHalLocal, GE_RgbColor geRgbColor);
226 GE_Result   GE_WriteProtect(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_U8 miu, MS_PHY addr_low, MS_PHY addr_high, GE_WPType eWPType);
227 GE_Result   GE_SetSrcTile(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_BOOL tile);
228 GE_Result   GE_SetDstTile(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_BOOL tile);
229 GE_Result   GE_GetFmtCaps(GE_CTX_HAL_LOCAL *pGEHalLocal, GE_BufFmt fmt, GE_BufType type, GE_FmtCaps *caps);
230 GE_Result   GE_Set_IOMap_Base(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_VIRT addr);
231 GE_Result   GE_Set_IOMap_Base2(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_VIRT addr);
232 //GE_Result   GE_Get_BackupRegArray(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_U32* addr);
233 //void           GE_RestoreReg(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_U16 addr, MS_U16 value);
234 //MS_U16      GE_BackupReg(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_U16 addr);
235 MS_U16      GE_GetNextTAGID(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_BOOL bStepTagBefore);
236 GE_Result   GE_WaitTAGID(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_U16 tagID);
237 GE_Result   GE_Restore_HAL_Context(GE_CTX_HAL_LOCAL *pGEHalLocal);
238 GE_Result   GE_ClrInvalMIUFlg(GE_CTX_HAL_LOCAL *pGEHalLocal,MS_BOOL enable);
239 GE_Result   GE_EnableDynaClkGate(GE_CTX_HAL_LOCAL *pGEHalLocal,MS_BOOL enable);
240 GE_Result   GE_CalcBltScaleRatio(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_U16 u16SrcWidth, MS_U16 u16SrcHeight, MS_U16 u16DstWidth, MS_U16 u16DstHeight, GE_ScaleInfo *pScaleinfo);
241 GE_Result   GE_SetBltScaleRatio(GE_CTX_HAL_LOCAL *pGEHalLocal,GE_Rect *src, GE_DstBitBltType *dst, GE_Flag flags, GE_ScaleInfo* scaleinfo);
242 GE_Result   GE_BitBltEX_Trape(GE_CTX_HAL_LOCAL *pGEHalLocal, GE_Rect *pSrcRect, GE_Normalized_Trapezoid *pGENormTrapezoid, MS_U32 u32Flags, GE_ScaleInfo* pScaleinfo);
243 GE_Result   GE_FillTrapezoid(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_BOOL bYTrapezoid, GE_Normalized_Trapezoid *pGENormTrapezoid, MS_U32 u32Color, GE_ColorDelta *pColorDeltaX, GE_ColorDelta *pColorDeltaY);
244 GE_Result   GE_EnableTrapezoidAA(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_BOOL bEnable);
245 GE_Result   GE_EnableTrapSubPixCorr(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_BOOL bEnable);
246 GE_Result   GE_SetDisaMIUAccess(GE_CTX_HAL_LOCAL *pGEHalLocal,MS_BOOL enable);
247 GE_Result   GE_SetASCK(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_BOOL enable);
248 GE_Result   GE_SetDSCK(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_BOOL enable);
249 GE_Result   GE_SetVCmdBuffer(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_PHY PhyAddr, GE_VcmqBufSize enBufSize);
250 MS_PHY    GE_ConvertAPIAddr2HAL(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_U8 u8MIUId, MS_PHY PhyGE_APIAddrInMIU);
251 MS_PHY    GE_ConvertHALAddr2API(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_U8 u8MIUId, MS_PHY PhyGE_HALAddr);
252 void        GE_SetActiveCtrlMiu1(GE_CTX_HAL_LOCAL *pGEHalLocal);
253 GE_Result   GE_SetClock(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_BOOL bOnOff);
254 MS_BOOL     GE_NonOnePixelModeCaps(GE_CTX_HAL_LOCAL *pGEHalLocal, PatchBitBltInfo* patchInfo);
255 GE_Result   HAL_GE_EnableCalcSrc_WidthHeight(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_BOOL bEnable);
256 GE_Result   GEWD_ReadReg(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_U16 addr, MS_U16* value);
257 GE_Result   GEWD_WriteReg(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_U16 addr, MS_U16 value);
258 GE_Result   GE_SetTLBMode(GE_CTX_HAL_LOCAL *pGEHalLocal, GE_TLB_Mode tlb_type);
259 GE_Result   GE_GetTLBSRCADDR(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_PHY* addr);
260 GE_Result   GE_GetTLBDSTADDR(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_PHY* addr);
261 GE_Result   GE_SetTLBSrcBaseAddr(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_PHY addr);
262 GE_Result   GE_SetTLBDstBaseAddr(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_PHY addr);
263 GE_Result   GE_FlushTLBTable(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_BOOL bEnable);
264 GE_Result   GE_SetTLBTag(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_U16 tag);
265 GE_Result   GE_StopFlushTLB(GE_CTX_HAL_LOCAL *pGEHalLocal);
266 GE_Result   GE_Get_MIU_INTERVAL(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_U8 miu, MS_PHY* value);
267 GE_Result   HAL_GE_AdjustDstWin( GE_CTX_HAL_LOCAL *pGEHalLocal, MS_BOOL bDstXInv );
268 GE_Result   HAL_GE_AdjustRotateDstWin(GE_CTX_HAL_LOCAL *pGEHalLocal, MS_U8 u8Rotate);
269 GE_Result   HAL_GE_SetBurstMiuLen(GE_CTX_HAL_LOCAL *pGEHalLocal,MS_BOOL bEnable,MS_U32 u32BurstLen);
270 
271 
272 #define      GE_SetSrcBufMIUId(pGEHalLocal, u8MIUId)  do{}while(0)
273 #define      GE_SetDstBufMIUId(pGEHalLocal, u8MIUId)  do{}while(0)
274 #define      GE_SetVQBufMIUId(pGEHalLocal, u8MIUId)  do{}while(0)
275 #define      GE_GetSrcBufMIUId(pGEHalLocal, u32GE_HALAddr)     ((MS_U8)(((u32GE_HALAddr)&(1UL<<31))>>31))
276 #define      GE_GetDstBufMIUId(pGEHalLocal, u32GE_HALAddr)     ((MS_U8)(((u32GE_HALAddr)&(1UL<<31))>>31))
277 #endif // _HAL_GE_H_
278 
279