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

/***************************************************************************
 *     (c)2005-2011 Broadcom Corporation
 *  
 *  This program is the proprietary software of Broadcom Corporation and/or its licensors,
 *  and may only be used, duplicated, modified or distributed pursuant to the terms and
 *  conditions of a separate, written license agreement executed between you and Broadcom
 *  (an "Authorized License").  Except as set forth in an Authorized License, Broadcom grants
 *  no license (express or implied), right to use, or waiver of any kind with respect to the
 *  Software, and Broadcom expressly reserves all rights in and to the Software and all
 *  intellectual property rights therein.  IF YOU HAVE NO AUTHORIZED LICENSE, THEN YOU
 *  HAVE NO RIGHT TO USE THIS SOFTWARE IN ANY WAY, AND SHOULD IMMEDIATELY
 *  NOTIFY BROADCOM AND DISCONTINUE ALL USE OF THE SOFTWARE.  
 *   
 *  Except as expressly set forth in the Authorized License,
 *   
 *  1.     This program, including its structure, sequence and organization, constitutes the valuable trade
 *  secrets of Broadcom, and you shall use all reasonable efforts to protect the confidentiality thereof,
 *  and to use this information only in connection with your use of Broadcom integrated circuit products.
 *   
 *  2.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS" 
 *  AND WITH ALL FAULTS AND BROADCOM MAKES NO PROMISES, REPRESENTATIONS OR 
 *  WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT TO 
 *  THE SOFTWARE.  BROADCOM SPECIFICALLY DISCLAIMS ANY AND ALL IMPLIED WARRANTIES 
 *  OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR PURPOSE, 
 *  LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, QUIET POSSESSION 
 *  OR CORRESPONDENCE TO DESCRIPTION. YOU ASSUME THE ENTIRE RISK ARISING OUT OF 
 *  USE OR PERFORMANCE OF THE SOFTWARE.
 *  
 *  3.     TO THE MAXIMUM EXTENT PERMITTED BY LAW, IN NO EVENT SHALL BROADCOM OR ITS 
 *  LICENSORS BE LIABLE FOR (i) CONSEQUENTIAL, INCIDENTAL, SPECIAL, INDIRECT, OR 
 *  EXEMPLARY DAMAGES WHATSOEVER ARISING OUT OF OR IN ANY WAY RELATING TO YOUR 
 *  USE OF OR INABILITY TO USE THE SOFTWARE EVEN IF BROADCOM HAS BEEN ADVISED OF 
 *  THE POSSIBILITY OF SUCH DAMAGES; OR (ii) ANY AMOUNT IN EXCESS OF THE AMOUNT 
 *  ACTUALLY PAID FOR THE SOFTWARE ITSELF OR U.S. $1, WHICHEVER IS GREATER. THESE 
 *  LIMITATIONS SHALL APPLY NOTWITHSTANDING ANY FAILURE OF ESSENTIAL PURPOSE OF 
 *  ANY LIMITED REMEDY.
 * 
 * $brcm_Workfile: bads_utils.h $
 * $brcm_Revision: 6 $
 * $brcm_Date: 3/18/11 4:33p $
 *
 * Module Description:
 *
 * Revision History:
 *
 * $brcm_Log: /AP/bcm3128/a0/src/driver/ads/bads_utils.h $
 * 
 * 6   3/18/11 4:33p farshidf
 * SW3461-1: merge  main
 * 
 * ADS_3128_1/1   3/15/11 5:14p cbrooks
 * bcm3128-1:Added new HAB for CWC and changed FFEDFE command
 * 
 * 5   2/8/11 11:48a farshidf
 * SW3128-1: update the constellation function
 * 
 * 4   1/26/11 6:54p cbrooks
 * sw3128-1:Fixed prototypes
 * 
 * 3   1/26/11 3:28p cbrooks
 * sw3128-1:Cleanup Code
 * 
 * 2   1/25/11 9:30p cbrooks
 * sw3128-1: Cleanup Code
 * 
 * 1   12/17/10 4:12p farshidf
 * SW3128-1: new files
 * 
 ***************************************************************************/
#ifndef BADS_UTILS_H__
#define BADS_UTILS_H__

#ifdef __cplusplus
extern "C" {
#endif

/*****************************************************************************
 * ADS Function Prototypes Used by PI or Local 
 *****************************************************************************/
BERR_Code BADS_P_Read_Constellation(
    BADS_3x7x_ChannelHandle hChn,       /* [in] Device channel handle */
    int16_t nbrToGet,                   /* [in] Number values to get */
    int16_t *iVal,                      /* [out] Ptr to array to store output I soft decision */
    int16_t *qVal,                      /* [out] Ptr to array to store output Q soft decision */
    int16_t *nbrGotten                  /* [out] Number of values gotten/read */
    );
BERR_Code BADS_P_HAB_Read_Integrators(BADS_3x7x_ChannelHandle hChn, uint8_t *HAB_Buffer, uint8_t Size_HAB);
BERR_Code BADS_P_HAB_Read_FFEDFE(BADS_3x7x_ChannelHandle hChn, uint8_t *HAB_Buffer, uint8_t Size_HAB, uint8_t FFE);
BERR_Code BADS_P_HAB_Read_CWC(BADS_3x7x_ChannelHandle hChn, uint8_t *HAB_Buffer, uint8_t Size_HAB)      ;

/*****************************************************************************
 * ADS Function Prototypes Used Local 
 *****************************************************************************/
BERR_Code BADS_P_Range_Check(BADS_3x7x_ChannelHandle);
void BADS_P_Set_CFL_Frequency(BADS_3x7x_ChannelHandle hChn, int32_t CFL_Frequency);
void BADS_P_Set_CFL_Integrator(BADS_3x7x_ChannelHandle hChn, int32_t CFL_Error);
void BADS_P_Set_TL_Frequency(BADS_3x7x_ChannelHandle hChn, uint32_t Symbol_Rate);
void BADS_P_Set_TL_Sweep(BADS_3x7x_ChannelHandle hChn, uint32_t Symbol_Rate, int32_t TL_Sweep_Rate);
void BADS_P_Set_CPL_Integrator(BADS_3x7x_ChannelHandle hChn, uint32_t Symbol_Rate, int32_t CPL_Error);
void BADS_P_Set_CPL_Sweep(BADS_3x7x_ChannelHandle hChn, uint32_t Symbol_Rate, int32_t CPL_Sweep_Rate);  
int32_t BADS_P_Get_CFL_Frequency(BADS_3x7x_ChannelHandle hChn);
uint32_t BADS_P_Get_TL_Frequency(BADS_3x7x_ChannelHandle hChn);
int32_t BADS_P_Get_VID_Error(BADS_3x7x_ChannelHandle hChn);
int32_t BADS_P_Get_CFL_Error(BADS_3x7x_ChannelHandle hChn);
int32_t BADS_P_Get_CPL_Error(BADS_3x7x_ChannelHandle hChn, uint32_t Symbol_Rate);

#ifdef __cplusplus
}
#endif

#endif