r64_message_ie.h

wimax bs模拟器

/******************************************************************************
**
**    Copyright (c) 2007, UTStarcom, Inc.
**            All Rights Reserved.
**
**    Subsystem : Wimax BS
**    File      : r64_message_ie.h
**    Created By: Eric.Tang
**    Created On: 1/5/2007
**
**    Purpose:
**        This file define R64 message structure.
**    History:
**    Programmer  Date       Rev     Description
**    Eric.Tang   1/5/2007   0.0     Creating file
**    Eric.Tang/Scott 1/17   0.1     Updated accordong to new spec and Haojie's comments
******************************************************************************/

#ifndef _R64_MESSAGE_IE_H_
#define _R64_MESSAGE_IE_H_

/*PROTOCOL VERSION*/
#define R64_PROTOCOL_VERSION			1

/*function type definition*/
#define R64_FUNCTION_TYPE_QOS                    1
#define R64_FUNCTION_TYPE_HANDOFF                2
#define R64_FUNCTION_TYPE_DATA_PATH              3
#define R64_FUNCTION_TYPE_CONTEXT                4
#define R64_FUNCTION_TYPE_R3_MOBILITY            5
#define R64_FUNCTION_TYPE_PAGING                 6
#define R64_FUNCTION_TYPE_RRM                    7
#define R64_FUNCTION_TYPE_AUTH_RELAY             8
#define R64_FUNCTION_TYPE_MS_STATE_CHANGE        9
#define R64_FUNCTION_TYPE_ACCT_INFO              10

/*message type definition*/

/* 1. message type of R64_FUNCTION_TYPE_QOS    */
#define R64_ID_RESOURCE_REGISTRATION_REQUEST     1
#define R64_ID_RESOURCE_REGISTRATION_RESPONSE    2
#define R64_ID_PD_REQUEST                        3
#define R64_ID_PD_RESPONSE                       4
#define R64_ID_PR_REQUEST                        5
#define R64_ID_PR_RESPONSE                       6
#define R64_ID_LU_REQUEST                        7
#define R64_ID_LU_RESPONSE                       8

/* 2. message type of  R64_FUNCTION_TYPE_HANDOFF    */
#define R64_ID_HANDOFF_REQUEST                   1
#define R64_ID_HANDOFF_RESPONSE                  2
#define R64_ID_HANDOFF_CONFIRM                   3
#define R64_ID_HANDOFF_COMPLETE                  4
#define R64_ID_HANDOFF_ACK                       5

/* 3. message type of  R64_FUNCTION_TYPE_DATA_PATH    */
#define R64_ID_DATA_PATH_PRE_REGISTRATION_REQUEST  1
#define R64_ID_DATA_PATH_REGISTRATION_REQUEST      2
#define R64_ID_DATA_PATH_DE_REGISTRATION_REQUEST   3
#define R64_ID_DATA_PATH_MODIFICATION_REQUEST      4
#define R64_ID_DATA_PATH_PRE_REGISTRATION_RESPONSE 5
#define R64_ID_DATA_PATH_REGISTRATION_RESPONSE     6
#define R64_ID_DATA_PATH_DE_REGISTRATION_RESPONSE  7
#define R64_ID_DATA_PATH_MODIFICATION_RESPONSE     8
#define R64_ID_DATA_PATH_REGISTRATION_ACK      9
#define R64_ID_DATA_PATH_SETUP_REQUEST             10
#define R64_ID_DATA_PATH_SETUP_RESPONSE            11
#define R64_ID_DATA_PATH_MODIFY_ACK                 12
#define R64_ID_DATA_PATH_RELEASE_REQUEST           13
#define R64_ID_DATA_PATH_RELEASE_RESPONSE          14
#define R64_ID_DATA_PATH_RELEASE_ACK				15
#define R64_ID_DATA_PATH_DE_REGISTRATION_ACK	16
#define R64_ID_DATA_PATH_SETUP_ACK				17

/* 4. message type of  R64_FUNCTION_TYPE_CONTEXT    */
#define R64_ID_CONTEXT_REQUEST        1
#define R64_ID_CONTEXT_REPORT         2
#define R64_ID_CONTEXT_ACK            3
#define R64_ID_CONTEXT_RSP            4
#define R64_ID_MS_INFO_REQUEST        5
#define R64_ID_MS_INFO_RESPONSE       6

/* 5. message type of  R64_FUNCTION_TYPE_R3_MOBILITY    */
#define R64_ID_RELOCATION_REQUEST     1
#define R64_ID_RELOCATION_RESPONSE    2
#define R64_ID_RELOCATION_CONFIRM     3


/* 6. message type of  R64_FUNCTION_TYPE_PAGING    */
#define R64_ID_LOCATION_UPDATE_REQUEST      1
#define R64_ID_LOCATION_UPDATE_RESPONSE     2
#define R64_ID_LOCATION_UPDATE_CONFRIM      3
#define R64_ID_PAGING_ANNOUNCE              4
#define R64_ID_INIT_PAGING_REQ              5
#define R64_ID_INIT_PAGING_RSP              6

/* 7. message type of  R64_FUNCTION_TYPE_RRM    */
#define R64_ID_PHY_PARAMETER_REQUEST        1
#define R64_ID_PHY_PARAMETER_RESPONSE       2
#define R64_ID_SPARE_CAPACITY_REQUEST       3
#define R64_ID_SPARE_CAPACITY_RESPONSE      4

/* 8. message type of  R64_FUNCTION_TYPE_AUTH_RELAY    */
#define R64_ID_AUTH_RELAY_EAP_START                1
#define R64_ID_AUTH_RELAY_EAP_TRANSFER             2
#define R64_ID_AUTH_RELAY_AUTHENTICATED_EAP_START  3
#define R64_ID_AUTH_RELAY_AUTHENTICATED_EAP_RELAY  4

/* 9. message type of  R64_FUNCTION_TYPE_MS_STATE_CHANGE    */
#define R64_ID_DELETE_MS_CONTEXT_DIRECTIVE           1
#define R64_ID_DELETE_MS_CONTEXT_DIRECTIVE_ACK       2
#define R64_ID_IM_ENTRY_MS_STATE_CHANGE_ACK          3
#define R64_ID_IM_ENTRY_MS_STATE_CHANGE_DIRECTIVE    4
#define R64_ID_IM_ENTRY_MS_STATE_CHANGE_REQUEST      5
#define R64_ID_IM_ENTRY_MS_STATE_CHANGE_RESPONSE     6
#define R64_ID_IM_EXIT_MS_STATE_CHANGE_ACK           7
#define R64_ID_IM_EXIT_MS_STATE_CHANGE_DIRECTIVE     8
#define R64_ID_IM_EXIT_MS_STATE_CHANGE_REQUEST       9
#define R64_ID_IM_EXIT_MS_STATE_CHANGE_RESPONSE      10
#define R64_ID_NW_ENTRY_MS_STATE_CHANGE_ACK          11
#define R64_ID_NW_ENTRY_MS_STATE_CHANGE_DIRECTIVE    12
#define R64_ID_NW_ENTRY_MS_STATE_CHANGE_REQUEST      13
#define R64_ID_NW_ENTRY_MS_STATE_CHANGE_RESPONSE     14

/* 10. Message Type of ACCT function */
#define R64_ID_ACCT_INFO_REQUEST   1
#define R64_ID_ACCT_INFO_REPORT    2
#define R64_ID_ACC_INFO_ACK        3


/*macro definition*/
#define R64_MSID_LENGTH            6
#define R64_BSID_LENGTH            6

#define R64_MAX_MS_NAI_LEN         256

#define R64_MAX_EAP_MESSAGE_LEN    512

#define R64_MAX_IP_ADDR_NUM        4 /*???*/

#define R64_MAX_PHSM               40
#define R64_MAX_SF_NUM_PER_SS      4

#define R64_MAX_SBC_CONTEXT_LEN    512

#define R64_MAX_REG_CONTEXT_LEN    512

#define R64_MAX_PKM_CONTEXT_LEN    512

#define R64_MAX_TEK_CONTEXT_LEN    512

#define R64_MAX_SA_DESCRIPTOR_NUM  4

#define R64_MAX_TARGET_BS_NUM      4 /*need confirm*/

typedef enum{
    IF_TYPE_R6 = 0,
    IF_TYPE_R4 = 1
}R64_IF_TYPE_E;

typedef enum
{
    R64_CONTEXT_PURPOSE_CAPACITY_EXCHANGE = 1,
    R64_CONTEXT_PURPOSE_EAP_PROCEDURE,
    R64_CONTEXT_PURPOSE_MS_REGISTRATION,
    R64_CONTEXT_PURPOSE_HANDOFF,
    R64_CONTEXT_PURPOSE_MS_DEREGISTRATION,
    R64_CONTEXT_PURPOSE_MS_ERROR
}R64_CONTEXT_PURPOSE_INDICATOR_E;

typedef enum
{
    R64_CAUSE_SUCCESS = 0,
    R64_CAUSE_FAILURE    
}R64_CAUSE_CODE_E;

typedef enum
{
    R64_REGISTRATION_INITIAL_NW_ENTRY = 1,
    R64_REGISTRATION_PRE_DUE_TO_HANDOFF,
    R64_REGISTRATION_DUE_TO_HANDOFF,
    R64_REGISTRATION_BS_INITIATED_DEREGISTRATION,
    R64_REGISTRATION_GW_INITIATED_DEREGISTRATION,
    R64_REGISTRATION_DEREGISTRATION_DUE_TO_HANDOFF
}R64_REGISTRATION_TYPE_E;


typedef enum
{
    R64_CLASSIFIER_ACTION_ADD = 0,
    R64_CLASSIFIER_ACTION_REPLACE,
    R64_CLASSIFIER_ACTION_DELETE
}R64_CLASSIFIER_ACTION_E;

typedef enum
{
    R64_ETHERNET_CS,
    R64_IP_CS    
}R64_CS_TYPE_E;

typedef enum
{
    R64_IP_PROTOCOL_UDP = 1,
    R64_IP_PROTOCOL_TCP
}R64_IP_PROTOCOL_TYPE_E;

typedef enum
{
    R64_DATA_PATH_TYPE_GRE = 1,
}R64_DATA_PATH_TYPE_E;

typedef enum
{
    R64_IM_EXIT_OPERATION_NO,
    R64_IM_EXIT_OPERATION_YES /*Enumerator: Idle Mode to Active Transition
                                0 = no
                                1 = yes*/
}R64_IM_EXIT_OPERATION_IND_E;

typedef enum
{
    R64_SDU_LENGTH_FIXED = 0,
    R64_SDU_LENGTH_VARIABLE    
}R64_SDU_LENGTH_INDICATOR_E;

typedef enum
{
    R64_SERVICE_FLOW_TYPE_RESERVED0 = 0,
    R64_SERVICE_FLOW_TYPE_UNDEFINED,
    R64_SERVICE_FLOW_TYPE_BE,
    R64_SERVICE_FLOW_TYPE_NRTPS,
    R64_SERVICE_FLOW_TYPE_RTPS,
    R64_SERVICE_FLOW_TYPE_ERTPS,
    R64_SERVICE_FLOW_TYPE_UGS
}R64_SERVICE_FLOW_TYPE_E;

typedef enum 
{
    R64_RESERVED_ACTION_CREATE = 0x01,
    R64_RESERVED_ACTION_ADMIT = 0x02,
    R64_RESERVED_ACTION_ACTIVATE = 0x04,
    R64_RESERVED_ACTION_MODIFY = 0x08,
    R64_RESERVED_ACTION_DELETE = 0x10
}R64_RESERVED_ACTION_E;

typedef enum
{
    R64_SF_DIRECTION_UPLINK = 1,
    R64_SF_DIRECTION_DOWNLINK    
}R64_SF_DIRECTION_E;

typedef enum
{
    R64_TARGET_NODE = 1,
    R64_SERVING_NODE
}R64_NODE_INDICATOR_E;

typedef enum
{
    R64_PHS_ACTION_ADD = 0,
    R64_PHS_ACTION_REPLACE,
    R64_PHS_ACTION_DELETE,
    R64_PHS_ACTION_DELETE_ALL
}R64_PHS_RULE_ACTION_CODE_E;

typedef enum
{
    R64_PAGING_ACTION_STOP = 0,
    R64_PAGING_ACTION_START    
}R64_PAGING_ACTION_E;

typedef enum
{
    R64_PAGING_CAUSE_LCS = 1,
    R64_PAGING_CAUSE_DATA_DELIVER,
    R64_PAGING_CAUSE_IM_EXIT,
    R64_PAGING_CAUSE_RESERVED,
}R64_PAGING_CAUSE_E;    

typedef enum
{
    R64_LU_REFUSE = 0,
    R64_LU_ACCEPT    
}R64_LU_STATUS_E;

typedef enum
{
    R64_IM_EVENT_CODE_ENTRY = 0,
    R64_IM_EVENT_CODE_EXIT_NW_PAGE,
    R64_IM_EVENT_CODE_EXIT,
    R64_IM_EVENT_CODE_LOCATION_UPDATE,
    R64_IM_EVENT_CODE_PAGING_ANNOUNCE
}R64_IM_EVENT_CODE_E;    

typedef enum
{
    R64_HO_TYPE_HHO = 0,
    R64_HO_TYPE_FBSS,
    R64_HO_TYPE_MDHO    
}R64_HO_TYPE_E;

typedef enum
{
    R64_PRE_REG_RESULT_SUCCESS = 0,
    R64_PRE_REG_RESULT_NO_RESOURCE,
    R64_PRE_REG_RESULT_NOT_SUPPORT
}R64_PRE_REG_RESULT_CODE_E;

typedef enum
{
    R64_HO_INDICATION_CONFIRM = 0,
    R64_HO_INDICATION_CANCEL,
    R64_HO_INDICATION_REJECT
}R64_HO_INDICATION_TYPE_E;

typedef enum
{
    R64_HO_OPERATION_MODE_RECOMMENTED_HO_REQUEST = 0,
    R64_HO_OPERATION_MODE_MANDATORY_HO_REQUEST    
}R64_HO_OPERATION_MODE_E;

typedef enum
{
    R64_SA_TYPE_PRIMARY = 0,
    R64_SA_TYPE_STATIC,
    R64_SA_TYPE_DYNAMIC
}R64_SA_TYPE_E;

typedef enum
{
    R64_SA_SERVICE_TYPE_UNICAST = 0,
    R64_SA_SERVICE_TYPE_GROUP_MULTICAST,
    R64_SA_SERVICE_TYPE_MBS
}R64_SA_SERVICE_TYPE_E;

typedef enum
{
    R64_EAP_AUTH_IN_CURRENT_BS = 0,
    R64_EAP_AUTH_IN_TARGET_BS    
}R64_HO_AUTHORIZATION_POLICY_INDICATOR_E;

typedef enum
{
	R64_TOS_HIGHEST = 0,
	R64_TOS_SECOND,
	R64_TOS_THIRD,
	R64_TOS_LOWEST
}R64_TOS_ID_E;

/*element definition*/
typedef struct _R64_CONTEXT_PURPOSE_INDICATOR_
{
    BYTE indicator;   /*type: 101, len: 1 byte,value: see  R64_CONTEXT_PURPOSE_INDICATOR_E,comments:Indicates the purpose of the message*/
}R64_CONTEXT_PURPOSE_INDICATOR_S;

/*MS id*/
typedef struct _R64_MS_ID_