xref: /utopia/UTPA2-700.0.x/modules/demodulator/drv/dmd/u3/Int_DVBC/drvDMD.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   drvDMD.h
98 /// @brief  DVBC Demodulator Driver Interface
99 /// @author MStar Semiconductor,Inc.
100 ///////////////////////////////////////////////////////////////////////////////////////////////////
101 
102 #ifndef _DRV_DMD_H_
103 #define _DRV_DMD_H_
104 
105 
106 
107 #ifdef __cplusplus
108 extern "C"
109 {
110 #endif
111 
112 //-------------------------------------------------------------------------------------------------
113 //  Driver Capability
114 //-------------------------------------------------------------------------------------------------
115 
116 
117 //-------------------------------------------------------------------------------------------------
118 //  Macro and Define
119 //-------------------------------------------------------------------------------------------------
120 
121 
122 //-------------------------------------------------------------------------------------------------
123 //  Type and Structure
124 //-------------------------------------------------------------------------------------------------
125 
126 /// Mdulation constellation scheme
127 typedef enum _DMD_QamType
128 {
129     E_DMD_QAM16  = 0,                                                   ///< QAM 16
130     E_DMD_QAM32  = 1,                                                   ///< QAM 32
131     E_DMD_QAM64  = 2,                                                   ///< QAM 64
132     E_DMD_QAM128 = 3,                                                   ///< QAM 128
133     E_DMD_QAM256 = 4,                                                   ///< QAM 256
134 
135     E_DMD_QAM_LASTNUM,
136 } __attribute__((packed)) DMD_QAMType;
137 
138 /// Demodulation IQ type
139 typedef enum _DMD_IQType
140 {
141     E_DMD_IQ_NORMAL = 0,                                                ///< IQ Normal
142     E_DMD_IQ_INVERT = 1,                                                ///< IQ Invert
143 } __attribute__((packed)) DMD_IQType;
144 
145 /// Demodulation tap assign
146 typedef enum _DMD_TapAssign
147 {
148     E_DMD_TAP_PRE  = 0,                                                 ///< PreTap assign
149     E_DMD_TAP_POST = 1,                                                 ///< PostTap assign
150 } __attribute__((packed)) DMD_TapAssign;
151 
152 
153 #if   1//(FRONTEND_DEMOD_TYPE == DEMOD_MSDVBC)
154 
155 /// Demodulator auto tune control
156 typedef struct
157 {
158     // Demodulator option
159     MS_BOOL                         bX4CFE_en;                          ///< Carrier frequency estimation
160     MS_BOOL                         bPPD_en;                            ///< Tap assign estimation
161     MS_BOOL                         bIQAutoSwap_en;                     ///< IQ mode auto swap
162     MS_BOOL                         bQAMScan_en;                        ///< QAM type auto scan
163     MS_BOOL                         bFHO_en;                            ///< FHO
164 	MS_BOOL							(*fptTunerSet)(MS_U32);				///< Tuner set freq function pointer
165 } DMD_Mode;
166 
167 /// Demodulator tune parameter
168 typedef struct
169 {
170     // Channel setting
171     MS_U32                          u32SymRate;                         ///< Symbol rate (Ksym/sec)
172 
173     // Channel characteristic
174     DMD_QAMType                     eQamType;                           ///< QAM type
175     DMD_IQType                      eIQSwap;                            ///< IQ type
176     DMD_TapAssign                   eTapAssign;                         ///< Tap assign
177     MS_U32                          u32FreqOffset;                      ///< Carrier frequency offset
178 	MS_U8							u8TuneFreqOffset;					///< Request Tuner offset
179 	MS_U32							u32TunerFreq;						///< Request Tuner offset
180 } DMD_Param;
181 
182 /// Demodulator special status parameter
183 typedef struct
184 {
185 	MS_BOOL							bRtyTunerFreq;						///< Tuner freq retry flag
186 	MS_BOOL							bRtyTunerOvr;						///< Retry over indicator for freq offset retry
187 	MS_S32							s32TunerFreqOffset;					///< Demod request tuner freq offset
188 }DMD_Status;
189 
190 #else
191 
192 typedef struct
193 {
194     // N/A
195 } DMD_Mode;
196 
197 // Device dependant parameter
198 typedef struct
199 {
200     // N/A
201 } DMD_Param;
202 
203 typedef struct
204 {
205 	// N/A
206 }DMD_Status;
207 
208 #endif
209 
210 
211 //-------------------------------------------------------------------------------------------------
212 //  Function and Variable
213 //-------------------------------------------------------------------------------------------------
214 extern MS_BOOL MDrv_Dmd_Init(void);
215 extern MS_BOOL MDrv_Dmd_Open(void);
216 extern MS_BOOL MDrv_Dmd_Close(void);
217 extern MS_BOOL MDrv_Dmd_Reset(void);
218 extern MS_BOOL MDrv_Dmd_Restart(DMD_Param *pParam);
219 extern MS_BOOL MDrv_Dmd_SetMode(DMD_Mode *pMode);
220 extern MS_BOOL MDrv_Dmd_TsOut(MS_BOOL bEnable);
221 extern MS_BOOL MDrv_Dmd_PowerOnOff(MS_BOOL bPowerOn);
222 extern MS_BOOL MDrv_Dmd_SetBW(MS_U32 u32BW);
223 extern MS_BOOL MDrv_Dmd_GetBW(MS_U32 *pu32BW);
224 extern MS_BOOL MDrv_Dmd_GetLock(MS_BOOL *pbLock);
225 extern MS_BOOL MDrv_Dmd_GetSNR(MS_U32 *pu32SNR);
226 extern MS_BOOL MDrv_Dmd_GetBER(float *pfBER);
227 extern MS_BOOL MDrv_Dmd_GetPWR(MS_S32 *ps32Signal);
228 extern MS_BOOL MDrv_Dmd_GetParam(DMD_Param *pParam);
229 extern MS_BOOL MDrv_Dmd_Config(MS_U8 *pRegParam);
230 
231 #ifdef __cplusplus
232 }
233 #endif
234 
235 
236 #endif // _DRV_DMD_H_
237