source: svn/newcon3bcm2_21bu/BSEAV/lib/si/a56/nim/si_nim_cdt.h

/***************************************************************
**
** Broadcom Corp. Confidential
** Copyright 2003-2012 Broadcom Corp. All Rights Reserved.
**
** THIS SOFTWARE MAY ONLY BE USED SUBJECT TO AN EXECUTED 
** SOFTWARE LICENSE AGREEMENT BETWEEN THE USER AND BROADCOM. 
** YOU HAVE NO RIGHT TO USE OR EXPLOIT THIS MATERIAL EXCEPT 
** SUBJECT TO THE TERMS OF SUCH AN AGREEMENT.
**
** File:                si_nim_cdt.h
** Description: defines for the CDT table parse function of
**              the NIM table section. 
**
** Created: 03/08/2001 
**                      01/31/2012 modified to support A/56
**
** REVISION:
**
** $Log: $
**
**
****************************************************************/
#ifndef SI_NIM_CDT_H
#define SI_NIM_CDT_H

#define NIM_CDT_MAX_NUM_OF_CARRIRE_INDEX        256    /* p16 of ANSI/A56 */

#define NIM_CDT_SPACING_UNIM0   10                      /* in KHz */
#define NIM_CDT_SPACING_UNIM1   125                     /* in KHz */

#define NIM_CDT_FREQUENCY_UNIM0 10                      /* in KHz */
#define NIM_CDT_FREQUENCY_UNIM1 125                     /* in KHz */

#define NIM_CDT_TABLE_SIZE      5                               /* size of CDT in bytes. */

/* For the following, refer to table 5.3 of ANSI/A56 */
#define NIM_CDT_NUMBER_OF_CARRIERS_BYTE_INDX    0
#define NIM_CDT_NUMBER_OF_CARRIERS_BYTE_NUM    1
#define NIM_CDT_NUMBER_OF_CARRIERS_SHIFT    0
#define NIM_CDT_NUMBER_OF_CARRIERS_MASK    0xff

#define NIM_CDT_SPACING_UNIM_BYTE_INDX    1
#define NIM_CDT_SPACING_UNIM_BYTE_NUM    1
#define NIM_CDT_SPACING_UNIM_BYTE_SHIFT    7
#define NIM_CDT_SPACING_UNIM_BYTE_MASK    0x01

#define NIM_CDT_FREQUENCY_SPACING_BYTE_INDX    1
#define NIM_CDT_FREQUENCY_SPACING_BYTE_NUM    2
#define NIM_CDT_FREQUENCY_SPACING_BYTE_SHIFT    0
#define NIM_CDT_FREQUENCY_SPACING_BYTE_MASK    0x3fff

#define NIM_CDT_FREQUENCY_UNIM_BYTE_INDX    3
#define NIM_CDT_FREQUENCY_UNIM_BYTE_NUM    1
#define NIM_CDT_FREQUENCY_UNIM_BYTE_SHIFT    7
#define NIM_CDT_FREQUENCY_UNIM_BYTE_MASK    0x01

#define NIM_CDT_FIRST_CARRIER_FREQUENCY_BYTE_INDX    3
#define NIM_CDT_FIRST_CARRIER_FREQUENCY_BYTE_NUM    2
#define NIM_CDT_FIRST_CARRIER_FREQUENCY_BYTE_SHIFT    0
#define NIM_CDT_FIRST_CARRIER_FREQUENCY_BYTE_MASK    0x7fff

typedef struct NIM_CDT_INFO 
{
        unsigned char idx;
        unsigned short freq_khz;
} NIM_CDT_INFO;

typedef struct SI_NIM_CDT_Callback_t
{
        void (*cb)(NIM_CDT_INFO *pCDT, void *data);
        void * data;
}SI_NIM_CDT_Callback_t;

#ifdef __cplusplus
extern "C" {
#endif

void SI_NIM_CDT_Init (SI_NIM_CDT_Callback_t *cb);
unsigned char SI_NIM_CDT_parse (unsigned char * cds_record, unsigned char idx);

#ifdef __cplusplus
}
#endif

#endif