xref: /utopia/UTPA2-700.0.x/modules/dms/hal/k6/dms/include/halDMS.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   halDMS.h
98 /// @brief  DMS HAL Interface
99 /// @author MStar Semiconductor Inc.
100 ///////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _HAL_DMS_H_
103 #define _HAL_DMS_H_
104 #include "UFO.h"
105 #ifdef __cplusplus
106 extern "C" {
107 #endif
108 
109 //-------------------------------------------------------------------------------------------------
110 //  Driver Capability
111 //-------------------------------------------------------------------------------------------------
112 
113 //-------------------------------------------------------------------------------------------------
114 //  Macro and Define
115 //-------------------------------------------------------------------------------------------------
116 
117 //-------------------------------------------------------------------------------------------------
118 //  Type and Structure
119 //-------------------------------------------------------------------------------------------------
120 #include "apiDMS_Type.h"
121 #include "apiXC.h"
122 //-------------------------------------------------------------------------------------------------
123 //  Function and Variable
124 //-------------------------------------------------------------------------------------------------
125 #if defined(HAL_DMS_C)
126 #define DMS_HAL_INTERFACE
127 #else
128 #define DMS_HAL_INTERFACE extern
129 #endif
130 
131 #define DMS_HAL_DIP_Align           16
132 #define DMS_HAL_DIPR_Align_YUV420   32
133 #define DMS_DIP_Support_HVSP 1
134 #define DMS_DIP_Support_DI   0
135 #define DMS_DIP_Support_3DDI 1
136 #define DMS_DIP_NWindow_Support_2P5DDI 0
137 #define DMS_DIP_Support_IMI 0
138 
139 #define DMS_DIPWindow_NORMAL 0
140 #define DMS_DIPWindow_CAPTURE 1
141 
142 #define DMS_MFDEC_CAPTURE 2
143 #define DMS_MFDEC_NORMAL 1
144 
145 // DMS_MAIN_WINDOW_FLOW_VERSION
146 // 0: MAIN_WINDOW_FLOW : don't need mainQ, diQ, DI by XC
147 // 1: MAIN_WINDOW_FLOW : need mainQ, diQ, DI by DIP
148 #define DMS_MAIN_WINDOW_FLOW_VERSION 0
149 #define SKIP_DMS_MAIN_WINDOW_FLOW(windowId) if((DMS_MAIN_WINDOW_FLOW_VERSION == 0) && (windowId == MVOP_WINDOW))    \
150                                             {                                \
151                                                 continue;                    \
152                                             }
153 #define DMS_DONT_USE_CMA 0
154 //All Hard code Register
155 #define REG_SC_BK12_0F_L (0x1200|(0x0F<<1))
156 #define REG_SC_BK12_17_L (0x1200|(0x17<<1))
157 #define REG_SC_BK36_03_L (0x3600|(0x03<<1))
158 
159 typedef enum
160 {
161     DS_IP,
162     DS_OP,
163 } DMS_ds_reg_ip_op_sel;
164 
165 typedef enum
166 {
167     DMS_DS_XC,
168     DMS_DS_MVOP,
169 } DMS_ds_reg_source_sel;
170 
171 typedef struct
172 {
173     MS_U16 u16CMDCNT_IPM;
174     MS_U16 u16CMDCNT_IPS;
175     MS_U16 u16CMDCNT_OPM;
176     MS_U16 u16CMDCNT_OPS;
177 } DMS_DS_CMDCNT;
178 
179 typedef struct
180 {
181     MS_WINDOW_TYPE stMVOPCropWindow;
182     MS_PHY phyMVOP_LumaAddr;
183     MS_PHY phyMVOP_ChromaAddr;
184     MS_U32 u32HPostRatio;
185     MS_U32 u32VPostRatio;
186     MS_U32 u32FlowFlag;
187     MS_U16 u16H_Start;
188     MS_U16 u16H_End;
189     MS_U16 u16V_Start;
190     MS_U16 u16V_End;
191     MS_U16 u16MVOP_Pitch;
192     MS_BOOL bMVOP_422Pack;
193 } DMS_DS_SWDB;
194 
195 DMS_HAL_INTERFACE MS_BOOL Hal_DMS_XC_SetMute(void* pInstance, MS_BOOL bEnable);
196 DMS_HAL_INTERFACE MS_BOOL HAL_DMS_XC_DSSetConfig(void* pInstance);
197 DMS_HAL_INTERFACE MS_BOOL HAL_DMS_XC_DSSetWin(void* pInstance, MS_WINDOW_TYPE* stMVOPCropWindow, const XC_SETWIN_INFO* stXCSetWinInfo, MS_U32 u32FlowFlag);
198 DMS_HAL_INTERFACE MS_BOOL HAL_DMS_XC_DSSetMVOPPitch(void* pInstance, MS_U16 u16Pitch);
199 DMS_HAL_INTERFACE MS_BOOL HAL_DMS_XC_DSSetMVOPAddr(void* pInstance, MS_PHY phyLumaAddr, MS_PHY phyChromaAddr, MS_BOOL b422Pack);
200 DMS_HAL_INTERFACE MS_BOOL HAL_DMS_XC_DSFire(void* pInstance);
201 DMS_HAL_INTERFACE MS_BOOL HAL_DMS_XC_GetCaps(void* pInstance, EN_DMS_CAPABILITY *peCapability);
202 DMS_HAL_INTERFACE MS_BOOL HAL_DMS_Release_CMA(void* pInstance, EN_DMS_MEMORY_TYPE enMemType, MS_U32 u32CMAHeapID);
203 DMS_HAL_INTERFACE MS_BOOL HAL_DMS_Setup_CMA(void* pInstance, EN_DMS_MEMORY_TYPE enMemType, MS_U32 u32CMAHeapID);
204 
205 
206 #ifdef __cplusplus
207 }
208 #endif
209 
210 #endif
211 
212 
213