开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > Linux/Unix编程 > 网络 > 查看源码
mac802_16pkt.h
资源名称：WiMAX_Protocol_Code.rar　[点击查看]
上传用户：hzie11
上传日期：2013-10-07
资源大小：1487k
文件大小：24k
源码类别：

网络

开发平台：

C/C++

mac802_16pkt.h：源码内容
  1. /* This software was developed at the National Institute of Standards and
  2.  * Technology by employees of the Federal Government in the course of
  3.  * their official duties. Pursuant to title 17 Section 105 of the United
  4.  * States Code this software is not subject to copyright protection and
  5.  * is in the public domain.
  6.  * NIST assumes no responsibility whatsoever for its use by other parties,
  7.  * and makes no guarantees, expressed or implied, about its quality,
  8.  * reliability, or any other characteristic.
  9.  * <BR>
  10.  * We would appreciate acknowledgement if the software is used.
  11.  * <BR>
  12.  * NIST ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" CONDITION AND
  13.  * DISCLAIM ANY LIABILITY OF ANY KIND FOR ANY DAMAGES WHATSOEVER RESULTING
  14.  * FROM THE USE OF THIS SOFTWARE.
  15.  * </PRE></P>
  16.  * @author  rouil
  17.  */
  19. #ifndef MAC802_16PKT_H
  20. #define MAC802_16PKT_H
  22. #include "packet.h"
  23. #include "ofdmphy.h"
  25. //#define HDR_MAC802_16(p) ((hdr_mac802_16 *)hdr_mac::access(p))
  26. #define HDR_MAC802_16(p) (hdr_mac802_16::access(p))
  27. #define HDR_MAC802_16_SIZE 6
  28. #define HDR_MAC802_16_FRAGSUB_SIZE 2
  30. /** Define fragmentation encoding */
  31. enum fragment_status {
  32.   FRAG_NOFRAG = 0,
  33.   FRAG_LAST,
  34.   FRAG_FIRST,
  35.   FRAG_CONT
  36. };
  37.   
  38. /** Define Mac management type */
  39. enum mngmt_type {
  40.   MAC_UCD = 0,
  41.   MAC_DCD,
  42.   MAC_DL_MAP,
  43.   MAC_UL_MAP,
  44.   MAC_RNG_REQ,
  45.   MAC_RNG_RSP,
  46.   MAC_REG_REQ,
  47.   MAC_REG_RSP,
  48.   // 8: reserved
  49.   // 9-10: Privacy key, not used 
  50.   MAC_DSA_REQ=11,
  51.   MAC_DSA_RSP,
  52.   MAC_DSA_ACK,
  53.   
  54.   MAC_MOB_NBR_ADV=53,
  55.   MAC_MOB_SCN_REQ,
  56.   MAC_MOB_SCN_RSP,
  57.   MAC_MOB_BSHO_REQ,
  58.   MAC_MOB_MSHO_REQ,
  59.   MAC_MOB_BSHO_RSP,
  60.   MAC_MOB_HO_IND,
  61.   MAC_MOB_SCN_REP,
  62.   MAC_MOB_ASC_REP=66
  63. };
  65. /** Enumeration of scanning types */
  66. enum wimax_scanning_type {
  67.   SCAN_WITHOUT_ASSOC,
  68.   SCAN_ASSOC_LVL0,
  69.   SCAN_ASSOC_LVL1,
  70.   SCAN_ASSOC_LVL2
  71. };
  73. /** Structure containing physical layer information */
  74. struct phy_info_t {
  75.   double freq_;              //the frequency at which it is sent
  76.   Ofdm_mod_rate modulation_; //modulation at which the packet was sent
  77.   double g_; //The cyclic prefix information. Used for synchronization
  78. };
  80. /** Define generic MAC header */
  81. struct gen_mac_header_t {
  82.   u_char ht : 1;
  83.   u_char ec : 1;
  84.   u_char type : 6;
  85.   u_char rsv1: 1;
  86.   u_char ci: 1;
  87.   u_char eks: 2;
  88.   u_char rsv2: 1;
  89.   u_int16_t len: 11;
  90.   u_int16_t cid;
  91.   u_char hcs;
  92. };
  94. /** Define bandwidth request header */
  95. struct bw_req_header_t {
  96.   u_char ht : 1;
  97.   u_char ec : 1;
  98.   u_char type : 3;  
  99.   u_int32_t br : 19;
  100.   u_int16_t cid;
  101.   u_char hcs;  
  102. };
  104. /** Define structure for packet information */
  105. struct hdr_mac802_16
  106. {
  107.   //virtual info for physical layer
  108.   phy_info_t phy_info;
  109.   
  110.   //generic mac header or bw request header
  111.   gen_mac_header_t header;
  113.   //check how to put the subheaders (piggyback)
  114.   bool frag_subheader; //set to true if there is a fragmentation subheader
  115.   char fc : 2;  //00:no fragmentation, 01:last, 10: first, 11: middle 
  116.   char fsn : 3; //fragmentation number 
  118.   //for management frames, we put 
  119.   //payload in the packet payload
  120.   //because the size changes
  122.   //Packet header access functions
  123.   static int offset_;
  124.   inline static int& offset() {return offset_;}
  125.   inline static hdr_mac802_16* access(const Packet* p)
  126.   {
  127.     return (hdr_mac802_16*) p->access(offset_);
  128.   }
  129. };
  131. /**** Defines some constant for the maximum size of messages ****/
  132. /* When sending a packet, the message is copied for each 
  133.  * destination. In that case, we need to store all the information
  134.  * in the packet itself and not use pointer. We then use arrays.
  135.  */
  136. #define MAX_MAP_IE  10
  137. #define MAX_PROFILE 10
  138. #define MAX_NBR     10
  140. /**** Defines IEs ****/
  141. /** Defines DL_MAP IE (see p462.) */
  142. struct mac802_16_dlmap_ie {
  143.   u_int16_t cid;
  144.   u_char diuc : 4;            //p463
  145.   u_char preamble : 1;
  146.   u_int16_t start_time : 11;
  147.   //may contain extended info
  148. };
  149. #define DL_MAP_IE_SIZE 4
  151. /** fast Ranging IE (802.16e) */
  152. struct mac802_16_fast_ranging_ie {
  153.   int mac_addr;  //48 bits
  154.   u_char uiuc : 4; 
  155.   u_int16_t duration : 12; //in OFDM symbols
  156. };
  157. #define FAST_RANGING_IE_SIZE 9
  159. /** Defines UL_MAP IE (see p464.) */
  160. struct mac802_16_ulmap_ie {
  161.   u_int16_t cid;
  162.   u_int16_t start_time : 11;
  163.   u_char sub_channel_index : 5;
  164.   u_char uiuc : 4;
  165.   u_int16_t duration : 11;
  166.   u_char midamble_rep : 2;
  167.   //may contain additional info depending on uiuc
  168.   u_char extended_uiuc : 4;
  169.   u_char length : 4;
  170.   mac802_16_fast_ranging_ie fast_ranging;
  171. };
  172. #define UL_MAP_IE_SIZE 6
  174. /**** Defines burst profiles ****/
  176. /* Burst profiles are TLV encoded...we just pick the info we 
  177.  * are interested in.
  178.  */
  179. /** Defines DCD profile */
  180. struct mac802_16_dcd_profile {
  181.   u_char diuc : 4;
  182.   u_int32_t frequency;
  183.   u_char fec;
  184.   //may have more info
  185. };
  186. #define DCD_PROFILE_SIZE 12
  188. /** Defines UCD profile */
  189. struct mac802_16_ucd_profile {
  190.   u_char uiuc : 4;
  191.   u_char fec;
  192.   //may have more info
  193. };
  194. #define UCD_PROFILE_SIZE 6
  196. /**** Defines frames ****/
  197. /** DCD frame */
  198. struct mac802_16_dcd_frame {
  199.   u_char type;
  200.   u_char dcid;
  201.   u_char config_change_count;
  202.   //info for all channels: TLV encoded
  203.   u_char frame_duration_code;
  204.   u_int32_t frame_number : 24;
  205.   u_char ttg;
  206.   u_char rtg;
  207.   u_int32_t frequency;
  208.   //downlink burst profiles
  209.   u_int32_t nb_prof;
  210.   mac802_16_dcd_profile profiles[MAX_PROFILE];
  211. };
  213. //+3 for the end of map profile
  214. #define GET_DCD_SIZE(X) 22+X*DCD_PROFILE_SIZE+3
  216. /** DL_MAP frame */
  217. struct mac802_16_dl_map_frame {
  218.   u_char type;
  219.   u_char dcd_count;
  220.   int bsid; //normaly 48 bits
  221.   //DL_MAP IEs
  222.   u_int32_t nb_ies;
  223.   mac802_16_dlmap_ie ies[MAX_MAP_IE]; 
  224. };
  226. //there is X IEs 
  227. #define GET_DL_MAP_SIZE(X) 8+X*DL_MAP_IE_SIZE
  229. /** UCD frame */
  230. struct mac802_16_ucd_frame {
  231.   u_char type;
  232.   u_char config_change_count;
  233.   u_char rng_backoff_start;
  234.   u_char rng_backoff_end;
  235.   u_char req_backoff_start;
  236.   u_char req_backoff_end;
  237.   //info for overall channel
  238.   /*
  239.   u_int16_t rsv_timeout;
  240.   */
  241.   u_int16_t bw_req_size;
  242.   u_int16_t rng_req_size;
  243.   //uplink burst profile
  244.   u_int32_t nb_prof;
  245.   mac802_16_ucd_profile profiles[MAX_PROFILE];
  246. };
  248. //+3 for the end of map profile
  249. #define GET_UCD_SIZE(X) 14+X*UCD_PROFILE_SIZE+3
  251. /** UL_MAP frame */
  252. struct mac802_16_ul_map_frame {
  253.   u_char type;
  254.   u_char ucid;
  255.   u_char ucd_count;
  256.   u_int32_t allocation_start;
  257.   //UL_MAP IEs
  258.   u_int32_t nb_ies;
  259.   mac802_16_ulmap_ie ies[MAX_MAP_IE];
  260. };
  262. #define GET_UL_MAP_SIZE(X) 7+X*UL_MAP_IE_SIZE
  264. /**** Defines ranging messages ****/
  265. /** Ranging request frame */
  266. struct mac802_16_rng_req_frame {
  267.   u_char type;
  268.   u_char dc_id;
  269.   /*TLV values*/
  270.   /* Requested Downlink Burst Profile
  271.    * bits 0-3: DIUC of the downlink burst profile
  272.    * bits 4-7: LSB of Configuration Change Count value
  273.    * of DCD defining the burst profile assocciated with DIUC
  274.    */
  275.   u_char req_dl_burst_profile;
  276.   int ss_mac_address; //should be 6 bytes
  277.   //u_char aas_bc_cap; //broadcast capability. optional
  278. };
  279. #define RNG_REQ_SIZE 13 //max value
  281. /** Ranging status */
  282. enum ranging_status {
  283.   RNG_CONTINUE = 1,
  284.   RNG_ABORT,
  285.   RNG_SUCCESS,
  286.   RNG_RERANGE
  287. };
  289. /** Ranging response frame */
  290. struct mac802_16_rng_rsp_frame {
  291.   u_char type;
  292.   u_char uc_id;
  293.   /*TLV values*/
  294.   u_char pw_adjust;
  295.   u_int32_t freq_adjust;
  296.   u_char rng_status;
  297.   /* byte 0: the least robust DIUC that may be used by BS for 
  298.    * transmissions to the SS
  299.    * byte 1: Configuration Change Count of DCD defining the burst profile
  300.    * associated with DIUC 
  301.    */
  302.   u_int16_t dl_op_burst_profile;
  303.   int ss_mac_address; //6 bytes
  304.   u_int16_t basic_cid;
  305.   u_int16_t primary_cid;
  306.   u_char aas_bc_perm; 
  307. };
  308. #define RNG_RSP_SIZE 28
  310. /**** Defines registration messages ****/
  311. /** Registration request frame */
  312. struct mac802_16_reg_req_frame {
  313.   u_char type;
  314.   /*TLV values*/
  315.   u_char ss_mngmt_support;
  316.   u_char ip_mngmt_support;
  317.   u_int16_t uplink_cid_support;
  318.   
  319. };
  320. #define REG_REQ_SIZE 12
  322. /** Registration response frame */
  323. struct mac802_16_reg_rsp_frame {
  324.   u_char type;
  325.   u_char response;
  326.   /*TLV values*/
  327.   u_char ss_mngmt_support;
  328.   u_int16_t sec_mngmt_cid;
  329. };
  330. #define REG_RSP_SIZE 12
  332. /**** Defines Dynamic Service Addition messages ****/
  333. /** DSA request frame */
  334. struct mac802_16_dsa_req_frame {
  335.   u_char type; //11
  336.   u_int16_t transaction_id;
  337.   /*TLV values*/
  338.   bool uplink; //direction of the flow, normaly coded in TLV with
  339.                //type 145 or 146 (see p647).
  340.   u_int16_t cid;
  341. };
  342. //parameter X indicates if cid is present (i.e request from BS)
  343. #define GET_DSA_REQ_SIZE(X) 6+4*X
  345. /** DSA response frame */
  346. struct mac802_16_dsa_rsp_frame {
  347.   u_char type; //12
  348.   u_int16_t transaction_id;
  349.   u_char confirmation_code;
  350.   /*TLV values*/
  351.   bool uplink; //direction of the flow, normaly coded in TLV with
  352.                //type 145 or 146 (see p647).
  353.   u_int16_t cid;
  354. };
  355. //parameter X indicates if cid is present (i.e response from BS)
  356. #define GET_DSA_RSP_SIZE(X) 6+4*X
  358. /** DSA Acknowledgement frame */
  359. struct mac802_16_dsa_ack_frame {
  360.   u_char type; //13
  361.   u_int16_t transaction_id;
  362.   u_char confirmation_code;
  363.   /*TLV values*/
  364.   bool uplink; //direction of the flow, normaly coded in TLV with
  365.                //type 145 or 146 (see p647).
  366. };
  367. #define DSA_ACK_SIZE 6
  370. /**** Defines Mobility messages (802.16e) ****/
  371. /** Structure of physical profile ID */
  372. struct mac802_16_phy_profile_id {
  373.   u_char colocatedFA: 1;
  374.   u_char FAconfig: 1;
  375.   u_char timefreq_synch: 2;
  376.   u_char bs_eirp: 1;
  377.   u_char dcducd_ref: 1;
  378.   u_char FAindex: 1;
  379.   u_char trigger_ref: 1;
  380. };
  382. /** Structure of physical mode ID */
  383. struct mac802_16_phy_mode_id {
  384.   u_char bandwidth: 7;
  385.   u_char fttsize: 3;
  386.   u_char cp: 2;
  387.   u_char duration_code: 4;
  388. };
  390. /** Information about a neighbor BS */
  391. struct mac802_16_nbr_adv_info {
  392.   u_char length;
  393.   mac802_16_phy_profile_id phy_profile_id;
  394.   u_char fa_index; //if FA index indicator=1 in phy_profile_id
  395.   u_char bs_eirp;
  396.   int nbr_bsid;    
  397.   u_char preamble_index; //in OFDM, 5lsb=
  398.   u_char ho_process_opt;
  399.   u_char sched_srv_supported;
  400.   u_char dcd_ccc: 4;
  401.   u_char ucd_ccc: 4;
  402.   /* other TLV information */
  403.   bool dcd_included; //tell if the dcd is included
  404.   mac802_16_dcd_frame dcd_settings;
  405.   bool ucd_included; //tell if the ucd is included
  406.   mac802_16_ucd_frame ucd_settings;
  407.   bool phy_included; //tell if the phy mode ID is included
  408.   mac802_16_phy_mode_id phy_mode_id;
  409. };
  411. /** Neighbor advertisment frame */
  412. struct mac802_16_mob_nbr_adv_frame {
  413.   u_char type; //53
  414.   u_char skip_opt_field;
  415.   u_int32_t operatorID: 24;
  416.   u_char ccc;
  417.   u_char frag_index: 4;
  418.   u_char total_frag: 4;
  419.   u_char n_neighbors; //number of neighbors
  420.   mac802_16_nbr_adv_info nbr_info[MAX_NBR];
  421. };
  423. /** Code BS using index in scan request */
  424. struct mac802_16_mob_scn_req_bs_index {
  425.   u_char neighbor_bs_index;
  426.   u_char scanning_type: 3; //0: scanning without association
  427.                            //1: scanning+assoc level 0
  428.                            //2: scanning+assoc level 1
  429.                            //3: scanning+assoc level 2
  430.                            //4-7: reserved
  431. };
  432.  
  433. /** Code BS using full address in scan request */
  434. struct mac802_16_mob_scn_req_bs_full {
  435.   int recommended_bs_id;   /* 6 bytes */
  436.   u_char scanning_type: 3; //0: scanning without association
  437.                            //1: scanning+assoc level 0
  438.                            //2: scanning+assoc level 1
  439.                            //3: scanning+assoc level 2
  440.                            //4-7: reserved
  441. };
  443. /** Scan request frame */
  444. struct mac802_16_mob_scn_req_frame {
  445.   u_char type; //54
  446.   u_char scan_duration; //units of frames
  447.   u_char interleaving_interval; //units of frames
  448.   u_char scan_iteration; //in frame
  449.   u_char n_recommended_bs_index; //number of BS recommended
  450.   u_char ccc; //present if n_recommended_bs_index!= 0
  451.   mac802_16_mob_scn_req_bs_index rec_bs_index[MAX_NBR];
  452.   u_char n_recommended_bs_full;
  453.   mac802_16_mob_scn_req_bs_full rec_bs_full[MAX_NBR];
  454.   /* TLV info*/
  455. };
  457. /** Code BS using index in scan response */
  458. struct mac802_16_mob_scn_rsp_bs_index {
  459.   u_char neighbor_bs_index;
  460.   u_char scanning_type: 3; //0: scanning without association
  461.                            //1: scanning+assoc level 0
  462.                            //2: scanning+assoc level 1
  463.                            //3: scanning+assoc level 2
  464.                            //4-7: reserved
  465.   /* next present if scanning is 2 or 3*/
  466.   u_char rdv_time;
  467.   u_char cdma_code;
  468.   u_char transmission_opp_offset;
  469. };
  471. /** Code BS using full address in scan response */
  472. struct mac802_16_mob_scn_rsp_bs_full {
  473.   int recommended_bs_id;   /* 6 bytes */
  474.   u_char scanning_type: 3; //0: scanning without association
  475.                            //1: scanning+assoc level 0
  476.                            //2: scanning+assoc level 1
  477.                            //3: scanning+assoc level 2
  478.                            //4-7: reserved
  479.   /* next present if scanning is 2 or 3*/
  480.   u_char rdv_time;
  481.   u_char cdma_code;
  482.   u_char transmission_opp_offset;
  483. };
  485. /** Scan response frame */
  486. struct mac802_16_mob_scn_rsp_frame {
  487.   u_char type; //55
  488.   u_char scan_duration; //units of frames
  489.   u_char report_mode: 2;
  490.   u_char report_period;
  491.   u_char report_metric;
  492.   /*next information present only if scan duration !=0*/
  493.   u_char start_frame: 4;
  494.   u_char interleaving_interval;
  495.   u_char scan_iteration;
  496.   u_char n_recommended_bs_index;
  497.   //next if n_recommended_bs_index !=0
  498.   u_char ccc_mob_nbr_adv;
  499.   mac802_16_mob_scn_rsp_bs_index rec_bs_index[MAX_NBR];
  500.   u_char n_recommended_bs_full;
  501.   mac802_16_mob_scn_rsp_bs_full rec_bs_full[MAX_NBR];
  502.   /* end if scan duration !=0 */
  503.   /* TLV information */
  504. };
  506. /** Measurements about current BS */
  507. struct mac802_16_mob_scn_rep_current_bs {
  508.   u_char temp_bsid: 4;
  509.   u_char bs_cinr_mean; //if report_metric[0]==1
  510.   u_char bs_rssi_mean; //if report_metric[1]==1
  511.   u_char relative_delay; //if report_metric[2]==1
  512.   u_char bs_rtd; //if report_metric[3]==1
  513. };
  515. /** Measurements about neighbor BS using index */
  516. struct mac802_16_mob_scn_rep_bs_index {
  517.   u_char neighbor_bs_index;
  518.   u_char bs_cinr_mean; //if report_metric[0]==1
  519.   u_char bs_rssi_mean; //if report_metric[1]==1
  520.   u_char relative_delay; //if report_metric[2]==1
  521. };
  523. /** Measurements about neighbor BS using full address */
  524. struct mac802_16_mob_scn_rep_bs_full {
  525.   int neighbor_bs_id; /* 6 bytes */
  526.   u_char bs_cinr_mean; //if report_metric[0]==1
  527.   u_char bs_rssi_mean; //if report_metric[1]==1
  528.   u_char relative_delay; //if report_metric[2]==1
  529. };
  531. /** Scan report frame */
  532. struct mac802_16_mob_scn_rep_frame {
  533.   u_char type; //60
  534.   u_char report_mode: 1;
  535.   u_char comp_nbr_bsid_ind: 1;
  536.   u_char n_current_bs: 3;
  537.   u_char report_metric: 8;
  538.   mac802_16_mob_scn_rep_current_bs current_bs[MAX_NBR];
  539.   u_char n_neighbor_bs_index;
  540.   //next if n_recommended_bs_index !=0
  541.   u_char ccc_mob_nbr_adv;
  542.   mac802_16_mob_scn_rep_bs_index nbr_bs_index[MAX_NBR];
  543.   u_char n_recommended_bs_full;
  544.   mac802_16_mob_scn_rep_bs_full nbr_bs_full[MAX_NBR];
  545.   /* other TLV information */
  546. };
  548. /** Code BS using index in association result report */
  549. struct mac802_16_mob_asc_rep_bs_index {
  550.   u_char neighbor_bs_index;
  551.   uint32_t timing_adjust;
  552.   u_char power_level_adjust;
  553.   uint32_t offset_freq_adjust;
  554.   u_char rng_status;
  555.   u_char service_level_prediction;
  556. };
  558. /** Code BS using address in association result report */
  559. struct mac802_16_mob_asc_rep_bs_full {
  560.   int neighbor_bs_id; /* 6 bytes */
  561.   uint32_t timing_adjust;
  562.   u_char power_level_adjust;
  563.   uint32_t offset_freq_adjust;
  564.   u_char rng_status;
  565.   u_char service_level_prediction;
  566. };
  568. /** Association result report frame */
  569. struct mac802_16_mob_asc_rep_frame {
  570.   u_char type; //66
  571.   u_char n_recommended_bs_index;
  572.   //next if n_recommended_bs_index !=0
  573.   u_char ccc_mob_nbr_adv;
  574.   mac802_16_mob_asc_rep_bs_index rec_bs_index[MAX_NBR];
  575.   u_char n_recommended_bs_full;
  576.   mac802_16_mob_asc_rep_bs_full rec_bs_full[MAX_NBR];
  577. }; 
  579. /** Code request in mode 000 (HO request) */
  580. struct mac802_16_mob_bsho_req_mode_000 {
  581.   int neighbor_bsid; /* 6 bytes */
  582.   u_char service_level_prediction;
  583.   u_char preamble_index;
  584.   u_char ho_process_optimization;
  585.   u_char net_assisted_ho_supported: 1;
  586.   u_char ho_id_included_indicator: 1;
  587.   u_char ho_autho_policy_indicator: 1;
  588.   //if ho_id_included_indicator==1
  589.   u_char ho_id;
  590.   //if ho_autho_policy_indicator==1
  591.   u_char ho_autho_policy_support;
  592. };
  594. /** Structure for BSHO request */
  595. struct mac802_16_mob_bsho_req_mode_new_bs {
  596.   int neighbor_bsid; /* 6 bytes */
  597.   u_char temp_bsid: 3;
  598.  
  599. };
  601. /** Structure for BSHO request */
  602. struct mac802_16_mob_bsho_req_mode_new_bs2 {
  603.   int neighbor_bsid; /* 6 bytes */
  604.   u_char temp_bsid: 3;
  605.   uint16_t new_cid[MAX_NBR];
  606.   uint16_t new_said[MAX_NBR];
  607.  
  608. };
  610. /** Structure for BSHO request */
  611. struct mac802_16_mob_bsho_req_mode_new_bs3 {
  612.   int neighbor_bsid; /* 6 bytes */
  613.   u_char temp_bsid: 3;
  614.   uint16_t new_cid[MAX_NBR];
  615.   uint16_t new_said[MAX_NBR];
  616.   int cqich_id; //variable 
  617.   u_char feedback_channel_off: 6;
  618.   u_char period: 2;
  619.   u_char frame_offset: 3;
  620.   u_char duration: 3;
  621.   u_char mimo_permutation_feedback: 2; 
  622. };
  624. /** Structure for BSHO request */
  625. struct mac802_16_mob_bsho_req_mode_current_bs {
  626.   u_char temp_bsid: 3;
  627. };
  629. /** BSHO request frame */
  630. struct mac802_16_mob_bsho_req_frame {
  631.   u_char type; //56
  632.   u_char net_assisted_ho_supported: 1;
  633.   u_char mode: 3;
  634.   //if mode == 0b000
  635.   u_char ho_op_mode: 1;
  636.   u_char n_recommended;
  637.   u_char resource_retain_flag: 1;
  638.   mac802_16_mob_bsho_req_mode_000 n_rec[];
  639.   //if mode == 0b001
  640.   u_char tmp_bsid: 3;
  641.   u_char ak_change_indicator: 1;
  642.   u_char n_cids;
  643.   uint16_t cids[MAX_NBR];
  644.   u_char n_saids;
  645.   uint16_t saids[MAX_NBR];
  646.   
  647.   //if mode == 0b010: attribute defined in mode 0b001
  648.   //u_char tmp_bsid: 3;
  649.   //u_char ak_change_indicator: 1;
  650.   
  651.   //if mode == 0b011
  652.   u_char n_new_bs: 3;
  653.   mac802_16_mob_bsho_req_mode_new_bs new_bs[MAX_NBR];
  654.   u_char n_current_bs: 3;
  655.   mac802_16_mob_bsho_req_mode_current_bs current_bs[MAX_NBR];
  656.   //also include the following elements defined in mode 0b001
  657.   //u_char tmp_bsid: 3;
  658.   //u_char ak_change_indicator: 1;
  659.   //u_char n_cids;
  660.   //uint16_t cids[MAX_NBR];
  661.   //u_char n_saids;
  662.   //uint16_t saids[MAX_NBR];
  663.   
  664.   //if mode == 0b100, include the following attributes (already defined)
  665.   //u_char n_new_bs: 3;
  666.   //mac802_16_mob_bsho_req_mode_new_bs new_bs[MAX_NBR];
  667.   //u_char n_current_bs: 3;
  668.   //mac802_16_mob_bsho_req_mode_current_bs current_bs[MAX_NBR];
  669.   //u_char tmp_bsid: 3;
  670.   //u_char ak_change_indicator: 1;
  671.   
  672.   //if mode == 0b101
  673.   //u_char n_new_bs: 3;
  674.   //u_char n_cids;
  675.   //u_char n_saids;
  676.   mac802_16_mob_bsho_req_mode_new_bs2 new_bs2[MAX_NBR];
  677.   //u_char n_current_bs: 3;
  678.   //mac802_16_mob_bsho_req_mode_current_bs current_bs[];
  679.   //u_char tmp_bsid: 3;
  680.   //u_char ak_change_indicator: 1;
  681.   
  682.   //if mode == 0b110
  683.   //u_char n_new_bs: 3;
  684.   //u_char n_cids;
  685.   //u_char n_saids;
  686.   mac802_16_mob_bsho_req_mode_new_bs3 new_bs3[MAX_NBR];
  687.   //u_char n_current_bs: 3;
  688.   //mac802_16_mob_bsho_req_mode_current_bs current_bs[];
  689.   //u_char tmp_bsid: 3;
  690.   //u_char ak_change_indicator: 1;
  692.   u_char action_time: 7;
  693.   /* TLV information */
  694. };
  696. /** Structure for MSHO request */
  697. struct mac802_16_mob_msho_req_bs_index {
  698.   u_char neighbor_bs_index;
  699.   u_char preamble_index;
  700.   u_char bs_cinr_mean; //if report_metric[0]==1
  701.   u_char bs_rssi_mean; //if report_metric[1]==1
  702.   u_char relative_delay; //if report_metric[2]==1
  703.   u_char service_level_prediction: 3;
  704.   u_char arrival_time_diff_ind: 1;
  705.   //next if arrival_time_diff_ind==1
  706.   u_char arrival_time_diff: 4;
  707. };
  709. /** Structure for MSHO request */
  710. struct mac802_16_mob_msho_req_current_bs {
  711.   u_char temp_bsid: 4;
  712.   u_char bs_cinr_mean; //if report_metric[0]==1
  713.   u_char bs_rssi_mean; //if report_metric[1]==1
  714.   u_char relative_delay; //if report_metric[2]==1
  715.   u_char bs_rtd; //if report_metric[3]==1
  716. };
  718. /** MSHO request frame */
  719. struct mac802_16_mob_msho_req_frame {
  720.   u_char type; //57
  721.   u_char report_metric;
  722.   u_char n_new_bs_index;
  723.   //next if n_recommended_bs_index !=0
  724.   u_char ccc_mob_nbr_adv;
  725.   mac802_16_mob_msho_req_bs_index bs_index[MAX_NBR];
  726.   //end 
  727.   u_char n_new_bs_full;
  728.   mac802_16_mob_msho_req_bs_index bs_full[MAX_NBR];
  729.   u_char n_current_bs;
  730.   mac802_16_mob_msho_req_current_bs bs_current[MAX_NBR];
  731.   /* other TLV information */
  732. };
  734. /** Structure for BSHO response */
  735. struct mac802_16_mob_bsho_rsp_rec {
  736.   int neighbor_bsid; /* 6 bytes */
  737.   u_char preamble_index;
  738.   u_char service_level_prediction;
  739.   u_char ho_process_optimization;
  740.   u_char net_assisted_ho_supported: 1;
  741.   u_char ho_id_included_indicator: 1;
  742.   //if ho_id_included_indicator==1
  743.   u_char ho_id;
  744.   //end if
  745.   u_char ho_autho_policy_indicator: 1;
  746.   //if ho_autho_policy_indicator==1
  747.   u_char ho_autho_policy_support;
  748.   //end if
  749.   
  750. };
  752. /** Structure for BSHO response */
  753. struct mac802_16_mob_bsho_rsp_mode_new_bs2 {
  754.   int neighbor_bsid; /* 6 bytes */
  755.   u_char temp_bsid: 3;
  756.   uint16_t new_cid[];
  757. };
  759. /** BSHO response frame */
  760. struct mac802_16_mob_bsho_rsp_frame {
  761.   u_char type; //58
  762.   u_char mode: 3;
  763.   
  764.   //if mode == 0b000
  765.   u_char ho_operation_mode: 1;
  766.   u_char n_recommended;
  767.   u_char resource_retain_flag: 1;
  768.   mac802_16_mob_bsho_rsp_rec n_rec[MAX_NBR];
  770.   //if mode == 0b001
  771.   u_char tmp_bsid: 3;
  772.   u_char ak_change_indicator: 1;
  773.   u_char n_cids;
  774.   uint16_t cids[MAX_NBR];
  775.   u_char n_saids;
  776.   uint16_t saids[MAX_NBR];
  778.   //if mode == 0b010
  779.   //u_char tmp_bsid: 3;
  780.   //u_char ak_change_indicator: 1;
  782.   //if mode == 0b011
  783.   u_char n_new_bs: 3;
  784.   mac802_16_mob_bsho_req_mode_new_bs new_bs[MAX_NBR];
  785.   u_char n_current_bs: 3;
  786.   mac802_16_mob_bsho_req_mode_current_bs current_bs[MAX_NBR];
  787.   //also include the following elements defined in mode 0b001
  788.   //u_char tmp_bsid: 3;
  789.   //u_char ak_change_indicator: 1;
  790.   //u_char n_cids;
  791.   //uint16_t cids[MAX_NBR];
  792.   //u_char n_saids;
  793.   //uint16_t saids[MAX_NBR];
  795.   //if mode == 0b100
  796.   //u_char n_new_bs: 3;
  797.   //mac802_16_mob_bsho_req_mode_new_bs new_bs[MAX_NBR]; //same struct as req
  798.   //u_char n_current_bs: 3;
  799.   //mac802_16_mob_bsho_req_mode_current_bs current_bs[MAX_NBR]; //same as req
  800.   //u_char tmp_bsid: 3;
  801.   //u_char ak_change_indicator: 1;
  803.   //if mode == 0b101
  804.   //u_char n_new_bs: 3;
  805.   //u_char n_cids;
  806.   mac802_16_mob_bsho_rsp_mode_new_bs2 new_bs2[MAX_NBR];
  807.   //u_char n_current_bs: 3;
  808.   //mac802_16_mob_bsho_req_mode_current_bs current_bs[MAX_NBR];
  809.   //u_char tmp_bsid: 3;
  810.   //u_char ak_change_indicator: 1;
  811.   
  812.   //if mode == 0b110
  813.   //u_char n_new_bs: 3;
  814.   //u_char n_cids;
  815.   //u_char n_saids;
  816.   mac802_16_mob_bsho_req_mode_new_bs3 new_bs3[MAX_NBR]; //same as request
  817.   //u_char n_current_bs: 3;
  818.   //mac802_16_mob_bsho_req_mode_current_bs current_bs[MAX_NBR];
  819.   //u_char tmp_bsid: 3;
  820.   //u_char ak_change_indicator: 1;
  822.   u_char action_time: 7;
  823.   /* TLV information */
  825. };
  827. /** Structure for Handover indication */
  828. struct mac802_16_mob_ho_ind_bs {
  829.   u_char temp_bsid: 3;
  830. };
  832. /** HO indication frame */
  833. struct mac802_16_mob_ho_ind_frame {
  834.   u_char type; //59
  835.   u_char mode: 2;
  836.   //if mode==0b00
  837.   u_char ho_ind_type: 2;
  838.   u_char rng_param_valid_ind: 2;
  839.   //next valid if ho_ind_type==0b00
  840.   int target_bsid; /* 6 bytes */
  841.   
  842.   //if mode==0b01
  843.   u_char mdhofbss_ind_type: 2;
  844.   //next valid if mdhofbss_ind_type==0b00
  845.   u_char bsid: 3;
  846.   u_char action_time;
  847.   //end valid if mdhofbss_ind_type==0b00
  849.   //if mode==0b10
  850.   //u_char mdhofbss_ind_type: 2;
  851.   //next valid if mdhofbss_ind_type==0b00
  852.   u_char diversity_set_included;
  853.   //next valid if diversity_set_included==1
  854.   u_char anchor_bsid: 3;
  855.   u_char n_bs;
  856.   mac802_16_mob_ho_ind_bs bs[MAX_NBR];
  857.   //end valid if diversity_set_included==1
  858.   //u_char action_time;
  859.   //end valid if mdhofbss_ind_type==0b00
  860.   u_char preamble_index;
  861.   
  862.   /* TLV information */
  863. };
  865. /** This class contains helpers for manipulating 802.16 messages
  866.  *  and getting the packet size 
  867.  */
  868. class Mac802_16pkt {
  869.  public:
  870.   /**
  871.    * Return the size of the MOB_NBR-ADV frame
  872.    * @param frame The frame 
  873.    */
  874.   static int getMOB_NBR_ADV_size(mac802_16_mob_nbr_adv_frame *frame);
  876.   /**
  877.    * Return the size of the MOB_SCN-REQ 
  878.    * @param frame The frame 
  879.    */
  880.   static int getMOB_SCN_REQ_size(mac802_16_mob_scn_req_frame *frame);
  882.   /**
  883.    * Return the size of the MOB_SCN-RSP 
  884.    * @param frame The frame 
  885.    */
  886.   static int getMOB_SCN_RSP_size(mac802_16_mob_scn_rsp_frame *frame);
  888.   /**
  889.    * Return the size of the MOB_MSHO-REQ 
  890.    * @param frame The frame 
  891.    */
  892.   static int getMOB_MSHO_REQ_size(mac802_16_mob_msho_req_frame *frame);
  894.   /**
  895.    * Return the size of the MOB_BSHO-RSP 
  896.    * @param frame The frame 
  897.    */
  898.   static int getMOB_BSHO_RSP_size(mac802_16_mob_bsho_rsp_frame *frame);
  900.   /**
  901.    * Return the size of the MOB_HO-IND 
  902.    * @param frame The frame 
  903.    */
  904.   static int getMOB_HO_IND_size(mac802_16_mob_ho_ind_frame *frame);
  905. };
  908. #endif