xref: /utopia/UTPA2-700.0.x/modules/graphic/drv/gop/drvGFLIP.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 /// @file   drvGFLIP.h
97 /// @brief  MStar gflip Interface header file
98 /// @author MStar Semiconductor Inc.
99 /// @attention
100 /// <b><em></em></b>
101 ///////////////////////////////////////////////////////////////////////////////////////////////////
102 
103 #ifndef _MDRV_GFLIP_H
104 #define _MDRV_GFLIP_H
105 
106 #ifdef _MDRV_GFLIP_C
107 #define INTERFACE
108 #else
109 #define INTERFACE extern
110 #endif
111 
112 #if defined(__cplusplus)
113 extern "C" {
114 #endif
115 #include "drvGOP.h"
116 #include "halGOP.h"
117 #include "mdrv_gflip_st.h"
118 
119 
120 #define MAX_GOP_GWIN             MAX_GOP0_GWIN
121 #define MAX_FLIP_ADDR_FIFO      (0x10UL)
122 
123 //=============================================================================
124 // Defines & Macros
125 //=============================================================================
126 
127 //=============================================================================
128 // Type and Structure Declaration
129 //=============================================================================
130 typedef struct DLL_PACKED
131 {
132     MS_PHY u64Addr; //in
133     MS_U32 u32TagId; //in
134 }GFLIP_INFO, *PGFLIP_INFO;
135 
136 typedef struct __attribute__((packed))
137 {
138   MS_GOP_CTX_SHARED apiCtxShared;
139   GOP_CTX_HAL_SHARED halCtxShared;
140 }GOP_CTX_DRV_SHARED;
141 typedef struct DLL_PACKED
142 {
143     MS_GOP_CTX_LOCAL  apiCtxLocal;
144     GOP_CTX_DRV_SHARED *pDrvCtxShared;//pointer to shared context paramemetrs
145     GOP_CTX_HAL_LOCAL    halCtxLocal;
146     MS_U8 *pu8REGMAP_Base[MAX_GOP_SUPPORT];
147     MS_U16 u16REGMAP_Offset[MAX_GOP_SUPPORT];
148     MS_U32 u32REGMAP_Len[MAX_GOP_SUPPORT];
149     //GFLIP parameters
150     MS_BOOL bEnableVsyncIntFlip[MAX_GOP_SUPPORT];
151 #ifdef MSOS_TYPE_LINUX
152     MS_S32 s32FdGFlip;
153 #elif defined(MSOS_TYPE_LINUX_KERNEL)
154 #else
155     GFLIP_INFO GFlipInfo[MAX_GOP_SUPPORT][MAX_GOP_GWIN][MAX_FLIP_ADDR_FIFO];
156     MS_U32 u32GFlipInfoReadPtr[MAX_GOP_SUPPORT][MAX_GOP_GWIN];
157     MS_U32 u32GFlipInfoWritePtr[MAX_GOP_SUPPORT][MAX_GOP_GWIN];
158     MS_U16 u16GOPRefCnt[MAX_GOP_SUPPORT];
159     MS_BOOL bGFlipInVsyncLimitation[MAX_GOP_SUPPORT];
160     GFLIP_DWININT_INFO gflipDWinIntInfo;
161 #endif
162     MS_BOOL gop_gwin_frwr;
163     MS_BOOL gop_dwin_frwr;
164     MS_BOOL bGOPBankFwr[SHARED_GOP_MAX_COUNT];
165     MS_BOOL b16BPPTileMode[SHARED_GOP_MAX_COUNT];
166     MS_BOOL b32BPPTileMode[SHARED_GOP_MAX_COUNT];
167 
168     MS_U8 current_gop;
169 }GOP_CTX_DRV_LOCAL;
170 
171 //=============================================================================
172 // Function
173 //=============================================================================
174 
175 //Init related:
176 INTERFACE MS_BOOL MDrv_GFLIP_Init(MS_GOP_CTX_LOCAL *pGOPCtx, MS_U32 u32GopIdx, MS_BOOL bEnableVsyncIntFlip);
177 INTERFACE MS_BOOL MDrv_GFLIP_DeInit(MS_GOP_CTX_LOCAL *pGOPCtx, MS_U32 u32GopIdx);
178 
179 //Drv Interface related(drv interface):
180 INTERFACE MS_BOOL MDrv_GFLIP_SetMultiFlipInfo(MS_GOP_CTX_LOCAL*pGOPCtx,MS_GFLIP_MULTIINFO* pMultiinfo);
181 INTERFACE MS_BOOL MDrv_GFLIP_SetTLBMultiFlipInfo(MS_GOP_CTX_LOCAL*pGOPCtx,MS_TLB_GFLIP_MULTIINFO* pTLBMultiinfo);
182 INTERFACE MS_BOOL MDrv_GFLIP_SetFlipInfo(MS_GOP_CTX_LOCAL *pGOPCtx, MS_U32 u32GopIdx, MS_U32 u32GwinIdx, MS_PHY u64MainAddress, MS_PHY u64SubAddress, MS_U32 u32TagId, MS_U32 * u32QEntry);
183 INTERFACE MS_BOOL MDrv_GFLIP_SetGwinInfo(MS_GOP_CTX_LOCAL*pGOPCtx, MS_U8 u8GopIdx, MS_U8 u8GwinIdx,DRV_GOP_GWIN_INFO* pinfo);
184 INTERFACE MS_BOOL MDrv_GFLIP_RestoreFromVsyncLimitation(MS_GOP_CTX_LOCAL *pGOPCtx);
185 INTERFACE MS_BOOL MDrv_GFLIP_GetDWinIntInfo(MS_GOP_CTX_LOCAL *pGOPCtx, GFLIP_DWININT_INFO *pGFlipDWinIntInfo, MS_U32 u32Timeout);
186 INTERFACE MS_BOOL MDrv_GFLIP_GetVECaptureState(MS_GOP_CTX_LOCAL *pGOPCtx, PMS_DRVGOP_VECAPTURESTATE pstVECapState);
187 INTERFACE MS_BOOL MDrv_GFLIP_VECaptureWaitOnFrame(MS_GOP_CTX_LOCAL *pGOPCtx, PMS_DRVGOP_VECAPTURESTATE pstVECapState);
188 INTERFACE MS_BOOL MDrv_GFLIP_EnaVECapture(MS_GOP_CTX_LOCAL *pGOPCtx, PMS_DRVGOP_VECAPTURESTATE pstVECapState);
189 INTERFACE MS_BOOL MDrv_GFLIP_ClearFlipQueue(MS_GOP_CTX_LOCAL *pGOPCtx, MS_U32 u32GopIdx, MS_U32 u32GwinIdx);
190 INTERFACE MS_BOOL MDrv_GFLIP_SetGPIO3DPin(MS_GOP_CTX_LOCAL*pGOPCtx, MS_U32 u32GPIO3DPin);
191 
192 #if defined(__cplusplus)
193 }
194 #endif
195 
196 #undef INTERFACE
197 
198 #endif //_MDRV_GFLIP_H
199 
200