bp_cmd_vm.h

#ifndef __BP_CMD_VM_H__
#define __BP_CMD_VM_H__

//#define FW_HEADER_DEF  1

#ifndef FW_HEADER_DEF
#ifndef U32_T
typedef unsigned int            U32_T;          /* 32-bit unsigned */
typedef unsigned short int      U16_T;          /* 16-bit  unsigned */
typedef unsigned char           U8_T;           /* 8-bit unsigned */
#endif
#endif
typedef U8_T                    byte;


//#ifndef FW_HEADER_DEF
    #pragma pack(push)  /* push current alignment to stack */
    #pragma pack(1)     /* set alignment to 1 byte boundary */
//#endif


/******************************************************\
*                                                      * 
*      COMMUNICATION PROTOCOL SPECIFICATION            *
*                                                      * 
*	  <COMMAND_ID><COMMAND_LEN><COMMAND_DATA>          *
*                                                      *
\******************************************************/

/*
 * BP cmd IDs
 */
#define	CMD_VM_GET_BYPASS_CAPS				1
#define CMD_VM_GET_WD_SET_CAPS				2
#define CMD_VM_SET_BYPASS					3
#define CMD_VM_GET_BYPASS					4
#define CMD_VM_GET_BYPASS_CHANGE			5
#define CMD_VM_SET_BYPASS_WD				6
#define CMD_VM_GET_BYPASS_WD				7
#define CMD_VM_GET_WD_EXPIRE_TIME			8
#define CMD_VM_RESET_BYPASS_WD_TIMER		9
#define CMD_VM_SET_DIS_BYPASS				10
#define CMD_VM_GET_DIS_BYPASS				11
#define CMD_VM_SET_BYPASS_PWOFF			12
#define CMD_VM_GET_BYPASS_PWOFF			13
#define CMD_VM_SET_BYPASS_PWUP				14
#define CMD_VM_GET_BYPASS_PWUP				15
#define CMD_VM_SET_STD_NIC					16
#define CMD_VM_GET_STD_NIC					17
#define CMD_VM_SET_TAP						18
#define CMD_VM_GET_TAP						19        
#define CMD_VM_GET_TAP_CHANGE				20
#define CMD_VM_SET_DIS_TAP					21
#define CMD_VM_GET_DIS_TAP					22
#define CMD_VM_SET_TAP_PWUP				23 
#define CMD_VM_GET_TAP_PWUP				24
#define CMD_VM_SET_WD_EXP_MODE				25                       
#define CMD_VM_GET_WD_EXP_MODE				26
#define CMD_VM_SET_DISC					27
#define CMD_VM_GET_DISC					28         
#define CMD_VM_GET_DISC_CHANGE				29
#define CMD_VM_SET_DIS_DISC				30
#define CMD_VM_GET_DIS_DISC				31
#define CMD_VM_SET_DISC_PWUP				32 
#define CMD_VM_GET_DISC_PWUP				33

#define CMD_VM_SET_WD_AUTORESET            34
#define CMD_VM_GET_WD_AUTORESET            35

#define CMD_VM_SET_TPL                     36
#define CMD_VM_GET_TPL                     37
#define CMD_VM_GET_BYPASS_SLAVE            38
#define CMD_VM_IS_BYPASS                   39
#define CMD_VM_SET_TX                      40
#define CMD_VM_GET_TX                      41


#define CMD_VM_GET_BYPASS_INFO				100
#define CMD_VM_GET_BP_WAIT_AT_PWUP			101
#define CMD_VM_SET_BP_WAIT_AT_PWUP			102
#define CMD_VM_GET_BP_HW_RESET				103
#define CMD_VM_SET_BP_HW_RESET				104
#define CMD_VM_SET_BP_MANUF				105

#define CMD_VM_GET_BPNIC_INFO			106
#define CMD_VM_GET_BP_PCI_INFO			    107
#define CMD_VM_GET_BP_ALL_INFO			    108


#define CMD_VM_GET_BP_DEV_NUM      	    109
#define CMD_VM_GET_BP_DRV_VER      	    110
#define CMD_VM_GET_BP_OEM_DATA      	    111

#define CMD_VM_SET_BP_BLINK               112



typedef U8_T cmd_vm_id_t;



/*
 * BP cmd response codes
 */
#define BP_ERR_OK						1
#define BP_ERR_NOT_CAP					2
#define BP_ERR_DEV_BUSY					3
#define BP_ERR_INVAL_DEV_NUM			4 
#define BP_ERR_INVAL_STATE				5 
#define BP_ERR_INVAL_PARAM				6 
#define BP_ERR_UNSUPPORTED_PARAM		7 
#define BP_ERR_INVAL_CMD				8 
#define BP_ERR_UNSUPPORTED_CMD			9 
#define BP_ERR_INTERNAL					10
#define BP_ERR_UNKNOWN					11

typedef U8_T cmd_vm_rsp_id_t;




typedef U8_T cmd_vm_bp_board_t;



/*
 * BP device info
 */
typedef struct _cmd_vm_bp_info_t {
    cmd_vm_bp_board_t dev_id;
    byte fw_ver;
}cmd_vm_bp_info_t;


/*
 * BP command device number
 */
#define  DEV_NUM_MAX 4
typedef U8_T cmd_vm_dev_num_t;


/*
 * BP command data lenth type
 */
typedef U8_T cmd_vm_data_len_t;


/*
 * BP command data structure
 */
typedef union _cmd_vm_data_t {
#if 0
    /* 
     * CMD_GET_BYPASS_CAPS
     */
#define BP_CAP                   BIT0
#define BP_STATUS_CAP            BIT1
#define BP_STATUS_CHANGE_CAP     BIT2
#define SW_CTL_CAP               BIT3
#define BP_DIS_CAP               BIT4
#define BP_DIS_STATUS_CAP        BIT5
#define STD_NIC_CAP              BIT6
#define BP_PWOFF_ON_CAP          BIT7
#define BP_PWOFF_OFF_CAP         BIT8
#define BP_PWOFF_CTL_CAP         BIT9
#define BP_PWUP_ON_CAP           BIT10
#define BP_PWUP_OFF_CAP          BIT11
#define BP_PWUP_CTL_CAP          BIT12
#define WD_CTL_CAP               BIT13
#define WD_STATUS_CAP            BIT14
#define WD_TIMEOUT_CAP           BIT15
#define TX_CTL_CAP               BIT16  
#define TX_STATUS_CAP            BIT17  
#define TAP_CAP                  BIT18 
#define TAP_STATUS_CAP           BIT19 
#define TAP_STATUS_CHANGE_CAP    BIT20 
#define TAP_DIS_CAP              BIT21
#define TAP_DIS_STATUS_CAP       BIT22
#define TAP_PWUP_ON_CAP          BIT23
#define TAP_PWUP_OFF_CAP         BIT24
#define TAP_PWUP_CTL_CAP         BIT25
#define NIC_CAP_NEG              BIT26
#define TPL_CAP                  BIT27
#define DISC_CAP                 BIT28
#define DISC_DIS_CAP             BIT29
#define DISC_PWUP_CTL_CAP        BIT30
#endif
    U32_T bypass_caps;


    /* 
     * CMD_GET_WD_SET_CAPS
     */

    /* --------------------------------------------------------------------------------------
     * Bit	feature			description									Products
     * ---------------------------------------------------------------------------------------
     * 0-3	WD_MIN_TIME		The interface WD minimal time period in		PXG2/4BP - 5 (500mS)
     *						100mS units									All the other
     *																	products - 1(100mS)
     * ---------------------------------------------------------------------------------------
     * 4 	WD_STEP_TIME 	The steps of the WD timer in				PXG2/4BP - 0
     *						0 - for linear steps (WD_MIN_TIME * X)		All the other
     *						1 - for multiply by 2 from previous step	products - 1
     *						(WD_MIN_TIME * 2^X)
     * ---------------------------------------------------------------------------------------
     * 5-8 	WD_STEP_COUNT 	Number of register bits available for		PXG2/4BP -7
     *						configuring the WD timer. From that the		All the other
     *						number of steps the WD timer will have is	products - 4
     *						2^X (X number of bits available for
     *						defining the value)
     * ---------------------------------------------------------------------------------------
     * 9-31					RESERVED Reserved, should be ignored.
     * -------------------------------------------------------------------------------------*/

    U32_T wd_set_caps;


    /* 
     * CMD_SET_BYPASS
     */
    /* 
     * CMD_GET_BYPASS
     */
//#define BYPASS_OFF             0
//#define BYPASS_ON              1

    U8_T bypass_mode;


    /* 
     * CMD_GET_BYPASS_CHANGE
     */
#define BYPASS_NOT_CHANGED     0
#define BYPASS_CHANGED         1

    U8_T bypass_change;


    /* 
     * CMD_SET_BYPASS_WD
     */
    /* 
     * CMD_GET_BYPASS_WD
     */

    U32_T timeout;
    U32_T timeout_set;


    /* 
     * CMD_GET_WD_EXPIRE_TIME
     */

    U32_T time_left;


    /* 
     * CMD_SET_DIS_BYPASS
     */
    /* 
     * CMD_GET_DIS_BYPASS
     */
#define DIS_BYPASS_ENABLE      0
#define DIS_BYPASS_DISABLE     1

    U8_T dis_bypass;


    /* 
     * CMD_SET_BYPASS_PWOFF
     */
    /* 
     * CMD_GET_BYPASS_PWOFF
     */
#define BYPASS_PWOFF_DIS       0
#define BYPASS_PWOFF_EN        1

    U8_T bypass_pwoff;


    /* 
     * CMD_SET_BYPASS_PWUP
     */
    /* 
     * CMD_GET_BYPASS_PWUP
     */
#define BYPASS_PWUP_DIS        0
#define BYPASS_PWUP_EN         1

    U8_T bypass_pwup;


    /* 
     * CMD_SET_STD_NIC
     */
    /* 
     * CMD_GET_STD_NIC
     */
#define DEF_BYPASS_MODE        0
#define STD_NIC_MODE           1

    U8_T std_nic;


    /* 
     * CMD_SET_TAP
     */
    /* 
     * CMD_GET_TAP
     */
//#define TAP_OFF                0
//#define TAP_ON                 1

    U8_T tap_mode;


    /* 
     * CMD_GET_TAP_CHANGE
     */
#define TAP_NOT_CHANGED        0
#define TAP_CHANGED            1

    U8_T tap_change;


    /* 
     * CMD_SET_DIS_TAP
     */
    /* 
     * CMD_GET_DIS_TAP
     */
#define DIS_TAP_ENABLE         0
#define DIS_TAP_DISABLE        1

    U8_T dis_tap;


    /* 
     * CMD_SET_TAP_PWUP
     */
    /* 
     * CMD_GET_TAP_PWUP
     */
#define TAP_PWUP_DIS           0
#define TAP_PWUP_EN            1

    U8_T tap_pwup;


    /* 
     * CMD_SET_WD_EXP_MODE
     */
    /* 
     * CMD_GET_WD_EXP_MODE
     */
#define WD_EXP_MODE_BYPASS     0
#define WD_EXP_MODE_TAP        1
#define WD_EXP_MODE_DISC       2

    U8_T wd_exp_mode;


    /* 
     * CMD_SET_DISC
     */
    /* 
     * CMD_GET_DISC
     */
//#define DISC_OFF               0
//#define DISC_ON                1

    U8_T disc_mode;


    /* 
     * CMD_GET_DISC_CHANGE
     */
//#define DISC_NOT_CHANGED       0
//#define DISC_CHANGED           1

    U8_T disc_change;


    /* 
     * CMD_SET_DIS_DISC
     */
    /* 
     * CMD_GET_DIS_DISC
     */
//#define DIS_DISC_ENABLE        0
//#define DIS_DISC_DISABLE       1

    U8_T dis_disc;


    /* 
     * CMD_SET_DISC_PWUP
     */
    /* 
     * CMD_GET_DISC_PWUP
     */
//#define DISC_PWUP_DIS        0
//#define DISC_PWUP_EN         1

    U8_T disc_pwup;


    /* 
     * CMD_GET_BYPASS_INFO
     */
    cmd_vm_bp_info_t bypass_info;


    /* 
     * CMD_GET_BP_WAIT_AT_PWUP
     */
    /* 
     * CMD_SET_BP_WAIT_AT_PWUP
     */
//#define BP_WAIT_AT_PWUP_DIS    0
//#define BP_WAIT_AT_PWUP_EN     1
    U8_T bp_wait_at_pwup;


    /* 
     * CMD_GET_BP_HW_RESET
     */
    /* 
     * CMD_SET_BP_HW_RESET
     */
//#define BP_HW_RESET_DIS        0
//#define BP_HW_RESET_EN         1

    U8_T bp_hw_reset;

}cmd_vm_data_t;


/******************************************************\
*                                                      * 
*   <DEV_NUM><COMMAND_ID><COMMAND_LEN><COMMAND_DATA>   *
*                                                      *
\******************************************************/
#define BP_CMD_PACKET_SIZE   (sizeof(cmd_vm_dev_num_t)  \
                           + sizeof(cmd_vm_id_t)       \
						   + sizeof(cmd_vm_data_len_t) \
                           + sizeof(cmd_vm_data_t))

typedef union _bp_cmd_vm_t {
    byte cmd_vm_bytes[64]; //	For Byte Access

    struct {
        byte str[6];
        byte str1[6];
        byte type[2];
        U32_T multiplex_id;
        U32_T request_id;
        cmd_vm_dev_num_t   cmd_vm_dev_num;
        cmd_vm_id_t        cmd_vm_id;
        cmd_vm_data_len_t  cmd_vm_data_len;
        U32_T           cmd_vm_data;
    }cmd_vm;

}bp_cmd_vm_t;


/******************************************************\
*                                                      * 
*       <COMMAND_ID><COMMAND_LEN><COMMAND_DATA>        *
*                                                      *
\******************************************************/
#define BP_VM_RSP_PACKET_SIZE      sizeof(cmd_vm_rsp_id_t)    \
						      + sizeof(cmd_vm_data_len_t)  \
                              + sizeof(cmd_vm_data_t) 

typedef union _bp_cmd_vm_rsp_t {
    byte cmd_vm_bytes[64]; //	For Byte Access

    struct {
        byte str[6];
        byte str1[6];
        byte type[2];
        U32_T multiplex_id;
        U32_T request_id;
        cmd_vm_rsp_id_t    rsp_id;
        cmd_vm_data_len_t  rsp_data_len;
        U32_T       rsp_data;
    }rsp;
    struct {
        byte str[6];
        byte str1[6];
        byte type[2]; 
        U32_T multiplex_id;
        U32_T request_id;
        cmd_vm_rsp_id_t rsp_id; 
        byte         fw_ver;  
        byte         info[40];
    }rsp_info;   
}bp_cmd_vm_rsp_t;

#ifndef FW_HEADER_DEF
    #pragma pack(pop)  /* push current alignment to stack */
#endif

#endif /* End of __BP_CMD_VM_H__ */