source: svn/newcon3bcm2_21bu/nexus/modules/frontend/common/src/nexus_frontend_qam.c

/***************************************************************************
*     (c)2004-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: nexus_frontend_qam.c $
* $brcm_Revision: 10 $
* $brcm_Date: 10/12/11 12:04p $
*
* API Description:
*   API name: Frontend QAM
*    Generic APIs for QAM tuning.
*
* Revision History:
*
* $brcm_Log: /nexus/modules/frontend/common/src/nexus_frontend_qam.c $
* 
* 10   10/12/11 12:04p erickson
* SW3461-50, SW3128-16: add qam scan
* 
* 9   9/6/11 9:32p vishk
* SW3461-48: Fix 3461 frontend issues.
* 
* 8   10/21/10 7:00p vishk
* SW7420-1020: Request for non-blocking call support in Nexus frontend
* 
* 7   8/5/10 4:36p VISHK
* SW7405-4722: Add support for "Frequency offset" and "Null packets" for
*  ADS and expose "auto acquire" in nexus for AOB
* 
* 6   3/8/10 8:42p VISHK
* SW7405-3995: Support spectrum mode and spectrum inversion control from
*  nexus.
* 
* 5   12/31/09 4:36p VISHK
* SW7550-135: Support 7550 QAM/DVB-C support in Nexus
* 
* 4   1/23/09 3:32p jgarrett
* PR 51457: Adding frontend extension hooks for tuners and
*  frontends/demods
* 
* 3   7/11/08 5:07p jtna
* PR42924: Add channel change measurements functionality
* 
* 2   5/1/08 11:19a erickson
* PR42376: default the QAM symbolRate based on the mode and annex if 0
*
* 1   1/18/08 2:19p jgarrett
* PR 38808: Merging to main branch
*
* Nexus_Devel/2   10/10/07 2:32p jgarrett
* PR 35551: Making annex b default
*
* Nexus_Devel/1   10/5/07 5:52p jgarrett
* PR 35551: Adding initial version
*
* Nexus_Devel/1   10/4/07 2:41p jgarrett
* PR 35551: Adding initial version
*
***************************************************************************/

#include "nexus_frontend_module.h"

BDBG_MODULE(nexus_frontend_qam);

BTRC_MODULE_DECLARE(ChnChange_Tune);

/***************************************************************************
Summary:
        Initialize a QAM settings structure to defaults
See Also:
    NEXUS_Frontend_TuneQam
 ***************************************************************************/
void NEXUS_Frontend_GetDefaultQamSettings(
    NEXUS_FrontendQamSettings *pSettings
    )
{
    BKNI_Memset(pSettings, 0, sizeof(*pSettings));
    pSettings->mode = NEXUS_FrontendQamMode_e64;
    pSettings->annex = NEXUS_FrontendQamAnnex_eB;
    pSettings->bandwidth = NEXUS_FrontendQamBandwidth_e6Mhz;
    pSettings->spectrumMode = NEXUS_FrontendQamSpectrumMode_eManual;
    pSettings->frequencyOffset = NEXUS_FrontendQamFrequencyOffset_e180Khz;
}

/***************************************************************************
Summary:
        Tune to a QAM channel
See Also:
    NEXUS_Frontend_InitQamSettings
 ***************************************************************************/
NEXUS_Error NEXUS_Frontend_TuneQam(
    NEXUS_FrontendHandle handle,
    const NEXUS_FrontendQamSettings *pSettings
    )
{
    BDBG_ASSERT(NULL != handle);
    BDBG_ASSERT(NULL != pSettings);
    BTRC_TRACE(ChnChange_Tune, START);

    if ( NULL == handle->tuneQam )
    {
        if ( handle->pParentFrontend )
        {
            return NEXUS_Frontend_TuneQam(handle->pParentFrontend, pSettings);
        }
        else
        {
            return BERR_TRACE(BERR_NOT_SUPPORTED);
        }
    }
    else
    {
        return handle->tuneQam(handle->pDeviceHandle, pSettings);
    }
}

/***************************************************************************
Summary:
        Get the status synchronously of a QAM tuner
See Also:
    NEXUS_Frontend_TuneQam
 ***************************************************************************/
NEXUS_Error NEXUS_Frontend_GetQamStatus(
    NEXUS_FrontendHandle handle,
    NEXUS_FrontendQamStatus *pStatus /* [out] */
    )
{
    BDBG_ASSERT(NULL != handle);
    BDBG_ASSERT(NULL != pStatus);

    if ( NULL == handle->getQamStatus )
    {
        if ( handle->pParentFrontend )
        {
            return NEXUS_Frontend_GetQamStatus(handle->pParentFrontend, pStatus);
        }
        else
        {
            return BERR_TRACE(BERR_NOT_SUPPORTED);
        }
    }
    else
    {
        return handle->getQamStatus(handle->pDeviceHandle, pStatus);
    }
}

/***************************************************************************
Summary:
        Get the status asynchronously of a QAM tuner
See Also:
    NEXUS_Frontend_TuneQam
    NEXUS_Frontend_RequestQamStatus
 ***************************************************************************/
NEXUS_Error NEXUS_Frontend_GetQamAsyncStatus(
    NEXUS_FrontendHandle handle,
    NEXUS_FrontendQamStatus *pStatus /* [out] */
    )
{
    BDBG_ASSERT(NULL != handle);
    BDBG_ASSERT(NULL != pStatus);

    if ( NULL == handle->getQamAsyncStatus )
    {
        if ( handle->pParentFrontend )
        {
            return NEXUS_Frontend_GetQamAsyncStatus(handle->pParentFrontend, pStatus);
        }
        else
        {
            return BERR_TRACE(BERR_NOT_SUPPORTED);
        }
    }
    else
    {
        return handle->getQamAsyncStatus(handle->pDeviceHandle, pStatus);
    }
}

/***************************************************************************
Summary:
        Request the status asynchronously of a QAM tuner
See Also:
    NEXUS_Frontend_GetQamAsyncStatus
 ***************************************************************************/
NEXUS_Error NEXUS_Frontend_RequestQamAsyncStatus(
    NEXUS_FrontendHandle handle
    )
{
    BDBG_ASSERT(NULL != handle);

    if ( NULL == handle->requestQamAsyncStatus )
    {
        if ( handle->pParentFrontend )
        {
            return NEXUS_Frontend_RequestQamAsyncStatus(handle->pParentFrontend);
        }
        else
        {
            return BERR_TRACE(BERR_NOT_SUPPORTED);
        }
    }
    else
    {
        return handle->requestQamAsyncStatus(handle->pDeviceHandle);
    }
}

/***************************************************************************
Summary:
        Request the status asynchronously of a QAM tuner
See Also:
    NEXUS_Frontend_GetQamAsyncStatus
 ***************************************************************************/
NEXUS_Error NEXUS_Frontend_GetQamScanStatus(
        NEXUS_FrontendHandle handle,
        NEXUS_FrontendQamScanStatus *pScanStatus /* [out] */
        )
{
    BDBG_ASSERT(NULL != handle);

    if ( NULL == handle->getQamScanStatus )
    {
        if ( handle->pParentFrontend )
        {
            return NEXUS_Frontend_GetQamScanStatus(handle->pParentFrontend, pScanStatus);
        }
        else
        {
            return BERR_TRACE(BERR_NOT_SUPPORTED);
        }
    }
    else
    {
        return handle->getQamScanStatus(handle->pDeviceHandle, pScanStatus);
    }
}

unsigned NEXUS_Frontend_P_GetDefaultQamSymbolRate(NEXUS_FrontendQamMode mode, NEXUS_FrontendQamAnnex annex)
{
    if (annex == NEXUS_FrontendQamAnnex_eA) {
        switch (mode) {
        case NEXUS_FrontendQamMode_e64:
        case NEXUS_FrontendQamMode_e256:
            return 6952000;
        case NEXUS_FrontendQamMode_e16:
        case NEXUS_FrontendQamMode_e32:
        case NEXUS_FrontendQamMode_e128:
        default:
            return 6952000; /* TODO */
        }

    }
    else {
        switch (mode) {
        case NEXUS_FrontendQamMode_e64:
            return 5056941;
        case NEXUS_FrontendQamMode_e256:
            return 5360537;
        case NEXUS_FrontendQamMode_e16:
        case NEXUS_FrontendQamMode_e32:
        case NEXUS_FrontendQamMode_e128:
        default:
            return 5056941; /* TODO */
        }
    }
}