xref: /utopia/UTPA2-700.0.x/modules/gpd/api/gpd/apiGPD_priv.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 _APIGPD_PRIV_H_
95 #define _APIGPD_PRIV_H_
96 
97 ////////////////////////////////////////////////////////////////////////////////
98 /// @file apiGPD.h
99 /// @author MStar Semiconductor Inc.
100 /// @brief GPD control driver
101 ////////////////////////////////////////////////////////////////////////////////
102 
103 ////////////////////////////////////////////////////////////////////////////////
104 // Header Files
105 ////////////////////////////////////////////////////////////////////////////////
106 #ifdef __cplusplus
107 extern "C"
108 {
109 #endif
110 
111 #include "MsTypes.h"
112 #include "apiGPD.h"
113 
114 #define SUPPORT_GPD_NUM_MAX     1
115 
116 typedef void* (*IOCTL_GPD_INIT)(MS_PHY);
117 typedef MS_S32 (*IOCTL_GPD_INPUT_SOURCE)(gpd_pic_info*, MS_PHY, MS_U32);
118 typedef MS_S32 (*IOCTL_GPD_OUTPUT_DECODE)(MS_PHY, MS_U32, MS_U32);
119 typedef MS_S32 (*IOCTL_GPD_OUTPUT_DECODE_ROI)(MS_PHY, MS_U32, MS_U32, gpd_roi_info*);
120 typedef MS_S32 (*IOCTL_GPD_OUTPUT_DECODE_MGIF)(MS_PHY, MS_U32, MS_U32);
121 typedef MS_S32 (*IOCTL_GPD_GET_DURATION)(void);
122 typedef void (*IOCTL_GPD_SET_GIF_MODE)(int);
123 typedef void (*IOCTL_GPD_SCALING_ENABLE)(MS_U32);
124 typedef void (*IOCTL_GPD_SCALING_DISABLE)(void);
125 typedef MS_U32 (*IOCTL_GPD_SET_CONTROL)(gpd_user_cmd, MS_VIRT);
126 typedef MS_U32 (*IOCTL_GPD_GET_CONTROL)(gpd_get_cmd, MS_VIRT);
127 typedef MS_U32 (*IOCTL_GPD_GET_CRC_RESULT)(const MS_U8 *, MS_U32);
128 
129 
130 typedef struct __attribute__((packed))
131 {
132     MS_U8 u8DecoderInUse[SUPPORT_GPD_NUM_MAX];
133 }GPD_RESOURCE_PRIVATE;
134 
135 typedef struct _GPD_INSTANCE_PRIVATE
136 {
137     void* pResource;
138     // instance variable
139     MS_U8                                       Index_of_decoder;
140     MS_BOOL                                     bGPDInUse;
141     MS_BOOL                                     bGPDSuspend;
142 #ifdef UTOPIA_20
143     IOCTL_GPD_INIT                              fpGPDInit;
144     IOCTL_GPD_INPUT_SOURCE                      fpGPDInputSource;
145     IOCTL_GPD_OUTPUT_DECODE                     fpGPDOutputDecode;
146     IOCTL_GPD_OUTPUT_DECODE_ROI                 fpGPDOutputDecodeROI;
147     IOCTL_GPD_OUTPUT_DECODE_MGIF                fpGPDOutputDecodeMGIF;
148     IOCTL_GPD_GET_DURATION                      fpGPDGetDuration;
149     IOCTL_GPD_SET_GIF_MODE                      fpGPDSetGIFMode;
150     IOCTL_GPD_SCALING_ENABLE                    fpGPDScalingEnable;
151     IOCTL_GPD_SCALING_DISABLE                   fpGPDScalingDisable;
152     IOCTL_GPD_SET_CONTROL                       fpGPDSetControl;
153     IOCTL_GPD_GET_CONTROL                       fpGPDGetControl;
154     IOCTL_GPD_GET_CRC_RESULT                    fpGPDGetCRCResult;
155 #endif
156 }GPD_INSTANCE_PRIVATE;
157 
158 void GPDRegisterToUtopia(FUtopiaOpen ModuleType);
159 MS_U32 GPDOpen(void** ppInstance, MS_U32 u32ModuleVersion, void* pAttribute);
160 MS_U32 GPDClose(void* pInstance);
161 MS_U32 GPDIoctl(void* pInstance, MS_U32 u32Cmd, void* pArgs);
162 MS_U32 GPDStr(MS_U32 u32PowerState, void* pModule);
163 
164 #ifdef CONFIG_UTOPIA_PROC_DBG_SUPPORT
165 MS_U32          GPDMdbIoctl                         (MS_U32 u32Cmd, const void* const pArgs);
166 void _MApi_GPD_GetMdbInfo(MS_U64* u64ReqHdl);
167 #endif
168 
169 void *_MApi_GPD_Init(MS_PHY SrcBuf);
170 MS_S32 _MApi_GPD_InputSource(gpd_pic_info* param, MS_PHY InputBuf, MS_U32 Size);
171 MS_S32 _MApi_GPD_OutputDecode(MS_PHY DecodeBuf, MS_U32 ocolor, MS_U32 Size);
172 MS_S32 _MApi_GPD_OutputDecodeROI(MS_PHY DecodeBuf, MS_U32 ocolor, MS_U32 Size, gpd_roi_info *roi);
173 MS_S32 _MApi_GPD_OutputDecodeMGIF(MS_PHY DecodeBuf, MS_U32 ocolor, MS_U32 Size);
174 MS_S32 _MApi_GPD_GetDuration(void);
175 void _MApi_GPD_SetGIFMode(MS_U32 mode);
176 
177 void _MApi_GPD_ScalingEnable(MS_U32 mode);
178 void _MApi_GPD_ScalingDisable(void);
179 MS_U32 _MApi_GPD_SetControl(gpd_user_cmd cmd_id, MS_VIRT param);
180 MS_U32 _MApi_GPD_GetControl(gpd_get_cmd cmd_id, MS_VIRT param);
181 MS_U32 _MApi_GPD_GetCRCResult(const MS_U8 *pu8Data, MS_U32 u32Size, MS_U32, MS_U32);
182 
183 #ifdef __cplusplus
184 }
185 #endif
186 #endif // _APIGPD_PRIV_H_
187 
188 
189 
190 
191 
192