mac802_16pkt.h~

This documentation is based on the following versions:- pre-release of the wimax model developed by

/* This software was developed at the National Institute of Standards and
 * Technology by employees of the Federal Government in the course of
 * their official duties. Pursuant to title 17 Section 105 of the United
 * States Code this software is not subject to copyright protection and
 * is in the public domain.
 * NIST assumes no responsibility whatsoever for its use by other parties,
 * and makes no guarantees, expressed or implied, about its quality,
 * reliability, or any other characteristic.
 * <BR>
 * We would appreciate acknowledgement if the software is used.
 * <BR>
 * NIST ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" CONDITION AND
 * DISCLAIM ANY LIABILITY OF ANY KIND FOR ANY DAMAGES WHATSOEVER RESULTING
 * FROM THE USE OF THIS SOFTWARE.
 * </PRE></P>
 * @author  rouil
 */

#ifndef MAC802_16PKT_H
#define MAC802_16PKT_H

#include "packet.h"
#include "ofdmphy.h"

//#define HDR_MAC802_16(p)	((hdr_mac802_16 *)hdr_mac::access(p))
#define HDR_MAC802_16(p)	(hdr_mac802_16::access(p))
#define HDR_MAC802_16_SIZE 6
#define HDR_MAC802_16_FRAGSUB_SIZE 2

/** Define fragmentation encoding */
enum fragment_status {
  FRAG_NOFRAG = 0,
  FRAG_LAST,
  FRAG_FIRST,
  FRAG_CONT
};
  
/** Define Mac management type */
enum mngmt_type {
  MAC_UCD = 0,
  MAC_DCD,
  MAC_DL_MAP,
  MAC_UL_MAP,
  MAC_RNG_REQ,
  MAC_RNG_RSP,
  MAC_REG_REQ,
  MAC_REG_RSP,
  // 8: reserved
  // 9-10: Privacy key, not used 
  MAC_DSA_REQ=11,
  MAC_DSA_RSP,
  MAC_DSA_ACK,
  
  MAC_MOB_NBR_ADV=53,
  MAC_MOB_SCN_REQ,
  MAC_MOB_SCN_RSP,
  MAC_MOB_BSHO_REQ,
  MAC_MOB_MSHO_REQ,
  MAC_MOB_BSHO_RSP,
  MAC_MOB_HO_IND,
  MAC_MOB_SCN_REP,
  MAC_MOB_ASC_REP=66
};

/** Enumeration of scanning types */
enum wimax_scanning_type {
  SCAN_WITHOUT_ASSOC,
  SCAN_ASSOC_LVL0,
  SCAN_ASSOC_LVL1,
  SCAN_ASSOC_LVL2
};

/** Structure containing physical layer information */
struct phy_info_t {
  double freq_;              //the frequency at which it is sent
  Ofdm_mod_rate modulation_; //modulation at which the packet was sent
  double g_; //The cyclic prefix information. Used for synchronization
};

/** Define generic MAC header */
struct gen_mac_header_t {
  u_char ht : 1;
  u_char ec : 1;
  u_char type : 6;
  u_char rsv1: 1;
  u_char ci: 1;
  u_char eks: 2;
  u_char rsv2: 1;
  u_int16_t len: 11;
  u_int16_t cid;
  u_char hcs;
};

/** Define bandwidth request header */
struct bw_req_header_t {
  u_char ht : 1;
  u_char ec : 1;
  u_char type : 3;  
  u_int32_t br : 19;
  u_int16_t cid;
  u_char hcs;  
};

/** Define structure for packet information */
struct hdr_mac802_16
{
  //virtual info for physical layer
  phy_info_t phy_info;
  
  //generic mac header or bw request header
  gen_mac_header_t header;

  //check how to put the subheaders (piggyback)
  bool frag_subheader; //set to true if there is a fragmentation subheader
  char fc : 2;  //00:no fragmentation, 01:last, 10: first, 11: middle 
  char fsn : 3; //fragmentation number 

  //for management frames, we put 
  //payload in the packet payload
  //because the size changes

  //Packet header access functions
  static int offset_;
  inline static int& offset() {return offset_;}
  inline static hdr_mac802_16* access(const Packet* p)
  {
    return (hdr_mac802_16*) p->access(offset_);
  }
};

/**** Defines some constant for the maximum size of messages ****/
/* When sending a packet, the message is copied for each 
 * destination. In that case, we need to store all the information
 * in the packet itself and not use pointer. We then use arrays.
 */
#define MAX_MAP_IE  10
#define MAX_PROFILE 10
#define MAX_NBR     10

/**** Defines IEs ****/
/** Defines DL_MAP IE (see p462.) */
struct mac802_16_dlmap_ie {
  u_int16_t cid;
  u_char diuc : 4;            //p463
  u_char preamble : 1;
  u_int16_t start_time : 11;
  //may contain extended info
};
#define DL_MAP_IE_SIZE 4

/** fast Ranging IE (802.16e) */
struct mac802_16_fast_ranging_ie {
  int mac_addr;  //48 bits
  u_char uiuc : 4; 
  u_int16_t duration : 12; //in OFDM symbols
};
#define FAST_RANGING_IE_SIZE 9

/** Defines UL_MAP IE (see p464.) */
struct mac802_16_ulmap_ie {
  u_int16_t cid;
  u_int16_t start_time : 11;
  u_char sub_channel_index : 5;
  u_char uiuc : 4;
  u_int16_t duration : 11;
  u_char midamble_rep : 2;
  //may contain additional info depending on uiuc
  u_char extended_uiuc : 4;
  u_char length : 4;
  mac802_16_fast_ranging_ie fast_ranging;
};
#define UL_MAP_IE_SIZE 6

/**** Defines burst profiles ****/

/* Burst profiles are TLV encoded...we just pick the info we 
 * are interested in.
 */
/** Defines DCD profile */
struct mac802_16_dcd_profile {
  u_char diuc : 4;
  u_int32_t frequency;
  u_char fec;
  //may have more info
};
#define DCD_PROFILE_SIZE 12

/** Defines UCD profile */
struct mac802_16_ucd_profile {
  u_char uiuc : 4;
  u_char fec;
  //may have more info
};
#define UCD_PROFILE_SIZE 6

/**** Defines frames ****/
/** DCD frame */
struct mac802_16_dcd_frame {
  u_char type;
  u_char dcid;
  u_char config_change_count;
  //info for all channels: TLV encoded
  u_char frame_duration_code;
  u_int32_t frame_number : 24;
  u_char ttg;
  u_char rtg;
  u_int32_t frequency;
  //downlink burst profiles
  u_int32_t nb_prof;
  mac802_16_dcd_profile profiles[MAX_PROFILE];
};

//+3 for the end of map profile
#define GET_DCD_SIZE(X) 22+X*DCD_PROFILE_SIZE+3

/** DL_MAP frame */
struct mac802_16_dl_map_frame {
  u_char type;
  u_char dcd_count;
  int bsid; //normaly 48 bits
  //DL_MAP IEs
  u_int32_t nb_ies;
  mac802_16_dlmap_ie ies[MAX_MAP_IE]; 
};

//there is X IEs 
#define GET_DL_MAP_SIZE(X) 8+X*DL_MAP_IE_SIZE

/** UCD frame */
struct mac802_16_ucd_frame {
  u_char type;
  u_char config_change_count;
  u_char rng_backoff_start;
  u_char rng_backoff_end;
  u_char req_backoff_start;
  u_char req_backoff_end;
  //info for overall channel
  /*
  u_int16_t rsv_timeout;
  */
  u_int16_t bw_req_size;
  u_int16_t rng_req_size;
  //uplink burst profile
  u_int32_t nb_prof;
  mac802_16_ucd_profile profiles[MAX_PROFILE];
};

//+3 for the end of map profile
#define GET_UCD_SIZE(X) 14+X*UCD_PROFILE_SIZE+3

/** UL_MAP frame */
struct mac802_16_ul_map_frame {
  u_char type;
  u_char ucid;
  u_char ucd_count;
  u_int32_t allocation_start;
  //UL_MAP IEs
  u_int32_t nb_ies;
  mac802_16_ulmap_ie ies[MAX_MAP_IE];
};

#define GET_UL_MAP_SIZE(X) 7+X*UL_MAP_IE_SIZE

/**** Defines ranging messages ****/
/** Ranging request frame */
struct mac802_16_rng_req_frame {
  u_char type;
  u_char dc_id;
  /*TLV values*/
  /* Requested Downlink Burst Profile
   * bits 0-3: DIUC of the downlink burst profile
   * bits 4-7: LSB of Configuration Change Count value
   * of DCD defining the burst profile assocciated with DIUC
   */
  u_char req_dl_burst_profile;
  int ss_mac_address; //should be 6 bytes
  //u_char aas_bc_cap; //broadcast capability. optional
};
#define RNG_REQ_SIZE 13 //max value

/** Ranging status */
enum ranging_status {
  RNG_CONTINUE = 1,
  RNG_ABORT,
  RNG_SUCCESS,
  RNG_RERANGE
};

/** Ranging response frame */
struct mac802_16_rng_rsp_frame {
  u_char type;
  u_char uc_id;
  /*TLV values*/
  u_char pw_adjust;
  u_int32_t freq_adjust;
  u_char rng_status;
  /* byte 0: the least robust DIUC that may be used by BS for 
   * transmissions to the SS
   * byte 1: Configuration Change Count of DCD defining the burst profile
   * associated with DIUC 
   */
  u_int16_t dl_op_burst_profile;
  int ss_mac_address; //6 bytes
  u_int16_t basic_cid;
  u_int16_t primary_cid;
  u_char aas_bc_perm; 
};
#define RNG_RSP_SIZE 28

/**** Defines registration messages ****/
/** Registration request frame */
struct mac802_16_reg_req_frame {
  u_char type;
  /*TLV values*/
  u_char ss_mngmt_support;
  u_char ip_mngmt_support;
  u_int16_t uplink_cid_support;
  
};
#define REG_REQ_SIZE 12

/** Registration response frame */
struct mac802_16_reg_rsp_frame {
  u_char type;
  u_char response;
  /*TLV values*/
  u_char ss_mngmt_support;
  u_int16_t sec_mngmt_cid;
};
#define REG_RSP_SIZE 12

/**** Defines Dynamic Service Addition messages ****/
/** DSA request frame */
struct mac802_16_dsa_req_frame {
  u_char type; //11
  u_int16_t transaction_id;
  /*TLV values*/
  bool uplink; //direction of the flow, normaly coded in TLV with
               //type 145 or 146 (see p647).
  u_int16_t cid;
};
//parameter X indicates if cid is present (i.e request from BS)
#define GET_DSA_REQ_SIZE(X) 6+4*X

/** DSA response frame */
struct mac802_16_dsa_rsp_frame {
  u_char type; //12
  u_int16_t transaction_id;
  u_char confirmation_code;
  /*TLV values*/
  bool uplink; //direction of the flow, normaly coded in TLV with
               //type 145 or 146 (see p647).
  u_int16_t cid;
};
//parameter X indicates if cid is present (i.e response from BS)
#define GET_DSA_RSP_SIZE(X) 6+4*X

/** DSA Acknowledgement frame */
struct mac802_16_dsa_ack_frame {
  u_char type; //13
  u_int16_t transaction_id;
  u_char confirmation_code;
  /*TLV values*/
  bool uplink; //direction of the flow, normaly coded in TLV with
               //type 145 or 146 (see p647).
};
#define DSA_ACK_SIZE 6


/**** Defines Mobility messages (802.16e) ****/
/** Structure of physical profile ID */
struct mac802_16_phy_profile_id {
  u_char colocatedFA: 1;
  u_char FAconfig: 1;
  u_char timefreq_synch: 2;
  u_char bs_eirp: 1;
  u_char dcducd_ref: 1;
  u_char FAindex: 1;
  u_char trigger_ref: 1;
};

/** Structure of physical mode ID */
struct mac802_16_phy_mode_id {
  u_char bandwidth: 7;
  u_char fttsize: 3;
  u_char cp: 2;
  u_char duration_code: 4;
};

/** Information about a neighbor BS */
struct mac802_16_nbr_adv_info {
  u_char length;
  mac802_16_phy_profile_id phy_profile_id;
  u_char fa_index; //if FA index indicator=1 in phy_profile_id
  u_char bs_eirp;
  int nbr_bsid;    
  u_char preamble_index; //in OFDM, 5lsb=
  u_char ho_process_opt;
  u_char sched_srv_supported;
  u_char dcd_ccc: 4;
  u_char ucd_ccc: 4;
  /* other TLV information */
  bool dcd_included; //tell if the dcd is included
  mac802_16_dcd_frame dcd_settings;
  bool ucd_included; //tell if the ucd is included
  mac802_16_ucd_frame ucd_settings;
  bool phy_included; //tell if the phy mode ID is included
  mac802_16_phy_mode_id phy_mode_id;
};

/** Neighbor advertisment frame */
struct mac802_16_mob_nbr_adv_frame {
  u_char type; //53
  u_char skip_opt_field;
  u_int32_t operatorID: 24;
  u_char ccc;
  u_char frag_index: 4;
  u_char total_frag: 4;
  u_char n_neighbors; //number of neighbors
  mac802_16_nbr_adv_info nbr_info[MAX_NBR];
};

/** Code BS using index in scan request */
struct mac802_16_mob_scn_req_bs_index {
  u_char neighbor_bs_index;
  u_char scanning_type: 3; //0: scanning without association
                           //1: scanning+assoc level 0
                           //2: scanning+assoc level 1
                           //3: scanning+assoc level 2
                           //4-7: reserved
};
 
/** Code BS using full address in scan request */
struct mac802_16_mob_scn_req_bs_full {
  int recommended_bs_id;   /* 6 bytes */
  u_char scanning_type: 3; //0: scanning without association
                           //1: scanning+assoc level 0
                           //2: scanning+assoc level 1
                           //3: scanning+assoc level 2
                           //4-7: reserved
};

/** Scan request frame */
struct mac802_16_mob_scn_req_frame {
  u_char type; //54
  u_char scan_duration; //units of frames
  u_char interleaving_interval; //units of frames
  u_char scan_iteration; //in frame
  u_char n_recommended_bs_index; //number of BS recommended
  u_char ccc; //present if n_recommended_bs_index!= 0
  mac802_16_mob_scn_req_bs_index rec_bs_index[MAX_NBR];
  u_char n_recommended_bs_full;
  mac802_16_mob_scn_req_bs_full rec_bs_full[MAX_NBR];
  /* TLV info*/
};