xref: /utopia/UTPA2-700.0.x/projects/tmplib/include/apiGPD_v2.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) 2006-2007 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   apiGPD_v2.h
98 /// @brief  GPD Driver Interface
99 /// @author MStar Semiconductor Inc.
100 ///////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _API_GPD_V2_H_
103 #define _API_GPD_V2_H_
104 
105 #ifdef __cplusplus
106 extern "C"
107 {
108 #endif
109 
110 #include "MsTypes.h"
111 //-------------------------------------------------------------------------------------------------
112 // Defines
113 //-------------------------------------------------------------------------------------------------
114 // below for utopia20 structure
115 
116 typedef enum {
117     MApi_CMD_GPD_Init,
118     MApi_CMD_GPD_InputSource,
119     MApi_CMD_GPD_OutputDecode,
120     MApi_CMD_GPD_OutputDecodeROI,
121     MApi_CMD_GPD_OutputDecodeMGIF,
122     MApi_CMD_GPD_GetDuration,
123     MApi_CMD_GPD_SetGIFMode,
124     MApi_CMD_GPD_ScalingEnable,
125     MApi_CMD_GPD_ScalingDisable,
126     MApi_CMD_GPD_SetControl,
127     MApi_CMD_GPD_GetControl,
128     MApi_CMD_GPD_GetCRCResult
129 } E_GPD_V2_IOCTL_CMD;
130 
131 
132 typedef struct _GPD_INIT_PARAM
133 {
134     MS_PHY SrcBuf;
135     void* retVal;
136 }GPD_INIT_PARAM, *PGPD_INIT_PARAM;
137 
138 typedef struct _GPD_INPUTSOURCE_PARAM
139 {
140     gpd_pic_info* param;
141     MS_PHY InputBuf;
142     MS_U32 Size;
143     MS_S32 retVal;
144 }GPD_INPUTSOURCE_PARAM, *PGPD_INPUTSOURCE_PARAM;
145 
146 typedef struct _GPD_OUTPUTDECODE_PARAM
147 {
148     MS_PHY DecodeBuf;
149     MS_U32 ocolor;
150     MS_U32 Size;
151     MS_S32 retVal;
152 }GPD_OUTPUTDECODE_PARAM, *PGPD_OUTPUTDECODE_PARAM;
153 
154 typedef struct _GPD_OUTPUTDECODEROI_PARAM
155 {
156     MS_PHY DecodeBuf;
157     MS_U32 ocolor;
158     MS_U32 Size;
159     gpd_roi_info *roi;
160     MS_S32 retVal;
161 }GPD_OUTPUTDECODEROI_PARAM, *PGPD_OUTPUTDECODEROI_PARAM;
162 
163 typedef struct _GPD_GETDURATION_PARAM
164 {
165     MS_S32 retVal;
166 }GPD_GETDURATION_PARAM, *PGPD_GETDURATION_PARAM;
167 
168 typedef struct _GPD_SETGIFMODE_PARAM
169 {
170    MS_U32 mode;
171 }GPD_SETGIFMODE_PARAM, *PGPD_SETGIFMODE_PARAM;
172 
173 typedef struct _GPD_SCALINGENABLE_PARAM
174 {
175     MS_U32 mode;
176 }GPD_SCALINGENABLE_PARAM, *PGPD_SCALINGENABLE_PARAM;
177 
178 
179 typedef struct _GPD_CONTROL_PARAM
180 {
181     gpd_user_cmd cmd_id;
182     MS_VIRT param;
183     MS_S32 retVal;
184 }GPD_CONTROL_PARAM, *PGPD_CONTROL_PARAM;
185 
186 typedef struct _GPD_GET_CONTROL_PARAM
187 {
188     gpd_get_cmd cmd_id;
189     MS_VIRT param;
190     MS_S32 retVal;
191 }GPD_GET_CONTROL_PARAM, *PGPD_GET_CONTROL_PARAM;
192 
193 typedef struct _GPD_GETCRCRESULT_PARAM
194 {
195     const MS_U8 *pu8Data;
196     MS_U32 u32Size;
197     MS_U32 u32Width;
198     MS_U32 ocolor;
199     MS_U32 retVal;
200 }GPD_GETCRCRESULT_PARAM, *PGPD_GETCRCRESULT_PARAM;
201 
202 
203 void GPDRegisterToUtopia(FUtopiaOpen ModuleType);
204 MS_U32 GPD_Open(void** ppInstance, MS_U32 u32ModuleVersion, void* pAttribute);
205 MS_U32 GPD_Close(void* pInstance);
206 MS_U32 GPD_Ioctl(void* pInstance, MS_U32 u32Cmd, void* pArgs);
207 
208 
209 #ifdef __cplusplus
210 }
211 #endif
212 
213 #endif // _API_GPD_V2_H_
214 
215 
216