hamaro_enum.h

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

/* cobra_enum.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_enum.h, 10, 2006-10-20 2:12:16, Xiao Dong Zhang$
*
*   Abstract:
*
*       Contains common enums used within the Hamaro Driver software.
*
\******************************************************************* ---*/

#ifndef HAMARO_ENUMS_H_DEFINED
#define HAMARO_ENUMS_H_DEFINED

#include "hamaro_defs.h"                  /* TRUE and FALSE from cobra_defs file is needed, so added */

/*******************************************************************************************************/
/* error codes */
/*******************************************************************************************************/
typedef enum  HAMAROErrno{                /* standardized method to relate error numbers to err strings */
  HAMARO_NOERR = 0,                       /*   0 = no error.  (first enum err item must be 0) */
  HAMARO_BADPTR,                          /*   bad pointer value passed by caller */
  HAMARO_INVALID_NIM,                     /*   HAMARO_NIM passed was invalid */
  HAMARO_NIM_OPENED,                      /*   HAMARO_NIM passed was already opened */
  HAMARO_SBIO_NULL,                       /*   user-supplied SBRead or SBWrite funct is NULL */
  HAMARO_TIMER_NULL,                      /*   timer function was NULL or invalid */
  HAMARO_NIM_NULL,                        /*   nim passed by caller is NULL */
  HAMARO_IO_READERR,                      /*   error encountered at read demod */
  HAMARO_IO_WRITERR,                      /*   error encountered at write demod */
  HAMARO_INVALID_TUNER,                   /*   tuner type is not valid (or not supported by driver) */
  HAMARO_TUNER_PARMS,                     /*   tuner parms passed was NULL */
  HAMARO_CONST_IQBUF,                     /*   NULL pointer passed at HAMARO_ConstGetPoints() */
  HAMARO_CONST_IQLOW,                     /*   caller asked for more constl pts than are currently recorded */
  HAMARO_RANGE,                           /*   Warning: caller wrote register with value out-of-bounds */
  HAMARO_BAD_PARM,                        /*   bad parameter passed by caller -- see file/line to determine error */
  HAMARO_PARM_RANGE,                      /*   parm value passed was out of valid range */
  HAMARO_SETILLEGAL,                      /*   caller asked to set demod into a condition that is illegal. */
  HAMARO_BAD_RTNVAL,                      /*   unexpected return value received from hardware (register) */
  HAMARO_LOCKIND_ERR,                         /*   unable to read a lockind at HAMARO_GetLockIndicators() */
  HAMARO_REG_MATCH_IDX,                       /*   register array is corrupt */
  HAMARO_REG_HDWR_REWTERR,                    /*   hardware read,mask,write error during write op */
  HAMARO_REG_MATCH_TRX,                       /*   raw data to external data translation error */
  HAMARO_REG_MATCH_DTRX,                      /*   external data to raw data translation error */
  HAMARO_REG_VERFY_IDX,                       /*   register map index does not match linear position */
  HAMARO_REG_VERFY_ADDR,                      /*   reg.map addr variable is inconsistent with expected range */
  HAMARO_REG_VERFY_REGRW,                     /*   reg.map regrw field contains invalid data */
  HAMARO_REG_VERFY_REGFLT,                    /*   reg.map regfilter field contains invalid data */
  HAMARO_REG_VERFY_REGDTP,                    /*   reg.map regdaattype field contains invalid data */
  HAMARO_REG_VERFY_DFLT,                      /*   reg.map default value is out of bounds */
  HAMARO_REG_VERFY_BCNT,                      /*   reg.map bit count/length values are questionable */
  HAMARO_REG_VERFY_DTLEN,                     /*   regdatatype field/len error (i.e. field is bit, but length > 1bit) */
  HAMARO_REG_HDWR_REGRDO,                     /*   reg.map:  Write attempted to read-only register */
  HAMARO_REG_HDWR_REGWTO,                     /*   reg.map:  read attempted to write-only register */
  HAMARO_INIT_XTAL,                       /*   initenv...() - crystal freq is out-of-bounds */
  HAMARO_INIT_VCO,                        /*   initenv...() - vcoinit is neither True not False */
  HAMARO_INIT_MPEG,                       /*   initenv...() - mpeg (default settings) struct is NULL */
  HAMARO_INIT_TUNER,                      /*   initenv...() - tuner parm passed is invalid */
  HAMARO_DEMOD_ERR,                       /*   demod register read has invalid setting */
  HAMARO_VITSETTING,                      /*   demod viterbi setting is zero */
  HAMARO_ERRBYTE,                         /*   demod is not set to return BYTE error counts */
  HAMARO_NOTSUPPORT,                      /*   feature not supported by driver */
  HAMARO_IQ_NULL,                         /*   HAMARO_IQPAK pointer was NULL */
  HAMARO_INVALID_VCONO,                           /*   invalid vco number selected in driver */
  HAMARO_TUNERTYPE,                       /*   tuner type is invalid */
  HAMARO_BAD_BP,                          /*   attempt to set breakpoint percentage with invalid breakpoint% */
  HAMARO_BAD_CXCTL,                       /*   Invalid setting for tuner control bits (bit2 20, 19) */
  HAMARO_BAD_CXDATA,                      /*   data to be sent to tuner fails range check */
  HAMARO_BAD_CXMETH,                      /*   tuner i/o method is invalid see TUNER_io_method setting */
  HAMARO_TUNERERR,                        /*   tuner -> unable to set tuner to default i/o settings */
  HAMARO_TUNERIO,                         /*   tuner -> unable to perform i/o to tuner */
  HAMARO_TUNEREDGE,                       /*   unable to find a tuner edge */
  HAMARO_BAD_DIV,                         /*   API: Averted div by zero error -- results are undef */
  HAMARO_BAD_TUNERPARMS,                      /*   tunerparms passed by caller contains invalid settings */
  HAMARO_VITSET,                          /*   viterbi settings are incorrect */
  HAMARO_IQ_IO,                           /*   unable to read I, Q pairs from hardware (shared reg.) */
  HAMARO_CXTYPE,                          /*   unable to determine demod type (CxType) */
  HAMARO_BADCXDATABND,                    /*   band data sent to tuner fails data range test */
  HAMARO_BADCXDATAVGA,                    /*   vga data sent to tuner fails data range test */
  HAMARO_BADCXDATAVCA,                    /*   vca data sent to tuner fails data range test */
  HAMARO_BADCXDATAPLL,                    /*   pll data sent to tuner fails data range test */
  HAMARO_TUNERREF,                        /*   invalid tuner reference divider setting */
  HAMARO_TUNERVCO,                        /*   No valid VCO exists for the selected frequency */
  HAMARO_LNB_MSGLEN,                      /*   LNB message less-than 3 bytes in length */
  HAMARO_LNB_STALLED,                     /*   LNB message could not be sent in time allocated */
  HAMARO_LNB_BUSY,                        /*   LNB message busy flag is not set (should be set) */
  HAMARO_DEMOD_REVB_SINGLE,               /*   (invalid use of Rev B SW) */
  HAMARO_DISEQC_RXLEN,                    /*   Rx buffer passed-into API was too short */
  HAMARO_DISEQC_VERSION,                  /*   Wrong version to Rx Diseqc Messages */
  HAMARO_DISEQC_TIMEOUT,                  /*   demod took to long to rx diseqc message */
  HAMARO_PDMFOUT,                         /*   error setting pdmfout register */
  HAMARO_BAD_TUNER_FREQ,                  /*   the tuner frequency is outside the LNB search range limit */
  HAMARO_SCE_DEADLOCK,                    /*   symbol clock estimator deadlocks */
  HAMARO_DEMOD_UNSUPPORTED,               /*   demod is not supported by the driver */
                                       /* --> insert error codes above this point */
  HAMARO_EOERR,                           /*   this item must be last "valid" error number */
  HAMARO_NEGONE=0xffff                    /*   (Special OP used in 2115 to get last error encountered */
} HAMAROERRNO;

/*******************************************************************************************************/
/* Register index */
/*******************************************************************************************************/
typedef enum HAMARORegIdx{                   /* register simplification ID -- this enum list MUST be in EXACT       */
                                       /* sequential order as entered in REGISTER struct.  When the driver   */
                                       /* is first started, each entry in REGISTER is tested for validity.   */
  CX2430X_RSTHAMARO=0,                  /* first entry must be set to zero */
  CX2430X_RSTCTL,                      
  CX2430X_RSTBTL,
  CX2430X_RSTDEMOD,
  CX2430X_ACQREACQUIRE,
  CX2430X_RSTVITERBI,
  CX2430X_RSTRS,
  CX2430X_SYSPRESET,
  CX2430X_SYSRESET,
  CX2430X_SYSVERSION,
  CX2430X_PLLMULT,
  CX2430X_PLLGAIN,
  CX2430X_MODULATIONREG,               
  CX2430X_SYSMODTYPE,
  CX2430X_SYSTRANSTD,
  CX2430X_ACQAUTOACQEN,
  CX2430X_MPGDATAWIDTH,
  CX2430X_MPGGAPCLK,
  CX2430X_MPGCLKPOS,
  CX2430X_MPGNULLDATAVAL,
  CX2430X_MPGFIXNULLDATAEN,
  CX2430X_MPGSYNCPUNC,
  CX2430X_MPGFAILMODE,                 /* added */
  CX2430X_MPGFAILPOL,                  /* added */
  CX2430X_MPGVALIDMODE,                /* added */
  CX2430X_MPGVALIDPOL,                 /* added */
  CX2430X_MPGSTARTMODE,
  CX2430X_MPGSTARTPOL,
  CX2430X_MPGTEIDIS,
  CX2430X_MPGFAILNSVAL,
  CX2430X_MPGPARSEL,
  CX2430X_MPGCNTL3SEL,
  CX2430X_MPGCNTL1SEL,
  CX2430X_MPGCNTL2SEL,
  CX2430X_MODULEVER,
  CX2430X_SYSSYMBOLRATE,
  CX2430X_ACQPRFREQNOMMSB, //0x0b[7:8]
  CX2430X_ACQPRFREQNOMSIGN,//0x0c[4:1]
  CX2430X_ACQPRFREQNOMLSB, //0x0c[3:4]
  CX2430X_DMDSAMPLEGAIN,   //0x0c[7:3]
  CX2430X_ACQFREQRANGE,
  CX2430X_ACQVITSINOM,
  CX2430X_ACQVITCRNOM,
  CX2430X_ACQCREN,
  CX2430X_ACQSISEARCHDIS,
  CX2430X_ACQREPEATCR,
  CX2430X_BTLLOCKTHD,
  CX2430X_BTLLOCKCLR,
  CX2430X_BTLLOCKGAIN,
  CX2430X_BTLLOCKDEC,
  CX2430X_BTLLOCKINC,
  CX2430X_BTLASXEI2CERR, 
  CX2430X_BTLUSESYMRDWR, 
  CX2430X_BTLUSESHORTRW, 
  CX2430X_BTLUSEWIDERW,  
  CX2430X_BTLLOCK,         
  CX2430X_ACQFULLSYNC,
  CX2430X_ACQDEINTSYNC,
  CX2430X_ACQSYNCBYTESYNC,
  CX2430X_ACQVITSYNC,
  CX2430X_ACQDMDSYNC,
  CX2430X_SYNCSTATUS,
  CX2430X_PLLLOCK,
  CX2430X_ACQPRFREQCURR,
  
  CX2430X_ACQPRFREQCURRMSB, //0x15[7:8]
  CX2430X_ACQPRFREQCURRSIGN,//0x16[4:1]
  CX2430X_ACQPRFREQCURRLSB, //0x16[3:4]

  CX2430X_ACQPRFREQRDSEL,
  CX2430X_ESNOSTART,
  CX2430X_ESNORDY,
  CX2430X_ESNOCOUNT,
  CX2430X_ACQVITNORMCOUNT,
  CX2430X_ACQVITCURRSI,
  CX2430X_ACQVITCURRCR,
  CX2430X_BERSTART,
  CX2430X_STARTPNBER,
  CX2430X_BERREADY,
  CX2430X_BERCOUNT_RS,
  CX2430X_BERCOUNT,                    /* added */

  CX2430X_EQADAPTMODE,
  CX2430X_EQBWSEL,   
  
  CX2430X_TUNBURSTBUSY,
  CX2430X_TUNBURSTRDY,
  CX2430X_TUNBURSTCLKRATE,
  CX2430X_TUNDATABIT,
  CX2430X_TUNCLKBIT,
  CX2430X_TUNENBIT,
  CX2430X_TUNPLLLOCK,
  CX2430X_TUNBURSTDIS,
  CX2430X_TUNBURSTCLKPOL,
  CX2430X_TUNBURSTLENGTH,
  CX2430X_TUNBURSTDATA,

  CX2430X_TUNI2CRPTEN, //0x23[6:1]
  CX2430X_TUNI2CRPTSTART,