hamaro_defs.h

机顶盒Hamaro解调器驱动。包含自动搜台

/* cobra_defs.h */

/*+++ *******************************************************************\
*
*   Copyright and Disclaimer:
*
*       ---------------------------------------------------------------
*       ALL SOFTWARE, APPLICATIONS, DOCUMENTATION, OR MATERIALS        
*       FURNISHED HEREIN IS PROVIDED *AS IS*.  CONEXANT DOES NOT MAKE  
*       ANY WARRANTIES, EITHER EXPRESS OR IMPLIED, AND HEREBY EXPRESSLY
*       DISCLAIMS ANY AND ALL SUCH WARRANTIES TO THE EXTENT PERMITTED  
*       BY LAW, INCLUDING, SPECIFICALLY, ANY IMPLIED WARRANTY ARISING  
*       BY STATUTE OR OTHERWISE IN LAW OR FROM A COURSE OF DEALING OR  
*       USAGE OF TRADE.  CONEXANT DOES NOT MAKE ANY WARRANTIES, EITHER 
*       EXPRESS OR IMPLIED, AND HEREBY EXPRESSLY DISCLAIMS ANY AND ALL 
*       SUCH WARRANTIES WITH RESPECT TO ALL SOFTWARE, APPLICATIONS,    
*       DOCUMENTATION, AND MATERIALS INCLUDING ALL IMPLIED WARRANTIES  
*       OF MERCHANTABILITY, OR OF MERCHANTABLE QUALITY, OR OF FITNESS  
*       FOR ANY PURPOSE, PARTICULAR, SPECIFIC OR OTHERWISE, OR OF      
*       NONINFRINGEMENT OF INTELLECTUAL PROPERTY RIGHTS OF OTHERS,     
*       RELATING TO THE SOFTWARE, APPLICATIONS, OPERATION,             
*       DOCUMENTATION, DATA OR RESULTS GENERATED BY THE OPERATION OR   
*       USE THEREOF, AND MATERIALS PROVIDED HEREIN.  THE ENTIRE RISK AS
*       TO THE SUBSTANCE, QUALITY AND PERFORMANCE OF SOFTWARE,         
*       APPLICATIONS, AND DOCUMENTATION DESCRIBING SUCH SOFTWARE       
*       REMAINS WITH THE BUYER.                                        
*                                                                      
*       REGARDLESS OF WHETHER ANY REMEDY SET FORTH HEREIN FAILS OF ITS 
*       ESSENTIAL PURPOSE OR OTHERWISE, CONEXANT SHALL NOT BE LIABLE   
*       FOR ANY EXEMPLARY, SPECIAL, PUNITIVE, SPECULATIVE, INDIRECT,   
*       CONSEQUENTIAL OR INCIDENTAL DAMAGES OF ANY KIND (INCLUDING     
*       WITHOUT LIMITATION LOST PROFITS, LOSS OF INCOME, LOSS OF       
*       GOODWILL, OR OTHER TANGIBLE OR INTANGIBLE BUSINESS LOSS)       
*       ARISING OUT OF OR IN CONNECTION WITH, DIRECTLY OR INDIRECTLY,  
*       SOFTWARE, APPLICATIONS, DOCUMENTATION, OR ANY SERVICES OR      
*       MATERIALS PROVIDED HEREUNDER, OR USE OR INABILITY TO USE THE   
*       SOFTWARE, EVEN IF CONEXANT HAS BEEN ADVISED OF THE POSSIBILITY 
*       OF SUCH DAMAGES.                                               
*
*       Copyright (c) 2001 Conexant Systems, Inc.
*       All Rights Reserved.
*       ---------------------------------------------------------------
*
*   Module Revision Id:
*
*       $Header: hamaro_defs.h, 13, 2007-8-17 15:36:41, Tim Lu$
*
*   Abstract:
*
*       Contains common definitions and typedefs used throughout the 
*       Cobra Driver software.
*
\******************************************************************* ---*/

#ifndef HAMARO_DEFS_H_DEFINED
#define HAMARO_DEFS_H_DEFINED

/*******************************************************************************************************/

#ifndef NULL
#define NULL  0
#endif
#ifndef CNULL
#define CNULL  '\0'
#endif

#ifndef TRUE
#define TRUE    1                    /* from msdn: The bool type participates in integral promotions.*/
#define FALSE   0                    /* ... An r-value of type bool can be converted to an r-value */
#endif                               /* ... of type int, with false becoming zero and true becoming one.*/

#ifndef True
#define True    TRUE 
#define False   FALSE
#endif               

/*******************************************************************************************************/
/* common-use types */
/*******************************************************************************************************/
#ifndef BOOL
typedef int     BOOL;
#endif  /* BOOL */

/*******************************************************************************************************/
/* common-use equivs */
/*******************************************************************************************************/
typedef int            HAMARO_AGCACC;
typedef unsigned char  HAMARO_INTEROPTS;
typedef unsigned long  HAMARO_SYMBRATE;
typedef unsigned char  HAMARO_VCONO;
typedef BOOL           HAMARO_VCOINIT;

/*******************************************************************************************************/
/* function prototypes passed by application (aka user) */
/*******************************************************************************************************/
typedef unsigned char   HAMARO_SBaddress;
typedef unsigned long*  HAMARO_SBstatus;
typedef unsigned long (*HAMARO_READ_SB)(unsigned long, HAMARO_SBaddress, HAMARO_SBstatus);         /* type pointer to function to read byte to ser.bus */
typedef void (*HAMARO_WRITE_SB)(unsigned long, HAMARO_SBaddress, unsigned long, HAMARO_SBstatus);  /* type pointer to function to write byte to ser.bus */

/*******************************************************************************************************/
/* common equates */
/*******************************************************************************************************/
#define HAMARO_INTR_POLLING          HAMARO_INTR_CLEAR   /* Interrupt processing will be polled */
#define HAMARO_SPEC_INV_BOTH         HAMARO_SPEC_INV_ON_BOTH    /*   equiv to search -inv, failing that, search inv */
#define HAMARO_ROSIE_TYPE_STRING    "CX24108/109"
#define HAMARO_VIPER_TYPE_STRING	"CX24118/128"
#define HAMARO_RATTLER_TYPE_STRING	"CX24113"

/*******************************************************************************************************/
/*                               --- Demod Handle Management ---                                       */
/*******************************************************************************************************/
#define HAMARO_DEMOD_HANDLE_I2C_ADDR_MASK      0x000000FF 
#define HAMARO_DEMOD_HANDLE_I2C_ADDR_SHIFT     0UL 
#define HAMARO_DEMOD_HANDLE_UNIT_MASK          0x00000100 
#define HAMARO_TUNER_HANDLE_UNIT_MASK          0x00000200 
#define HAMARO_DEMOD_HANDLE_UNIT_SHIFT         8UL 
#define HAMARO_TUNER_HANDLE_UNIT_SHIFT         9UL 
#define HAMARO_DEMOD_HANDLE_CLIENT_MASK        0xFFFF0000 
#define HAMARO_DEMOD_HANDLE_CLIENT_SHIFT       16UL 

#define HAMARO_DEMOD_HANDLE_RESERVED_MASK      ~(HAMARO_DEMOD_HANDLE_I2C_ADDR_MASK | \
                                                HAMARO_DEMOD_HANDLE_UNIT_MASK     | \
                                                HAMARO_DEMOD_HANDLE_CLIENT_MASK) 

/* Access macros allowing position independent extraction and insertion of handle fields */
#define HAMARO_GET_DEMOD_HANDLE_I2C_ADDR(handle) \
   (((handle) & HAMARO_DEMOD_HANDLE_I2C_ADDR_MASK) >> HAMARO_DEMOD_HANDLE_I2C_ADDR_SHIFT)

#define HAMARO_GET_DEMOD_HANDLE_CLIENT_INFO(handle) \
   (((handle) & HAMARO_DEMOD_HANDLE_CLIENT_MASK) >> HAMARO_DEMOD_HANDLE_CLIENT_SHIFT)
       
#define HAMARO_GET_DEMOD_HANDLE_UNIT(handle) \
   (((handle) & HAMARO_DEMOD_HANDLE_UNIT_MASK) >> HAMARO_DEMOD_HANDLE_UNIT_SHIFT)