source: svn/trunk/newcon3bcm2_21bu/magnum/portinginterface/ads/7552/bads_acquire.h

Last change on this file was 2, checked in by jglee, 11 years ago

first commit

  • Property svn:executable set to *
File size: 8.8 KB
Line 
1/***************************************************************************
2 *     (c)2005-2011 Broadcom Corporation
3 * 
4 *  This program is the proprietary software of Broadcom Corporation and/or its licensors,
5 *  and may only be used, duplicated, modified or distributed pursuant to the terms and
6 *  conditions of a separate, written license agreement executed between you and Broadcom
7 *  (an "Authorized License").  Except as set forth in an Authorized License, Broadcom grants
8 *  no license (express or implied), right to use, or waiver of any kind with respect to the
9 *  Software, and Broadcom expressly reserves all rights in and to the Software and all
10 *  intellectual property rights therein.  IF YOU HAVE NO AUTHORIZED LICENSE, THEN YOU
11 *  HAVE NO RIGHT TO USE THIS SOFTWARE IN ANY WAY, AND SHOULD IMMEDIATELY
12 *  NOTIFY BROADCOM AND DISCONTINUE ALL USE OF THE SOFTWARE. 
13 *   
14 *  Except as expressly set forth in the Authorized License,
15 *   
16 *  1.     This program, including its structure, sequence and organization, constitutes the valuable trade
17 *  secrets of Broadcom, and you shall use all reasonable efforts to protect the confidentiality thereof,
18 *  and to use this information only in connection with your use of Broadcom integrated circuit products.
19 *   
20 *  2.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS"
21 *  AND WITH ALL FAULTS AND BROADCOM MAKES NO PROMISES, REPRESENTATIONS OR
22 *  WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO
23 *  THE SOFTWARE.  BROADCOM SPECIFICALLY DISCLAIMS ANY AND ALL IMPLIED WARRANTIES
24 *  OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE,
25 *  LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION
26 *  OR CORRESPONDENCE TO DESCRIPTION. YOU ASSUME THE ENTIRE RISK ARISING OUT OF
27 *  USE OR PERFORMANCE OF THE SOFTWARE.
28 * 
29 *  3.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, IN NO EVENT SHALL BROADCOM OR ITS
30 *  LICENSORS BE LIABLE FOR (i) CONSEQUENTIAL, INCIDENTAL, SPECIAL, INDIRECT, OR
31 *  EXEMPLARY DAMAGES WHATSOEVER ARISING OUT OF OR IN ANY WAY RELATING TO YOUR
32 *  USE OF OR INABILITY TO USE THE SOFTWARE EVEN IF BROADCOM HAS BEEN ADVISED OF
33 *  THE POSSIBILITY OF SUCH DAMAGES; OR (ii) ANY AMOUNT IN EXCESS OF THE AMOUNT
34 *  ACTUALLY PAID FOR THE SOFTWARE ITSELF OR U.S. $1, WHICHEVER IS GREATER. THESE
35 *  LIMITATIONS SHALL APPLY NOTWITHSTANDING ANY FAILURE OF ESSENTIAL PURPOSE OF
36 *  ANY LIMITED REMEDY.
37 *
38 * $brcm_Workfile: bads_acquire.h $
39 * $brcm_Revision: 27 $
40 * $brcm_Date: 10/12/11 2:44p $
41 *
42 * [File Description:]
43 *
44 * Revision History:
45 *
46 * $brcm_Log: /AP/ctfe/core/ads/bads_acquire.h $
47 *
48 * 27   10/12/11 2:44p mpovich
49 * SW3128-38: Merge to main branch from integ. branch.
50 *
51 * Fw_Integration_Devel/5   10/12/11 2:43p mpovich
52 * SW3128-38: Merge to integ. branch from devel. branch.
53 *
54 * Fw_Integration_Devel/AP_V2_0_ADS_DEV/2   10/12/11 11:45a mpovich
55 * SW3128-38: Merge ADS Early Exit feature to devel. branch.
56 *
57 * 26   10/12/11 11:26a farshidf
58 * SW3128-54: merge to main
59 *
60 * Fw_Integration_Devel/4   10/12/11 10:40a farshidf
61 * SW3128-54: merge to Integ branch
62 *
63 * Fw_Integration_Devel/AP_V2_0_ADS_DEV/1   10/6/11 11:47a farshidf
64 * SW3128-1: update for 3128c0
65 *
66 * Fw_Integration_Devel/AP_V2_0_ADS_DEV/SW3128-38/1   10/5/11 4:19p mpovich
67 * SW3128-38: Early exit feature - encapsulate early exit flag within
68 *  bads_acquire module.
69 *
70 * 25   8/12/11 3:12p farshidf
71 * SW3461-1: merge to main
72 *
73 * Fw_Integration_Devel/2   8/12/11 2:10p farshidf
74 * SW3461-1: merge to integ
75 *
76 * Fw_Integration_Devel/AP_V0_6_ADS_DEV/4   7/27/11 7:58p cbrooks
77 * sw3128-1:added early exit
78 *
79 * Fw_Integration_Devel/AP_V0_6_ADS_DEV/3   7/15/11 6:43p farshidf
80 * SWDTV-7869: fix
81 *
82 * Fw_Integration_Devel/AP_V0_6_ADS_DEV/2   7/15/11 6:27p farshidf
83 * SWDTV-7869: fix compile error
84 *
85 * Fw_Integration_Devel/AP_V0_6_ADS_DEV/1   7/15/11 6:22p farshidf
86 * SWDTV-7869: add the new FFT function for B0
87 *
88 * 23   6/9/11 6:14p mpovich
89 * SW3461-1: Merge Ver 0.4 Integ. onto main branch.
90 *
91 * SW_System_4_Integ_Test/2   6/9/11 2:15p mpovich
92 * SW3461-1: Rebase with main branch.
93 *
94 * 22   6/7/11 3:14p farshidf
95 * SW3128-1: merge to main
96 *
97 * SW_System_4_Integ_Test/1   6/6/11 1:57p mpovich
98 * SW3461-1: Integ. test all development branches together.
99 *
100 * Ads_Fw_Devel_3/1   5/27/11 12:28p cbrooks
101 * sw3128-1:Added IMC and CWC
102 *
103 * 21   4/28/11 3:57p farshidf
104 * SW3128-1: merge to main
105 *
106 * ADS_3128_3/1   4/28/11 1:08p cbrooks
107 * sw3128-1:New Code for scan
108 *
109 * 20   4/26/11 6:49p farshidf
110 * SW3128-1: merge main
111 *
112 * ADS_3128_2/5   4/26/11 4:53p farshidf
113 * SW3128-1: merge main
114 *
115 * 19   4/18/11 5:32p farshidf
116 * SW3128-1: update to make it work with host chip
117 *
118 * 18   4/15/11 4:48p farshidf
119 * SW3128-1: merge main
120 *
121 * ADS_3128_2/3   4/13/11 5:04p cbrooks
122 * sw3128-1:new cwc code
123 *
124 * ADS_3128_2/2   4/11/11 8:31p cbrooks
125 * SW3128-1:Added CWC code
126 *
127 * ADS_3128_2/1   4/11/11 12:46p cbrooks
128 * sw3128-1:New CWC code
129 *
130 * 16   1/31/11 7:55p cbrooks
131 * sw3128-1:new code
132 *
133 * 15   1/30/11 6:35p cbrooks
134 * sw3128-1:FFT Code
135 *
136 * 14   1/26/11 6:54p cbrooks
137 * sw3128-1:Fixed prototypes
138 *
139 * 13   1/26/11 3:28p cbrooks
140 * sw3128-1:Cleanup Code
141 *
142 * 12   1/25/11 9:29p cbrooks
143 * sw3128-1: Cleanup Code
144 *
145 * 11   12/17/10 4:16p farshidf
146 * SW3128-1: update
147 *
148 *
149 ***************************************************************************/
150
151#ifndef _BADS_ACQUIRE_H__
152#define _BADS_ACQUIRE__H__           
153
154#ifdef __cplusplus
155extern "C" {
156#endif
157
158
159/*Combined Timing Loop Coefficients*/
160#define BCHP_DS_TLC_COMBO_COEFFS_SHIFT BCHP_DS_TLC_TLICOEFF_SHIFT
161#define BCHP_DS_TLC_COMBO_COEFFS_MASK (BCHP_DS_TLC_reserved1_MASK | BCHP_DS_TLC_TLLCOEFF_SIGN_MASK | BCHP_DS_TLC_TLLCOEFF_MASK | BCHP_DS_TLC_reserved2_MASK | BCHP_DS_TLC_TLICOEFF_SIGN_MASK | BCHP_DS_TLC_TLICOEFF_MASK)
162
163/*Combined Frequency Loop Coefficients*/
164#define BCHP_DS_CFLC_COMBO_COEFFS_SHIFT BCHP_DS_CFLC_CFLICOEFF_SHIFT
165#define BCHP_DS_CFLC_COMBO_COEFFS_MASK (BCHP_DS_CFLC_reserved1_MASK | BCHP_DS_CFLC_CFLLCOEFF_SIGN_MASK | BCHP_DS_CFLC_CFLLCOEFF_MASK | BCHP_DS_CFLC_reserved2_MASK | BCHP_DS_CFLC_CFLICOEFF_SIGN_MASK | BCHP_DS_CFLC_CFLICOEFF_MASK)
166
167/*Combined Phase Loop Coefficients*/
168#define BCHP_DS_EQ_CPLC_COMBO_COEFFS_SHIFT BCHP_DS_EQ_CPLC_CPLICOEFF_SHIFT
169#define BCHP_DS_EQ_CPLC_COMBO_COEFFS_MASK (BCHP_DS_EQ_CPLC_CPLLCOEFF_MASK | BCHP_DS_EQ_CPLC_CPLICOEFF_MASK)
170
171/*Combined DFE Taps*/
172#define BCHP_DS_FRZ_COMBO_DFEFRZ_SHIFT BCHP_DS_FRZ_DFEFRZ1_6_SHIFT
173#define BCHP_DS_FRZ_COMBO_DFEFRZ_MASK (BCHP_DS_FRZ_DFEFRZ31_36_MASK | BCHP_DS_FRZ_DFEFRZ25_30_MASK | BCHP_DS_FRZ_DFEFRZ19_24_MASK | BCHP_DS_FRZ_DFEFRZ13_18_MASK | BCHP_DS_FRZ_DFEFRZ7_12_MASK | BCHP_DS_FRZ_DFEFRZ1_6_MASK)
174
175/*combined FEC counter clears*/
176#define BCHP_DS_TPFEC_CLEARCNT2_SHIFT  BCHP_DS_TPFEC_CLR_BMPG2_SHIFT
177#define BCHP_DS_TPFEC_CLEARCNT2_MASK   (BCHP_DS_TPFEC_CLR_UERC2_MASK | BCHP_DS_TPFEC_CLR_NBERC2_MASK | BCHP_DS_TPFEC_CLR_CBERC2_MASK | BCHP_DS_TPFEC_CLR_BMPG2_MASK)
178
179/*****************************************************************************
180 * ADS Function Prototypes Used by PI or Local
181 *****************************************************************************/
182BERR_Code BADS_P_Initialize(BADS_3x7x_ChannelHandle hChn);
183BERR_Code BADS_P_ChnLockStatus(BADS_3x7x_ChannelHandle hChn);
184BERR_Code BADS_P_Acquire(BADS_3x7x_ChannelHandle hChn);
185
186/*****************************************************************************
187 * ADS Function Prototypes Used Local
188 *****************************************************************************/
189void BADS_P_ProgramFEC(BADS_3x7x_ChannelHandle hChn);
190uint8_t Set_BADS_P_Set_CWC_Auto(BADS_3x7x_ChannelHandle hChn, uint32_t Symbol_Rate, int32_t CWC_Offset_Freq);
191void BADS_P_Get_AcquisitionScan_Settings(BADS_3x7x_ChannelHandle hChn);
192void BADS_P_Get_ChannelPower(BADS_3x7x_ChannelHandle hChn);
193int16_t BADS_P_Scale_Power_Check(BADS_3x7x_ChannelHandle hChn, int16_t Power_Check);
194void BADS_P_AcquisitionPercentageTest(BADS_3x7x_ChannelHandle hChn);
195bool BADS_P_ADS_SLEEP(BADS_3x7x_ChannelHandle hChn, unsigned int Delay);       
196/* Acquire Early Exit */
197BERR_Code BADS_P_AbortAcquire(BADS_3x7x_ChannelHandle hChn);
198
199void Setup1(BADS_3x7x_ChannelHandle hChn);
200/*THE FFT FUNCTION IS DIFFERERNT BETWEEN CORES*/
201#if BCHP_DS_CORE_V_9_1
202        uint32_t BADS_P_Get_TimingScan_FFT(BADS_3x7x_ChannelHandle hChn, uint32_t Upper_Baud_Search, bool ReturnBin);
203        int32_t BADS_P_Get_CarrierScan_FFT(BADS_3x7x_ChannelHandle hChn, uint32_t Symbol_Rate, bool CMA);
204#elif ((BCHP_DS_CORE_V_9_2) || (BCHP_DS_CORE_V_9_3))
205        uint32_t BADS_P_Get_TimingScan_Advanced_FFT(BADS_3x7x_ChannelHandle hChn, uint32_t Upper_Baud_Search, bool ReturnBin);
206        int32_t BADS_P_Get_CarrierScan_Advanced_FFT(BADS_3x7x_ChannelHandle hChn, uint32_t Symbol_Rate, bool CMA);
207#endif
208
209#ifdef __cplusplus
210}
211#endif
212
213#endif /* _BADS_ACQUIRE_PRIV_H__ */
Note: See TracBrowser for help on using the repository browser.