source: svn/newcon3bcm2_21bu/BSEAV/lib/si/a56/nim/si_nim.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.h
** Description: defines for the NIM table section. 
**
** Created: 03/08/2001 
**                      1/31/2012, modified for A56 support
**
** REVISION:
**
** $Log: $
**
**
****************************************************************/
#ifndef SI_NIM_H
#define SI_NIM_H

#include "si_nim_cdt.h"
#include "si_nim_mmt.h"
#include "si_transmission_medium.h"

/* For the following, refer to table 5.1 of ANSI/A/56 03 Jan 96 */
#define NIM_TABLE_ID_BYTE_INDX                  0
#define NIM_TABLE_ID_BYTE_NUM                   1
#define NIM_TABLE_ID_SHIFT                              0
#define NIM_TABLE_ID_MASK                               0xff

#define NIM_SECTION_LENGTH_BYTE_INDX    1
#define NIM_SECTION_LENGTH_BYTE_NUM             2
#define NIM_SECTION_LENGTH_SHIFT                0
#define NIM_SECTION_LENGTH_MASK                 0x0fff

#define NIM_PROTOCOL_VERSION_BYTE_INDX  3
#define NIM_PROTOCOL_VERSION_BYTE_NUM   1
#define NIM_PROTOCOL_VERSION_SHIFT              0
#define NIM_PROTOCOL_VERSION_MASK               0x1f

#define NIM_FIRST_INDEX_BYTE_INDX               4
#define NIM_FIRST_INDEX_BYTE_NUM                1
#define NIM_FIRST_INDEX_SHIFT                   0
#define NIM_FIRST_INDEX_MASK                    0xff

#define NIM_NUMBER_OF_RECORDS_BYTE_INDX 5
#define NIM_NUMBER_OF_RECORDS_BYTE_NUM  1
#define NIM_NUMBER_OF_RECORDS_SHIFT             0
#define NIM_NUMBER_OF_RECORDS_MASK              0xff

#define NIM_TRANSMISSION_MEDIUM_BYTE_INDX       6
#define NIM_TRANSMISSION_MEDIUM_BYTE_NUM        1
#define NIM_TRANSMISSION_MEDIUM_SHIFT   4
#define NIM_TRANSMISSION_MEDIUM_MASK    0x0f

#define NIM_TABLE_TYPE_BYTE_INDX                6
#define NIM_TABLE_TYPE_BYTE_NUM                 1
#define NIM_TABLE_TYPE_SHIFT                    0
#define NIM_TABLE_TYPE_MASK                             0x0f

/* For the following, refer to table 5.2 of ANSI/A56 1996 */
typedef enum {
        NIM_TT_INVALID,
        NIM_TT_CDT,             
        NIM_TT_MMT,
        NIM_TT_SIT,
        NIM_TT_TDT
} NIM_TABLE_TYPE;

#ifdef __cplusplus
extern "C" {
#endif

void SI_NIM_Init (SI_NIM_CDT_Callback_t *p_cdt_cb,
        SI_NIM_MMT_Callback_t *p_mmt_cb,
        unsigned char NIM_CDT_Version_Number,
        unsigned char NIM_MMT_Version_Number);

SI_RET_CODE SI_NIM_parse (unsigned char * nit_table);
bool SI_NIM_CDT_Complete(void);
bool SI_NIM_MMT_Complete(void);

#ifdef __cplusplus
}
#endif

#endif