xref: /utopia/UTPA2-700.0.x/projects/tmplib/include/drvDIP.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 _DRVDIP_H_
95 #define _DRVDIP_H_
96 
97 ////////////////////////////////////////////////////////////////////////////////
98 /// @file drvDIP.h
99 /// @author MStar Semiconductor Inc.
100 /// @brief DIP control driver
101 ////////////////////////////////////////////////////////////////////////////////
102 
103 ////////////////////////////////////////////////////////////////////////////////
104 // Header Files
105 ////////////////////////////////////////////////////////////////////////////////
106 #ifdef __cplusplus
107 extern "C"
108 {
109 #endif
110 
111 #define MAX_NR_BUFF_CNT     2UL
112 #define MAX_DATA_BUFF_CNT   16UL
113 
114 typedef struct
115 {
116     MS_U8               u8NR_BufCnt;
117     MS_PHY              u32NR_RationBuf;
118     MS_PHY              u32NR_DataBuf[MAX_NR_BUFF_CNT];
119     MS_U32              u32NR_BufWidth;
120     MS_U32              u32NR_BufHeight;
121 } NR_INFO;
122 
123 typedef struct
124 {
125     MS_U8               u8DI_BufCnt;
126     MS_PHY              u32DI_YBuf[MAX_DATA_BUFF_CNT];
127     MS_PHY              u32DI_CBuf[MAX_DATA_BUFF_CNT];
128     MS_U32              u32DI_BufWidth;
129     MS_U32              u32DI_BufHeight;
130     MS_U16              u16Valid_DIBuf;
131     MS_U32              u32DI_FrameCnt;
132 } DI_INFO;
133 
134 
135 typedef struct
136 {
137     MS_BOOL             Init;
138     NR_INFO             NR_Info;
139     DI_INFO             DI_Info;
140 
141 } DIP_MGR;
142 
143 typedef enum
144 {
145     DIP_ERR_OK,
146     DIP_ERR_FAIL,
147     DIP_ERR_INVALID_BUFFER_CNT,
148     DIP_ERR_INVALID_BUFFER_START,
149     DIP_ERR_INVALID_BUFFER_WIDTH,
150     DIP_ERR_INVALID_BUFFER_HEIGHT,
151     DIP_ERR_INVALID_BUFFER_SZIE
152 }DIP_ERRCODE;
153 
154 typedef enum
155 {
156     E_DIP_INPUT_UNKNOWN = 0,
157     E_DIP_INPUT_NTSC,
158     E_DIP_INPUT_PAL,
159     E_DIP_INPUT_WEBCAM,
160 }DIP_INPUT;
161 
162 typedef enum
163 {
164     E_DIP_YUV_ORDER_UYVY = 0,
165     E_DIP_YUV_ORDER_YUYV = 1,
166 } DIP_YUV_ORDER;
167 
168 typedef enum
169 {
170     E_DIP_INIT ,
171     E_DIP_ENABLE ,
172     E_DIP_ONESHOT ,
173     E_DIP_SET_INFO ,
174     E_DIP_SET_YUORD ,
175     E_DIP_GET_BUFSTUS ,
176     E_DIP_CLR_BUFSTUS ,
177     E_DIP_SET_SCANTYPE ,
178     E_DIP_SET_INPUTMODE ,
179     E_DIP_SET_WEBCAM ,
180 } DIP_CNTL;
181 
182 typedef enum
183 {
184     //By HW or SW DIP
185     E_DIP_CAP_CONFIG,
186 }
187 EN_DIP_CAPS;
188 
189 typedef enum
190 {
191     E_DIP_CFG_SW =0,
192     E_DIP_CFG_HW =1,
193 }
194 EN_DIP_Config;
195 
196 typedef struct
197 {
198     /// dwin dram starting address (unit: Byte).
199     MS_PHY   u32FbAddr0;
200     ///  dwin access address high bond (unit: Byte).
201     MS_PHY   u32FbAddr1;
202     /// dwin width (unit: pix).
203     MS_U16 u16W;
204     /// height (unit: line).
205     MS_U16 u16H;
206 
207     MS_U8  u8BufCnt;
208 
209 } DIP_PROPERTY;
210 
211 typedef struct
212 {
213     /// dwin dram starting address (unit: Byte).
214     MS_VIRT u32WebCamAddr0;
215     ///  dwin access address high bond (unit: Byte).
216     MS_VIRT u32WebCamAddr1;
217     /// dwin width (unit: pix).
218     MS_U16 u16WebCamW;
219     /// height (unit: line).
220     MS_U16 u16WebCamH;
221 
222 } DIP_WEBCAM_PROPERTY;
223 
224 // DIP_ERRCODE MDrv_DIP_GetChipCaps(EN_DIP_CAPS eCapType, MS_U32* pRet, MS_U32 ret_size);
225 
226 // void MDrv_DIP_Init(MS_U32 u32InputMode);
227 // void MDrv_DIP_SetFrameInfo(MS_U32 u32FrameX, MS_U32 u32FrameY,
228 //     MS_U32 u32FrameWidth, MS_U32 u32FrameHeight, MS_BOOL bInterLace);
229 // void MDrv_DIP_InputMode(MS_U32 u32InputMode);
230 // void MDrv_DIP_SetNRBuf(MS_U8 u8BufCnt, MS_U32 u32BufWidth, MS_U32 u32BufHeight,
231 //                                MS_PHY u32BufStart, MS_PHY u32BufEnd);
232 // void MDrv_DIP_SetDIBuf(MS_U8 u8BufCnt, MS_U32 u32BufWidth, MS_U32 u32BufHeight,
233 //                                MS_PHY u32BufStart, MS_PHY u32BufEnd);
234 // void MDrv_DIP_GetDIInfo(DI_INFO *pDIInfo);
235 // void MDrv_DIP_GetNRInfo(NR_INFO *pNRInfo);
236 // void MDrv_DIP_EnableNRDI(MS_BOOL bEnableNR, MS_BOOL bEnableSNR, MS_BOOL bEnableTNR, MS_BOOL bEnableDI);
237 // void MDrv_DIP_GetDIBufCount(MS_U32 *pu32Count);
238 // void MDrv_DIP_ClearDIBufStatus(MS_U8 u8Arg);
239 // void MDrv_DIP_GetDIFrameCount(MS_U32 *pu32FrameCount);
240 // void MDrv_DIP_GetDIBufStatus(MS_U32 *pu32DIBufStatus);
241 // void MDrv_DIP_GetDIShow(void);
242 // void MDrv_DIP_SetMMIOMapBase(void);
243 // void MDrv_DIP_SetWebCamBuff(MS_U32 u32BufWidth, MS_U32 u32BufHeight,
244 //                                MS_VIRT u32BufStart, MS_VIRT u32BufEnd);
245 // void MDrv_DIP_Trigger(void);
246 // void MDrv_DIP_SetYUVOrder(DIP_YUV_ORDER dipOrder);
247 // MS_BOOL MDrv_DIP_OneShot(MS_U32 u32BufWidth, MS_U32 u32BufHeight
248 //     , MS_U32 u32InputBufStart, MS_U32 u32OutputBufStart, MS_U8 u8OutputBufCnt);
249 // MS_BOOL MDrv_DIP_RegisterXCSetDIPInfo(DIP_ERRCODE (*fpDIP_CB)(MS_U16 cmd,MS_U32 *arg,MS_U16 size));
250 
251 #ifdef __cplusplus
252 }
253 #endif
254 
255 #endif
256