source: svn/trunk/newcon3bcm2_21bu/BSEAV/lib/si/a56/vcm/si_vcm.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_vcm.h
** Description: defines and headers for function that parses the 
**                              VCM table sections.
**
** Created: 03/08/2001 
**                      02/01/2012 modified for A56 support
**
** REVISION:
**
** $Log: $
**
**
****************************************************************/

#ifndef SI_VCM_H
#define SI_VCM_H

#include "si_vcm_vct.h"

typedef enum 
{
        VCT,    /* virtual channel table */
        DCM,    /* defined channels map */
        ICT,    /* inverse channel table */
} VCM_TABLE_SUBTYPE;

/* For the following, refer to table 5.15 of A56 1996 */
#define VCM_TABLE_ID_BYTE_INDX                  0
#define VCM_TABLE_ID_BYTE_NUM                   1
#define VCM_TABLE_ID_SHIFT                              0
#define VCM_TABLE_ID_MASK                               0xff

#define VCM_SECTION_LENGTH_BYTE_INDX    1
#define VCM_SECTION_LENGTH_BYTE_NUM             2
#define VCM_SECTION_LENGTH_SHIFT        0
#define VCM_SECTION_LENGTH_MASK                 0x0fff

#define VCM_PROTOCOL_VERSION_BYTE_INDX  3
#define VCM_PROTOCOL_VERSION_BYTE_NUM   1
#define VCM_PROTOCOL_VERSION_SHIFT              0
#define VCM_PROTOCOL_VERSION_MASK               0x1f

#define VCM_TRANS_MEDIUM_BYTE_INDX              4
#define VCM_TRANS_MEDIUM_BYTE_NUM               1
#define VCM_TRANS_MEDIUM_SHIFT                  4
#define VCM_TRANS_MEDIUM_MASK                   0xf

#define VCM_TABLE_SUBTYPE_BYTE_INDX             4
#define VCM_TABLE_SUBTYPE_BYTE_NUM              1
#define VCM_TABLE_SUBTYPE_SHIFT                 0
#define VCM_TABLE_SUBTYPE_MASK                  0xf

#define VCM_VCT_ID_BYTE_INDX                    5
#define VCM_VCT_ID_BYTE_NUM                             2
#define VCM_VCT_ID_SHIFT                                0
#define VCM_VCT_ID_MASK                                 0xffff

#ifdef __cplusplus
extern "C" {
#endif

void SI_VCM_Init(SI_VCM_VCT_Callback_t *cb,unsigned char VCM_VCT_version_number);
SI_RET_CODE SI_VCM_parse (unsigned char * table);
bool SI_VCM_Complete(void);

#ifdef __cplusplus
}
#endif

#endif