xref: /utopia/UTPA2-700.0.x/modules/graphic/api/gfx/apiGFX_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 #ifndef _APIGOP_PRIV_H_
95 #define _APIGOP_PRIV_H_
96 
97 ////////////////////////////////////////////////////////////////////////////////
98 /// @file drvBDMA.h
99 /// @author MStar Semiconductor Inc.
100 /// @brief Byte DMA control driver
101 ////////////////////////////////////////////////////////////////////////////////
102 
103 ////////////////////////////////////////////////////////////////////////////////
104 // Header Files
105 ////////////////////////////////////////////////////////////////////////////////
106 #ifdef __cplusplus
107 extern "C"
108 {
109 #endif
110 
111 //Local define
112 #define PATCH_T3_SCK_FAIL 1 //[2009.07.02]T3/U3 GE HW issue:set source alpha is max for filtering the background color
113 
114 #define GFX_DEBUGINFO_LEVEL(a, x)           if (g_apiGFXLocal.u32dbglvl <= a) {MS_DEBUG_MSG(x);}
115 #define GFX_DBG_HDR     "[GFXDBG]"
116 
117 #define GFX_DEBUGINFO(x)                    //MS_DEBUG_MSG(x)
118 
119 #undef GFX_ASSERT
120 #ifdef GFX_DEBUG
121 #define GFX_ASSERT(_bool, _f)                 if (!(_bool)) { MS_CRITICAL_MSG(_f); while (1); }
122 #else
123 #define GFX_ASSERT(_bool, _f)                 while (0)
124 #endif // #ifdef SCL_DEBUG
125 
126 #include "ULog.h"
127 
128 // Debug Logs, level form low(INFO) to high(FATAL, always show)
129 // Function information, ex function entry
130 #define GFX_INFO(x, args...) ULOGI("GE API", x, ##args)
131 // Warning, illegal paramter but can be self fixed in functions
132 #define GFX_WARN(x, args...) ULOGW("GE API", x, ##args)
133 //  Need debug, illegal paramter.
134 #define GFX_DBUG(x, args...) ULOGD("GE API", x, ##args)
135 // Error, function will be terminated but system not crash
136 #define GFX_ERR(x, args...) ULOGE("GE API", x, ##args)
137 // Critical, system crash. (ex. assert)
138 #define GFX_FATAL(x, args...) ULOGF("GE API", x, ##args)
139 
140 typedef struct
141 {
142     GFX_Set_Colorkey*           pColorKey;              //////////ColorKey
143     GFX_Set_ROP*                pROP;                   //////////ROP
144 }GFX_Function;
145 
146 typedef struct _GFX_SetConfig
147 {
148     MS_BOOL                     bOnePixelMode;          //////////OnePixelMode
149     MS_BOOL                     bDither;                //////////Dither
150     MS_BOOL                     bVQEnable;              //////////Virual Cmd Queue
151     MS_BOOL                     bABLEnable;             //////////Alpha Blending Enable
152     GFX_RotateAngle             eRotate;                //////////Rotate
153     GFX_Set_Mirror*             pMirror;                //////////Mirror
154     MS_U32                      u32TagID;               //////////TagID
155     GFX_Set_Clip_Property*      pClip;                  //////////Clip
156 }GFX_SetConfig;
157 #ifndef MSOS_TYPE_OPTEE
158 typedef struct
159 {
160     GFX_FireInfo*               pFireInfo;
161     GFX_OvalFillInfo*           pDrawOvalInfo;
162 }GFX_Set_DrawOvalInfo;
163 
164 typedef struct
165 {
166     GFX_FireInfo*               pFireInfo;
167     MS_S32                      fHandle;
168     MS_U8                       charArray[256];
169     MS_U32                      u32StrWidth;
170     GFX_TextOutInfo*            pTextInfo;
171     GFX_FontInfo *              pFonttable;
172 }GFX_TextOut_V2;
173 #endif
174 
175 void            GFXRegisterToUtopia                 (FUtopiaOpen ModuleType);
176 MS_U32          GFXOpen                             (void** ppInstance, const void* const pAttribute);
177 MS_U32          GFXClose                            (void* pInstance);
178 MS_U32          GFXIoctl                            (void* pInstance, MS_U32 u32Cmd, void* pArgs);
179 #ifdef CONFIG_UTOPIA_PROC_DBG_SUPPORT
180 MS_U32          GFXMdbIoctl                         (MS_U32 u32Cmd, const void* const pArgs);
181 #endif
182 
183 #ifdef __cplusplus
184 }
185 #endif
186 #endif
187