source: svn/newcon3bcm2_21bu/nexus/app/bapp_tune.h

/******************************************************************************
 *    (c)2008-2009 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:  $
 * $brcm_Revision:  $
 * $brcm_Date:  $
 *
 * Module Description:
 *
 * Revision History:
 *
 * Created: 09/28/2009 by Jeff Fisher
 *
 * $brcm_Log:  $
 * 
 *
 *****************************************************************************/
#ifndef BAPP_TUNE_H__
#define BAPP_TUNE_H__
#include "bapp_event.h"
#include "bapp_freq_table.h"
/**
Summary:
        main  reference obtained bapp_tune
**/

typedef struct bapp_tune *bapp_tune_t;
/**
Summary:
        Frontend type
**/

typedef enum bapp_tune_type_t
{
        eTUNE_TYPE_QAM,
        eTUNE_TYPE_VSB
}bapp_tune_type_t;

/**
Summary:
        Signal status structure 
**/
typedef struct bapp_tune_event_t
{
        bapp_event_type_t type;         /* application event type ID */
    unsigned int     id;
    unsigned int        lock;
        unsigned int    power;
        unsigned int    ticks;
        unsigned int    SNR;
        unsigned int    freq_hz;
        int                             mode;
}bapp_tune_event_t;

#ifdef __cplusplus
extern "C" {
#endif

/**
Summary:
        Return a bapp_tune handle if frontend exists.
**/
bapp_result_t bapp_tune_open(bapp_tune_type_t fe_type, 
                                                         bapp_tune_t *p_tune, 
                                                         int *band);
/**
Summary:
        Release resources.
**/
bapp_result_t bapp_tune_close(bapp_tune_t p_tune);


/**
Summary:
        Lock the frontend.
**/
bapp_result_t bapp_tune_lock(bapp_tune_t p_tune, 
                                                         unsigned int freq_hz);
/**
Summary:
        Unlock the frontend.
**/
bapp_result_t bapp_tune_unlock(bapp_tune_t p_tune);

/*
Summary:
        Send frontend status event to the application.
*/

void bapp_tune_send_status(bapp_tune_t p_tune);

#ifdef __cplusplus
}
#endif

#endif /* BAPP_TUNE_H__ */