source: svn/newcon3bcm2_21bu/dst/dhl/src/devices/dtqs22ddp101a/MxL201RF_API.h

Last change on this file was 76, checked in by megakiss, 10 years ago

1W 대기전력을 만족시키기 위하여 POWEROFF시 튜너를 Standby 상태로 함

  • Property svn:executable set to *
File size: 7.2 KB
Line 
1/*
2 
3 Driver APIs for MxL201RF Tuner
4 
5 Copyright, Maxlinear, Inc.
6 All Rights Reserved
7 
8 File Name:      MxL201RF_API.h
9
10 
11 */
12#ifndef __MxL201RF_API_H
13#define __MxL201RF_API_H
14
15//#include <windows.h>
16
17#if defined( __cplusplus )
18extern "C"                     /* Use "C" external linkage                  */
19{
20#endif
21
22#include "MxL201RF_Common.h"
23
24
25/******************************************************************************
26**
27**  Name: MxL_Set_Register
28**
29**  Description:    Write one register to MxL201RF
30**
31**  Parameters:         myTuner                         - Pointer to MxL201RF_TunerConfigS
32**                                      RegAddr                         - Register address to be written
33**                                      RegData                         - Data to be written
34**
35**  Returns:        MxL_ERR_MSG                 - MxL_OK if success     
36**                                                                              - MxL_ERR_SET_REG if fail
37**
38******************************************************************************/
39MxL_ERR_MSG MxL_Set_Register(MxL201RF_TunerConfigS* myTuner, UINT8 RegAddr, UINT8 RegData);
40
41/******************************************************************************
42**
43**  Name: MxL_Get_Register
44**
45**  Description:    Read one register from MxL201RF
46**
47**  Parameters:         myTuner                         - Pointer to MxL201RF_TunerConfigS
48**                                      RegAddr                         - Register address to be read
49**                                      RegData                         - Pointer to register read
50**
51**  Returns:        MxL_ERR_MSG                 - MxL_OK if success     
52**                                                                              - MxL_ERR_GET_REG if fail
53**
54******************************************************************************/
55MxL_ERR_MSG MxL_Get_Register(MxL201RF_TunerConfigS* myTuner, UINT8 RegAddr, UINT8 *RegData);
56
57/******************************************************************************
58**
59**  Name: MxL_Tuner_Init
60**
61**  Description:    MxL201RF Initialization
62**
63**  Parameters:         myTuner                         - Pointer to MxL201RF_TunerConfigS
64**
65**  Returns:        MxL_ERR_MSG                 - MxL_OK if success     
66**                                                                              - MxL_ERR_INIT if fail
67**
68******************************************************************************/
69MxL_ERR_MSG MxL_Tuner_Init(MxL201RF_TunerConfigS* );
70
71/******************************************************************************
72**
73**  Name: MxL_Tuner_RFTune
74**
75**  Description:    Frequency tunning for channel
76**
77**  Parameters:         myTuner                         - Pointer to MxL201RF_TunerConfigS
78**                                      RF_Freq_Hz                      - RF Frequency in Hz
79**                                      BWMHz                           - Bandwidth 6, 7 or 8 MHz
80**
81**  Returns:        MxL_ERR_MSG                 - MxL_OK if success     
82**                                                                              - MxL_ERR_RFTUNE if fail
83**
84******************************************************************************/
85MxL_ERR_MSG MxL_Tuner_RFTune(MxL201RF_TunerConfigS*, UINT32 RF_Freq_Hz, MxL201RF_BW_MHz BWMHz);         
86
87/******************************************************************************
88**
89**  Name: MxL_Soft_Reset
90**
91**  Description:    Software Reset the MxL201RF Tuner
92**
93**  Parameters:         myTuner                         - Pointer to MxL201RF_TunerConfigS
94**
95**  Returns:        MxL_ERR_MSG                 - MxL_OK if success     
96**                                                                              - MxL_ERR_OTHERS if fail
97**
98******************************************************************************/
99MxL_ERR_MSG MxL_Soft_Reset(MxL201RF_TunerConfigS*);
100
101/******************************************************************************
102**
103**  Name: MxL_Standby
104**
105**  Description:    Enter Standby Mode
106**
107**  Parameters:         myTuner                         - Pointer to MxL201RF_TunerConfigS
108**
109**  Returns:        MxL_ERR_MSG                 - MxL_OK if success     
110**                                                                              - MxL_ERR_OTHERS if fail
111**
112******************************************************************************/
113MxL_ERR_MSG MxL_Stand_By(MxL201RF_TunerConfigS*);
114
115/******************************************************************************
116**
117**  Name: MxL_Wakeup
118**
119**  Description:    Wakeup from Standby Mode (Note: after wake up, please call RF_Tune again)
120**
121**  Parameters:         myTuner                         - Pointer to MxL201RF_TunerConfigS
122**
123**  Returns:        MxL_ERR_MSG                 - MxL_OK if success     
124**                                                                              - MxL_ERR_OTHERS if fail
125**
126******************************************************************************/
127MxL_ERR_MSG MxL_Wake_Up(MxL201RF_TunerConfigS*);
128
129/******************************************************************************
130**
131**  Name: MxL_Enable_LT
132**
133**  Description:    Enable/Disable the on-chip loop-thru
134**
135**  Parameters:         myTuner                         - Pointer to MxL201RF_TunerConfigS
136**                                      En_LT                           - 0: disable loop-thru, otherwise enable loop-thru
137**
138**  Returns:        MxL_ERR_MSG                 - MxL_OK if success     
139**                                                                              - MxL_ERR_SET_REG if fail
140**
141******************************************************************************/
142MxL_ERR_MSG MxL_Enable_LT(MxL201RF_TunerConfigS* myTuner, UINT8 En_LT);
143
144/******************************************************************************
145**
146**  Name: MxL_Check_ChipVersion
147**
148**  Description:    Return the MxL201RF Chip ID
149**
150**  Parameters:         myTuner                         - Pointer to MxL201RF_TunerConfigS
151**                                      myChipVersion           - MxL_ChipVersion
152**  Returns:        MxL_ERR_MSG                 
153**
154******************************************************************************/
155MxL_ERR_MSG MxL_Check_ChipVersion(MxL201RF_TunerConfigS*, MxL201RF_ChipVersion*);
156
157/******************************************************************************
158**
159**  Name: MxL_RFSynth_Lock_Status
160**
161**  Description:    RF synthesizer lock status of MxL201RF
162**
163**  Parameters:         myTuner                         - Pointer to MxL201RF_TunerConfigS
164**                                      isLock                          - Pointer to Lock Status
165**
166**  Returns:        MxL_ERR_MSG                 - MxL_OK if success     
167**                                                                              - MxL_ERR_OTHERS if fail
168**
169******************************************************************************/
170MxL_ERR_MSG MxL_RFSynth_Lock_Status(MxL201RF_TunerConfigS* , BOOL* isLock);
171
172/******************************************************************************
173**
174**  Name: MxL_REFSynth_Lock_Status
175**
176**  Description:    REF synthesizer lock status of MxL201RF
177**
178**  Parameters:         myTuner                         - Pointer to MxL201RF_TunerConfigS
179**                                      isLock                          - Pointer to Lock Status
180**
181**  Returns:        MxL_ERR_MSG                 - MxL_OK if success     
182**                                                                              - MxL_ERR_OTHERS if fail       
183**
184******************************************************************************/
185MxL_ERR_MSG MxL_REFSynth_Lock_Status(MxL201RF_TunerConfigS* , BOOL* isLock);
186
187/******************************************************************************
188**
189**  Name: MxL_Check_RF_Input_Power
190**
191**  Description:    Reads the RF Input power
192**
193**  Parameters:         myTuner                         - Pointer to MxL201RF_TunerConfigS
194**                                      RF_Input_Level          - Pointer to return value, RF input level
195**
196**  Returns:        MxL_ERR_MSG                 - MxL_OK if success     
197**                                                                              - MxL_ERR_OTHERS if fail       
198**
199******************************************************************************/
200MxL_ERR_MSG MxL_Check_RF_Input_Power(MxL201RF_TunerConfigS* , REAL32* RF_Input_Level);
201
202/******************************************************************************
203**
204**  Name: MxL_Input_Power_LUT_Reg_Write
205**
206**  Description:    Overwrite the registers used by LUT for input power reporting
207**
208**  Parameters:         myTuner                         - Pointer to MxL201RF_TunerConfigS
209**                                      LUT_Index                       - Sub-address index of LUT to be written
210                                        LUT_Val                         - Value to be written to LUT
211**
212**  Returns:        MxL_ERR_MSG                 - MxL_OK if success     
213**                                                                              - MxL_ERR_OTHERS if fail       
214**
215******************************************************************************/
216MxL_ERR_MSG MxL_Input_Power_LUT_Reg_Write(MxL201RF_TunerConfigS* , UINT8 LUT_Index, UINT8 LUT_Val);
217
218#if defined( __cplusplus )
219}
220#endif
221#endif //__MxL201RF_API_H
222
Note: See TracBrowser for help on using the repository browser.