xref: /utopia/UTPA2-700.0.x/modules/graphic/drv/ge/drvGE_private.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   drvGE.h
98 /// @brief  GE Driver Interface
99 /// @author MStar Semiconductor Inc.
100 ///////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _DRV_PRI_GE_H_
103 #define _DRV_PRI_GE_H_
104 
105 #ifdef __cplusplus
106 extern "C"
107 {
108 #endif
109 
110 typedef struct
111 {
112     GE_BlendOp                  eBldCoef;
113     GE_AlphaSrc                 eABLSrc;
114     MS_U32                      u32ABLConstCoef;
115 }GE_ABLINFO;
116 
117 typedef struct
118 {
119     MS_U8  u8X0;       ///< Position of the left edge of the bounding box
120     MS_U8  u8Width;    ///< Width of the bounding box
121     MS_U8  u8Y0;       ///< Position of the top edge of the bounding box
122     MS_U8  u8Height;   ///< Height of the bounding box
123 } GE_GlyphBbox;
124 
125 typedef struct
126 {
127     MS_PHY addr;       // flat address of whole memory map
128     MS_U32 len;
129     MS_BOOL inUsed;
130     MS_U32 width;
131     MS_U32 pitch;
132     MS_U32 height;
133     GE_BufFmt fmt;
134 } GE_BitmapInfo;
135 
136 typedef struct
137 {
138     /// font start address
139     MS_PHY addr;
140     /// font length
141     MS_U32 len;
142     /// font structure is used
143     MS_BOOL inUsed;
144     /// character width (pixel unit)
145     MS_U32 width;
146     /// character pitch (byte unit)
147     MS_U32 pitch;
148     /// character height (pixel unit)
149     MS_U32 height;
150     /// one character length (byte unit)
151     MS_U32 offset;
152     /// Bounding Box offset
153     GE_GlyphBbox* pBBox;
154     /// font format
155     GE_BufFmt fmt;
156 } GE_FontInfo;
157 
158 typedef struct __attribute__((packed))
159 {
160     GE_CTX_HAL_SHARED           halSharedCtx;
161     MS_U32                      u32GEClientAllocator;
162     MS_U32                      u32LstGEClientId;//for indicating context switch
163     MS_U32                      u32LstGEPaletteClientId;
164     MS_BOOL                     bNotFirstInit;
165     MS_U32                      u32HWSemaphoreCnt;
166     MS_U32                      u32VCmdQSize;                       /// MIN:4K, MAX:512K, <MIN:Disable
167     MS_PHY                      PhyVCmdQAddr;                       //  8-byte aligned
168     MS_BOOL                     bIsHK;                              /// Running as HK or Co-processor
169     MS_BOOL                     bIsCompt;                           /// Running as compatible mode. In compatible mode, the parameter checking loose for NOS APP compatibility.  TRUE=>compatible with 51/Chakra , FALSE=>linux OS style
170     MS_BOOL                     bInit;
171 
172 }GE_CTX_SHARED;
173 
174 typedef struct
175 {
176     GE_Context                  ctxHeader;
177     GE_CTX_SHARED*              pSharedCtx;//pointer to shared context paramemetrs
178     GE_CTX_HAL_LOCAL            halLocalCtx;
179     MS_U16                      u16ClipL;
180     MS_U16                      u16ClipR;
181     MS_U16                      u16ClipT;
182     MS_U16                      u16ClipB;
183 #if GE_LOCK_SUPPORT
184     MS_S32                      s32GEMutex;
185     MS_S32                      s32GELock;
186 #endif
187     MS_S32                      s32GE_Recursive_Lock_Cnt; //recursive lock number when bGELock is off
188     MS_U32                      u32GEClientId;
189     MS_U32                      u32GESEMID;
190     MS_U16                      u16GEPrevSEMID; //backup previous Sem ID for palette restore.
191     MS_BOOL                     bIsComp;
192     MS_U32                      u32CTXInitMagic;
193     MS_BOOL                     bSrcPaletteOn;
194     MS_BOOL                     bDstPaletteOn;
195     MS_PHY                    PhySrcAddr;
196     MS_PHY                    PhyDstAddr;
197     MS_PHY                      PhyVcmdqAddr;
198     MS_U16                      u16VcmdqMiuMsb;
199     MS_U16                      u16VcmdqSize;
200 }GE_CTX_LOCAL;
201 
202 
203 typedef struct
204 {
205     MS_U32                  u32dbglvl;
206     void                    (*fpGetBMP)(MS_S16, GE_BitmapInfo*);
207     void                    (*fpGetFont)(MS_S8, GE_FontInfo*);
208    // GFX_BlendCoef           _blendcoef;
209     MS_U8                   _angle;
210     MS_BOOL                 _bNearest;
211     MS_BOOL                 _bPatchMode;
212     MS_BOOL                 _bMirrorH;
213     MS_BOOL                 _bMirrorV;
214     MS_BOOL                 _bDstMirrorH;
215     MS_BOOL                 _bDstMirrorV;
216     MS_BOOL                 _bItalic;
217     MS_BOOL                 _line_enable;
218     MS_U8                   _line_pattern;
219     MS_U8                   _line_factor;
220     MS_BOOL                 bDither;
221 
222 #ifdef DBGLOG
223     //debug use only
224     MS_BOOL _bOutFileLog;
225     MS_U16  *_pu16OutLogAddr;
226     MS_U16  _u16LogCount;
227 #endif
228     GE_Context*             g_pGEContext ;
229     GE_CHIP_PROPERTY *      pGeChipProperty;
230     GE_ABLINFO              pABLInfo;
231     MS_U32                  u32LockStatus;
232     MS_BOOL                 _bInit;
233     MS_U32                  u32geRgbColor;
234 } GFX_API_LOCAL;
235 
236 
237 typedef struct _GFX_Resource_PRIVATE
238 {
239 
240 }GFX_Resource_PRIVATE;
241 
242 typedef struct _GFX_INSTANT_PRIVATE
243 {
244     /*Resource*/
245     GFX_Resource_PRIVATE*       pResource;
246 
247     GFX_API_LOCAL               GFXPrivate_g_apiGFXLocal;
248     GE_CTX_LOCAL                GFXPrivate_g_drvGECtxLocal;
249 
250     //GFX_BitBltInfo*             pGFXBufferInfo;
251     //GFX_Function*               pGFXFunction;
252     //GFX_SetConfig*              pGFXSetConfig;
253 }GFX_INSTANT_PRIVATE;
254 
255 // Debug Log
256 #include "ULog.h"
257 
258 // Debug Logs, level form low(INFO) to high(FATAL, always show)
259 // Function information, ex function entry
260 #define GE_D_INFO(x, args...) ULOGI("GE DRV", x, ##args)
261 // Warning, illegal paramter but can be self fixed in functions
262 #define GE_D_WARN(x, args...) ULOGW("GE DRV", x, ##args)
263 //  Need debug, illegal paramter.
264 #define GE_D_DBUG(x, args...) ULOGD("GE DRV", x, ##args)
265 // Error, function will be terminated but system not crash
266 #define GE_D_ERR(x, args...) ULOGE("GE DRV", x, ##args)
267 // Critical, system crash. (ex. assert)
268 #define GE_D_FATAL(x, args...) ULOGF("GE DRV", x, ##args)
269 
270 #ifdef __cplusplus
271 }
272 #endif
273 
274 #endif
275 
276