source: svn/newcon3bcm2_21bu/nexus/modules/frontend/common/src/nexus_frontend_ofdm.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_ofdm.c $
* $brcm_Revision: 12 $
* $brcm_Date: 9/26/11 2:03p $
*
* API Description:
*   API name: Frontend OFDM
*    Generic APIs for OFDM (Orthogonal Frequency-Division Multiplexing) tuning.
*    This is used in DVB-H and DVB-T environments.
*
* Revision History:
*
* $brcm_Log: X:/win_views/97231_SW3461_36/nexus/modules/frontend/common/src/nexus_frontend_ofdm.c $
* 
* 12   9/26/11 2:03p vishk
* SW3461-53: 3461 interrupt line 'stuck low' after multiple tune events.
*  Merge to mainline.
* 
* 11   9/7/11 6:10p vishk
* SW3461-36: add DVB T2 status API. Merge to the mainline.
* 
* 10   9/7/11 6:01p vishk
* SW3461-36: add DVB T2 status API. Fix compilation error.
* 
* SW3461-36/2   9/7/11 5:41p vishk
* SW3461-36: add DVB T2 status API.
* 
* SW3461-36/1   8/18/11 4:38p vishk
* SW3461-36: SW3461-27: SW3461-28: SW3461-26: SW3461-24: SW3461-25:
*  SW3461-18: Expose DVBT and DVBT2 status.
* 
* 9   6/6/11 2:47p vishk
* SW7231-32: Implement the Nexus code to support the 3461 frontend chip.
*  Set the right defaults.
* 
* 8   5/24/11 7:07p vishk
* SW7231-32: Implement the Nexus code to support the 3461 frontend chip
* 
* 7   5/18/10 6:05p jgarrett
* SW7550-399: Adding option for cable/terrestrial setup in OFDM
* 
* 6   12/22/09 2:06p maivu
* SW3556-941: Enable CCI mode by default
* 
* 5   1/23/09 3:32p jgarrett
* PR 51457: Adding frontend extension hooks for tuners and
*  frontends/demods
* 
* 4   7/30/08 12:50p jgarrett
* PR 45002: Adding TPS settings
* 
* 3   7/11/08 5:06p jtna
* PR42924: Add channel change measurements functionality
* 
* 2   2/8/08 6:37p jgarrett
* PR 39100: Adding OFDM support
* 
* 1   1/18/08 2:19p jgarrett
* PR 38808: Merging to main branch
* 
* Nexus_Devel/1   1/10/08 2:33p jgarrett
* PR 38653: Initial version
* 
***************************************************************************/

#include "nexus_frontend_module.h"

BDBG_MODULE(nexus_frontend_ofdm);

BTRC_MODULE_DECLARE(ChnChange_Tune);

/***************************************************************************
Summary:
    Initialize a OFDM settings structure to defaults
See Also:
    NEXUS_Frontend_TuneOfdm
 ***************************************************************************/
void NEXUS_Frontend_GetDefaultOfdmSettings(
    NEXUS_FrontendOfdmSettings *pSettings   /* [out] */
    )
{
    BKNI_Memset(pSettings, 0, sizeof(NEXUS_FrontendOfdmSettings));
    pSettings->bandwidth = NEXUS_FrontendOfdmBandwidth_e8Mhz;
    pSettings->pullInRange = NEXUS_FrontendOfdmPullInRange_eWide;
    pSettings->cciMode = NEXUS_FrontendOfdmCciMode_eAuto;
    pSettings->terrestrial = true;
}

/***************************************************************************
Summary:
    Tune to a OFDM channel
See Also:
    NEXUS_Frontend_InitOfdmSettings
 ***************************************************************************/
NEXUS_Error NEXUS_Frontend_TuneOfdm(
    NEXUS_FrontendHandle handle,
    const NEXUS_FrontendOfdmSettings *pSettings
    )
{
    BDBG_ASSERT(NULL != handle);
    BDBG_ASSERT(NULL != pSettings);
    BTRC_TRACE(ChnChange_Tune, START);
    if ( handle->tuneOfdm )
    {
        return handle->tuneOfdm(handle->pDeviceHandle, pSettings);
    }
    else
    {
        if ( handle->pParentFrontend )
        {
            return NEXUS_Frontend_TuneOfdm(handle->pParentFrontend, pSettings);
        }
        else
        {
            return BERR_TRACE(BERR_NOT_SUPPORTED);
        }
    }
}

/***************************************************************************
Summary:
    Get the status of a OFDM tuner
See Also:
    NEXUS_Frontend_TuneOfdm
 ***************************************************************************/
NEXUS_Error NEXUS_Frontend_GetOfdmStatus(
    NEXUS_FrontendHandle handle,
    NEXUS_FrontendOfdmStatus *pStatus /* [out] */
    )
{
    BSTD_UNUSED(handle);
    BSTD_UNUSED(pStatus);
    if ( handle->getOfdmStatus )
    {
        return handle->getOfdmStatus(handle->pDeviceHandle, pStatus);
    }
    else
    {
        if ( handle->pParentFrontend )
        {
            return NEXUS_Frontend_GetOfdmStatus(handle->pParentFrontend, pStatus);
        }
        else
        {
            return BERR_TRACE(BERR_NOT_SUPPORTED);
        }
    }
}

/***************************************************************************
Summary:
    Get the status asynchronously of a Ofdm tuner
See Also:
    NEXUS_Frontend_TuneOfdm
    NEXUS_Frontend_RequestOfdmStatus
 ***************************************************************************/
NEXUS_Error NEXUS_Frontend_GetOfdmAsyncStatus(
    NEXUS_FrontendHandle handle,
    NEXUS_FrontendOfdmStatus *pStatus /* [out] */
    )
{
    BDBG_ASSERT(NULL != handle);
    BDBG_ASSERT(NULL != pStatus);

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

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

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