xref: /utopia/UTPA2-700.0.x/projects/tmplib/include/drvSTBDC.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   drvMVOP.h
98 /// @brief  MVOP Driver Interface
99 /// @author MStar Semiconductor Inc.
100 ///////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _DRV_STBDC_H_
103 #define _DRV_STBDC_H_
104 
105 #ifdef __cplusplus
106 extern "C"
107 {
108 #endif
109 
110 //-------------------------------------------------------------------------------------------------
111 //  Driver Capability
112 //-------------------------------------------------------------------------------------------------
113 
114 
115 //-------------------------------------------------------------------------------------------------
116 //  Macro and Define
117 //-------------------------------------------------------------------------------------------------
118 /// Version string.
119 #define MSIF_STBDC_LIB_CODE              {'S','T','B','_'}    //Lib code
120 #define MSIF_STBDC_LIBVER                {'0','1'}            //LIB version
121 #define MSIF_STBDC_BUILDNUM              {'0','1'}            //Build Number
122 #define MSIF_STBDC_CHANGELIST            {'0','0','1','3','4','8','7','2'} //P4 ChangeList Number
123 
124 #define STBDC_DRV_VERSION                /* Character String for DRV/API version             */  \
125     MSIF_TAG,                           /* 'MSIF'                                           */  \
126     MSIF_CLASS,                         /* '00'                                             */  \
127     MSIF_CUS,                           /* 0x0000                                           */  \
128     MSIF_MOD,                           /* 0x0000                                           */  \
129     MSIF_CHIP,                                                                                  \
130     MSIF_CPU,                                                                                   \
131     MSIF_STBDC_LIB_CODE,                 /* IP__                                             */  \
132     MSIF_STBDC_LIBVER,                   /* 0.0 ~ Z.Z                                        */  \
133     MSIF_STBDC_BUILDNUM,                 /* 00 ~ 99                                          */  \
134     MSIF_STBDC_CHANGELIST,               /* CL#                                              */  \
135     MSIF_OS
136 
137 
138 #define _SUPPORT_IMG_OFFSET_
139 
140 //-------------------------------------------------------------------------------------------------
141 //  Type and Structure
142 //-------------------------------------------------------------------------------------------------
143 typedef enum
144 {
145     E_STBDC_OK    = 0,
146     E_STBDC_FAIL  = 1,
147     E_STBDC_INVALID_PARAM = 2
148 } STBDC_Result;
149 
150 /// MVOP tile format
151 typedef enum
152 {
153     E_STBDC_TILE_8x32  = 0,
154     E_STBDC_TILE_16x32 = 1,
155     E_STBDC_TILE_NONE  = 2
156 } STBDC_TileFormat;
157 
158 
159 
160 
161 typedef struct
162 {
163     MS_PHYADDR u32LumaAddr;
164     MS_PHYADDR u32ChromaAddr;
165     MS_U16 u16HSize;
166     MS_U16 u16VSize;
167     MS_U16 u16Pitch;
168     MS_BOOL bYUV422;    //!< YUV422 or YUV420
169     MS_BOOL bProgressive;   //!< Progressive or Interlace
170     MS_BOOL bBottomField;         // +S3, Field 0 or 1
171     MS_U16 u16CropX;
172     MS_U16 u16CropY;
173     MS_U16 u16CropWidth;
174     MS_U16 u16CropHeight;
175 } STBDC_InputCfg;
176 //---------------------
177 
178 
179 
180 typedef enum
181 {
182     STBDC_PATTERN_NORMAL     = 0,
183     STBDC_PATTERN_COLORBAR   = 1,
184     STBDC_PATTERN_FRAMECOLOR = 2,
185     STBDC_PATTERN_YCBCR      = 3,
186     STBDC_PATTERN_Y          = 4,
187     STBDC_PATTERN_CB         = 5,
188     STBDC_PATTERN_CR         = 6,
189     STBDC_PATTERN_DEFAULT    = 7   //new pattern = (last parrtern + 1) % MVOP_PATTERN_DEFAULT
190 } STBDC_Pattern;
191 
192 typedef enum
193 {
194     E_STBDC_INPUT_DRAM = 0,
195     E_STBDC_INPUT_HVD = 1,    //SVD for T2
196     E_STBDC_INPUT_MVD  = 2,
197     E_STBDC_INPUT_JPD  = 3,
198     E_STBDC_INPUT_UNKNOWN = -1
199 } STBDC_InputSel;
200 
201 /// MVOP VideoStat data structure
202 typedef struct
203 {
204     MS_U16 u16HorSize;
205     MS_U16 u16VerSize;
206     MS_U16 u16FrameRate;
207     MS_U8 u8AspectRate;
208     MS_U8 u8Interlace;
209     MS_U16 u16HorOffset;
210     MS_U16 u16VerOffset;
211 } STBDC_VidStat;
212 
213 
214 ///MVOP driver status
215 typedef struct _STBDC_DrvStatus
216 {
217     MS_BOOL bIsInit;
218     MS_BOOL bIsEnable;
219     MS_BOOL bIsUVShift;
220     MS_BOOL bIsBlackBG;
221     MS_BOOL bIsMonoMode;
222     MS_BOOL bIsSetTiming;
223 } STBDC_DrvStatus;
224 
225 //-------------------------------------------------------------------------------------------------
226 //  Function and Variable
227 //-------------------------------------------------------------------------------------------------
228 
229 
230 
231 
232 
233 #ifdef __cplusplus
234 }
235 #endif
236 
237 #endif // _DRV_MVOP_H_
238