1 /* 2 * 802.11e protocol header file 3 * 4 * Copyright (C) 1999-2019, Broadcom. 5 * 6 * Unless you and Broadcom execute a separate written software license 7 * agreement governing use of this software, this software is licensed to you 8 * under the terms of the GNU General Public License version 2 (the "GPL"), 9 * available at http://www.broadcom.com/licenses/GPLv2.php, with the 10 * following added to such license: 11 * 12 * As a special exception, the copyright holders of this software give you 13 * permission to link this software with independent modules, and to copy and 14 * distribute the resulting executable under terms of your choice, provided that 15 * you also meet, for each linked independent module, the terms and conditions 16 * of the license of that module. An independent module is a module which is 17 * not derived from this software. The special exception does not apply to any 18 * modifications of the software. 19 * 20 * Notwithstanding the above, under no circumstances may you combine this 21 * software in any way with any other Broadcom software provided under a license 22 * other than the GPL, without Broadcom's express prior written consent. 23 * 24 * 25 * <<Broadcom-WL-IPTag/Open:>> 26 * 27 * $Id: 802.11e.h 785355 2018-10-18 05:32:56Z $ 28 */ 29 30 #ifndef _802_11e_H_ 31 #define _802_11e_H_ 32 33 #ifndef _TYPEDEFS_H_ 34 #include <typedefs.h> 35 #endif // endif 36 37 /* This marks the start of a packed structure section. */ 38 #include <packed_section_start.h> 39 40 /* WME Traffic Specification (TSPEC) element */ 41 #define WME_TSPEC_HDR_LEN 2 /* WME TSPEC header length */ 42 #define WME_TSPEC_BODY_OFF 2 /* WME TSPEC body offset */ 43 44 #define WME_CATEGORY_CODE_OFFSET 0 /* WME Category code offset */ 45 #define WME_ACTION_CODE_OFFSET 1 /* WME Action code offset */ 46 #define WME_TOKEN_CODE_OFFSET 2 /* WME Token code offset */ 47 #define WME_STATUS_CODE_OFFSET 3 /* WME Status code offset */ 48 49 BWL_PRE_PACKED_STRUCT struct tsinfo { 50 uint8 octets[3]; 51 } BWL_POST_PACKED_STRUCT; 52 53 typedef struct tsinfo tsinfo_t; 54 55 /* 802.11e TSPEC IE */ 56 typedef BWL_PRE_PACKED_STRUCT struct tspec { 57 uint8 oui[DOT11_OUI_LEN]; /* WME_OUI */ 58 uint8 type; /* WME_TYPE */ 59 uint8 subtype; /* WME_SUBTYPE_TSPEC */ 60 uint8 version; /* WME_VERSION */ 61 tsinfo_t tsinfo; /* TS Info bit field */ 62 uint16 nom_msdu_size; /* (Nominal or fixed) MSDU Size (bytes) */ 63 uint16 max_msdu_size; /* Maximum MSDU Size (bytes) */ 64 uint32 min_srv_interval; /* Minimum Service Interval (us) */ 65 uint32 max_srv_interval; /* Maximum Service Interval (us) */ 66 uint32 inactivity_interval; /* Inactivity Interval (us) */ 67 uint32 suspension_interval; /* Suspension Interval (us) */ 68 uint32 srv_start_time; /* Service Start Time (us) */ 69 uint32 min_data_rate; /* Minimum Data Rate (bps) */ 70 uint32 mean_data_rate; /* Mean Data Rate (bps) */ 71 uint32 peak_data_rate; /* Peak Data Rate (bps) */ 72 uint32 max_burst_size; /* Maximum Burst Size (bytes) */ 73 uint32 delay_bound; /* Delay Bound (us) */ 74 uint32 min_phy_rate; /* Minimum PHY Rate (bps) */ 75 uint16 surplus_bw; /* Surplus Bandwidth Allowance (range 1.0-8.0) */ 76 uint16 medium_time; /* Medium Time (32 us/s periods) */ 77 } BWL_POST_PACKED_STRUCT tspec_t; 78 79 #define WME_TSPEC_LEN (sizeof(tspec_t)) /* not including 2-bytes of header */ 80 81 /* ts_info */ 82 /* 802.1D priority is duplicated - bits 13-11 AND bits 3-1 */ 83 #define TS_INFO_TID_SHIFT 1 /* TS info. TID shift */ 84 #define TS_INFO_TID_MASK (0xf << TS_INFO_TID_SHIFT) /* TS info. TID mask */ 85 #define TS_INFO_CONTENTION_SHIFT 7 /* TS info. contention shift */ 86 #define TS_INFO_CONTENTION_MASK \ 87 (0x1 << TS_INFO_CONTENTION_SHIFT) /* TS info. contention mask */ 88 #define TS_INFO_DIRECTION_SHIFT 5 /* TS info. direction shift */ 89 #define TS_INFO_DIRECTION_MASK \ 90 (0x3 << TS_INFO_DIRECTION_SHIFT) /* TS info. direction mask */ 91 #define TS_INFO_PSB_SHIFT 2 /* TS info. PSB bit Shift */ 92 #define TS_INFO_PSB_MASK (1 << TS_INFO_PSB_SHIFT) /* TS info. PSB mask */ 93 #define TS_INFO_UPLINK (0 << TS_INFO_DIRECTION_SHIFT) /* TS info. uplink */ 94 #define TS_INFO_DOWNLINK (1 << TS_INFO_DIRECTION_SHIFT) /* TS info. downlink \ 95 */ 96 #define TS_INFO_BIDIRECTIONAL \ 97 (3 << TS_INFO_DIRECTION_SHIFT) /* TS info. bidirectional */ 98 #define TS_INFO_USER_PRIO_SHIFT 3 /* TS info. user priority shift */ 99 /* TS info. user priority mask */ 100 #define TS_INFO_USER_PRIO_MASK (0x7 << TS_INFO_USER_PRIO_SHIFT) 101 102 /* Macro to get/set bit(s) field in TSINFO */ 103 #define WLC_CAC_GET_TID(pt) \ 104 ((((pt).octets[0]) & TS_INFO_TID_MASK) >> TS_INFO_TID_SHIFT) 105 #define WLC_CAC_GET_DIR(pt) \ 106 ((((pt).octets[0]) & TS_INFO_DIRECTION_MASK) >> TS_INFO_DIRECTION_SHIFT) 107 #define WLC_CAC_GET_PSB(pt) \ 108 ((((pt).octets[1]) & TS_INFO_PSB_MASK) >> TS_INFO_PSB_SHIFT) 109 #define WLC_CAC_GET_USER_PRIO(pt) \ 110 ((((pt).octets[1]) & TS_INFO_USER_PRIO_MASK) >> TS_INFO_USER_PRIO_SHIFT) 111 112 #define WLC_CAC_SET_TID(pt, id) \ 113 ((((pt).octets[0]) & (~TS_INFO_TID_MASK)) | ((id) << TS_INFO_TID_SHIFT)) 114 #define WLC_CAC_SET_USER_PRIO(pt, prio) \ 115 ((((pt).octets[0]) & (~TS_INFO_USER_PRIO_MASK)) | \ 116 ((prio) << TS_INFO_USER_PRIO_SHIFT)) 117 118 /* 802.11e QBSS Load IE */ 119 #define QBSS_LOAD_IE_LEN 5 /* QBSS Load IE length */ 120 #define QBSS_LOAD_AAC_OFF 3 /* AAC offset in IE */ 121 122 #define CAC_ADDTS_RESP_TIMEOUT 1000 /* default ADDTS response timeout in ms */ 123 /* DEFVAL dot11ADDTSResponseTimeout = 1s */ 124 125 /* 802.11e ADDTS status code */ 126 #define DOT11E_STATUS_ADMISSION_ACCEPTED 0 /* TSPEC Admission accepted status \ 127 */ 128 #define DOT11E_STATUS_ADDTS_INVALID_PARAM 1 /* TSPEC invalid parameter status \ 129 */ 130 #define DOT11E_STATUS_ADDTS_REFUSED_NSBW \ 131 3 /* ADDTS refused (non-sufficient BW) */ 132 #define DOT11E_STATUS_ADDTS_REFUSED_AWHILE \ 133 47 /* ADDTS refused but could retry later */ 134 #ifdef BCMCCX 135 #define CCX_STATUS_ASSOC_DENIED_UNKNOWN \ 136 0xc8 /* unspecified QoS related failure */ 137 #define CCX_STATUS_ASSOC_DENIED_AP_POLICY \ 138 0xc9 /* TSPEC refused due to AP policy */ 139 #define CCX_STATUS_ASSOC_DENIED_NO_BW \ 140 0xca /* Assoc denied due to AP insufficient BW */ 141 #define CCX_STATUS_ASSOC_DENIED_BAD_PARAM \ 142 0xcb /* one or more TSPEC with invalid parameter */ 143 #endif /* BCMCCX */ 144 145 /* 802.11e DELTS status code */ 146 #define DOT11E_STATUS_QSTA_LEAVE_QBSS 36 /* STA leave QBSS */ 147 #define DOT11E_STATUS_END_TS 37 /* END TS */ 148 #define DOT11E_STATUS_UNKNOWN_TS 38 /* UNKNOWN TS */ 149 #define DOT11E_STATUS_QSTA_REQ_TIMEOUT 39 /* STA ADDTS request timeout */ 150 151 /* This marks the end of a packed structure section. */ 152 #include <packed_section_end.h> 153 154 #endif /* _802_11e_CAC_H_ */ 155