1 /* 2 * mac80211 <-> driver interface 3 * 4 * Copyright 2002-2005, Devicescape Software, Inc. 5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz> 6 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net> 7 * Copyright 2013-2014 Intel Mobile Communications GmbH 8 * 9 * This program is free software; you can redistribute it and/or modify 10 * it under the terms of the GNU General Public License version 2 as 11 * published by the Free Software Foundation. 12 */ 13 14 #ifndef MAC80211_H 15 #define MAC80211_H 16 17 #include <linux/bug.h> 18 #include <linux/kernel.h> 19 #include <linux/if_ether.h> 20 #include <linux/skbuff.h> 21 #include <linux/ieee80211.h> 22 #include <net/cfg80211.h> 23 #include <asm/unaligned.h> 24 25 /** 26 * DOC: Introduction 27 * 28 * mac80211 is the Linux stack for 802.11 hardware that implements 29 * only partial functionality in hard- or firmware. This document 30 * defines the interface between mac80211 and low-level hardware 31 * drivers. 32 */ 33 34 /** 35 * DOC: Calling mac80211 from interrupts 36 * 37 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be 38 * called in hardware interrupt context. The low-level driver must not call any 39 * other functions in hardware interrupt context. If there is a need for such 40 * call, the low-level driver should first ACK the interrupt and perform the 41 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even 42 * tasklet function. 43 * 44 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also 45 * use the non-IRQ-safe functions! 46 */ 47 48 /** 49 * DOC: Warning 50 * 51 * If you're reading this document and not the header file itself, it will 52 * be incomplete because not all documentation has been converted yet. 53 */ 54 55 /** 56 * DOC: Frame format 57 * 58 * As a general rule, when frames are passed between mac80211 and the driver, 59 * they start with the IEEE 802.11 header and include the same octets that are 60 * sent over the air except for the FCS which should be calculated by the 61 * hardware. 62 * 63 * There are, however, various exceptions to this rule for advanced features: 64 * 65 * The first exception is for hardware encryption and decryption offload 66 * where the IV/ICV may or may not be generated in hardware. 67 * 68 * Secondly, when the hardware handles fragmentation, the frame handed to 69 * the driver from mac80211 is the MSDU, not the MPDU. 70 */ 71 72 /** 73 * DOC: mac80211 workqueue 74 * 75 * mac80211 provides its own workqueue for drivers and internal mac80211 use. 76 * The workqueue is a single threaded workqueue and can only be accessed by 77 * helpers for sanity checking. Drivers must ensure all work added onto the 78 * mac80211 workqueue should be cancelled on the driver stop() callback. 79 * 80 * mac80211 will flushed the workqueue upon interface removal and during 81 * suspend. 82 * 83 * All work performed on the mac80211 workqueue must not acquire the RTNL lock. 84 * 85 */ 86 87 struct device; 88 89 /** 90 * enum ieee80211_max_queues - maximum number of queues 91 * 92 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues. 93 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set 94 */ 95 enum ieee80211_max_queues { 96 IEEE80211_MAX_QUEUES = 16, 97 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1, 98 }; 99 100 #define IEEE80211_INVAL_HW_QUEUE 0xff 101 102 /** 103 * enum ieee80211_ac_numbers - AC numbers as used in mac80211 104 * @IEEE80211_AC_VO: voice 105 * @IEEE80211_AC_VI: video 106 * @IEEE80211_AC_BE: best effort 107 * @IEEE80211_AC_BK: background 108 */ 109 enum ieee80211_ac_numbers { 110 IEEE80211_AC_VO = 0, 111 IEEE80211_AC_VI = 1, 112 IEEE80211_AC_BE = 2, 113 IEEE80211_AC_BK = 3, 114 }; 115 #define IEEE80211_NUM_ACS 4 116 117 /** 118 * struct ieee80211_tx_queue_params - transmit queue configuration 119 * 120 * The information provided in this structure is required for QoS 121 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29. 122 * 123 * @aifs: arbitration interframe space [0..255] 124 * @cw_min: minimum contention window [a value of the form 125 * 2^n-1 in the range 1..32767] 126 * @cw_max: maximum contention window [like @cw_min] 127 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled 128 * @acm: is mandatory admission control required for the access category 129 * @uapsd: is U-APSD mode enabled for the queue 130 */ 131 struct ieee80211_tx_queue_params { 132 u16 txop; 133 u16 cw_min; 134 u16 cw_max; 135 u8 aifs; 136 bool acm; 137 bool uapsd; 138 }; 139 140 struct ieee80211_low_level_stats { 141 unsigned int dot11ACKFailureCount; 142 unsigned int dot11RTSFailureCount; 143 unsigned int dot11FCSErrorCount; 144 unsigned int dot11RTSSuccessCount; 145 }; 146 147 /** 148 * enum ieee80211_chanctx_change - change flag for channel context 149 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed 150 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed 151 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed 152 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel, 153 * this is used only with channel switching with CSA 154 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed 155 */ 156 enum ieee80211_chanctx_change { 157 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0), 158 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1), 159 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2), 160 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3), 161 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4), 162 }; 163 164 /** 165 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to 166 * 167 * This is the driver-visible part. The ieee80211_chanctx 168 * that contains it is visible in mac80211 only. 169 * 170 * @def: the channel definition 171 * @min_def: the minimum channel definition currently required. 172 * @rx_chains_static: The number of RX chains that must always be 173 * active on the channel to receive MIMO transmissions 174 * @rx_chains_dynamic: The number of RX chains that must be enabled 175 * after RTS/CTS handshake to receive SMPS MIMO transmissions; 176 * this will always be >= @rx_chains_static. 177 * @radar_enabled: whether radar detection is enabled on this channel. 178 * @drv_priv: data area for driver use, will always be aligned to 179 * sizeof(void *), size is determined in hw information. 180 */ 181 struct ieee80211_chanctx_conf { 182 struct cfg80211_chan_def def; 183 struct cfg80211_chan_def min_def; 184 185 u8 rx_chains_static, rx_chains_dynamic; 186 187 bool radar_enabled; 188 189 u8 drv_priv[0] __aligned(sizeof(void *)); 190 }; 191 192 /** 193 * enum ieee80211_chanctx_switch_mode - channel context switch mode 194 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already 195 * exist (and will continue to exist), but the virtual interface 196 * needs to be switched from one to the other. 197 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop 198 * to exist with this call, the new context doesn't exist but 199 * will be active after this call, the virtual interface switches 200 * from the old to the new (note that the driver may of course 201 * implement this as an on-the-fly chandef switch of the existing 202 * hardware context, but the mac80211 pointer for the old context 203 * will cease to exist and only the new one will later be used 204 * for changes/removal.) 205 */ 206 enum ieee80211_chanctx_switch_mode { 207 CHANCTX_SWMODE_REASSIGN_VIF, 208 CHANCTX_SWMODE_SWAP_CONTEXTS, 209 }; 210 211 /** 212 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information 213 * 214 * This is structure is used to pass information about a vif that 215 * needs to switch from one chanctx to another. The 216 * &ieee80211_chanctx_switch_mode defines how the switch should be 217 * done. 218 * 219 * @vif: the vif that should be switched from old_ctx to new_ctx 220 * @old_ctx: the old context to which the vif was assigned 221 * @new_ctx: the new context to which the vif must be assigned 222 */ 223 struct ieee80211_vif_chanctx_switch { 224 struct ieee80211_vif *vif; 225 struct ieee80211_chanctx_conf *old_ctx; 226 struct ieee80211_chanctx_conf *new_ctx; 227 }; 228 229 /** 230 * enum ieee80211_bss_change - BSS change notification flags 231 * 232 * These flags are used with the bss_info_changed() callback 233 * to indicate which BSS parameter changed. 234 * 235 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated), 236 * also implies a change in the AID. 237 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed 238 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed 239 * @BSS_CHANGED_ERP_SLOT: slot timing changed 240 * @BSS_CHANGED_HT: 802.11n parameters changed 241 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed 242 * @BSS_CHANGED_BEACON_INT: Beacon interval changed 243 * @BSS_CHANGED_BSSID: BSSID changed, for whatever 244 * reason (IBSS and managed mode) 245 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve 246 * new beacon (beaconing modes) 247 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be 248 * enabled/disabled (beaconing modes) 249 * @BSS_CHANGED_CQM: Connection quality monitor config changed 250 * @BSS_CHANGED_IBSS: IBSS join status changed 251 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed. 252 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note 253 * that it is only ever disabled for station mode. 254 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface. 255 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode) 256 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode) 257 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode) 258 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface 259 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS) 260 * changed (currently only in P2P client mode, GO mode will be later) 261 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available: 262 * currently dtim_period only is under consideration. 263 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed, 264 * note that this is only called when it changes after the channel 265 * context had been assigned. 266 * @BSS_CHANGED_OCB: OCB join status changed 267 */ 268 enum ieee80211_bss_change { 269 BSS_CHANGED_ASSOC = 1<<0, 270 BSS_CHANGED_ERP_CTS_PROT = 1<<1, 271 BSS_CHANGED_ERP_PREAMBLE = 1<<2, 272 BSS_CHANGED_ERP_SLOT = 1<<3, 273 BSS_CHANGED_HT = 1<<4, 274 BSS_CHANGED_BASIC_RATES = 1<<5, 275 BSS_CHANGED_BEACON_INT = 1<<6, 276 BSS_CHANGED_BSSID = 1<<7, 277 BSS_CHANGED_BEACON = 1<<8, 278 BSS_CHANGED_BEACON_ENABLED = 1<<9, 279 BSS_CHANGED_CQM = 1<<10, 280 BSS_CHANGED_IBSS = 1<<11, 281 BSS_CHANGED_ARP_FILTER = 1<<12, 282 BSS_CHANGED_QOS = 1<<13, 283 BSS_CHANGED_IDLE = 1<<14, 284 BSS_CHANGED_SSID = 1<<15, 285 BSS_CHANGED_AP_PROBE_RESP = 1<<16, 286 BSS_CHANGED_PS = 1<<17, 287 BSS_CHANGED_TXPOWER = 1<<18, 288 BSS_CHANGED_P2P_PS = 1<<19, 289 BSS_CHANGED_BEACON_INFO = 1<<20, 290 BSS_CHANGED_BANDWIDTH = 1<<21, 291 BSS_CHANGED_OCB = 1<<22, 292 293 /* when adding here, make sure to change ieee80211_reconfig */ 294 }; 295 296 /* 297 * The maximum number of IPv4 addresses listed for ARP filtering. If the number 298 * of addresses for an interface increase beyond this value, hardware ARP 299 * filtering will be disabled. 300 */ 301 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4 302 303 /** 304 * enum ieee80211_rssi_event - RSSI threshold event 305 * An indicator for when RSSI goes below/above a certain threshold. 306 * @RSSI_EVENT_HIGH: AP's rssi crossed the high threshold set by the driver. 307 * @RSSI_EVENT_LOW: AP's rssi crossed the low threshold set by the driver. 308 */ 309 enum ieee80211_rssi_event { 310 RSSI_EVENT_HIGH, 311 RSSI_EVENT_LOW, 312 }; 313 314 /** 315 * struct ieee80211_bss_conf - holds the BSS's changing parameters 316 * 317 * This structure keeps information about a BSS (and an association 318 * to that BSS) that can change during the lifetime of the BSS. 319 * 320 * @assoc: association status 321 * @ibss_joined: indicates whether this station is part of an IBSS 322 * or not 323 * @ibss_creator: indicates if a new IBSS network is being created 324 * @aid: association ID number, valid only when @assoc is true 325 * @use_cts_prot: use CTS protection 326 * @use_short_preamble: use 802.11b short preamble; 327 * if the hardware cannot handle this it must set the 328 * IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag 329 * @use_short_slot: use short slot time (only relevant for ERP); 330 * if the hardware cannot handle this it must set the 331 * IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag 332 * @dtim_period: num of beacons before the next DTIM, for beaconing, 333 * valid in station mode only if after the driver was notified 334 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then. 335 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old 336 * as it may have been received during scanning long ago). If the 337 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can 338 * only come from a beacon, but might not become valid until after 339 * association when a beacon is received (which is notified with the 340 * %BSS_CHANGED_DTIM flag.) 341 * @sync_device_ts: the device timestamp corresponding to the sync_tsf, 342 * the driver/device can use this to calculate synchronisation 343 * (see @sync_tsf) 344 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY 345 * is requested, see @sync_tsf/@sync_device_ts. 346 * @beacon_int: beacon interval 347 * @assoc_capability: capabilities taken from assoc resp 348 * @basic_rates: bitmap of basic rates, each bit stands for an 349 * index into the rate table configured by the driver in 350 * the current band. 351 * @beacon_rate: associated AP's beacon TX rate 352 * @mcast_rate: per-band multicast rate index + 1 (0: disabled) 353 * @bssid: The BSSID for this BSS 354 * @enable_beacon: whether beaconing should be enabled or not 355 * @chandef: Channel definition for this BSS -- the hardware might be 356 * configured a higher bandwidth than this BSS uses, for example. 357 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation. 358 * This field is only valid when the channel type is one of the HT types. 359 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value 360 * implies disabled 361 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis 362 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The 363 * may filter ARP queries targeted for other addresses than listed here. 364 * The driver must allow ARP queries targeted for all address listed here 365 * to pass through. An empty list implies no ARP queries need to pass. 366 * @arp_addr_cnt: Number of addresses currently on the list. Note that this 367 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list 368 * array size), it's up to the driver what to do in that case. 369 * @qos: This is a QoS-enabled BSS. 370 * @idle: This interface is idle. There's also a global idle flag in the 371 * hardware config which may be more appropriate depending on what 372 * your driver/device needs to do. 373 * @ps: power-save mode (STA only). This flag is NOT affected by 374 * offchannel/dynamic_ps operations. 375 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode. 376 * @ssid_len: Length of SSID given in @ssid. 377 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode. 378 * @txpower: TX power in dBm 379 * @txpower_type: TX power adjustment used to control per packet Transmit 380 * Power Control (TPC) in lower driver for the current vif. In particular 381 * TPC is enabled if value passed in %txpower_type is 382 * NL80211_TX_POWER_LIMITED (allow using less than specified from 383 * userspace), whereas TPC is disabled if %txpower_type is set to 384 * NL80211_TX_POWER_FIXED (use value configured from userspace) 385 * @p2p_noa_attr: P2P NoA attribute for P2P powersave 386 */ 387 struct ieee80211_bss_conf { 388 const u8 *bssid; 389 /* association related data */ 390 bool assoc, ibss_joined; 391 bool ibss_creator; 392 u16 aid; 393 /* erp related data */ 394 bool use_cts_prot; 395 bool use_short_preamble; 396 bool use_short_slot; 397 bool enable_beacon; 398 u8 dtim_period; 399 u16 beacon_int; 400 u16 assoc_capability; 401 u64 sync_tsf; 402 u32 sync_device_ts; 403 u8 sync_dtim_count; 404 u32 basic_rates; 405 struct ieee80211_rate *beacon_rate; 406 int mcast_rate[IEEE80211_NUM_BANDS]; 407 u16 ht_operation_mode; 408 s32 cqm_rssi_thold; 409 u32 cqm_rssi_hyst; 410 struct cfg80211_chan_def chandef; 411 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN]; 412 int arp_addr_cnt; 413 bool qos; 414 bool idle; 415 bool ps; 416 u8 ssid[IEEE80211_MAX_SSID_LEN]; 417 size_t ssid_len; 418 bool hidden_ssid; 419 int txpower; 420 enum nl80211_tx_power_setting txpower_type; 421 struct ieee80211_p2p_noa_attr p2p_noa_attr; 422 }; 423 424 /** 425 * enum mac80211_tx_info_flags - flags to describe transmission information/status 426 * 427 * These flags are used with the @flags member of &ieee80211_tx_info. 428 * 429 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame. 430 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence 431 * number to this frame, taking care of not overwriting the fragment 432 * number and increasing the sequence number only when the 433 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly 434 * assign sequence numbers to QoS-data frames but cannot do so correctly 435 * for non-QoS-data and management frames because beacons need them from 436 * that counter as well and mac80211 cannot guarantee proper sequencing. 437 * If this flag is set, the driver should instruct the hardware to 438 * assign a sequence number to the frame or assign one itself. Cf. IEEE 439 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for 440 * beacons and always be clear for frames without a sequence number field. 441 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack 442 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination 443 * station 444 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame 445 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon 446 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU 447 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211. 448 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted 449 * because the destination STA was in powersave mode. Note that to 450 * avoid race conditions, the filter must be set by the hardware or 451 * firmware upon receiving a frame that indicates that the station 452 * went to sleep (must be done on device to filter frames already on 453 * the queue) and may only be unset after mac80211 gives the OK for 454 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above), 455 * since only then is it guaranteed that no more frames are in the 456 * hardware queue. 457 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged 458 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status 459 * is for the whole aggregation. 460 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned, 461 * so consider using block ack request (BAR). 462 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be 463 * set by rate control algorithms to indicate probe rate, will 464 * be cleared for fragmented frames (except on the last fragment) 465 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate 466 * that a frame can be transmitted while the queues are stopped for 467 * off-channel operation. 468 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211, 469 * used to indicate that a pending frame requires TX processing before 470 * it can be sent out. 471 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211, 472 * used to indicate that a frame was already retried due to PS 473 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211, 474 * used to indicate frame should not be encrypted 475 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll 476 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must 477 * be sent although the station is in powersave mode. 478 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the 479 * transmit function after the current frame, this can be used 480 * by drivers to kick the DMA queue only if unset or when the 481 * queue gets full. 482 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted 483 * after TX status because the destination was asleep, it must not 484 * be modified again (no seqno assignment, crypto, etc.) 485 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME 486 * code for connection establishment, this indicates that its status 487 * should kick the MLME state machine. 488 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211 489 * MLME command (internal to mac80211 to figure out whether to send TX 490 * status to user space) 491 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame 492 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this 493 * frame and selects the maximum number of streams that it can use. 494 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on 495 * the off-channel channel when a remain-on-channel offload is done 496 * in hardware -- normal packets still flow and are expected to be 497 * handled properly by the device. 498 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP 499 * testing. It will be sent out with incorrect Michael MIC key to allow 500 * TKIP countermeasures to be tested. 501 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate. 502 * This flag is actually used for management frame especially for P2P 503 * frames not being sent at CCK rate in 2GHz band. 504 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period, 505 * when its status is reported the service period ends. For frames in 506 * an SP that mac80211 transmits, it is already set; for driver frames 507 * the driver may set this flag. It is also used to do the same for 508 * PS-Poll responses. 509 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate. 510 * This flag is used to send nullfunc frame at minimum rate when 511 * the nullfunc is used for connection monitoring purpose. 512 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it 513 * would be fragmented by size (this is optional, only used for 514 * monitor injection). 515 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with 516 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without 517 * any errors (like issues specific to the driver/HW). 518 * This flag must not be set for frames that don't request no-ack 519 * behaviour with IEEE80211_TX_CTL_NO_ACK. 520 * 521 * Note: If you have to add new flags to the enumeration, then don't 522 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary. 523 */ 524 enum mac80211_tx_info_flags { 525 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0), 526 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1), 527 IEEE80211_TX_CTL_NO_ACK = BIT(2), 528 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3), 529 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4), 530 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5), 531 IEEE80211_TX_CTL_AMPDU = BIT(6), 532 IEEE80211_TX_CTL_INJECTED = BIT(7), 533 IEEE80211_TX_STAT_TX_FILTERED = BIT(8), 534 IEEE80211_TX_STAT_ACK = BIT(9), 535 IEEE80211_TX_STAT_AMPDU = BIT(10), 536 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11), 537 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12), 538 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13), 539 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14), 540 IEEE80211_TX_INTFL_RETRIED = BIT(15), 541 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16), 542 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17), 543 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18), 544 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19), 545 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20), 546 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21), 547 IEEE80211_TX_CTL_LDPC = BIT(22), 548 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24), 549 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25), 550 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26), 551 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27), 552 IEEE80211_TX_STATUS_EOSP = BIT(28), 553 IEEE80211_TX_CTL_USE_MINRATE = BIT(29), 554 IEEE80211_TX_CTL_DONTFRAG = BIT(30), 555 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31), 556 }; 557 558 #define IEEE80211_TX_CTL_STBC_SHIFT 23 559 560 /** 561 * enum mac80211_tx_control_flags - flags to describe transmit control 562 * 563 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control 564 * protocol frame (e.g. EAP) 565 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll 566 * frame (PS-Poll or uAPSD). 567 * 568 * These flags are used in tx_info->control.flags. 569 */ 570 enum mac80211_tx_control_flags { 571 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0), 572 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1), 573 }; 574 575 /* 576 * This definition is used as a mask to clear all temporary flags, which are 577 * set by the tx handlers for each transmission attempt by the mac80211 stack. 578 */ 579 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \ 580 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \ 581 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \ 582 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \ 583 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \ 584 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \ 585 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \ 586 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP) 587 588 /** 589 * enum mac80211_rate_control_flags - per-rate flags set by the 590 * Rate Control algorithm. 591 * 592 * These flags are set by the Rate control algorithm for each rate during tx, 593 * in the @flags member of struct ieee80211_tx_rate. 594 * 595 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate. 596 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required. 597 * This is set if the current BSS requires ERP protection. 598 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble. 599 * @IEEE80211_TX_RC_MCS: HT rate. 600 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split 601 * into a higher 4 bits (Nss) and lower 4 bits (MCS number) 602 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in 603 * Greenfield mode. 604 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz. 605 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission 606 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission 607 * (80+80 isn't supported yet) 608 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the 609 * adjacent 20 MHz channels, if the current channel type is 610 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS. 611 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate. 612 */ 613 enum mac80211_rate_control_flags { 614 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0), 615 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1), 616 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2), 617 618 /* rate index is an HT/VHT MCS instead of an index */ 619 IEEE80211_TX_RC_MCS = BIT(3), 620 IEEE80211_TX_RC_GREEN_FIELD = BIT(4), 621 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5), 622 IEEE80211_TX_RC_DUP_DATA = BIT(6), 623 IEEE80211_TX_RC_SHORT_GI = BIT(7), 624 IEEE80211_TX_RC_VHT_MCS = BIT(8), 625 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9), 626 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10), 627 }; 628 629 630 /* there are 40 bytes if you don't need the rateset to be kept */ 631 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40 632 633 /* if you do need the rateset, then you have less space */ 634 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24 635 636 /* maximum number of rate stages */ 637 #define IEEE80211_TX_MAX_RATES 4 638 639 /* maximum number of rate table entries */ 640 #define IEEE80211_TX_RATE_TABLE_SIZE 4 641 642 /** 643 * struct ieee80211_tx_rate - rate selection/status 644 * 645 * @idx: rate index to attempt to send with 646 * @flags: rate control flags (&enum mac80211_rate_control_flags) 647 * @count: number of tries in this rate before going to the next rate 648 * 649 * A value of -1 for @idx indicates an invalid rate and, if used 650 * in an array of retry rates, that no more rates should be tried. 651 * 652 * When used for transmit status reporting, the driver should 653 * always report the rate along with the flags it used. 654 * 655 * &struct ieee80211_tx_info contains an array of these structs 656 * in the control information, and it will be filled by the rate 657 * control algorithm according to what should be sent. For example, 658 * if this array contains, in the format { <idx>, <count> } the 659 * information 660 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 } 661 * then this means that the frame should be transmitted 662 * up to twice at rate 3, up to twice at rate 2, and up to four 663 * times at rate 1 if it doesn't get acknowledged. Say it gets 664 * acknowledged by the peer after the fifth attempt, the status 665 * information should then contain 666 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ... 667 * since it was transmitted twice at rate 3, twice at rate 2 668 * and once at rate 1 after which we received an acknowledgement. 669 */ 670 struct ieee80211_tx_rate { 671 s8 idx; 672 u16 count:5, 673 flags:11; 674 } __packed; 675 676 #define IEEE80211_MAX_TX_RETRY 31 677 678 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate, 679 u8 mcs, u8 nss) 680 { 681 WARN_ON(mcs & ~0xF); 682 WARN_ON((nss - 1) & ~0x7); 683 rate->idx = ((nss - 1) << 4) | mcs; 684 } 685 686 static inline u8 687 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate) 688 { 689 return rate->idx & 0xF; 690 } 691 692 static inline u8 693 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate) 694 { 695 return (rate->idx >> 4) + 1; 696 } 697 698 /** 699 * struct ieee80211_tx_info - skb transmit information 700 * 701 * This structure is placed in skb->cb for three uses: 702 * (1) mac80211 TX control - mac80211 tells the driver what to do 703 * (2) driver internal use (if applicable) 704 * (3) TX status information - driver tells mac80211 what happened 705 * 706 * @flags: transmit info flags, defined above 707 * @band: the band to transmit on (use for checking for races) 708 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC 709 * @ack_frame_id: internal frame ID for TX status, used internally 710 * @control: union for control data 711 * @status: union for status data 712 * @driver_data: array of driver_data pointers 713 * @ampdu_ack_len: number of acked aggregated frames. 714 * relevant only if IEEE80211_TX_STAT_AMPDU was set. 715 * @ampdu_len: number of aggregated frames. 716 * relevant only if IEEE80211_TX_STAT_AMPDU was set. 717 * @ack_signal: signal strength of the ACK frame 718 */ 719 struct ieee80211_tx_info { 720 /* common information */ 721 u32 flags; 722 u8 band; 723 724 u8 hw_queue; 725 726 u16 ack_frame_id; 727 728 union { 729 struct { 730 union { 731 /* rate control */ 732 struct { 733 struct ieee80211_tx_rate rates[ 734 IEEE80211_TX_MAX_RATES]; 735 s8 rts_cts_rate_idx; 736 u8 use_rts:1; 737 u8 use_cts_prot:1; 738 u8 short_preamble:1; 739 u8 skip_table:1; 740 /* 2 bytes free */ 741 }; 742 /* only needed before rate control */ 743 unsigned long jiffies; 744 }; 745 /* NB: vif can be NULL for injected frames */ 746 struct ieee80211_vif *vif; 747 struct ieee80211_key_conf *hw_key; 748 u32 flags; 749 /* 4 bytes free */ 750 } control; 751 struct { 752 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES]; 753 s32 ack_signal; 754 u8 ampdu_ack_len; 755 u8 ampdu_len; 756 u8 antenna; 757 u16 tx_time; 758 void *status_driver_data[19 / sizeof(void *)]; 759 } status; 760 struct { 761 struct ieee80211_tx_rate driver_rates[ 762 IEEE80211_TX_MAX_RATES]; 763 u8 pad[4]; 764 765 void *rate_driver_data[ 766 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)]; 767 }; 768 void *driver_data[ 769 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)]; 770 }; 771 }; 772 773 /** 774 * struct ieee80211_scan_ies - descriptors for different blocks of IEs 775 * 776 * This structure is used to point to different blocks of IEs in HW scan 777 * and scheduled scan. These blocks contain the IEs passed by userspace 778 * and the ones generated by mac80211. 779 * 780 * @ies: pointers to band specific IEs. 781 * @len: lengths of band_specific IEs. 782 * @common_ies: IEs for all bands (especially vendor specific ones) 783 * @common_ie_len: length of the common_ies 784 */ 785 struct ieee80211_scan_ies { 786 const u8 *ies[IEEE80211_NUM_BANDS]; 787 size_t len[IEEE80211_NUM_BANDS]; 788 const u8 *common_ies; 789 size_t common_ie_len; 790 }; 791 792 793 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb) 794 { 795 return (struct ieee80211_tx_info *)skb->cb; 796 } 797 798 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb) 799 { 800 return (struct ieee80211_rx_status *)skb->cb; 801 } 802 803 /** 804 * ieee80211_tx_info_clear_status - clear TX status 805 * 806 * @info: The &struct ieee80211_tx_info to be cleared. 807 * 808 * When the driver passes an skb back to mac80211, it must report 809 * a number of things in TX status. This function clears everything 810 * in the TX status but the rate control information (it does clear 811 * the count since you need to fill that in anyway). 812 * 813 * NOTE: You can only use this function if you do NOT use 814 * info->driver_data! Use info->rate_driver_data 815 * instead if you need only the less space that allows. 816 */ 817 static inline void 818 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info) 819 { 820 int i; 821 822 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 823 offsetof(struct ieee80211_tx_info, control.rates)); 824 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 825 offsetof(struct ieee80211_tx_info, driver_rates)); 826 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8); 827 /* clear the rate counts */ 828 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++) 829 info->status.rates[i].count = 0; 830 831 BUILD_BUG_ON( 832 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20); 833 memset(&info->status.ampdu_ack_len, 0, 834 sizeof(struct ieee80211_tx_info) - 835 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len)); 836 } 837 838 839 /** 840 * enum mac80211_rx_flags - receive flags 841 * 842 * These flags are used with the @flag member of &struct ieee80211_rx_status. 843 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame. 844 * Use together with %RX_FLAG_MMIC_STRIPPED. 845 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware. 846 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame, 847 * verification has been done by the hardware. 848 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame. 849 * If this flag is set, the stack cannot do any replay detection 850 * hence the driver or hardware will have to do that. 851 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on 852 * the frame. 853 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on 854 * the frame. 855 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime 856 * field) is valid and contains the time the first symbol of the MPDU 857 * was received. This is useful in monitor mode and for proper IBSS 858 * merging. 859 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime 860 * field) is valid and contains the time the last symbol of the MPDU 861 * (including FCS) was received. 862 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame 863 * @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index 864 * @RX_FLAG_VHT: VHT MCS was used and rate_index is MCS index 865 * @RX_FLAG_40MHZ: HT40 (40 MHz) was used 866 * @RX_FLAG_SHORT_GI: Short guard interval was used 867 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present. 868 * Valid only for data frames (mainly A-MPDU) 869 * @RX_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, if 870 * the driver fills this value it should add %IEEE80211_RADIOTAP_MCS_HAVE_FMT 871 * to hw.radiotap_mcs_details to advertise that fact 872 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference 873 * number (@ampdu_reference) must be populated and be a distinct number for 874 * each A-MPDU 875 * @RX_FLAG_AMPDU_REPORT_ZEROLEN: driver reports 0-length subframes 876 * @RX_FLAG_AMPDU_IS_ZEROLEN: This is a zero-length subframe, for 877 * monitoring purposes only 878 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all 879 * subframes of a single A-MPDU 880 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU 881 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected 882 * on this subframe 883 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC 884 * is stored in the @ampdu_delimiter_crc field) 885 * @RX_FLAG_LDPC: LDPC was used 886 * @RX_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3 887 * @RX_FLAG_10MHZ: 10 MHz (half channel) was used 888 * @RX_FLAG_5MHZ: 5 MHz (quarter channel) was used 889 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU 890 * subframes instead of a one huge frame for performance reasons. 891 * All, but the last MSDU from an A-MSDU should have this flag set. E.g. 892 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while 893 * the 3rd (last) one must not have this flag set. The flag is used to 894 * deal with retransmission/duplication recovery properly since A-MSDU 895 * subframes share the same sequence number. Reported subframes can be 896 * either regular MSDU or singly A-MSDUs. Subframes must not be 897 * interleaved with other frames. 898 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific 899 * radiotap data in the skb->data (before the frame) as described by 900 * the &struct ieee80211_vendor_radiotap. 901 */ 902 enum mac80211_rx_flags { 903 RX_FLAG_MMIC_ERROR = BIT(0), 904 RX_FLAG_DECRYPTED = BIT(1), 905 RX_FLAG_MMIC_STRIPPED = BIT(3), 906 RX_FLAG_IV_STRIPPED = BIT(4), 907 RX_FLAG_FAILED_FCS_CRC = BIT(5), 908 RX_FLAG_FAILED_PLCP_CRC = BIT(6), 909 RX_FLAG_MACTIME_START = BIT(7), 910 RX_FLAG_SHORTPRE = BIT(8), 911 RX_FLAG_HT = BIT(9), 912 RX_FLAG_40MHZ = BIT(10), 913 RX_FLAG_SHORT_GI = BIT(11), 914 RX_FLAG_NO_SIGNAL_VAL = BIT(12), 915 RX_FLAG_HT_GF = BIT(13), 916 RX_FLAG_AMPDU_DETAILS = BIT(14), 917 RX_FLAG_AMPDU_REPORT_ZEROLEN = BIT(15), 918 RX_FLAG_AMPDU_IS_ZEROLEN = BIT(16), 919 RX_FLAG_AMPDU_LAST_KNOWN = BIT(17), 920 RX_FLAG_AMPDU_IS_LAST = BIT(18), 921 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(19), 922 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(20), 923 RX_FLAG_MACTIME_END = BIT(21), 924 RX_FLAG_VHT = BIT(22), 925 RX_FLAG_LDPC = BIT(23), 926 RX_FLAG_STBC_MASK = BIT(26) | BIT(27), 927 RX_FLAG_10MHZ = BIT(28), 928 RX_FLAG_5MHZ = BIT(29), 929 RX_FLAG_AMSDU_MORE = BIT(30), 930 RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(31), 931 }; 932 933 #define RX_FLAG_STBC_SHIFT 26 934 935 /** 936 * enum mac80211_rx_vht_flags - receive VHT flags 937 * 938 * These flags are used with the @vht_flag member of 939 * &struct ieee80211_rx_status. 940 * @RX_VHT_FLAG_80MHZ: 80 MHz was used 941 * @RX_VHT_FLAG_160MHZ: 160 MHz was used 942 * @RX_VHT_FLAG_BF: packet was beamformed 943 */ 944 enum mac80211_rx_vht_flags { 945 RX_VHT_FLAG_80MHZ = BIT(0), 946 RX_VHT_FLAG_160MHZ = BIT(1), 947 RX_VHT_FLAG_BF = BIT(2), 948 }; 949 950 /** 951 * struct ieee80211_rx_status - receive status 952 * 953 * The low-level driver should provide this information (the subset 954 * supported by hardware) to the 802.11 code with each received 955 * frame, in the skb's control buffer (cb). 956 * 957 * @mactime: value in microseconds of the 64-bit Time Synchronization Function 958 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware. 959 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use 960 * it but can store it and pass it back to the driver for synchronisation 961 * @band: the active band when this frame was received 962 * @freq: frequency the radio was tuned to when receiving this frame, in MHz 963 * @signal: signal strength when receiving this frame, either in dBm, in dB or 964 * unspecified depending on the hardware capabilities flags 965 * @IEEE80211_HW_SIGNAL_* 966 * @chains: bitmask of receive chains for which separate signal strength 967 * values were filled. 968 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't 969 * support dB or unspecified units) 970 * @antenna: antenna used 971 * @rate_idx: index of data rate into band's supported rates or MCS index if 972 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT) 973 * @vht_nss: number of streams (VHT only) 974 * @flag: %RX_FLAG_* 975 * @vht_flag: %RX_VHT_FLAG_* 976 * @rx_flags: internal RX flags for mac80211 977 * @ampdu_reference: A-MPDU reference number, must be a different value for 978 * each A-MPDU but the same for each subframe within one A-MPDU 979 * @ampdu_delimiter_crc: A-MPDU delimiter CRC 980 */ 981 struct ieee80211_rx_status { 982 u64 mactime; 983 u32 device_timestamp; 984 u32 ampdu_reference; 985 u32 flag; 986 u16 freq; 987 u8 vht_flag; 988 u8 rate_idx; 989 u8 vht_nss; 990 u8 rx_flags; 991 u8 band; 992 u8 antenna; 993 s8 signal; 994 u8 chains; 995 s8 chain_signal[IEEE80211_MAX_CHAINS]; 996 u8 ampdu_delimiter_crc; 997 }; 998 999 /** 1000 * struct ieee80211_vendor_radiotap - vendor radiotap data information 1001 * @present: presence bitmap for this vendor namespace 1002 * (this could be extended in the future if any vendor needs more 1003 * bits, the radiotap spec does allow for that) 1004 * @align: radiotap vendor namespace alignment. This defines the needed 1005 * alignment for the @data field below, not for the vendor namespace 1006 * description itself (which has a fixed 2-byte alignment) 1007 * Must be a power of two, and be set to at least 1! 1008 * @oui: radiotap vendor namespace OUI 1009 * @subns: radiotap vendor sub namespace 1010 * @len: radiotap vendor sub namespace skip length, if alignment is done 1011 * then that's added to this, i.e. this is only the length of the 1012 * @data field. 1013 * @pad: number of bytes of padding after the @data, this exists so that 1014 * the skb data alignment can be preserved even if the data has odd 1015 * length 1016 * @data: the actual vendor namespace data 1017 * 1018 * This struct, including the vendor data, goes into the skb->data before 1019 * the 802.11 header. It's split up in mac80211 using the align/oui/subns 1020 * data. 1021 */ 1022 struct ieee80211_vendor_radiotap { 1023 u32 present; 1024 u8 align; 1025 u8 oui[3]; 1026 u8 subns; 1027 u8 pad; 1028 u16 len; 1029 u8 data[]; 1030 } __packed; 1031 1032 /** 1033 * enum ieee80211_conf_flags - configuration flags 1034 * 1035 * Flags to define PHY configuration options 1036 * 1037 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this 1038 * to determine for example whether to calculate timestamps for packets 1039 * or not, do not use instead of filter flags! 1040 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only). 1041 * This is the power save mode defined by IEEE 802.11-2007 section 11.2, 1042 * meaning that the hardware still wakes up for beacons, is able to 1043 * transmit frames and receive the possible acknowledgment frames. 1044 * Not to be confused with hardware specific wakeup/sleep states, 1045 * driver is responsible for that. See the section "Powersave support" 1046 * for more. 1047 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set 1048 * the driver should be prepared to handle configuration requests but 1049 * may turn the device off as much as possible. Typically, this flag will 1050 * be set when an interface is set UP but not associated or scanning, but 1051 * it can also be unset in that case when monitor interfaces are active. 1052 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main 1053 * operating channel. 1054 */ 1055 enum ieee80211_conf_flags { 1056 IEEE80211_CONF_MONITOR = (1<<0), 1057 IEEE80211_CONF_PS = (1<<1), 1058 IEEE80211_CONF_IDLE = (1<<2), 1059 IEEE80211_CONF_OFFCHANNEL = (1<<3), 1060 }; 1061 1062 1063 /** 1064 * enum ieee80211_conf_changed - denotes which configuration changed 1065 * 1066 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed 1067 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed 1068 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed 1069 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed 1070 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed 1071 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed 1072 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed 1073 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed 1074 * Note that this is only valid if channel contexts are not used, 1075 * otherwise each channel context has the number of chains listed. 1076 */ 1077 enum ieee80211_conf_changed { 1078 IEEE80211_CONF_CHANGE_SMPS = BIT(1), 1079 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2), 1080 IEEE80211_CONF_CHANGE_MONITOR = BIT(3), 1081 IEEE80211_CONF_CHANGE_PS = BIT(4), 1082 IEEE80211_CONF_CHANGE_POWER = BIT(5), 1083 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6), 1084 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7), 1085 IEEE80211_CONF_CHANGE_IDLE = BIT(8), 1086 }; 1087 1088 /** 1089 * enum ieee80211_smps_mode - spatial multiplexing power save mode 1090 * 1091 * @IEEE80211_SMPS_AUTOMATIC: automatic 1092 * @IEEE80211_SMPS_OFF: off 1093 * @IEEE80211_SMPS_STATIC: static 1094 * @IEEE80211_SMPS_DYNAMIC: dynamic 1095 * @IEEE80211_SMPS_NUM_MODES: internal, don't use 1096 */ 1097 enum ieee80211_smps_mode { 1098 IEEE80211_SMPS_AUTOMATIC, 1099 IEEE80211_SMPS_OFF, 1100 IEEE80211_SMPS_STATIC, 1101 IEEE80211_SMPS_DYNAMIC, 1102 1103 /* keep last */ 1104 IEEE80211_SMPS_NUM_MODES, 1105 }; 1106 1107 /** 1108 * struct ieee80211_conf - configuration of the device 1109 * 1110 * This struct indicates how the driver shall configure the hardware. 1111 * 1112 * @flags: configuration flags defined above 1113 * 1114 * @listen_interval: listen interval in units of beacon interval 1115 * @max_sleep_period: the maximum number of beacon intervals to sleep for 1116 * before checking the beacon for a TIM bit (managed mode only); this 1117 * value will be only achievable between DTIM frames, the hardware 1118 * needs to check for the multicast traffic bit in DTIM beacons. 1119 * This variable is valid only when the CONF_PS flag is set. 1120 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use 1121 * in power saving. Power saving will not be enabled until a beacon 1122 * has been received and the DTIM period is known. 1123 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the 1124 * powersave documentation below. This variable is valid only when 1125 * the CONF_PS flag is set. 1126 * 1127 * @power_level: requested transmit power (in dBm), backward compatibility 1128 * value only that is set to the minimum of all interfaces 1129 * 1130 * @chandef: the channel definition to tune to 1131 * @radar_enabled: whether radar detection is enabled 1132 * 1133 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame 1134 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11, 1135 * but actually means the number of transmissions not the number of retries 1136 * @short_frame_max_tx_count: Maximum number of transmissions for a "short" 1137 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the 1138 * number of transmissions not the number of retries 1139 * 1140 * @smps_mode: spatial multiplexing powersave mode; note that 1141 * %IEEE80211_SMPS_STATIC is used when the device is not 1142 * configured for an HT channel. 1143 * Note that this is only valid if channel contexts are not used, 1144 * otherwise each channel context has the number of chains listed. 1145 */ 1146 struct ieee80211_conf { 1147 u32 flags; 1148 int power_level, dynamic_ps_timeout; 1149 int max_sleep_period; 1150 1151 u16 listen_interval; 1152 u8 ps_dtim_period; 1153 1154 u8 long_frame_max_tx_count, short_frame_max_tx_count; 1155 1156 struct cfg80211_chan_def chandef; 1157 bool radar_enabled; 1158 enum ieee80211_smps_mode smps_mode; 1159 }; 1160 1161 /** 1162 * struct ieee80211_channel_switch - holds the channel switch data 1163 * 1164 * The information provided in this structure is required for channel switch 1165 * operation. 1166 * 1167 * @timestamp: value in microseconds of the 64-bit Time Synchronization 1168 * Function (TSF) timer when the frame containing the channel switch 1169 * announcement was received. This is simply the rx.mactime parameter 1170 * the driver passed into mac80211. 1171 * @device_timestamp: arbitrary timestamp for the device, this is the 1172 * rx.device_timestamp parameter the driver passed to mac80211. 1173 * @block_tx: Indicates whether transmission must be blocked before the 1174 * scheduled channel switch, as indicated by the AP. 1175 * @chandef: the new channel to switch to 1176 * @count: the number of TBTT's until the channel switch event 1177 */ 1178 struct ieee80211_channel_switch { 1179 u64 timestamp; 1180 u32 device_timestamp; 1181 bool block_tx; 1182 struct cfg80211_chan_def chandef; 1183 u8 count; 1184 }; 1185 1186 /** 1187 * enum ieee80211_vif_flags - virtual interface flags 1188 * 1189 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering 1190 * on this virtual interface to avoid unnecessary CPU wakeups 1191 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality 1192 * monitoring on this virtual interface -- i.e. it can monitor 1193 * connection quality related parameters, such as the RSSI level and 1194 * provide notifications if configured trigger levels are reached. 1195 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this 1196 * interface. This flag should be set during interface addition, 1197 * but may be set/cleared as late as authentication to an AP. It is 1198 * only valid for managed/station mode interfaces. 1199 */ 1200 enum ieee80211_vif_flags { 1201 IEEE80211_VIF_BEACON_FILTER = BIT(0), 1202 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1), 1203 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2), 1204 }; 1205 1206 /** 1207 * struct ieee80211_vif - per-interface data 1208 * 1209 * Data in this structure is continually present for driver 1210 * use during the life of a virtual interface. 1211 * 1212 * @type: type of this virtual interface 1213 * @bss_conf: BSS configuration for this interface, either our own 1214 * or the BSS we're associated to 1215 * @addr: address of this interface 1216 * @p2p: indicates whether this AP or STA interface is a p2p 1217 * interface, i.e. a GO or p2p-sta respectively 1218 * @csa_active: marks whether a channel switch is going on. Internally it is 1219 * write-protected by sdata_lock and local->mtx so holding either is fine 1220 * for read access. 1221 * @driver_flags: flags/capabilities the driver has for this interface, 1222 * these need to be set (or cleared) when the interface is added 1223 * or, if supported by the driver, the interface type is changed 1224 * at runtime, mac80211 will never touch this field 1225 * @hw_queue: hardware queue for each AC 1226 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only 1227 * @chanctx_conf: The channel context this interface is assigned to, or %NULL 1228 * when it is not assigned. This pointer is RCU-protected due to the TX 1229 * path needing to access it; even though the netdev carrier will always 1230 * be off when it is %NULL there can still be races and packets could be 1231 * processed after it switches back to %NULL. 1232 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per 1233 * interface debug files. Note that it will be NULL for the virtual 1234 * monitor interface (if that is requested.) 1235 * @drv_priv: data area for driver use, will always be aligned to 1236 * sizeof(void *). 1237 */ 1238 struct ieee80211_vif { 1239 enum nl80211_iftype type; 1240 struct ieee80211_bss_conf bss_conf; 1241 u8 addr[ETH_ALEN]; 1242 bool p2p; 1243 bool csa_active; 1244 1245 u8 cab_queue; 1246 u8 hw_queue[IEEE80211_NUM_ACS]; 1247 1248 struct ieee80211_chanctx_conf __rcu *chanctx_conf; 1249 1250 u32 driver_flags; 1251 1252 #ifdef CONFIG_MAC80211_DEBUGFS 1253 struct dentry *debugfs_dir; 1254 #endif 1255 1256 /* must be last */ 1257 u8 drv_priv[0] __aligned(sizeof(void *)); 1258 }; 1259 1260 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif) 1261 { 1262 #ifdef CONFIG_MAC80211_MESH 1263 return vif->type == NL80211_IFTYPE_MESH_POINT; 1264 #endif 1265 return false; 1266 } 1267 1268 /** 1269 * wdev_to_ieee80211_vif - return a vif struct from a wdev 1270 * @wdev: the wdev to get the vif for 1271 * 1272 * This can be used by mac80211 drivers with direct cfg80211 APIs 1273 * (like the vendor commands) that get a wdev. 1274 * 1275 * Note that this function may return %NULL if the given wdev isn't 1276 * associated with a vif that the driver knows about (e.g. monitor 1277 * or AP_VLAN interfaces.) 1278 */ 1279 struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev); 1280 1281 /** 1282 * enum ieee80211_key_flags - key flags 1283 * 1284 * These flags are used for communication about keys between the driver 1285 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf. 1286 * 1287 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the 1288 * driver to indicate that it requires IV generation for this 1289 * particular key. Setting this flag does not necessarily mean that SKBs 1290 * will have sufficient tailroom for ICV or MIC. 1291 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by 1292 * the driver for a TKIP key if it requires Michael MIC 1293 * generation in software. 1294 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates 1295 * that the key is pairwise rather then a shared key. 1296 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a 1297 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames 1298 * (MFP) to be done in software. 1299 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver 1300 * if space should be prepared for the IV, but the IV 1301 * itself should not be generated. Do not set together with 1302 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does 1303 * not necessarily mean that SKBs will have sufficient tailroom for ICV or 1304 * MIC. 1305 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received 1306 * management frames. The flag can help drivers that have a hardware 1307 * crypto implementation that doesn't deal with management frames 1308 * properly by allowing them to not upload the keys to hardware and 1309 * fall back to software crypto. Note that this flag deals only with 1310 * RX, if your crypto engine can't deal with TX you can also set the 1311 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW. 1312 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the 1313 * driver for a CCMP/GCMP key to indicate that is requires IV generation 1314 * only for managment frames (MFP). 1315 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the 1316 * driver for a key to indicate that sufficient tailroom must always 1317 * be reserved for ICV or MIC, even when HW encryption is enabled. 1318 */ 1319 enum ieee80211_key_flags { 1320 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0), 1321 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1), 1322 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2), 1323 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3), 1324 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4), 1325 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5), 1326 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6), 1327 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7), 1328 }; 1329 1330 /** 1331 * struct ieee80211_key_conf - key information 1332 * 1333 * This key information is given by mac80211 to the driver by 1334 * the set_key() callback in &struct ieee80211_ops. 1335 * 1336 * @hw_key_idx: To be set by the driver, this is the key index the driver 1337 * wants to be given when a frame is transmitted and needs to be 1338 * encrypted in hardware. 1339 * @cipher: The key's cipher suite selector. 1340 * @flags: key flags, see &enum ieee80211_key_flags. 1341 * @keyidx: the key index (0-3) 1342 * @keylen: key material length 1343 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte) 1344 * data block: 1345 * - Temporal Encryption Key (128 bits) 1346 * - Temporal Authenticator Tx MIC Key (64 bits) 1347 * - Temporal Authenticator Rx MIC Key (64 bits) 1348 * @icv_len: The ICV length for this key type 1349 * @iv_len: The IV length for this key type 1350 */ 1351 struct ieee80211_key_conf { 1352 u32 cipher; 1353 u8 icv_len; 1354 u8 iv_len; 1355 u8 hw_key_idx; 1356 u8 flags; 1357 s8 keyidx; 1358 u8 keylen; 1359 u8 key[0]; 1360 }; 1361 1362 /** 1363 * struct ieee80211_cipher_scheme - cipher scheme 1364 * 1365 * This structure contains a cipher scheme information defining 1366 * the secure packet crypto handling. 1367 * 1368 * @cipher: a cipher suite selector 1369 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage 1370 * @hdr_len: a length of a security header used the cipher 1371 * @pn_len: a length of a packet number in the security header 1372 * @pn_off: an offset of pn from the beginning of the security header 1373 * @key_idx_off: an offset of key index byte in the security header 1374 * @key_idx_mask: a bit mask of key_idx bits 1375 * @key_idx_shift: a bit shift needed to get key_idx 1376 * key_idx value calculation: 1377 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift 1378 * @mic_len: a mic length in bytes 1379 */ 1380 struct ieee80211_cipher_scheme { 1381 u32 cipher; 1382 u16 iftype; 1383 u8 hdr_len; 1384 u8 pn_len; 1385 u8 pn_off; 1386 u8 key_idx_off; 1387 u8 key_idx_mask; 1388 u8 key_idx_shift; 1389 u8 mic_len; 1390 }; 1391 1392 /** 1393 * enum set_key_cmd - key command 1394 * 1395 * Used with the set_key() callback in &struct ieee80211_ops, this 1396 * indicates whether a key is being removed or added. 1397 * 1398 * @SET_KEY: a key is set 1399 * @DISABLE_KEY: a key must be disabled 1400 */ 1401 enum set_key_cmd { 1402 SET_KEY, DISABLE_KEY, 1403 }; 1404 1405 /** 1406 * enum ieee80211_sta_state - station state 1407 * 1408 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all, 1409 * this is a special state for add/remove transitions 1410 * @IEEE80211_STA_NONE: station exists without special state 1411 * @IEEE80211_STA_AUTH: station is authenticated 1412 * @IEEE80211_STA_ASSOC: station is associated 1413 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X) 1414 */ 1415 enum ieee80211_sta_state { 1416 /* NOTE: These need to be ordered correctly! */ 1417 IEEE80211_STA_NOTEXIST, 1418 IEEE80211_STA_NONE, 1419 IEEE80211_STA_AUTH, 1420 IEEE80211_STA_ASSOC, 1421 IEEE80211_STA_AUTHORIZED, 1422 }; 1423 1424 /** 1425 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth 1426 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz 1427 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz 1428 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz 1429 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz 1430 * (including 80+80 MHz) 1431 * 1432 * Implementation note: 20 must be zero to be initialized 1433 * correctly, the values must be sorted. 1434 */ 1435 enum ieee80211_sta_rx_bandwidth { 1436 IEEE80211_STA_RX_BW_20 = 0, 1437 IEEE80211_STA_RX_BW_40, 1438 IEEE80211_STA_RX_BW_80, 1439 IEEE80211_STA_RX_BW_160, 1440 }; 1441 1442 /** 1443 * struct ieee80211_sta_rates - station rate selection table 1444 * 1445 * @rcu_head: RCU head used for freeing the table on update 1446 * @rate: transmit rates/flags to be used by default. 1447 * Overriding entries per-packet is possible by using cb tx control. 1448 */ 1449 struct ieee80211_sta_rates { 1450 struct rcu_head rcu_head; 1451 struct { 1452 s8 idx; 1453 u8 count; 1454 u8 count_cts; 1455 u8 count_rts; 1456 u16 flags; 1457 } rate[IEEE80211_TX_RATE_TABLE_SIZE]; 1458 }; 1459 1460 /** 1461 * struct ieee80211_sta - station table entry 1462 * 1463 * A station table entry represents a station we are possibly 1464 * communicating with. Since stations are RCU-managed in 1465 * mac80211, any ieee80211_sta pointer you get access to must 1466 * either be protected by rcu_read_lock() explicitly or implicitly, 1467 * or you must take good care to not use such a pointer after a 1468 * call to your sta_remove callback that removed it. 1469 * 1470 * @addr: MAC address 1471 * @aid: AID we assigned to the station if we're an AP 1472 * @supp_rates: Bitmap of supported rates (per band) 1473 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities 1474 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities 1475 * @wme: indicates whether the STA supports QoS/WME. 1476 * @drv_priv: data area for driver use, will always be aligned to 1477 * sizeof(void *), size is determined in hw information. 1478 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid 1479 * if wme is supported. 1480 * @max_sp: max Service Period. Only valid if wme is supported. 1481 * @bandwidth: current bandwidth the station can receive with 1482 * @rx_nss: in HT/VHT, the maximum number of spatial streams the 1483 * station can receive at the moment, changed by operating mode 1484 * notifications and capabilities. The value is only valid after 1485 * the station moves to associated state. 1486 * @smps_mode: current SMPS mode (off, static or dynamic) 1487 * @rates: rate control selection table 1488 * @tdls: indicates whether the STA is a TDLS peer 1489 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only 1490 * valid if the STA is a TDLS peer in the first place. 1491 */ 1492 struct ieee80211_sta { 1493 u32 supp_rates[IEEE80211_NUM_BANDS]; 1494 u8 addr[ETH_ALEN]; 1495 u16 aid; 1496 struct ieee80211_sta_ht_cap ht_cap; 1497 struct ieee80211_sta_vht_cap vht_cap; 1498 bool wme; 1499 u8 uapsd_queues; 1500 u8 max_sp; 1501 u8 rx_nss; 1502 enum ieee80211_sta_rx_bandwidth bandwidth; 1503 enum ieee80211_smps_mode smps_mode; 1504 struct ieee80211_sta_rates __rcu *rates; 1505 bool tdls; 1506 bool tdls_initiator; 1507 1508 /* must be last */ 1509 u8 drv_priv[0] __aligned(sizeof(void *)); 1510 }; 1511 1512 /** 1513 * enum sta_notify_cmd - sta notify command 1514 * 1515 * Used with the sta_notify() callback in &struct ieee80211_ops, this 1516 * indicates if an associated station made a power state transition. 1517 * 1518 * @STA_NOTIFY_SLEEP: a station is now sleeping 1519 * @STA_NOTIFY_AWAKE: a sleeping station woke up 1520 */ 1521 enum sta_notify_cmd { 1522 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE, 1523 }; 1524 1525 /** 1526 * struct ieee80211_tx_control - TX control data 1527 * 1528 * @sta: station table entry, this sta pointer may be NULL and 1529 * it is not allowed to copy the pointer, due to RCU. 1530 */ 1531 struct ieee80211_tx_control { 1532 struct ieee80211_sta *sta; 1533 }; 1534 1535 /** 1536 * enum ieee80211_hw_flags - hardware flags 1537 * 1538 * These flags are used to indicate hardware capabilities to 1539 * the stack. Generally, flags here should have their meaning 1540 * done in a way that the simplest hardware doesn't need setting 1541 * any particular flags. There are some exceptions to this rule, 1542 * however, so you are advised to review these flags carefully. 1543 * 1544 * @IEEE80211_HW_HAS_RATE_CONTROL: 1545 * The hardware or firmware includes rate control, and cannot be 1546 * controlled by the stack. As such, no rate control algorithm 1547 * should be instantiated, and the TX rate reported to userspace 1548 * will be taken from the TX status instead of the rate control 1549 * algorithm. 1550 * Note that this requires that the driver implement a number of 1551 * callbacks so it has the correct information, it needs to have 1552 * the @set_rts_threshold callback and must look at the BSS config 1553 * @use_cts_prot for G/N protection, @use_short_slot for slot 1554 * timing in 2.4 GHz and @use_short_preamble for preambles for 1555 * CCK frames. 1556 * 1557 * @IEEE80211_HW_RX_INCLUDES_FCS: 1558 * Indicates that received frames passed to the stack include 1559 * the FCS at the end. 1560 * 1561 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING: 1562 * Some wireless LAN chipsets buffer broadcast/multicast frames 1563 * for power saving stations in the hardware/firmware and others 1564 * rely on the host system for such buffering. This option is used 1565 * to configure the IEEE 802.11 upper layer to buffer broadcast and 1566 * multicast frames when there are power saving stations so that 1567 * the driver can fetch them with ieee80211_get_buffered_bc(). 1568 * 1569 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE: 1570 * Hardware is not capable of short slot operation on the 2.4 GHz band. 1571 * 1572 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE: 1573 * Hardware is not capable of receiving frames with short preamble on 1574 * the 2.4 GHz band. 1575 * 1576 * @IEEE80211_HW_SIGNAL_UNSPEC: 1577 * Hardware can provide signal values but we don't know its units. We 1578 * expect values between 0 and @max_signal. 1579 * If possible please provide dB or dBm instead. 1580 * 1581 * @IEEE80211_HW_SIGNAL_DBM: 1582 * Hardware gives signal values in dBm, decibel difference from 1583 * one milliwatt. This is the preferred method since it is standardized 1584 * between different devices. @max_signal does not need to be set. 1585 * 1586 * @IEEE80211_HW_SPECTRUM_MGMT: 1587 * Hardware supports spectrum management defined in 802.11h 1588 * Measurement, Channel Switch, Quieting, TPC 1589 * 1590 * @IEEE80211_HW_AMPDU_AGGREGATION: 1591 * Hardware supports 11n A-MPDU aggregation. 1592 * 1593 * @IEEE80211_HW_SUPPORTS_PS: 1594 * Hardware has power save support (i.e. can go to sleep). 1595 * 1596 * @IEEE80211_HW_PS_NULLFUNC_STACK: 1597 * Hardware requires nullfunc frame handling in stack, implies 1598 * stack support for dynamic PS. 1599 * 1600 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS: 1601 * Hardware has support for dynamic PS. 1602 * 1603 * @IEEE80211_HW_MFP_CAPABLE: 1604 * Hardware supports management frame protection (MFP, IEEE 802.11w). 1605 * 1606 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS: 1607 * Hardware can provide ack status reports of Tx frames to 1608 * the stack. 1609 * 1610 * @IEEE80211_HW_CONNECTION_MONITOR: 1611 * The hardware performs its own connection monitoring, including 1612 * periodic keep-alives to the AP and probing the AP on beacon loss. 1613 * 1614 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC: 1615 * This device needs to get data from beacon before association (i.e. 1616 * dtim_period). 1617 * 1618 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports 1619 * per-station GTKs as used by IBSS RSN or during fast transition. If 1620 * the device doesn't support per-station GTKs, but can be asked not 1621 * to decrypt group addressed frames, then IBSS RSN support is still 1622 * possible but software crypto will be used. Advertise the wiphy flag 1623 * only in that case. 1624 * 1625 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device 1626 * autonomously manages the PS status of connected stations. When 1627 * this flag is set mac80211 will not trigger PS mode for connected 1628 * stations based on the PM bit of incoming frames. 1629 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure 1630 * the PS mode of connected stations. 1631 * 1632 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session 1633 * setup strictly in HW. mac80211 should not attempt to do this in 1634 * software. 1635 * 1636 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of 1637 * a virtual monitor interface when monitor interfaces are the only 1638 * active interfaces. 1639 * 1640 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to 1641 * be created. It is expected user-space will create vifs as 1642 * desired (and thus have them named as desired). 1643 * 1644 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the 1645 * crypto algorithms can be done in software - so don't automatically 1646 * try to fall back to it if hardware crypto fails, but do so only if 1647 * the driver returns 1. This also forces the driver to advertise its 1648 * supported cipher suites. 1649 * 1650 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface 1651 * queue mapping in order to use different queues (not just one per AC) 1652 * for different virtual interfaces. See the doc section on HW queue 1653 * control for more details. 1654 * 1655 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate 1656 * selection table provided by the rate control algorithm. 1657 * 1658 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any 1659 * P2P Interface. This will be honoured even if more than one interface 1660 * is supported. 1661 * 1662 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames 1663 * only, to allow getting TBTT of a DTIM beacon. 1664 * 1665 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates 1666 * and can cope with CCK rates in an aggregation session (e.g. by not 1667 * using aggregation for such frames.) 1668 * 1669 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA) 1670 * for a single active channel while using channel contexts. When support 1671 * is not enabled the default action is to disconnect when getting the 1672 * CSA frame. 1673 * 1674 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload 1675 * or tailroom of TX skbs without copying them first. 1676 * 1677 * @IEEE80211_SINGLE_HW_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands 1678 * in one command, mac80211 doesn't have to run separate scans per band. 1679 */ 1680 enum ieee80211_hw_flags { 1681 IEEE80211_HW_HAS_RATE_CONTROL = 1<<0, 1682 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1, 1683 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2, 1684 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3, 1685 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4, 1686 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5, 1687 IEEE80211_HW_SIGNAL_DBM = 1<<6, 1688 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC = 1<<7, 1689 IEEE80211_HW_SPECTRUM_MGMT = 1<<8, 1690 IEEE80211_HW_AMPDU_AGGREGATION = 1<<9, 1691 IEEE80211_HW_SUPPORTS_PS = 1<<10, 1692 IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11, 1693 IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12, 1694 IEEE80211_HW_MFP_CAPABLE = 1<<13, 1695 IEEE80211_HW_WANT_MONITOR_VIF = 1<<14, 1696 IEEE80211_HW_NO_AUTO_VIF = 1<<15, 1697 IEEE80211_HW_SW_CRYPTO_CONTROL = 1<<16, 1698 /* free slots */ 1699 IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18, 1700 IEEE80211_HW_CONNECTION_MONITOR = 1<<19, 1701 IEEE80211_HW_QUEUE_CONTROL = 1<<20, 1702 IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21, 1703 IEEE80211_HW_AP_LINK_PS = 1<<22, 1704 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW = 1<<23, 1705 IEEE80211_HW_SUPPORTS_RC_TABLE = 1<<24, 1706 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF = 1<<25, 1707 IEEE80211_HW_TIMING_BEACON_ONLY = 1<<26, 1708 IEEE80211_HW_SUPPORTS_HT_CCK_RATES = 1<<27, 1709 IEEE80211_HW_CHANCTX_STA_CSA = 1<<28, 1710 IEEE80211_HW_SUPPORTS_CLONED_SKBS = 1<<29, 1711 IEEE80211_SINGLE_HW_SCAN_ON_ALL_BANDS = 1<<30, 1712 }; 1713 1714 /** 1715 * struct ieee80211_hw - hardware information and state 1716 * 1717 * This structure contains the configuration and hardware 1718 * information for an 802.11 PHY. 1719 * 1720 * @wiphy: This points to the &struct wiphy allocated for this 1721 * 802.11 PHY. You must fill in the @perm_addr and @dev 1722 * members of this structure using SET_IEEE80211_DEV() 1723 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported 1724 * bands (with channels, bitrates) are registered here. 1725 * 1726 * @conf: &struct ieee80211_conf, device configuration, don't use. 1727 * 1728 * @priv: pointer to private area that was allocated for driver use 1729 * along with this structure. 1730 * 1731 * @flags: hardware flags, see &enum ieee80211_hw_flags. 1732 * 1733 * @extra_tx_headroom: headroom to reserve in each transmit skb 1734 * for use by the driver (e.g. for transmit headers.) 1735 * 1736 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb. 1737 * Can be used by drivers to add extra IEs. 1738 * 1739 * @max_signal: Maximum value for signal (rssi) in RX information, used 1740 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB 1741 * 1742 * @max_listen_interval: max listen interval in units of beacon interval 1743 * that HW supports 1744 * 1745 * @queues: number of available hardware transmit queues for 1746 * data packets. WMM/QoS requires at least four, these 1747 * queues need to have configurable access parameters. 1748 * 1749 * @rate_control_algorithm: rate control algorithm for this hardware. 1750 * If unset (NULL), the default algorithm will be used. Must be 1751 * set before calling ieee80211_register_hw(). 1752 * 1753 * @vif_data_size: size (in bytes) of the drv_priv data area 1754 * within &struct ieee80211_vif. 1755 * @sta_data_size: size (in bytes) of the drv_priv data area 1756 * within &struct ieee80211_sta. 1757 * @chanctx_data_size: size (in bytes) of the drv_priv data area 1758 * within &struct ieee80211_chanctx_conf. 1759 * 1760 * @max_rates: maximum number of alternate rate retry stages the hw 1761 * can handle. 1762 * @max_report_rates: maximum number of alternate rate retry stages 1763 * the hw can report back. 1764 * @max_rate_tries: maximum number of tries for each stage 1765 * 1766 * @max_rx_aggregation_subframes: maximum buffer size (number of 1767 * sub-frames) to be used for A-MPDU block ack receiver 1768 * aggregation. 1769 * This is only relevant if the device has restrictions on the 1770 * number of subframes, if it relies on mac80211 to do reordering 1771 * it shouldn't be set. 1772 * 1773 * @max_tx_aggregation_subframes: maximum number of subframes in an 1774 * aggregate an HT driver will transmit, used by the peer as a 1775 * hint to size its reorder buffer. 1776 * 1777 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX 1778 * (if %IEEE80211_HW_QUEUE_CONTROL is set) 1779 * 1780 * @radiotap_mcs_details: lists which MCS information can the HW 1781 * reports, by default it is set to _MCS, _GI and _BW but doesn't 1782 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_* values, only 1783 * adding _BW is supported today. 1784 * 1785 * @radiotap_vht_details: lists which VHT MCS information the HW reports, 1786 * the default is _GI | _BANDWIDTH. 1787 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_* values. 1788 * 1789 * @netdev_features: netdev features to be set in each netdev created 1790 * from this HW. Note only HW checksum features are currently 1791 * compatible with mac80211. Other feature bits will be rejected. 1792 * 1793 * @uapsd_queues: This bitmap is included in (re)association frame to indicate 1794 * for each access category if it is uAPSD trigger-enabled and delivery- 1795 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap. 1796 * Each bit corresponds to different AC. Value '1' in specific bit means 1797 * that corresponding AC is both trigger- and delivery-enabled. '0' means 1798 * neither enabled. 1799 * 1800 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may 1801 * deliver to a WMM STA during any Service Period triggered by the WMM STA. 1802 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values. 1803 * 1804 * @n_cipher_schemes: a size of an array of cipher schemes definitions. 1805 * @cipher_schemes: a pointer to an array of cipher scheme definitions 1806 * supported by HW. 1807 */ 1808 struct ieee80211_hw { 1809 struct ieee80211_conf conf; 1810 struct wiphy *wiphy; 1811 const char *rate_control_algorithm; 1812 void *priv; 1813 u32 flags; 1814 unsigned int extra_tx_headroom; 1815 unsigned int extra_beacon_tailroom; 1816 int vif_data_size; 1817 int sta_data_size; 1818 int chanctx_data_size; 1819 u16 queues; 1820 u16 max_listen_interval; 1821 s8 max_signal; 1822 u8 max_rates; 1823 u8 max_report_rates; 1824 u8 max_rate_tries; 1825 u8 max_rx_aggregation_subframes; 1826 u8 max_tx_aggregation_subframes; 1827 u8 offchannel_tx_hw_queue; 1828 u8 radiotap_mcs_details; 1829 u16 radiotap_vht_details; 1830 netdev_features_t netdev_features; 1831 u8 uapsd_queues; 1832 u8 uapsd_max_sp_len; 1833 u8 n_cipher_schemes; 1834 const struct ieee80211_cipher_scheme *cipher_schemes; 1835 }; 1836 1837 /** 1838 * struct ieee80211_scan_request - hw scan request 1839 * 1840 * @ies: pointers different parts of IEs (in req.ie) 1841 * @req: cfg80211 request. 1842 */ 1843 struct ieee80211_scan_request { 1844 struct ieee80211_scan_ies ies; 1845 1846 /* Keep last */ 1847 struct cfg80211_scan_request req; 1848 }; 1849 1850 /** 1851 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters 1852 * 1853 * @sta: peer this TDLS channel-switch request/response came from 1854 * @chandef: channel referenced in a TDLS channel-switch request 1855 * @action_code: see &enum ieee80211_tdls_actioncode 1856 * @status: channel-switch response status 1857 * @timestamp: time at which the frame was received 1858 * @switch_time: switch-timing parameter received in the frame 1859 * @switch_timeout: switch-timing parameter received in the frame 1860 * @tmpl_skb: TDLS switch-channel response template 1861 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb 1862 */ 1863 struct ieee80211_tdls_ch_sw_params { 1864 struct ieee80211_sta *sta; 1865 struct cfg80211_chan_def *chandef; 1866 u8 action_code; 1867 u32 status; 1868 u32 timestamp; 1869 u16 switch_time; 1870 u16 switch_timeout; 1871 struct sk_buff *tmpl_skb; 1872 u32 ch_sw_tm_ie; 1873 }; 1874 1875 /** 1876 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy 1877 * 1878 * @wiphy: the &struct wiphy which we want to query 1879 * 1880 * mac80211 drivers can use this to get to their respective 1881 * &struct ieee80211_hw. Drivers wishing to get to their own private 1882 * structure can then access it via hw->priv. Note that mac802111 drivers should 1883 * not use wiphy_priv() to try to get their private driver structure as this 1884 * is already used internally by mac80211. 1885 * 1886 * Return: The mac80211 driver hw struct of @wiphy. 1887 */ 1888 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy); 1889 1890 /** 1891 * SET_IEEE80211_DEV - set device for 802.11 hardware 1892 * 1893 * @hw: the &struct ieee80211_hw to set the device for 1894 * @dev: the &struct device of this 802.11 device 1895 */ 1896 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev) 1897 { 1898 set_wiphy_dev(hw->wiphy, dev); 1899 } 1900 1901 /** 1902 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware 1903 * 1904 * @hw: the &struct ieee80211_hw to set the MAC address for 1905 * @addr: the address to set 1906 */ 1907 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr) 1908 { 1909 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN); 1910 } 1911 1912 static inline struct ieee80211_rate * 1913 ieee80211_get_tx_rate(const struct ieee80211_hw *hw, 1914 const struct ieee80211_tx_info *c) 1915 { 1916 if (WARN_ON_ONCE(c->control.rates[0].idx < 0)) 1917 return NULL; 1918 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx]; 1919 } 1920 1921 static inline struct ieee80211_rate * 1922 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw, 1923 const struct ieee80211_tx_info *c) 1924 { 1925 if (c->control.rts_cts_rate_idx < 0) 1926 return NULL; 1927 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx]; 1928 } 1929 1930 static inline struct ieee80211_rate * 1931 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw, 1932 const struct ieee80211_tx_info *c, int idx) 1933 { 1934 if (c->control.rates[idx + 1].idx < 0) 1935 return NULL; 1936 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx]; 1937 } 1938 1939 /** 1940 * ieee80211_free_txskb - free TX skb 1941 * @hw: the hardware 1942 * @skb: the skb 1943 * 1944 * Free a transmit skb. Use this funtion when some failure 1945 * to transmit happened and thus status cannot be reported. 1946 */ 1947 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb); 1948 1949 /** 1950 * DOC: Hardware crypto acceleration 1951 * 1952 * mac80211 is capable of taking advantage of many hardware 1953 * acceleration designs for encryption and decryption operations. 1954 * 1955 * The set_key() callback in the &struct ieee80211_ops for a given 1956 * device is called to enable hardware acceleration of encryption and 1957 * decryption. The callback takes a @sta parameter that will be NULL 1958 * for default keys or keys used for transmission only, or point to 1959 * the station information for the peer for individual keys. 1960 * Multiple transmission keys with the same key index may be used when 1961 * VLANs are configured for an access point. 1962 * 1963 * When transmitting, the TX control data will use the @hw_key_idx 1964 * selected by the driver by modifying the &struct ieee80211_key_conf 1965 * pointed to by the @key parameter to the set_key() function. 1966 * 1967 * The set_key() call for the %SET_KEY command should return 0 if 1968 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be 1969 * added; if you return 0 then hw_key_idx must be assigned to the 1970 * hardware key index, you are free to use the full u8 range. 1971 * 1972 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is 1973 * set, mac80211 will not automatically fall back to software crypto if 1974 * enabling hardware crypto failed. The set_key() call may also return the 1975 * value 1 to permit this specific key/algorithm to be done in software. 1976 * 1977 * When the cmd is %DISABLE_KEY then it must succeed. 1978 * 1979 * Note that it is permissible to not decrypt a frame even if a key 1980 * for it has been uploaded to hardware, the stack will not make any 1981 * decision based on whether a key has been uploaded or not but rather 1982 * based on the receive flags. 1983 * 1984 * The &struct ieee80211_key_conf structure pointed to by the @key 1985 * parameter is guaranteed to be valid until another call to set_key() 1986 * removes it, but it can only be used as a cookie to differentiate 1987 * keys. 1988 * 1989 * In TKIP some HW need to be provided a phase 1 key, for RX decryption 1990 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key 1991 * handler. 1992 * The update_tkip_key() call updates the driver with the new phase 1 key. 1993 * This happens every time the iv16 wraps around (every 65536 packets). The 1994 * set_key() call will happen only once for each key (unless the AP did 1995 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is 1996 * provided by update_tkip_key only. The trigger that makes mac80211 call this 1997 * handler is software decryption with wrap around of iv16. 1998 * 1999 * The set_default_unicast_key() call updates the default WEP key index 2000 * configured to the hardware for WEP encryption type. This is required 2001 * for devices that support offload of data packets (e.g. ARP responses). 2002 */ 2003 2004 /** 2005 * DOC: Powersave support 2006 * 2007 * mac80211 has support for various powersave implementations. 2008 * 2009 * First, it can support hardware that handles all powersaving by itself, 2010 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware 2011 * flag. In that case, it will be told about the desired powersave mode 2012 * with the %IEEE80211_CONF_PS flag depending on the association status. 2013 * The hardware must take care of sending nullfunc frames when necessary, 2014 * i.e. when entering and leaving powersave mode. The hardware is required 2015 * to look at the AID in beacons and signal to the AP that it woke up when 2016 * it finds traffic directed to it. 2017 * 2018 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in 2019 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused 2020 * with hardware wakeup and sleep states. Driver is responsible for waking 2021 * up the hardware before issuing commands to the hardware and putting it 2022 * back to sleep at appropriate times. 2023 * 2024 * When PS is enabled, hardware needs to wakeup for beacons and receive the 2025 * buffered multicast/broadcast frames after the beacon. Also it must be 2026 * possible to send frames and receive the acknowledment frame. 2027 * 2028 * Other hardware designs cannot send nullfunc frames by themselves and also 2029 * need software support for parsing the TIM bitmap. This is also supported 2030 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and 2031 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still 2032 * required to pass up beacons. The hardware is still required to handle 2033 * waking up for multicast traffic; if it cannot the driver must handle that 2034 * as best as it can, mac80211 is too slow to do that. 2035 * 2036 * Dynamic powersave is an extension to normal powersave in which the 2037 * hardware stays awake for a user-specified period of time after sending a 2038 * frame so that reply frames need not be buffered and therefore delayed to 2039 * the next wakeup. It's compromise of getting good enough latency when 2040 * there's data traffic and still saving significantly power in idle 2041 * periods. 2042 * 2043 * Dynamic powersave is simply supported by mac80211 enabling and disabling 2044 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS 2045 * flag and mac80211 will handle everything automatically. Additionally, 2046 * hardware having support for the dynamic PS feature may set the 2047 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support 2048 * dynamic PS mode itself. The driver needs to look at the 2049 * @dynamic_ps_timeout hardware configuration value and use it that value 2050 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable 2051 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS 2052 * enabled whenever user has enabled powersave. 2053 * 2054 * Driver informs U-APSD client support by enabling 2055 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the 2056 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS 2057 * Nullfunc frames and stay awake until the service period has ended. To 2058 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames 2059 * from that AC are transmitted with powersave enabled. 2060 * 2061 * Note: U-APSD client mode is not yet supported with 2062 * %IEEE80211_HW_PS_NULLFUNC_STACK. 2063 */ 2064 2065 /** 2066 * DOC: Beacon filter support 2067 * 2068 * Some hardware have beacon filter support to reduce host cpu wakeups 2069 * which will reduce system power consumption. It usually works so that 2070 * the firmware creates a checksum of the beacon but omits all constantly 2071 * changing elements (TSF, TIM etc). Whenever the checksum changes the 2072 * beacon is forwarded to the host, otherwise it will be just dropped. That 2073 * way the host will only receive beacons where some relevant information 2074 * (for example ERP protection or WMM settings) have changed. 2075 * 2076 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER 2077 * interface capability. The driver needs to enable beacon filter support 2078 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When 2079 * power save is enabled, the stack will not check for beacon loss and the 2080 * driver needs to notify about loss of beacons with ieee80211_beacon_loss(). 2081 * 2082 * The time (or number of beacons missed) until the firmware notifies the 2083 * driver of a beacon loss event (which in turn causes the driver to call 2084 * ieee80211_beacon_loss()) should be configurable and will be controlled 2085 * by mac80211 and the roaming algorithm in the future. 2086 * 2087 * Since there may be constantly changing information elements that nothing 2088 * in the software stack cares about, we will, in the future, have mac80211 2089 * tell the driver which information elements are interesting in the sense 2090 * that we want to see changes in them. This will include 2091 * - a list of information element IDs 2092 * - a list of OUIs for the vendor information element 2093 * 2094 * Ideally, the hardware would filter out any beacons without changes in the 2095 * requested elements, but if it cannot support that it may, at the expense 2096 * of some efficiency, filter out only a subset. For example, if the device 2097 * doesn't support checking for OUIs it should pass up all changes in all 2098 * vendor information elements. 2099 * 2100 * Note that change, for the sake of simplification, also includes information 2101 * elements appearing or disappearing from the beacon. 2102 * 2103 * Some hardware supports an "ignore list" instead, just make sure nothing 2104 * that was requested is on the ignore list, and include commonly changing 2105 * information element IDs in the ignore list, for example 11 (BSS load) and 2106 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136, 2107 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility 2108 * it could also include some currently unused IDs. 2109 * 2110 * 2111 * In addition to these capabilities, hardware should support notifying the 2112 * host of changes in the beacon RSSI. This is relevant to implement roaming 2113 * when no traffic is flowing (when traffic is flowing we see the RSSI of 2114 * the received data packets). This can consist in notifying the host when 2115 * the RSSI changes significantly or when it drops below or rises above 2116 * configurable thresholds. In the future these thresholds will also be 2117 * configured by mac80211 (which gets them from userspace) to implement 2118 * them as the roaming algorithm requires. 2119 * 2120 * If the hardware cannot implement this, the driver should ask it to 2121 * periodically pass beacon frames to the host so that software can do the 2122 * signal strength threshold checking. 2123 */ 2124 2125 /** 2126 * DOC: Spatial multiplexing power save 2127 * 2128 * SMPS (Spatial multiplexing power save) is a mechanism to conserve 2129 * power in an 802.11n implementation. For details on the mechanism 2130 * and rationale, please refer to 802.11 (as amended by 802.11n-2009) 2131 * "11.2.3 SM power save". 2132 * 2133 * The mac80211 implementation is capable of sending action frames 2134 * to update the AP about the station's SMPS mode, and will instruct 2135 * the driver to enter the specific mode. It will also announce the 2136 * requested SMPS mode during the association handshake. Hardware 2137 * support for this feature is required, and can be indicated by 2138 * hardware flags. 2139 * 2140 * The default mode will be "automatic", which nl80211/cfg80211 2141 * defines to be dynamic SMPS in (regular) powersave, and SMPS 2142 * turned off otherwise. 2143 * 2144 * To support this feature, the driver must set the appropriate 2145 * hardware support flags, and handle the SMPS flag to the config() 2146 * operation. It will then with this mechanism be instructed to 2147 * enter the requested SMPS mode while associated to an HT AP. 2148 */ 2149 2150 /** 2151 * DOC: Frame filtering 2152 * 2153 * mac80211 requires to see many management frames for proper 2154 * operation, and users may want to see many more frames when 2155 * in monitor mode. However, for best CPU usage and power consumption, 2156 * having as few frames as possible percolate through the stack is 2157 * desirable. Hence, the hardware should filter as much as possible. 2158 * 2159 * To achieve this, mac80211 uses filter flags (see below) to tell 2160 * the driver's configure_filter() function which frames should be 2161 * passed to mac80211 and which should be filtered out. 2162 * 2163 * Before configure_filter() is invoked, the prepare_multicast() 2164 * callback is invoked with the parameters @mc_count and @mc_list 2165 * for the combined multicast address list of all virtual interfaces. 2166 * It's use is optional, and it returns a u64 that is passed to 2167 * configure_filter(). Additionally, configure_filter() has the 2168 * arguments @changed_flags telling which flags were changed and 2169 * @total_flags with the new flag states. 2170 * 2171 * If your device has no multicast address filters your driver will 2172 * need to check both the %FIF_ALLMULTI flag and the @mc_count 2173 * parameter to see whether multicast frames should be accepted 2174 * or dropped. 2175 * 2176 * All unsupported flags in @total_flags must be cleared. 2177 * Hardware does not support a flag if it is incapable of _passing_ 2178 * the frame to the stack. Otherwise the driver must ignore 2179 * the flag, but not clear it. 2180 * You must _only_ clear the flag (announce no support for the 2181 * flag to mac80211) if you are not able to pass the packet type 2182 * to the stack (so the hardware always filters it). 2183 * So for example, you should clear @FIF_CONTROL, if your hardware 2184 * always filters control frames. If your hardware always passes 2185 * control frames to the kernel and is incapable of filtering them, 2186 * you do _not_ clear the @FIF_CONTROL flag. 2187 * This rule applies to all other FIF flags as well. 2188 */ 2189 2190 /** 2191 * DOC: AP support for powersaving clients 2192 * 2193 * In order to implement AP and P2P GO modes, mac80211 has support for 2194 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD. 2195 * There currently is no support for sAPSD. 2196 * 2197 * There is one assumption that mac80211 makes, namely that a client 2198 * will not poll with PS-Poll and trigger with uAPSD at the same time. 2199 * Both are supported, and both can be used by the same client, but 2200 * they can't be used concurrently by the same client. This simplifies 2201 * the driver code. 2202 * 2203 * The first thing to keep in mind is that there is a flag for complete 2204 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set, 2205 * mac80211 expects the driver to handle most of the state machine for 2206 * powersaving clients and will ignore the PM bit in incoming frames. 2207 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of 2208 * stations' powersave transitions. In this mode, mac80211 also doesn't 2209 * handle PS-Poll/uAPSD. 2210 * 2211 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the 2212 * PM bit in incoming frames for client powersave transitions. When a 2213 * station goes to sleep, we will stop transmitting to it. There is, 2214 * however, a race condition: a station might go to sleep while there is 2215 * data buffered on hardware queues. If the device has support for this 2216 * it will reject frames, and the driver should give the frames back to 2217 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will 2218 * cause mac80211 to retry the frame when the station wakes up. The 2219 * driver is also notified of powersave transitions by calling its 2220 * @sta_notify callback. 2221 * 2222 * When the station is asleep, it has three choices: it can wake up, 2223 * it can PS-Poll, or it can possibly start a uAPSD service period. 2224 * Waking up is implemented by simply transmitting all buffered (and 2225 * filtered) frames to the station. This is the easiest case. When 2226 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211 2227 * will inform the driver of this with the @allow_buffered_frames 2228 * callback; this callback is optional. mac80211 will then transmit 2229 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER 2230 * on each frame. The last frame in the service period (or the only 2231 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to 2232 * indicate that it ends the service period; as this frame must have 2233 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS. 2234 * When TX status is reported for this frame, the service period is 2235 * marked has having ended and a new one can be started by the peer. 2236 * 2237 * Additionally, non-bufferable MMPDUs can also be transmitted by 2238 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them. 2239 * 2240 * Another race condition can happen on some devices like iwlwifi 2241 * when there are frames queued for the station and it wakes up 2242 * or polls; the frames that are already queued could end up being 2243 * transmitted first instead, causing reordering and/or wrong 2244 * processing of the EOSP. The cause is that allowing frames to be 2245 * transmitted to a certain station is out-of-band communication to 2246 * the device. To allow this problem to be solved, the driver can 2247 * call ieee80211_sta_block_awake() if frames are buffered when it 2248 * is notified that the station went to sleep. When all these frames 2249 * have been filtered (see above), it must call the function again 2250 * to indicate that the station is no longer blocked. 2251 * 2252 * If the driver buffers frames in the driver for aggregation in any 2253 * way, it must use the ieee80211_sta_set_buffered() call when it is 2254 * notified of the station going to sleep to inform mac80211 of any 2255 * TIDs that have frames buffered. Note that when a station wakes up 2256 * this information is reset (hence the requirement to call it when 2257 * informed of the station going to sleep). Then, when a service 2258 * period starts for any reason, @release_buffered_frames is called 2259 * with the number of frames to be released and which TIDs they are 2260 * to come from. In this case, the driver is responsible for setting 2261 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames, 2262 * to help the @more_data parameter is passed to tell the driver if 2263 * there is more data on other TIDs -- the TIDs to release frames 2264 * from are ignored since mac80211 doesn't know how many frames the 2265 * buffers for those TIDs contain. 2266 * 2267 * If the driver also implement GO mode, where absence periods may 2268 * shorten service periods (or abort PS-Poll responses), it must 2269 * filter those response frames except in the case of frames that 2270 * are buffered in the driver -- those must remain buffered to avoid 2271 * reordering. Because it is possible that no frames are released 2272 * in this case, the driver must call ieee80211_sta_eosp() 2273 * to indicate to mac80211 that the service period ended anyway. 2274 * 2275 * Finally, if frames from multiple TIDs are released from mac80211 2276 * but the driver might reorder them, it must clear & set the flags 2277 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP) 2278 * and also take care of the EOSP and MORE_DATA bits in the frame. 2279 * The driver may also use ieee80211_sta_eosp() in this case. 2280 * 2281 * Note that if the driver ever buffers frames other than QoS-data 2282 * frames, it must take care to never send a non-QoS-data frame as 2283 * the last frame in a service period, adding a QoS-nulldata frame 2284 * after a non-QoS-data frame if needed. 2285 */ 2286 2287 /** 2288 * DOC: HW queue control 2289 * 2290 * Before HW queue control was introduced, mac80211 only had a single static 2291 * assignment of per-interface AC software queues to hardware queues. This 2292 * was problematic for a few reasons: 2293 * 1) off-channel transmissions might get stuck behind other frames 2294 * 2) multiple virtual interfaces couldn't be handled correctly 2295 * 3) after-DTIM frames could get stuck behind other frames 2296 * 2297 * To solve this, hardware typically uses multiple different queues for all 2298 * the different usages, and this needs to be propagated into mac80211 so it 2299 * won't have the same problem with the software queues. 2300 * 2301 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability 2302 * flag that tells it that the driver implements its own queue control. To do 2303 * so, the driver will set up the various queues in each &struct ieee80211_vif 2304 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will 2305 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and 2306 * if necessary will queue the frame on the right software queue that mirrors 2307 * the hardware queue. 2308 * Additionally, the driver has to then use these HW queue IDs for the queue 2309 * management functions (ieee80211_stop_queue() et al.) 2310 * 2311 * The driver is free to set up the queue mappings as needed, multiple virtual 2312 * interfaces may map to the same hardware queues if needed. The setup has to 2313 * happen during add_interface or change_interface callbacks. For example, a 2314 * driver supporting station+station and station+AP modes might decide to have 2315 * 10 hardware queues to handle different scenarios: 2316 * 2317 * 4 AC HW queues for 1st vif: 0, 1, 2, 3 2318 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7 2319 * after-DTIM queue for AP: 8 2320 * off-channel queue: 9 2321 * 2322 * It would then set up the hardware like this: 2323 * hw.offchannel_tx_hw_queue = 9 2324 * 2325 * and the first virtual interface that is added as follows: 2326 * vif.hw_queue[IEEE80211_AC_VO] = 0 2327 * vif.hw_queue[IEEE80211_AC_VI] = 1 2328 * vif.hw_queue[IEEE80211_AC_BE] = 2 2329 * vif.hw_queue[IEEE80211_AC_BK] = 3 2330 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE 2331 * and the second virtual interface with 4-7. 2332 * 2333 * If queue 6 gets full, for example, mac80211 would only stop the second 2334 * virtual interface's BE queue since virtual interface queues are per AC. 2335 * 2336 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE 2337 * whenever the queue is not used (i.e. the interface is not in AP mode) if the 2338 * queue could potentially be shared since mac80211 will look at cab_queue when 2339 * a queue is stopped/woken even if the interface is not in AP mode. 2340 */ 2341 2342 /** 2343 * enum ieee80211_filter_flags - hardware filter flags 2344 * 2345 * These flags determine what the filter in hardware should be 2346 * programmed to let through and what should not be passed to the 2347 * stack. It is always safe to pass more frames than requested, 2348 * but this has negative impact on power consumption. 2349 * 2350 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS, 2351 * think of the BSS as your network segment and then this corresponds 2352 * to the regular ethernet device promiscuous mode. 2353 * 2354 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested 2355 * by the user or if the hardware is not capable of filtering by 2356 * multicast address. 2357 * 2358 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the 2359 * %RX_FLAG_FAILED_FCS_CRC for them) 2360 * 2361 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set 2362 * the %RX_FLAG_FAILED_PLCP_CRC for them 2363 * 2364 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate 2365 * to the hardware that it should not filter beacons or probe responses 2366 * by BSSID. Filtering them can greatly reduce the amount of processing 2367 * mac80211 needs to do and the amount of CPU wakeups, so you should 2368 * honour this flag if possible. 2369 * 2370 * @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS 2371 * is not set then only those addressed to this station. 2372 * 2373 * @FIF_OTHER_BSS: pass frames destined to other BSSes 2374 * 2375 * @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only 2376 * those addressed to this station. 2377 * 2378 * @FIF_PROBE_REQ: pass probe request frames 2379 */ 2380 enum ieee80211_filter_flags { 2381 FIF_PROMISC_IN_BSS = 1<<0, 2382 FIF_ALLMULTI = 1<<1, 2383 FIF_FCSFAIL = 1<<2, 2384 FIF_PLCPFAIL = 1<<3, 2385 FIF_BCN_PRBRESP_PROMISC = 1<<4, 2386 FIF_CONTROL = 1<<5, 2387 FIF_OTHER_BSS = 1<<6, 2388 FIF_PSPOLL = 1<<7, 2389 FIF_PROBE_REQ = 1<<8, 2390 }; 2391 2392 /** 2393 * enum ieee80211_ampdu_mlme_action - A-MPDU actions 2394 * 2395 * These flags are used with the ampdu_action() callback in 2396 * &struct ieee80211_ops to indicate which action is needed. 2397 * 2398 * Note that drivers MUST be able to deal with a TX aggregation 2399 * session being stopped even before they OK'ed starting it by 2400 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer 2401 * might receive the addBA frame and send a delBA right away! 2402 * 2403 * @IEEE80211_AMPDU_RX_START: start RX aggregation 2404 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation 2405 * @IEEE80211_AMPDU_TX_START: start TX aggregation 2406 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational 2407 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting 2408 * queued packets, now unaggregated. After all packets are transmitted the 2409 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe(). 2410 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets, 2411 * called when the station is removed. There's no need or reason to call 2412 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the 2413 * session is gone and removes the station. 2414 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped 2415 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and 2416 * now the connection is dropped and the station will be removed. Drivers 2417 * should clean up and drop remaining packets when this is called. 2418 */ 2419 enum ieee80211_ampdu_mlme_action { 2420 IEEE80211_AMPDU_RX_START, 2421 IEEE80211_AMPDU_RX_STOP, 2422 IEEE80211_AMPDU_TX_START, 2423 IEEE80211_AMPDU_TX_STOP_CONT, 2424 IEEE80211_AMPDU_TX_STOP_FLUSH, 2425 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT, 2426 IEEE80211_AMPDU_TX_OPERATIONAL, 2427 }; 2428 2429 /** 2430 * enum ieee80211_frame_release_type - frame release reason 2431 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll 2432 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to 2433 * frame received on trigger-enabled AC 2434 */ 2435 enum ieee80211_frame_release_type { 2436 IEEE80211_FRAME_RELEASE_PSPOLL, 2437 IEEE80211_FRAME_RELEASE_UAPSD, 2438 }; 2439 2440 /** 2441 * enum ieee80211_rate_control_changed - flags to indicate what changed 2442 * 2443 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit 2444 * to this station changed. The actual bandwidth is in the station 2445 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40 2446 * flag changes, for HT and VHT the bandwidth field changes. 2447 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed. 2448 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer 2449 * changed (in IBSS mode) due to discovering more information about 2450 * the peer. 2451 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed 2452 * by the peer 2453 */ 2454 enum ieee80211_rate_control_changed { 2455 IEEE80211_RC_BW_CHANGED = BIT(0), 2456 IEEE80211_RC_SMPS_CHANGED = BIT(1), 2457 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2), 2458 IEEE80211_RC_NSS_CHANGED = BIT(3), 2459 }; 2460 2461 /** 2462 * enum ieee80211_roc_type - remain on channel type 2463 * 2464 * With the support for multi channel contexts and multi channel operations, 2465 * remain on channel operations might be limited/deferred/aborted by other 2466 * flows/operations which have higher priority (and vise versa). 2467 * Specifying the ROC type can be used by devices to prioritize the ROC 2468 * operations compared to other operations/flows. 2469 * 2470 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC. 2471 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required 2472 * for sending managment frames offchannel. 2473 */ 2474 enum ieee80211_roc_type { 2475 IEEE80211_ROC_TYPE_NORMAL = 0, 2476 IEEE80211_ROC_TYPE_MGMT_TX, 2477 }; 2478 2479 /** 2480 * enum ieee80211_reconfig_complete_type - reconfig type 2481 * 2482 * This enum is used by the reconfig_complete() callback to indicate what 2483 * reconfiguration type was completed. 2484 * 2485 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type 2486 * (also due to resume() callback returning 1) 2487 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless 2488 * of wowlan configuration) 2489 */ 2490 enum ieee80211_reconfig_type { 2491 IEEE80211_RECONFIG_TYPE_RESTART, 2492 IEEE80211_RECONFIG_TYPE_SUSPEND, 2493 }; 2494 2495 /** 2496 * struct ieee80211_ops - callbacks from mac80211 to the driver 2497 * 2498 * This structure contains various callbacks that the driver may 2499 * handle or, in some cases, must handle, for example to configure 2500 * the hardware to a new channel or to transmit a frame. 2501 * 2502 * @tx: Handler that 802.11 module calls for each transmitted frame. 2503 * skb contains the buffer starting from the IEEE 802.11 header. 2504 * The low-level driver should send the frame out based on 2505 * configuration in the TX control data. This handler should, 2506 * preferably, never fail and stop queues appropriately. 2507 * Must be atomic. 2508 * 2509 * @start: Called before the first netdevice attached to the hardware 2510 * is enabled. This should turn on the hardware and must turn on 2511 * frame reception (for possibly enabled monitor interfaces.) 2512 * Returns negative error codes, these may be seen in userspace, 2513 * or zero. 2514 * When the device is started it should not have a MAC address 2515 * to avoid acknowledging frames before a non-monitor device 2516 * is added. 2517 * Must be implemented and can sleep. 2518 * 2519 * @stop: Called after last netdevice attached to the hardware 2520 * is disabled. This should turn off the hardware (at least 2521 * it must turn off frame reception.) 2522 * May be called right after add_interface if that rejects 2523 * an interface. If you added any work onto the mac80211 workqueue 2524 * you should ensure to cancel it on this callback. 2525 * Must be implemented and can sleep. 2526 * 2527 * @suspend: Suspend the device; mac80211 itself will quiesce before and 2528 * stop transmitting and doing any other configuration, and then 2529 * ask the device to suspend. This is only invoked when WoWLAN is 2530 * configured, otherwise the device is deconfigured completely and 2531 * reconfigured at resume time. 2532 * The driver may also impose special conditions under which it 2533 * wants to use the "normal" suspend (deconfigure), say if it only 2534 * supports WoWLAN when the device is associated. In this case, it 2535 * must return 1 from this function. 2536 * 2537 * @resume: If WoWLAN was configured, this indicates that mac80211 is 2538 * now resuming its operation, after this the device must be fully 2539 * functional again. If this returns an error, the only way out is 2540 * to also unregister the device. If it returns 1, then mac80211 2541 * will also go through the regular complete restart on resume. 2542 * 2543 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is 2544 * modified. The reason is that device_set_wakeup_enable() is 2545 * supposed to be called when the configuration changes, not only 2546 * in suspend(). 2547 * 2548 * @add_interface: Called when a netdevice attached to the hardware is 2549 * enabled. Because it is not called for monitor mode devices, @start 2550 * and @stop must be implemented. 2551 * The driver should perform any initialization it needs before 2552 * the device can be enabled. The initial configuration for the 2553 * interface is given in the conf parameter. 2554 * The callback may refuse to add an interface by returning a 2555 * negative error code (which will be seen in userspace.) 2556 * Must be implemented and can sleep. 2557 * 2558 * @change_interface: Called when a netdevice changes type. This callback 2559 * is optional, but only if it is supported can interface types be 2560 * switched while the interface is UP. The callback may sleep. 2561 * Note that while an interface is being switched, it will not be 2562 * found by the interface iteration callbacks. 2563 * 2564 * @remove_interface: Notifies a driver that an interface is going down. 2565 * The @stop callback is called after this if it is the last interface 2566 * and no monitor interfaces are present. 2567 * When all interfaces are removed, the MAC address in the hardware 2568 * must be cleared so the device no longer acknowledges packets, 2569 * the mac_addr member of the conf structure is, however, set to the 2570 * MAC address of the device going away. 2571 * Hence, this callback must be implemented. It can sleep. 2572 * 2573 * @config: Handler for configuration requests. IEEE 802.11 code calls this 2574 * function to change hardware configuration, e.g., channel. 2575 * This function should never fail but returns a negative error code 2576 * if it does. The callback can sleep. 2577 * 2578 * @bss_info_changed: Handler for configuration requests related to BSS 2579 * parameters that may vary during BSS's lifespan, and may affect low 2580 * level driver (e.g. assoc/disassoc status, erp parameters). 2581 * This function should not be used if no BSS has been set, unless 2582 * for association indication. The @changed parameter indicates which 2583 * of the bss parameters has changed when a call is made. The callback 2584 * can sleep. 2585 * 2586 * @prepare_multicast: Prepare for multicast filter configuration. 2587 * This callback is optional, and its return value is passed 2588 * to configure_filter(). This callback must be atomic. 2589 * 2590 * @configure_filter: Configure the device's RX filter. 2591 * See the section "Frame filtering" for more information. 2592 * This callback must be implemented and can sleep. 2593 * 2594 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit 2595 * must be set or cleared for a given STA. Must be atomic. 2596 * 2597 * @set_key: See the section "Hardware crypto acceleration" 2598 * This callback is only called between add_interface and 2599 * remove_interface calls, i.e. while the given virtual interface 2600 * is enabled. 2601 * Returns a negative error code if the key can't be added. 2602 * The callback can sleep. 2603 * 2604 * @update_tkip_key: See the section "Hardware crypto acceleration" 2605 * This callback will be called in the context of Rx. Called for drivers 2606 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY. 2607 * The callback must be atomic. 2608 * 2609 * @set_rekey_data: If the device supports GTK rekeying, for example while the 2610 * host is suspended, it can assign this callback to retrieve the data 2611 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter. 2612 * After rekeying was done it should (for example during resume) notify 2613 * userspace of the new replay counter using ieee80211_gtk_rekey_notify(). 2614 * 2615 * @set_default_unicast_key: Set the default (unicast) key index, useful for 2616 * WEP when the device sends data packets autonomously, e.g. for ARP 2617 * offloading. The index can be 0-3, or -1 for unsetting it. 2618 * 2619 * @hw_scan: Ask the hardware to service the scan request, no need to start 2620 * the scan state machine in stack. The scan must honour the channel 2621 * configuration done by the regulatory agent in the wiphy's 2622 * registered bands. The hardware (or the driver) needs to make sure 2623 * that power save is disabled. 2624 * The @req ie/ie_len members are rewritten by mac80211 to contain the 2625 * entire IEs after the SSID, so that drivers need not look at these 2626 * at all but just send them after the SSID -- mac80211 includes the 2627 * (extended) supported rates and HT information (where applicable). 2628 * When the scan finishes, ieee80211_scan_completed() must be called; 2629 * note that it also must be called when the scan cannot finish due to 2630 * any error unless this callback returned a negative error code. 2631 * The callback can sleep. 2632 * 2633 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan. 2634 * The driver should ask the hardware to cancel the scan (if possible), 2635 * but the scan will be completed only after the driver will call 2636 * ieee80211_scan_completed(). 2637 * This callback is needed for wowlan, to prevent enqueueing a new 2638 * scan_work after the low-level driver was already suspended. 2639 * The callback can sleep. 2640 * 2641 * @sched_scan_start: Ask the hardware to start scanning repeatedly at 2642 * specific intervals. The driver must call the 2643 * ieee80211_sched_scan_results() function whenever it finds results. 2644 * This process will continue until sched_scan_stop is called. 2645 * 2646 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan. 2647 * In this case, ieee80211_sched_scan_stopped() must not be called. 2648 * 2649 * @sw_scan_start: Notifier function that is called just before a software scan 2650 * is started. Can be NULL, if the driver doesn't need this notification. 2651 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR, 2652 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it 2653 * can use this parameter. The callback can sleep. 2654 * 2655 * @sw_scan_complete: Notifier function that is called just after a 2656 * software scan finished. Can be NULL, if the driver doesn't need 2657 * this notification. 2658 * The callback can sleep. 2659 * 2660 * @get_stats: Return low-level statistics. 2661 * Returns zero if statistics are available. 2662 * The callback can sleep. 2663 * 2664 * @get_tkip_seq: If your device implements TKIP encryption in hardware this 2665 * callback should be provided to read the TKIP transmit IVs (both IV32 2666 * and IV16) for the given key from hardware. 2667 * The callback must be atomic. 2668 * 2669 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this 2670 * if the device does fragmentation by itself; if this callback is 2671 * implemented then the stack will not do fragmentation. 2672 * The callback can sleep. 2673 * 2674 * @set_rts_threshold: Configuration of RTS threshold (if device needs it) 2675 * The callback can sleep. 2676 * 2677 * @sta_add: Notifies low level driver about addition of an associated station, 2678 * AP, IBSS/WDS/mesh peer etc. This callback can sleep. 2679 * 2680 * @sta_remove: Notifies low level driver about removal of an associated 2681 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback 2682 * returns it isn't safe to use the pointer, not even RCU protected; 2683 * no RCU grace period is guaranteed between returning here and freeing 2684 * the station. See @sta_pre_rcu_remove if needed. 2685 * This callback can sleep. 2686 * 2687 * @sta_add_debugfs: Drivers can use this callback to add debugfs files 2688 * when a station is added to mac80211's station list. This callback 2689 * and @sta_remove_debugfs should be within a CONFIG_MAC80211_DEBUGFS 2690 * conditional. This callback can sleep. 2691 * 2692 * @sta_remove_debugfs: Remove the debugfs files which were added using 2693 * @sta_add_debugfs. This callback can sleep. 2694 * 2695 * @sta_notify: Notifies low level driver about power state transition of an 2696 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating 2697 * in AP mode, this callback will not be called when the flag 2698 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic. 2699 * 2700 * @sta_state: Notifies low level driver about state transition of a 2701 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.) 2702 * This callback is mutually exclusive with @sta_add/@sta_remove. 2703 * It must not fail for down transitions but may fail for transitions 2704 * up the list of states. Also note that after the callback returns it 2705 * isn't safe to use the pointer, not even RCU protected - no RCU grace 2706 * period is guaranteed between returning here and freeing the station. 2707 * See @sta_pre_rcu_remove if needed. 2708 * The callback can sleep. 2709 * 2710 * @sta_pre_rcu_remove: Notify driver about station removal before RCU 2711 * synchronisation. This is useful if a driver needs to have station 2712 * pointers protected using RCU, it can then use this call to clear 2713 * the pointers instead of waiting for an RCU grace period to elapse 2714 * in @sta_state. 2715 * The callback can sleep. 2716 * 2717 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be 2718 * used to transmit to the station. The changes are advertised with bits 2719 * from &enum ieee80211_rate_control_changed and the values are reflected 2720 * in the station data. This callback should only be used when the driver 2721 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since 2722 * otherwise the rate control algorithm is notified directly. 2723 * Must be atomic. 2724 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This 2725 * is only used if the configured rate control algorithm actually uses 2726 * the new rate table API, and is therefore optional. Must be atomic. 2727 * 2728 * @sta_statistics: Get statistics for this station. For example with beacon 2729 * filtering, the statistics kept by mac80211 might not be accurate, so 2730 * let the driver pre-fill the statistics. The driver can fill most of 2731 * the values (indicating which by setting the filled bitmap), but not 2732 * all of them make sense - see the source for which ones are possible. 2733 * Statistics that the driver doesn't fill will be filled by mac80211. 2734 * The callback can sleep. 2735 * 2736 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max), 2737 * bursting) for a hardware TX queue. 2738 * Returns a negative error code on failure. 2739 * The callback can sleep. 2740 * 2741 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently, 2742 * this is only used for IBSS mode BSSID merging and debugging. Is not a 2743 * required function. 2744 * The callback can sleep. 2745 * 2746 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware. 2747 * Currently, this is only used for IBSS mode debugging. Is not a 2748 * required function. 2749 * The callback can sleep. 2750 * 2751 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize 2752 * with other STAs in the IBSS. This is only used in IBSS mode. This 2753 * function is optional if the firmware/hardware takes full care of 2754 * TSF synchronization. 2755 * The callback can sleep. 2756 * 2757 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us. 2758 * This is needed only for IBSS mode and the result of this function is 2759 * used to determine whether to reply to Probe Requests. 2760 * Returns non-zero if this device sent the last beacon. 2761 * The callback can sleep. 2762 * 2763 * @ampdu_action: Perform a certain A-MPDU action 2764 * The RA/TID combination determines the destination and TID we want 2765 * the ampdu action to be performed for. The action is defined through 2766 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn) 2767 * is the first frame we expect to perform the action on. Notice 2768 * that TX/RX_STOP can pass NULL for this parameter. 2769 * The @buf_size parameter is only valid when the action is set to 2770 * %IEEE80211_AMPDU_TX_OPERATIONAL and indicates the peer's reorder 2771 * buffer size (number of subframes) for this session -- the driver 2772 * may neither send aggregates containing more subframes than this 2773 * nor send aggregates in a way that lost frames would exceed the 2774 * buffer size. If just limiting the aggregate size, this would be 2775 * possible with a buf_size of 8: 2776 * - TX: 1.....7 2777 * - RX: 2....7 (lost frame #1) 2778 * - TX: 8..1... 2779 * which is invalid since #1 was now re-transmitted well past the 2780 * buffer size of 8. Correct ways to retransmit #1 would be: 2781 * - TX: 1 or 18 or 81 2782 * Even "189" would be wrong since 1 could be lost again. 2783 * 2784 * Returns a negative error code on failure. 2785 * The callback can sleep. 2786 * 2787 * @get_survey: Return per-channel survey information 2788 * 2789 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also 2790 * need to set wiphy->rfkill_poll to %true before registration, 2791 * and need to call wiphy_rfkill_set_hw_state() in the callback. 2792 * The callback can sleep. 2793 * 2794 * @set_coverage_class: Set slot time for given coverage class as specified 2795 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout 2796 * accordingly; coverage class equals to -1 to enable ACK timeout 2797 * estimation algorithm (dynack). To disable dynack set valid value for 2798 * coverage class. This callback is not required and may sleep. 2799 * 2800 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may 2801 * be %NULL. The callback can sleep. 2802 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep. 2803 * 2804 * @flush: Flush all pending frames from the hardware queue, making sure 2805 * that the hardware queues are empty. The @queues parameter is a bitmap 2806 * of queues to flush, which is useful if different virtual interfaces 2807 * use different hardware queues; it may also indicate all queues. 2808 * If the parameter @drop is set to %true, pending frames may be dropped. 2809 * Note that vif can be NULL. 2810 * The callback can sleep. 2811 * 2812 * @channel_switch: Drivers that need (or want) to offload the channel 2813 * switch operation for CSAs received from the AP may implement this 2814 * callback. They must then call ieee80211_chswitch_done() to indicate 2815 * completion of the channel switch. 2816 * 2817 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device. 2818 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may 2819 * reject TX/RX mask combinations they cannot support by returning -EINVAL 2820 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX). 2821 * 2822 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant). 2823 * 2824 * @remain_on_channel: Starts an off-channel period on the given channel, must 2825 * call back to ieee80211_ready_on_channel() when on that channel. Note 2826 * that normal channel traffic is not stopped as this is intended for hw 2827 * offload. Frames to transmit on the off-channel channel are transmitted 2828 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the 2829 * duration (which will always be non-zero) expires, the driver must call 2830 * ieee80211_remain_on_channel_expired(). 2831 * Note that this callback may be called while the device is in IDLE and 2832 * must be accepted in this case. 2833 * This callback may sleep. 2834 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is 2835 * aborted before it expires. This callback may sleep. 2836 * 2837 * @set_ringparam: Set tx and rx ring sizes. 2838 * 2839 * @get_ringparam: Get tx and rx ring current and maximum sizes. 2840 * 2841 * @tx_frames_pending: Check if there is any pending frame in the hardware 2842 * queues before entering power save. 2843 * 2844 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection 2845 * when transmitting a frame. Currently only legacy rates are handled. 2846 * The callback can sleep. 2847 * @rssi_callback: Notify driver when the average RSSI goes above/below 2848 * thresholds that were registered previously. The callback can sleep. 2849 * 2850 * @release_buffered_frames: Release buffered frames according to the given 2851 * parameters. In the case where the driver buffers some frames for 2852 * sleeping stations mac80211 will use this callback to tell the driver 2853 * to release some frames, either for PS-poll or uAPSD. 2854 * Note that if the @more_data parameter is %false the driver must check 2855 * if there are more frames on the given TIDs, and if there are more than 2856 * the frames being released then it must still set the more-data bit in 2857 * the frame. If the @more_data parameter is %true, then of course the 2858 * more-data bit must always be set. 2859 * The @tids parameter tells the driver which TIDs to release frames 2860 * from, for PS-poll it will always have only a single bit set. 2861 * In the case this is used for a PS-poll initiated release, the 2862 * @num_frames parameter will always be 1 so code can be shared. In 2863 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag 2864 * on the TX status (and must report TX status) so that the PS-poll 2865 * period is properly ended. This is used to avoid sending multiple 2866 * responses for a retried PS-poll frame. 2867 * In the case this is used for uAPSD, the @num_frames parameter may be 2868 * bigger than one, but the driver may send fewer frames (it must send 2869 * at least one, however). In this case it is also responsible for 2870 * setting the EOSP flag in the QoS header of the frames. Also, when the 2871 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP 2872 * on the last frame in the SP. Alternatively, it may call the function 2873 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP. 2874 * This callback must be atomic. 2875 * @allow_buffered_frames: Prepare device to allow the given number of frames 2876 * to go out to the given station. The frames will be sent by mac80211 2877 * via the usual TX path after this call. The TX information for frames 2878 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set 2879 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case 2880 * frames from multiple TIDs are released and the driver might reorder 2881 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag 2882 * on the last frame and clear it on all others and also handle the EOSP 2883 * bit in the QoS header correctly. Alternatively, it can also call the 2884 * ieee80211_sta_eosp() function. 2885 * The @tids parameter is a bitmap and tells the driver which TIDs the 2886 * frames will be on; it will at most have two bits set. 2887 * This callback must be atomic. 2888 * 2889 * @get_et_sset_count: Ethtool API to get string-set count. 2890 * 2891 * @get_et_stats: Ethtool API to get a set of u64 stats. 2892 * 2893 * @get_et_strings: Ethtool API to get a set of strings to describe stats 2894 * and perhaps other supported types of ethtool data-sets. 2895 * 2896 * @mgd_prepare_tx: Prepare for transmitting a management frame for association 2897 * before associated. In multi-channel scenarios, a virtual interface is 2898 * bound to a channel before it is associated, but as it isn't associated 2899 * yet it need not necessarily be given airtime, in particular since any 2900 * transmission to a P2P GO needs to be synchronized against the GO's 2901 * powersave state. mac80211 will call this function before transmitting a 2902 * management frame prior to having successfully associated to allow the 2903 * driver to give it channel time for the transmission, to get a response 2904 * and to be able to synchronize with the GO. 2905 * The callback will be called before each transmission and upon return 2906 * mac80211 will transmit the frame right away. 2907 * The callback is optional and can (should!) sleep. 2908 * 2909 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending 2910 * a TDLS discovery-request, we expect a reply to arrive on the AP's 2911 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS 2912 * setup-response is a direct packet not buffered by the AP. 2913 * mac80211 will call this function just before the transmission of a TDLS 2914 * discovery-request. The recommended period of protection is at least 2915 * 2 * (DTIM period). 2916 * The callback is optional and can sleep. 2917 * 2918 * @add_chanctx: Notifies device driver about new channel context creation. 2919 * @remove_chanctx: Notifies device driver about channel context destruction. 2920 * @change_chanctx: Notifies device driver about channel context changes that 2921 * may happen when combining different virtual interfaces on the same 2922 * channel context with different settings 2923 * @assign_vif_chanctx: Notifies device driver about channel context being bound 2924 * to vif. Possible use is for hw queue remapping. 2925 * @unassign_vif_chanctx: Notifies device driver about channel context being 2926 * unbound from vif. 2927 * @switch_vif_chanctx: switch a number of vifs from one chanctx to 2928 * another, as specified in the list of 2929 * @ieee80211_vif_chanctx_switch passed to the driver, according 2930 * to the mode defined in &ieee80211_chanctx_switch_mode. 2931 * 2932 * @start_ap: Start operation on the AP interface, this is called after all the 2933 * information in bss_conf is set and beacon can be retrieved. A channel 2934 * context is bound before this is called. Note that if the driver uses 2935 * software scan or ROC, this (and @stop_ap) isn't called when the AP is 2936 * just "paused" for scanning/ROC, which is indicated by the beacon being 2937 * disabled/enabled via @bss_info_changed. 2938 * @stop_ap: Stop operation on the AP interface. 2939 * 2940 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and 2941 * during resume, when the reconfiguration has completed. 2942 * This can help the driver implement the reconfiguration step (and 2943 * indicate mac80211 is ready to receive frames). 2944 * This callback may sleep. 2945 * 2946 * @ipv6_addr_change: IPv6 address assignment on the given interface changed. 2947 * Currently, this is only called for managed or P2P client interfaces. 2948 * This callback is optional; it must not sleep. 2949 * 2950 * @channel_switch_beacon: Starts a channel switch to a new channel. 2951 * Beacons are modified to include CSA or ECSA IEs before calling this 2952 * function. The corresponding count fields in these IEs must be 2953 * decremented, and when they reach 1 the driver must call 2954 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get() 2955 * get the csa counter decremented by mac80211, but must check if it is 2956 * 1 using ieee80211_csa_is_complete() after the beacon has been 2957 * transmitted and then call ieee80211_csa_finish(). 2958 * If the CSA count starts as zero or 1, this function will not be called, 2959 * since there won't be any time to beacon before the switch anyway. 2960 * @pre_channel_switch: This is an optional callback that is called 2961 * before a channel switch procedure is started (ie. when a STA 2962 * gets a CSA or an userspace initiated channel-switch), allowing 2963 * the driver to prepare for the channel switch. 2964 * @post_channel_switch: This is an optional callback that is called 2965 * after a channel switch procedure is completed, allowing the 2966 * driver to go back to a normal configuration. 2967 * 2968 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all 2969 * information in bss_conf is set up and the beacon can be retrieved. A 2970 * channel context is bound before this is called. 2971 * @leave_ibss: Leave the IBSS again. 2972 * 2973 * @get_expected_throughput: extract the expected throughput towards the 2974 * specified station. The returned value is expressed in Kbps. It returns 0 2975 * if the RC algorithm does not have proper data to provide. 2976 * 2977 * @get_txpower: get current maximum tx power (in dBm) based on configuration 2978 * and hardware limits. 2979 * 2980 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver 2981 * is responsible for continually initiating channel-switching operations 2982 * and returning to the base channel for communication with the AP. The 2983 * driver receives a channel-switch request template and the location of 2984 * the switch-timing IE within the template as part of the invocation. 2985 * The template is valid only within the call, and the driver can 2986 * optionally copy the skb for further re-use. 2987 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both 2988 * peers must be on the base channel when the call completes. 2989 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or 2990 * response) has been received from a remote peer. The driver gets 2991 * parameters parsed from the incoming frame and may use them to continue 2992 * an ongoing channel-switch operation. In addition, a channel-switch 2993 * response template is provided, together with the location of the 2994 * switch-timing IE within the template. The skb can only be used within 2995 * the function call. 2996 */ 2997 struct ieee80211_ops { 2998 void (*tx)(struct ieee80211_hw *hw, 2999 struct ieee80211_tx_control *control, 3000 struct sk_buff *skb); 3001 int (*start)(struct ieee80211_hw *hw); 3002 void (*stop)(struct ieee80211_hw *hw); 3003 #ifdef CONFIG_PM 3004 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan); 3005 int (*resume)(struct ieee80211_hw *hw); 3006 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled); 3007 #endif 3008 int (*add_interface)(struct ieee80211_hw *hw, 3009 struct ieee80211_vif *vif); 3010 int (*change_interface)(struct ieee80211_hw *hw, 3011 struct ieee80211_vif *vif, 3012 enum nl80211_iftype new_type, bool p2p); 3013 void (*remove_interface)(struct ieee80211_hw *hw, 3014 struct ieee80211_vif *vif); 3015 int (*config)(struct ieee80211_hw *hw, u32 changed); 3016 void (*bss_info_changed)(struct ieee80211_hw *hw, 3017 struct ieee80211_vif *vif, 3018 struct ieee80211_bss_conf *info, 3019 u32 changed); 3020 3021 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif); 3022 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif); 3023 3024 u64 (*prepare_multicast)(struct ieee80211_hw *hw, 3025 struct netdev_hw_addr_list *mc_list); 3026 void (*configure_filter)(struct ieee80211_hw *hw, 3027 unsigned int changed_flags, 3028 unsigned int *total_flags, 3029 u64 multicast); 3030 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta, 3031 bool set); 3032 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd, 3033 struct ieee80211_vif *vif, struct ieee80211_sta *sta, 3034 struct ieee80211_key_conf *key); 3035 void (*update_tkip_key)(struct ieee80211_hw *hw, 3036 struct ieee80211_vif *vif, 3037 struct ieee80211_key_conf *conf, 3038 struct ieee80211_sta *sta, 3039 u32 iv32, u16 *phase1key); 3040 void (*set_rekey_data)(struct ieee80211_hw *hw, 3041 struct ieee80211_vif *vif, 3042 struct cfg80211_gtk_rekey_data *data); 3043 void (*set_default_unicast_key)(struct ieee80211_hw *hw, 3044 struct ieee80211_vif *vif, int idx); 3045 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 3046 struct ieee80211_scan_request *req); 3047 void (*cancel_hw_scan)(struct ieee80211_hw *hw, 3048 struct ieee80211_vif *vif); 3049 int (*sched_scan_start)(struct ieee80211_hw *hw, 3050 struct ieee80211_vif *vif, 3051 struct cfg80211_sched_scan_request *req, 3052 struct ieee80211_scan_ies *ies); 3053 int (*sched_scan_stop)(struct ieee80211_hw *hw, 3054 struct ieee80211_vif *vif); 3055 void (*sw_scan_start)(struct ieee80211_hw *hw, 3056 struct ieee80211_vif *vif, 3057 const u8 *mac_addr); 3058 void (*sw_scan_complete)(struct ieee80211_hw *hw, 3059 struct ieee80211_vif *vif); 3060 int (*get_stats)(struct ieee80211_hw *hw, 3061 struct ieee80211_low_level_stats *stats); 3062 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx, 3063 u32 *iv32, u16 *iv16); 3064 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value); 3065 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value); 3066 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 3067 struct ieee80211_sta *sta); 3068 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 3069 struct ieee80211_sta *sta); 3070 #ifdef CONFIG_MAC80211_DEBUGFS 3071 void (*sta_add_debugfs)(struct ieee80211_hw *hw, 3072 struct ieee80211_vif *vif, 3073 struct ieee80211_sta *sta, 3074 struct dentry *dir); 3075 void (*sta_remove_debugfs)(struct ieee80211_hw *hw, 3076 struct ieee80211_vif *vif, 3077 struct ieee80211_sta *sta, 3078 struct dentry *dir); 3079 #endif 3080 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 3081 enum sta_notify_cmd, struct ieee80211_sta *sta); 3082 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 3083 struct ieee80211_sta *sta, 3084 enum ieee80211_sta_state old_state, 3085 enum ieee80211_sta_state new_state); 3086 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw, 3087 struct ieee80211_vif *vif, 3088 struct ieee80211_sta *sta); 3089 void (*sta_rc_update)(struct ieee80211_hw *hw, 3090 struct ieee80211_vif *vif, 3091 struct ieee80211_sta *sta, 3092 u32 changed); 3093 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw, 3094 struct ieee80211_vif *vif, 3095 struct ieee80211_sta *sta); 3096 void (*sta_statistics)(struct ieee80211_hw *hw, 3097 struct ieee80211_vif *vif, 3098 struct ieee80211_sta *sta, 3099 struct station_info *sinfo); 3100 int (*conf_tx)(struct ieee80211_hw *hw, 3101 struct ieee80211_vif *vif, u16 ac, 3102 const struct ieee80211_tx_queue_params *params); 3103 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif); 3104 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 3105 u64 tsf); 3106 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif); 3107 int (*tx_last_beacon)(struct ieee80211_hw *hw); 3108 int (*ampdu_action)(struct ieee80211_hw *hw, 3109 struct ieee80211_vif *vif, 3110 enum ieee80211_ampdu_mlme_action action, 3111 struct ieee80211_sta *sta, u16 tid, u16 *ssn, 3112 u8 buf_size); 3113 int (*get_survey)(struct ieee80211_hw *hw, int idx, 3114 struct survey_info *survey); 3115 void (*rfkill_poll)(struct ieee80211_hw *hw); 3116 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class); 3117 #ifdef CONFIG_NL80211_TESTMODE 3118 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 3119 void *data, int len); 3120 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb, 3121 struct netlink_callback *cb, 3122 void *data, int len); 3123 #endif 3124 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 3125 u32 queues, bool drop); 3126 void (*channel_switch)(struct ieee80211_hw *hw, 3127 struct ieee80211_vif *vif, 3128 struct ieee80211_channel_switch *ch_switch); 3129 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant); 3130 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant); 3131 3132 int (*remain_on_channel)(struct ieee80211_hw *hw, 3133 struct ieee80211_vif *vif, 3134 struct ieee80211_channel *chan, 3135 int duration, 3136 enum ieee80211_roc_type type); 3137 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw); 3138 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx); 3139 void (*get_ringparam)(struct ieee80211_hw *hw, 3140 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max); 3141 bool (*tx_frames_pending)(struct ieee80211_hw *hw); 3142 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 3143 const struct cfg80211_bitrate_mask *mask); 3144 void (*rssi_callback)(struct ieee80211_hw *hw, 3145 struct ieee80211_vif *vif, 3146 enum ieee80211_rssi_event rssi_event); 3147 3148 void (*allow_buffered_frames)(struct ieee80211_hw *hw, 3149 struct ieee80211_sta *sta, 3150 u16 tids, int num_frames, 3151 enum ieee80211_frame_release_type reason, 3152 bool more_data); 3153 void (*release_buffered_frames)(struct ieee80211_hw *hw, 3154 struct ieee80211_sta *sta, 3155 u16 tids, int num_frames, 3156 enum ieee80211_frame_release_type reason, 3157 bool more_data); 3158 3159 int (*get_et_sset_count)(struct ieee80211_hw *hw, 3160 struct ieee80211_vif *vif, int sset); 3161 void (*get_et_stats)(struct ieee80211_hw *hw, 3162 struct ieee80211_vif *vif, 3163 struct ethtool_stats *stats, u64 *data); 3164 void (*get_et_strings)(struct ieee80211_hw *hw, 3165 struct ieee80211_vif *vif, 3166 u32 sset, u8 *data); 3167 3168 void (*mgd_prepare_tx)(struct ieee80211_hw *hw, 3169 struct ieee80211_vif *vif); 3170 3171 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw, 3172 struct ieee80211_vif *vif); 3173 3174 int (*add_chanctx)(struct ieee80211_hw *hw, 3175 struct ieee80211_chanctx_conf *ctx); 3176 void (*remove_chanctx)(struct ieee80211_hw *hw, 3177 struct ieee80211_chanctx_conf *ctx); 3178 void (*change_chanctx)(struct ieee80211_hw *hw, 3179 struct ieee80211_chanctx_conf *ctx, 3180 u32 changed); 3181 int (*assign_vif_chanctx)(struct ieee80211_hw *hw, 3182 struct ieee80211_vif *vif, 3183 struct ieee80211_chanctx_conf *ctx); 3184 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw, 3185 struct ieee80211_vif *vif, 3186 struct ieee80211_chanctx_conf *ctx); 3187 int (*switch_vif_chanctx)(struct ieee80211_hw *hw, 3188 struct ieee80211_vif_chanctx_switch *vifs, 3189 int n_vifs, 3190 enum ieee80211_chanctx_switch_mode mode); 3191 3192 void (*reconfig_complete)(struct ieee80211_hw *hw, 3193 enum ieee80211_reconfig_type reconfig_type); 3194 3195 #if IS_ENABLED(CONFIG_IPV6) 3196 void (*ipv6_addr_change)(struct ieee80211_hw *hw, 3197 struct ieee80211_vif *vif, 3198 struct inet6_dev *idev); 3199 #endif 3200 void (*channel_switch_beacon)(struct ieee80211_hw *hw, 3201 struct ieee80211_vif *vif, 3202 struct cfg80211_chan_def *chandef); 3203 int (*pre_channel_switch)(struct ieee80211_hw *hw, 3204 struct ieee80211_vif *vif, 3205 struct ieee80211_channel_switch *ch_switch); 3206 3207 int (*post_channel_switch)(struct ieee80211_hw *hw, 3208 struct ieee80211_vif *vif); 3209 3210 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif); 3211 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif); 3212 u32 (*get_expected_throughput)(struct ieee80211_sta *sta); 3213 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 3214 int *dbm); 3215 3216 int (*tdls_channel_switch)(struct ieee80211_hw *hw, 3217 struct ieee80211_vif *vif, 3218 struct ieee80211_sta *sta, u8 oper_class, 3219 struct cfg80211_chan_def *chandef, 3220 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie); 3221 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw, 3222 struct ieee80211_vif *vif, 3223 struct ieee80211_sta *sta); 3224 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw, 3225 struct ieee80211_vif *vif, 3226 struct ieee80211_tdls_ch_sw_params *params); 3227 }; 3228 3229 /** 3230 * ieee80211_alloc_hw_nm - Allocate a new hardware device 3231 * 3232 * This must be called once for each hardware device. The returned pointer 3233 * must be used to refer to this device when calling other functions. 3234 * mac80211 allocates a private data area for the driver pointed to by 3235 * @priv in &struct ieee80211_hw, the size of this area is given as 3236 * @priv_data_len. 3237 * 3238 * @priv_data_len: length of private data 3239 * @ops: callbacks for this device 3240 * @requested_name: Requested name for this device. 3241 * NULL is valid value, and means use the default naming (phy%d) 3242 * 3243 * Return: A pointer to the new hardware device, or %NULL on error. 3244 */ 3245 struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len, 3246 const struct ieee80211_ops *ops, 3247 const char *requested_name); 3248 3249 /** 3250 * ieee80211_alloc_hw - Allocate a new hardware device 3251 * 3252 * This must be called once for each hardware device. The returned pointer 3253 * must be used to refer to this device when calling other functions. 3254 * mac80211 allocates a private data area for the driver pointed to by 3255 * @priv in &struct ieee80211_hw, the size of this area is given as 3256 * @priv_data_len. 3257 * 3258 * @priv_data_len: length of private data 3259 * @ops: callbacks for this device 3260 * 3261 * Return: A pointer to the new hardware device, or %NULL on error. 3262 */ 3263 static inline 3264 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len, 3265 const struct ieee80211_ops *ops) 3266 { 3267 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL); 3268 } 3269 3270 /** 3271 * ieee80211_register_hw - Register hardware device 3272 * 3273 * You must call this function before any other functions in 3274 * mac80211. Note that before a hardware can be registered, you 3275 * need to fill the contained wiphy's information. 3276 * 3277 * @hw: the device to register as returned by ieee80211_alloc_hw() 3278 * 3279 * Return: 0 on success. An error code otherwise. 3280 */ 3281 int ieee80211_register_hw(struct ieee80211_hw *hw); 3282 3283 /** 3284 * struct ieee80211_tpt_blink - throughput blink description 3285 * @throughput: throughput in Kbit/sec 3286 * @blink_time: blink time in milliseconds 3287 * (full cycle, ie. one off + one on period) 3288 */ 3289 struct ieee80211_tpt_blink { 3290 int throughput; 3291 int blink_time; 3292 }; 3293 3294 /** 3295 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags 3296 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio 3297 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working 3298 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one 3299 * interface is connected in some way, including being an AP 3300 */ 3301 enum ieee80211_tpt_led_trigger_flags { 3302 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0), 3303 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1), 3304 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2), 3305 }; 3306 3307 #ifdef CONFIG_MAC80211_LEDS 3308 char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw); 3309 char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw); 3310 char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw); 3311 char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw); 3312 char *__ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, 3313 unsigned int flags, 3314 const struct ieee80211_tpt_blink *blink_table, 3315 unsigned int blink_table_len); 3316 #endif 3317 /** 3318 * ieee80211_get_tx_led_name - get name of TX LED 3319 * 3320 * mac80211 creates a transmit LED trigger for each wireless hardware 3321 * that can be used to drive LEDs if your driver registers a LED device. 3322 * This function returns the name (or %NULL if not configured for LEDs) 3323 * of the trigger so you can automatically link the LED device. 3324 * 3325 * @hw: the hardware to get the LED trigger name for 3326 * 3327 * Return: The name of the LED trigger. %NULL if not configured for LEDs. 3328 */ 3329 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw) 3330 { 3331 #ifdef CONFIG_MAC80211_LEDS 3332 return __ieee80211_get_tx_led_name(hw); 3333 #else 3334 return NULL; 3335 #endif 3336 } 3337 3338 /** 3339 * ieee80211_get_rx_led_name - get name of RX LED 3340 * 3341 * mac80211 creates a receive LED trigger for each wireless hardware 3342 * that can be used to drive LEDs if your driver registers a LED device. 3343 * This function returns the name (or %NULL if not configured for LEDs) 3344 * of the trigger so you can automatically link the LED device. 3345 * 3346 * @hw: the hardware to get the LED trigger name for 3347 * 3348 * Return: The name of the LED trigger. %NULL if not configured for LEDs. 3349 */ 3350 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw) 3351 { 3352 #ifdef CONFIG_MAC80211_LEDS 3353 return __ieee80211_get_rx_led_name(hw); 3354 #else 3355 return NULL; 3356 #endif 3357 } 3358 3359 /** 3360 * ieee80211_get_assoc_led_name - get name of association LED 3361 * 3362 * mac80211 creates a association LED trigger for each wireless hardware 3363 * that can be used to drive LEDs if your driver registers a LED device. 3364 * This function returns the name (or %NULL if not configured for LEDs) 3365 * of the trigger so you can automatically link the LED device. 3366 * 3367 * @hw: the hardware to get the LED trigger name for 3368 * 3369 * Return: The name of the LED trigger. %NULL if not configured for LEDs. 3370 */ 3371 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw) 3372 { 3373 #ifdef CONFIG_MAC80211_LEDS 3374 return __ieee80211_get_assoc_led_name(hw); 3375 #else 3376 return NULL; 3377 #endif 3378 } 3379 3380 /** 3381 * ieee80211_get_radio_led_name - get name of radio LED 3382 * 3383 * mac80211 creates a radio change LED trigger for each wireless hardware 3384 * that can be used to drive LEDs if your driver registers a LED device. 3385 * This function returns the name (or %NULL if not configured for LEDs) 3386 * of the trigger so you can automatically link the LED device. 3387 * 3388 * @hw: the hardware to get the LED trigger name for 3389 * 3390 * Return: The name of the LED trigger. %NULL if not configured for LEDs. 3391 */ 3392 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw) 3393 { 3394 #ifdef CONFIG_MAC80211_LEDS 3395 return __ieee80211_get_radio_led_name(hw); 3396 #else 3397 return NULL; 3398 #endif 3399 } 3400 3401 /** 3402 * ieee80211_create_tpt_led_trigger - create throughput LED trigger 3403 * @hw: the hardware to create the trigger for 3404 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags 3405 * @blink_table: the blink table -- needs to be ordered by throughput 3406 * @blink_table_len: size of the blink table 3407 * 3408 * Return: %NULL (in case of error, or if no LED triggers are 3409 * configured) or the name of the new trigger. 3410 * 3411 * Note: This function must be called before ieee80211_register_hw(). 3412 */ 3413 static inline char * 3414 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags, 3415 const struct ieee80211_tpt_blink *blink_table, 3416 unsigned int blink_table_len) 3417 { 3418 #ifdef CONFIG_MAC80211_LEDS 3419 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table, 3420 blink_table_len); 3421 #else 3422 return NULL; 3423 #endif 3424 } 3425 3426 /** 3427 * ieee80211_unregister_hw - Unregister a hardware device 3428 * 3429 * This function instructs mac80211 to free allocated resources 3430 * and unregister netdevices from the networking subsystem. 3431 * 3432 * @hw: the hardware to unregister 3433 */ 3434 void ieee80211_unregister_hw(struct ieee80211_hw *hw); 3435 3436 /** 3437 * ieee80211_free_hw - free hardware descriptor 3438 * 3439 * This function frees everything that was allocated, including the 3440 * private data for the driver. You must call ieee80211_unregister_hw() 3441 * before calling this function. 3442 * 3443 * @hw: the hardware to free 3444 */ 3445 void ieee80211_free_hw(struct ieee80211_hw *hw); 3446 3447 /** 3448 * ieee80211_restart_hw - restart hardware completely 3449 * 3450 * Call this function when the hardware was restarted for some reason 3451 * (hardware error, ...) and the driver is unable to restore its state 3452 * by itself. mac80211 assumes that at this point the driver/hardware 3453 * is completely uninitialised and stopped, it starts the process by 3454 * calling the ->start() operation. The driver will need to reset all 3455 * internal state that it has prior to calling this function. 3456 * 3457 * @hw: the hardware to restart 3458 */ 3459 void ieee80211_restart_hw(struct ieee80211_hw *hw); 3460 3461 /** 3462 * ieee80211_napi_add - initialize mac80211 NAPI context 3463 * @hw: the hardware to initialize the NAPI context on 3464 * @napi: the NAPI context to initialize 3465 * @napi_dev: dummy NAPI netdevice, here to not waste the space if the 3466 * driver doesn't use NAPI 3467 * @poll: poll function 3468 * @weight: default weight 3469 * 3470 * See also netif_napi_add(). 3471 */ 3472 void ieee80211_napi_add(struct ieee80211_hw *hw, struct napi_struct *napi, 3473 struct net_device *napi_dev, 3474 int (*poll)(struct napi_struct *, int), 3475 int weight); 3476 3477 /** 3478 * ieee80211_rx - receive frame 3479 * 3480 * Use this function to hand received frames to mac80211. The receive 3481 * buffer in @skb must start with an IEEE 802.11 header. In case of a 3482 * paged @skb is used, the driver is recommended to put the ieee80211 3483 * header of the frame on the linear part of the @skb to avoid memory 3484 * allocation and/or memcpy by the stack. 3485 * 3486 * This function may not be called in IRQ context. Calls to this function 3487 * for a single hardware must be synchronized against each other. Calls to 3488 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be 3489 * mixed for a single hardware. Must not run concurrently with 3490 * ieee80211_tx_status() or ieee80211_tx_status_ni(). 3491 * 3492 * In process context use instead ieee80211_rx_ni(). 3493 * 3494 * @hw: the hardware this frame came in on 3495 * @skb: the buffer to receive, owned by mac80211 after this call 3496 */ 3497 void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb); 3498 3499 /** 3500 * ieee80211_rx_irqsafe - receive frame 3501 * 3502 * Like ieee80211_rx() but can be called in IRQ context 3503 * (internally defers to a tasklet.) 3504 * 3505 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not 3506 * be mixed for a single hardware.Must not run concurrently with 3507 * ieee80211_tx_status() or ieee80211_tx_status_ni(). 3508 * 3509 * @hw: the hardware this frame came in on 3510 * @skb: the buffer to receive, owned by mac80211 after this call 3511 */ 3512 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb); 3513 3514 /** 3515 * ieee80211_rx_ni - receive frame (in process context) 3516 * 3517 * Like ieee80211_rx() but can be called in process context 3518 * (internally disables bottom halves). 3519 * 3520 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may 3521 * not be mixed for a single hardware. Must not run concurrently with 3522 * ieee80211_tx_status() or ieee80211_tx_status_ni(). 3523 * 3524 * @hw: the hardware this frame came in on 3525 * @skb: the buffer to receive, owned by mac80211 after this call 3526 */ 3527 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw, 3528 struct sk_buff *skb) 3529 { 3530 local_bh_disable(); 3531 ieee80211_rx(hw, skb); 3532 local_bh_enable(); 3533 } 3534 3535 /** 3536 * ieee80211_sta_ps_transition - PS transition for connected sta 3537 * 3538 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS 3539 * flag set, use this function to inform mac80211 about a connected station 3540 * entering/leaving PS mode. 3541 * 3542 * This function may not be called in IRQ context or with softirqs enabled. 3543 * 3544 * Calls to this function for a single hardware must be synchronized against 3545 * each other. 3546 * 3547 * @sta: currently connected sta 3548 * @start: start or stop PS 3549 * 3550 * Return: 0 on success. -EINVAL when the requested PS mode is already set. 3551 */ 3552 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start); 3553 3554 /** 3555 * ieee80211_sta_ps_transition_ni - PS transition for connected sta 3556 * (in process context) 3557 * 3558 * Like ieee80211_sta_ps_transition() but can be called in process context 3559 * (internally disables bottom halves). Concurrent call restriction still 3560 * applies. 3561 * 3562 * @sta: currently connected sta 3563 * @start: start or stop PS 3564 * 3565 * Return: Like ieee80211_sta_ps_transition(). 3566 */ 3567 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta, 3568 bool start) 3569 { 3570 int ret; 3571 3572 local_bh_disable(); 3573 ret = ieee80211_sta_ps_transition(sta, start); 3574 local_bh_enable(); 3575 3576 return ret; 3577 } 3578 3579 /* 3580 * The TX headroom reserved by mac80211 for its own tx_status functions. 3581 * This is enough for the radiotap header. 3582 */ 3583 #define IEEE80211_TX_STATUS_HEADROOM 14 3584 3585 /** 3586 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames 3587 * @sta: &struct ieee80211_sta pointer for the sleeping station 3588 * @tid: the TID that has buffered frames 3589 * @buffered: indicates whether or not frames are buffered for this TID 3590 * 3591 * If a driver buffers frames for a powersave station instead of passing 3592 * them back to mac80211 for retransmission, the station may still need 3593 * to be told that there are buffered frames via the TIM bit. 3594 * 3595 * This function informs mac80211 whether or not there are frames that are 3596 * buffered in the driver for a given TID; mac80211 can then use this data 3597 * to set the TIM bit (NOTE: This may call back into the driver's set_tim 3598 * call! Beware of the locking!) 3599 * 3600 * If all frames are released to the station (due to PS-poll or uAPSD) 3601 * then the driver needs to inform mac80211 that there no longer are 3602 * frames buffered. However, when the station wakes up mac80211 assumes 3603 * that all buffered frames will be transmitted and clears this data, 3604 * drivers need to make sure they inform mac80211 about all buffered 3605 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP). 3606 * 3607 * Note that technically mac80211 only needs to know this per AC, not per 3608 * TID, but since driver buffering will inevitably happen per TID (since 3609 * it is related to aggregation) it is easier to make mac80211 map the 3610 * TID to the AC as required instead of keeping track in all drivers that 3611 * use this API. 3612 */ 3613 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta, 3614 u8 tid, bool buffered); 3615 3616 /** 3617 * ieee80211_get_tx_rates - get the selected transmit rates for a packet 3618 * 3619 * Call this function in a driver with per-packet rate selection support 3620 * to combine the rate info in the packet tx info with the most recent 3621 * rate selection table for the station entry. 3622 * 3623 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 3624 * @sta: the receiver station to which this packet is sent. 3625 * @skb: the frame to be transmitted. 3626 * @dest: buffer for extracted rate/retry information 3627 * @max_rates: maximum number of rates to fetch 3628 */ 3629 void ieee80211_get_tx_rates(struct ieee80211_vif *vif, 3630 struct ieee80211_sta *sta, 3631 struct sk_buff *skb, 3632 struct ieee80211_tx_rate *dest, 3633 int max_rates); 3634 3635 /** 3636 * ieee80211_tx_status - transmit status callback 3637 * 3638 * Call this function for all transmitted frames after they have been 3639 * transmitted. It is permissible to not call this function for 3640 * multicast frames but this can affect statistics. 3641 * 3642 * This function may not be called in IRQ context. Calls to this function 3643 * for a single hardware must be synchronized against each other. Calls 3644 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe() 3645 * may not be mixed for a single hardware. Must not run concurrently with 3646 * ieee80211_rx() or ieee80211_rx_ni(). 3647 * 3648 * @hw: the hardware the frame was transmitted by 3649 * @skb: the frame that was transmitted, owned by mac80211 after this call 3650 */ 3651 void ieee80211_tx_status(struct ieee80211_hw *hw, 3652 struct sk_buff *skb); 3653 3654 /** 3655 * ieee80211_tx_status_noskb - transmit status callback without skb 3656 * 3657 * This function can be used as a replacement for ieee80211_tx_status 3658 * in drivers that cannot reliably map tx status information back to 3659 * specific skbs. 3660 * 3661 * Calls to this function for a single hardware must be synchronized 3662 * against each other. Calls to this function, ieee80211_tx_status_ni() 3663 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware. 3664 * 3665 * @hw: the hardware the frame was transmitted by 3666 * @sta: the receiver station to which this packet is sent 3667 * (NULL for multicast packets) 3668 * @info: tx status information 3669 */ 3670 void ieee80211_tx_status_noskb(struct ieee80211_hw *hw, 3671 struct ieee80211_sta *sta, 3672 struct ieee80211_tx_info *info); 3673 3674 /** 3675 * ieee80211_tx_status_ni - transmit status callback (in process context) 3676 * 3677 * Like ieee80211_tx_status() but can be called in process context. 3678 * 3679 * Calls to this function, ieee80211_tx_status() and 3680 * ieee80211_tx_status_irqsafe() may not be mixed 3681 * for a single hardware. 3682 * 3683 * @hw: the hardware the frame was transmitted by 3684 * @skb: the frame that was transmitted, owned by mac80211 after this call 3685 */ 3686 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw, 3687 struct sk_buff *skb) 3688 { 3689 local_bh_disable(); 3690 ieee80211_tx_status(hw, skb); 3691 local_bh_enable(); 3692 } 3693 3694 /** 3695 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback 3696 * 3697 * Like ieee80211_tx_status() but can be called in IRQ context 3698 * (internally defers to a tasklet.) 3699 * 3700 * Calls to this function, ieee80211_tx_status() and 3701 * ieee80211_tx_status_ni() may not be mixed for a single hardware. 3702 * 3703 * @hw: the hardware the frame was transmitted by 3704 * @skb: the frame that was transmitted, owned by mac80211 after this call 3705 */ 3706 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw, 3707 struct sk_buff *skb); 3708 3709 /** 3710 * ieee80211_report_low_ack - report non-responding station 3711 * 3712 * When operating in AP-mode, call this function to report a non-responding 3713 * connected STA. 3714 * 3715 * @sta: the non-responding connected sta 3716 * @num_packets: number of packets sent to @sta without a response 3717 */ 3718 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets); 3719 3720 #define IEEE80211_MAX_CSA_COUNTERS_NUM 2 3721 3722 /** 3723 * struct ieee80211_mutable_offsets - mutable beacon offsets 3724 * @tim_offset: position of TIM element 3725 * @tim_length: size of TIM element 3726 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets 3727 * to CSA counters. This array can contain zero values which 3728 * should be ignored. 3729 */ 3730 struct ieee80211_mutable_offsets { 3731 u16 tim_offset; 3732 u16 tim_length; 3733 3734 u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM]; 3735 }; 3736 3737 /** 3738 * ieee80211_beacon_get_template - beacon template generation function 3739 * @hw: pointer obtained from ieee80211_alloc_hw(). 3740 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 3741 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will 3742 * receive the offsets that may be updated by the driver. 3743 * 3744 * If the driver implements beaconing modes, it must use this function to 3745 * obtain the beacon template. 3746 * 3747 * This function should be used if the beacon frames are generated by the 3748 * device, and then the driver must use the returned beacon as the template 3749 * The driver or the device are responsible to update the DTIM and, when 3750 * applicable, the CSA count. 3751 * 3752 * The driver is responsible for freeing the returned skb. 3753 * 3754 * Return: The beacon template. %NULL on error. 3755 */ 3756 struct sk_buff * 3757 ieee80211_beacon_get_template(struct ieee80211_hw *hw, 3758 struct ieee80211_vif *vif, 3759 struct ieee80211_mutable_offsets *offs); 3760 3761 /** 3762 * ieee80211_beacon_get_tim - beacon generation function 3763 * @hw: pointer obtained from ieee80211_alloc_hw(). 3764 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 3765 * @tim_offset: pointer to variable that will receive the TIM IE offset. 3766 * Set to 0 if invalid (in non-AP modes). 3767 * @tim_length: pointer to variable that will receive the TIM IE length, 3768 * (including the ID and length bytes!). 3769 * Set to 0 if invalid (in non-AP modes). 3770 * 3771 * If the driver implements beaconing modes, it must use this function to 3772 * obtain the beacon frame. 3773 * 3774 * If the beacon frames are generated by the host system (i.e., not in 3775 * hardware/firmware), the driver uses this function to get each beacon 3776 * frame from mac80211 -- it is responsible for calling this function exactly 3777 * once before the beacon is needed (e.g. based on hardware interrupt). 3778 * 3779 * The driver is responsible for freeing the returned skb. 3780 * 3781 * Return: The beacon template. %NULL on error. 3782 */ 3783 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw, 3784 struct ieee80211_vif *vif, 3785 u16 *tim_offset, u16 *tim_length); 3786 3787 /** 3788 * ieee80211_beacon_get - beacon generation function 3789 * @hw: pointer obtained from ieee80211_alloc_hw(). 3790 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 3791 * 3792 * See ieee80211_beacon_get_tim(). 3793 * 3794 * Return: See ieee80211_beacon_get_tim(). 3795 */ 3796 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw, 3797 struct ieee80211_vif *vif) 3798 { 3799 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL); 3800 } 3801 3802 /** 3803 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter 3804 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 3805 * 3806 * The csa counter should be updated after each beacon transmission. 3807 * This function is called implicitly when 3808 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the 3809 * beacon frames are generated by the device, the driver should call this 3810 * function after each beacon transmission to sync mac80211's csa counters. 3811 * 3812 * Return: new csa counter value 3813 */ 3814 u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif); 3815 3816 /** 3817 * ieee80211_csa_finish - notify mac80211 about channel switch 3818 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 3819 * 3820 * After a channel switch announcement was scheduled and the counter in this 3821 * announcement hits 1, this function must be called by the driver to 3822 * notify mac80211 that the channel can be changed. 3823 */ 3824 void ieee80211_csa_finish(struct ieee80211_vif *vif); 3825 3826 /** 3827 * ieee80211_csa_is_complete - find out if counters reached 1 3828 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 3829 * 3830 * This function returns whether the channel switch counters reached zero. 3831 */ 3832 bool ieee80211_csa_is_complete(struct ieee80211_vif *vif); 3833 3834 3835 /** 3836 * ieee80211_proberesp_get - retrieve a Probe Response template 3837 * @hw: pointer obtained from ieee80211_alloc_hw(). 3838 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 3839 * 3840 * Creates a Probe Response template which can, for example, be uploaded to 3841 * hardware. The destination address should be set by the caller. 3842 * 3843 * Can only be called in AP mode. 3844 * 3845 * Return: The Probe Response template. %NULL on error. 3846 */ 3847 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw, 3848 struct ieee80211_vif *vif); 3849 3850 /** 3851 * ieee80211_pspoll_get - retrieve a PS Poll template 3852 * @hw: pointer obtained from ieee80211_alloc_hw(). 3853 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 3854 * 3855 * Creates a PS Poll a template which can, for example, uploaded to 3856 * hardware. The template must be updated after association so that correct 3857 * AID, BSSID and MAC address is used. 3858 * 3859 * Note: Caller (or hardware) is responsible for setting the 3860 * &IEEE80211_FCTL_PM bit. 3861 * 3862 * Return: The PS Poll template. %NULL on error. 3863 */ 3864 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw, 3865 struct ieee80211_vif *vif); 3866 3867 /** 3868 * ieee80211_nullfunc_get - retrieve a nullfunc template 3869 * @hw: pointer obtained from ieee80211_alloc_hw(). 3870 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 3871 * 3872 * Creates a Nullfunc template which can, for example, uploaded to 3873 * hardware. The template must be updated after association so that correct 3874 * BSSID and address is used. 3875 * 3876 * Note: Caller (or hardware) is responsible for setting the 3877 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields. 3878 * 3879 * Return: The nullfunc template. %NULL on error. 3880 */ 3881 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw, 3882 struct ieee80211_vif *vif); 3883 3884 /** 3885 * ieee80211_probereq_get - retrieve a Probe Request template 3886 * @hw: pointer obtained from ieee80211_alloc_hw(). 3887 * @src_addr: source MAC address 3888 * @ssid: SSID buffer 3889 * @ssid_len: length of SSID 3890 * @tailroom: tailroom to reserve at end of SKB for IEs 3891 * 3892 * Creates a Probe Request template which can, for example, be uploaded to 3893 * hardware. 3894 * 3895 * Return: The Probe Request template. %NULL on error. 3896 */ 3897 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw, 3898 const u8 *src_addr, 3899 const u8 *ssid, size_t ssid_len, 3900 size_t tailroom); 3901 3902 /** 3903 * ieee80211_rts_get - RTS frame generation function 3904 * @hw: pointer obtained from ieee80211_alloc_hw(). 3905 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 3906 * @frame: pointer to the frame that is going to be protected by the RTS. 3907 * @frame_len: the frame length (in octets). 3908 * @frame_txctl: &struct ieee80211_tx_info of the frame. 3909 * @rts: The buffer where to store the RTS frame. 3910 * 3911 * If the RTS frames are generated by the host system (i.e., not in 3912 * hardware/firmware), the low-level driver uses this function to receive 3913 * the next RTS frame from the 802.11 code. The low-level is responsible 3914 * for calling this function before and RTS frame is needed. 3915 */ 3916 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 3917 const void *frame, size_t frame_len, 3918 const struct ieee80211_tx_info *frame_txctl, 3919 struct ieee80211_rts *rts); 3920 3921 /** 3922 * ieee80211_rts_duration - Get the duration field for an RTS frame 3923 * @hw: pointer obtained from ieee80211_alloc_hw(). 3924 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 3925 * @frame_len: the length of the frame that is going to be protected by the RTS. 3926 * @frame_txctl: &struct ieee80211_tx_info of the frame. 3927 * 3928 * If the RTS is generated in firmware, but the host system must provide 3929 * the duration field, the low-level driver uses this function to receive 3930 * the duration field value in little-endian byteorder. 3931 * 3932 * Return: The duration. 3933 */ 3934 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw, 3935 struct ieee80211_vif *vif, size_t frame_len, 3936 const struct ieee80211_tx_info *frame_txctl); 3937 3938 /** 3939 * ieee80211_ctstoself_get - CTS-to-self frame generation function 3940 * @hw: pointer obtained from ieee80211_alloc_hw(). 3941 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 3942 * @frame: pointer to the frame that is going to be protected by the CTS-to-self. 3943 * @frame_len: the frame length (in octets). 3944 * @frame_txctl: &struct ieee80211_tx_info of the frame. 3945 * @cts: The buffer where to store the CTS-to-self frame. 3946 * 3947 * If the CTS-to-self frames are generated by the host system (i.e., not in 3948 * hardware/firmware), the low-level driver uses this function to receive 3949 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible 3950 * for calling this function before and CTS-to-self frame is needed. 3951 */ 3952 void ieee80211_ctstoself_get(struct ieee80211_hw *hw, 3953 struct ieee80211_vif *vif, 3954 const void *frame, size_t frame_len, 3955 const struct ieee80211_tx_info *frame_txctl, 3956 struct ieee80211_cts *cts); 3957 3958 /** 3959 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame 3960 * @hw: pointer obtained from ieee80211_alloc_hw(). 3961 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 3962 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self. 3963 * @frame_txctl: &struct ieee80211_tx_info of the frame. 3964 * 3965 * If the CTS-to-self is generated in firmware, but the host system must provide 3966 * the duration field, the low-level driver uses this function to receive 3967 * the duration field value in little-endian byteorder. 3968 * 3969 * Return: The duration. 3970 */ 3971 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, 3972 struct ieee80211_vif *vif, 3973 size_t frame_len, 3974 const struct ieee80211_tx_info *frame_txctl); 3975 3976 /** 3977 * ieee80211_generic_frame_duration - Calculate the duration field for a frame 3978 * @hw: pointer obtained from ieee80211_alloc_hw(). 3979 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 3980 * @band: the band to calculate the frame duration on 3981 * @frame_len: the length of the frame. 3982 * @rate: the rate at which the frame is going to be transmitted. 3983 * 3984 * Calculate the duration field of some generic frame, given its 3985 * length and transmission rate (in 100kbps). 3986 * 3987 * Return: The duration. 3988 */ 3989 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, 3990 struct ieee80211_vif *vif, 3991 enum ieee80211_band band, 3992 size_t frame_len, 3993 struct ieee80211_rate *rate); 3994 3995 /** 3996 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames 3997 * @hw: pointer as obtained from ieee80211_alloc_hw(). 3998 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 3999 * 4000 * Function for accessing buffered broadcast and multicast frames. If 4001 * hardware/firmware does not implement buffering of broadcast/multicast 4002 * frames when power saving is used, 802.11 code buffers them in the host 4003 * memory. The low-level driver uses this function to fetch next buffered 4004 * frame. In most cases, this is used when generating beacon frame. 4005 * 4006 * Return: A pointer to the next buffered skb or NULL if no more buffered 4007 * frames are available. 4008 * 4009 * Note: buffered frames are returned only after DTIM beacon frame was 4010 * generated with ieee80211_beacon_get() and the low-level driver must thus 4011 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns 4012 * NULL if the previous generated beacon was not DTIM, so the low-level driver 4013 * does not need to check for DTIM beacons separately and should be able to 4014 * use common code for all beacons. 4015 */ 4016 struct sk_buff * 4017 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif); 4018 4019 /** 4020 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32 4021 * 4022 * This function returns the TKIP phase 1 key for the given IV32. 4023 * 4024 * @keyconf: the parameter passed with the set key 4025 * @iv32: IV32 to get the P1K for 4026 * @p1k: a buffer to which the key will be written, as 5 u16 values 4027 */ 4028 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf, 4029 u32 iv32, u16 *p1k); 4030 4031 /** 4032 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key 4033 * 4034 * This function returns the TKIP phase 1 key for the IV32 taken 4035 * from the given packet. 4036 * 4037 * @keyconf: the parameter passed with the set key 4038 * @skb: the packet to take the IV32 value from that will be encrypted 4039 * with this P1K 4040 * @p1k: a buffer to which the key will be written, as 5 u16 values 4041 */ 4042 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf, 4043 struct sk_buff *skb, u16 *p1k) 4044 { 4045 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data; 4046 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control); 4047 u32 iv32 = get_unaligned_le32(&data[4]); 4048 4049 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k); 4050 } 4051 4052 /** 4053 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX 4054 * 4055 * This function returns the TKIP phase 1 key for the given IV32 4056 * and transmitter address. 4057 * 4058 * @keyconf: the parameter passed with the set key 4059 * @ta: TA that will be used with the key 4060 * @iv32: IV32 to get the P1K for 4061 * @p1k: a buffer to which the key will be written, as 5 u16 values 4062 */ 4063 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf, 4064 const u8 *ta, u32 iv32, u16 *p1k); 4065 4066 /** 4067 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key 4068 * 4069 * This function computes the TKIP RC4 key for the IV values 4070 * in the packet. 4071 * 4072 * @keyconf: the parameter passed with the set key 4073 * @skb: the packet to take the IV32/IV16 values from that will be 4074 * encrypted with this key 4075 * @p2k: a buffer to which the key will be written, 16 bytes 4076 */ 4077 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf, 4078 struct sk_buff *skb, u8 *p2k); 4079 4080 /** 4081 * ieee80211_aes_cmac_calculate_k1_k2 - calculate the AES-CMAC sub keys 4082 * 4083 * This function computes the two AES-CMAC sub-keys, based on the 4084 * previously installed master key. 4085 * 4086 * @keyconf: the parameter passed with the set key 4087 * @k1: a buffer to be filled with the 1st sub-key 4088 * @k2: a buffer to be filled with the 2nd sub-key 4089 */ 4090 void ieee80211_aes_cmac_calculate_k1_k2(struct ieee80211_key_conf *keyconf, 4091 u8 *k1, u8 *k2); 4092 4093 /** 4094 * struct ieee80211_key_seq - key sequence counter 4095 * 4096 * @tkip: TKIP data, containing IV32 and IV16 in host byte order 4097 * @ccmp: PN data, most significant byte first (big endian, 4098 * reverse order than in packet) 4099 * @aes_cmac: PN data, most significant byte first (big endian, 4100 * reverse order than in packet) 4101 * @aes_gmac: PN data, most significant byte first (big endian, 4102 * reverse order than in packet) 4103 * @gcmp: PN data, most significant byte first (big endian, 4104 * reverse order than in packet) 4105 */ 4106 struct ieee80211_key_seq { 4107 union { 4108 struct { 4109 u32 iv32; 4110 u16 iv16; 4111 } tkip; 4112 struct { 4113 u8 pn[6]; 4114 } ccmp; 4115 struct { 4116 u8 pn[6]; 4117 } aes_cmac; 4118 struct { 4119 u8 pn[6]; 4120 } aes_gmac; 4121 struct { 4122 u8 pn[6]; 4123 } gcmp; 4124 }; 4125 }; 4126 4127 /** 4128 * ieee80211_get_key_tx_seq - get key TX sequence counter 4129 * 4130 * @keyconf: the parameter passed with the set key 4131 * @seq: buffer to receive the sequence data 4132 * 4133 * This function allows a driver to retrieve the current TX IV/PN 4134 * for the given key. It must not be called if IV generation is 4135 * offloaded to the device. 4136 * 4137 * Note that this function may only be called when no TX processing 4138 * can be done concurrently, for example when queues are stopped 4139 * and the stop has been synchronized. 4140 */ 4141 void ieee80211_get_key_tx_seq(struct ieee80211_key_conf *keyconf, 4142 struct ieee80211_key_seq *seq); 4143 4144 /** 4145 * ieee80211_get_key_rx_seq - get key RX sequence counter 4146 * 4147 * @keyconf: the parameter passed with the set key 4148 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only); 4149 * the value on TID 0 is also used for non-QoS frames. For 4150 * CMAC, only TID 0 is valid. 4151 * @seq: buffer to receive the sequence data 4152 * 4153 * This function allows a driver to retrieve the current RX IV/PNs 4154 * for the given key. It must not be called if IV checking is done 4155 * by the device and not by mac80211. 4156 * 4157 * Note that this function may only be called when no RX processing 4158 * can be done concurrently. 4159 */ 4160 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf, 4161 int tid, struct ieee80211_key_seq *seq); 4162 4163 /** 4164 * ieee80211_set_key_tx_seq - set key TX sequence counter 4165 * 4166 * @keyconf: the parameter passed with the set key 4167 * @seq: new sequence data 4168 * 4169 * This function allows a driver to set the current TX IV/PNs for the 4170 * given key. This is useful when resuming from WoWLAN sleep and the 4171 * device may have transmitted frames using the PTK, e.g. replies to 4172 * ARP requests. 4173 * 4174 * Note that this function may only be called when no TX processing 4175 * can be done concurrently. 4176 */ 4177 void ieee80211_set_key_tx_seq(struct ieee80211_key_conf *keyconf, 4178 struct ieee80211_key_seq *seq); 4179 4180 /** 4181 * ieee80211_set_key_rx_seq - set key RX sequence counter 4182 * 4183 * @keyconf: the parameter passed with the set key 4184 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only); 4185 * the value on TID 0 is also used for non-QoS frames. For 4186 * CMAC, only TID 0 is valid. 4187 * @seq: new sequence data 4188 * 4189 * This function allows a driver to set the current RX IV/PNs for the 4190 * given key. This is useful when resuming from WoWLAN sleep and GTK 4191 * rekey may have been done while suspended. It should not be called 4192 * if IV checking is done by the device and not by mac80211. 4193 * 4194 * Note that this function may only be called when no RX processing 4195 * can be done concurrently. 4196 */ 4197 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf, 4198 int tid, struct ieee80211_key_seq *seq); 4199 4200 /** 4201 * ieee80211_remove_key - remove the given key 4202 * @keyconf: the parameter passed with the set key 4203 * 4204 * Remove the given key. If the key was uploaded to the hardware at the 4205 * time this function is called, it is not deleted in the hardware but 4206 * instead assumed to have been removed already. 4207 * 4208 * Note that due to locking considerations this function can (currently) 4209 * only be called during key iteration (ieee80211_iter_keys().) 4210 */ 4211 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf); 4212 4213 /** 4214 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN 4215 * @vif: the virtual interface to add the key on 4216 * @keyconf: new key data 4217 * 4218 * When GTK rekeying was done while the system was suspended, (a) new 4219 * key(s) will be available. These will be needed by mac80211 for proper 4220 * RX processing, so this function allows setting them. 4221 * 4222 * The function returns the newly allocated key structure, which will 4223 * have similar contents to the passed key configuration but point to 4224 * mac80211-owned memory. In case of errors, the function returns an 4225 * ERR_PTR(), use IS_ERR() etc. 4226 * 4227 * Note that this function assumes the key isn't added to hardware 4228 * acceleration, so no TX will be done with the key. Since it's a GTK 4229 * on managed (station) networks, this is true anyway. If the driver 4230 * calls this function from the resume callback and subsequently uses 4231 * the return code 1 to reconfigure the device, this key will be part 4232 * of the reconfiguration. 4233 * 4234 * Note that the driver should also call ieee80211_set_key_rx_seq() 4235 * for the new key for each TID to set up sequence counters properly. 4236 * 4237 * IMPORTANT: If this replaces a key that is present in the hardware, 4238 * then it will attempt to remove it during this call. In many cases 4239 * this isn't what you want, so call ieee80211_remove_key() first for 4240 * the key that's being replaced. 4241 */ 4242 struct ieee80211_key_conf * 4243 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif, 4244 struct ieee80211_key_conf *keyconf); 4245 4246 /** 4247 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying 4248 * @vif: virtual interface the rekeying was done on 4249 * @bssid: The BSSID of the AP, for checking association 4250 * @replay_ctr: the new replay counter after GTK rekeying 4251 * @gfp: allocation flags 4252 */ 4253 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid, 4254 const u8 *replay_ctr, gfp_t gfp); 4255 4256 /** 4257 * ieee80211_wake_queue - wake specific queue 4258 * @hw: pointer as obtained from ieee80211_alloc_hw(). 4259 * @queue: queue number (counted from zero). 4260 * 4261 * Drivers should use this function instead of netif_wake_queue. 4262 */ 4263 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue); 4264 4265 /** 4266 * ieee80211_stop_queue - stop specific queue 4267 * @hw: pointer as obtained from ieee80211_alloc_hw(). 4268 * @queue: queue number (counted from zero). 4269 * 4270 * Drivers should use this function instead of netif_stop_queue. 4271 */ 4272 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue); 4273 4274 /** 4275 * ieee80211_queue_stopped - test status of the queue 4276 * @hw: pointer as obtained from ieee80211_alloc_hw(). 4277 * @queue: queue number (counted from zero). 4278 * 4279 * Drivers should use this function instead of netif_stop_queue. 4280 * 4281 * Return: %true if the queue is stopped. %false otherwise. 4282 */ 4283 4284 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue); 4285 4286 /** 4287 * ieee80211_stop_queues - stop all queues 4288 * @hw: pointer as obtained from ieee80211_alloc_hw(). 4289 * 4290 * Drivers should use this function instead of netif_stop_queue. 4291 */ 4292 void ieee80211_stop_queues(struct ieee80211_hw *hw); 4293 4294 /** 4295 * ieee80211_wake_queues - wake all queues 4296 * @hw: pointer as obtained from ieee80211_alloc_hw(). 4297 * 4298 * Drivers should use this function instead of netif_wake_queue. 4299 */ 4300 void ieee80211_wake_queues(struct ieee80211_hw *hw); 4301 4302 /** 4303 * ieee80211_scan_completed - completed hardware scan 4304 * 4305 * When hardware scan offload is used (i.e. the hw_scan() callback is 4306 * assigned) this function needs to be called by the driver to notify 4307 * mac80211 that the scan finished. This function can be called from 4308 * any context, including hardirq context. 4309 * 4310 * @hw: the hardware that finished the scan 4311 * @aborted: set to true if scan was aborted 4312 */ 4313 void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted); 4314 4315 /** 4316 * ieee80211_sched_scan_results - got results from scheduled scan 4317 * 4318 * When a scheduled scan is running, this function needs to be called by the 4319 * driver whenever there are new scan results available. 4320 * 4321 * @hw: the hardware that is performing scheduled scans 4322 */ 4323 void ieee80211_sched_scan_results(struct ieee80211_hw *hw); 4324 4325 /** 4326 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped 4327 * 4328 * When a scheduled scan is running, this function can be called by 4329 * the driver if it needs to stop the scan to perform another task. 4330 * Usual scenarios are drivers that cannot continue the scheduled scan 4331 * while associating, for instance. 4332 * 4333 * @hw: the hardware that is performing scheduled scans 4334 */ 4335 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw); 4336 4337 /** 4338 * enum ieee80211_interface_iteration_flags - interface iteration flags 4339 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have 4340 * been added to the driver; However, note that during hardware 4341 * reconfiguration (after restart_hw) it will iterate over a new 4342 * interface and over all the existing interfaces even if they 4343 * haven't been re-added to the driver yet. 4344 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all 4345 * interfaces, even if they haven't been re-added to the driver yet. 4346 */ 4347 enum ieee80211_interface_iteration_flags { 4348 IEEE80211_IFACE_ITER_NORMAL = 0, 4349 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0), 4350 }; 4351 4352 /** 4353 * ieee80211_iterate_active_interfaces - iterate active interfaces 4354 * 4355 * This function iterates over the interfaces associated with a given 4356 * hardware that are currently active and calls the callback for them. 4357 * This function allows the iterator function to sleep, when the iterator 4358 * function is atomic @ieee80211_iterate_active_interfaces_atomic can 4359 * be used. 4360 * Does not iterate over a new interface during add_interface(). 4361 * 4362 * @hw: the hardware struct of which the interfaces should be iterated over 4363 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags 4364 * @iterator: the iterator function to call 4365 * @data: first argument of the iterator function 4366 */ 4367 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, 4368 u32 iter_flags, 4369 void (*iterator)(void *data, u8 *mac, 4370 struct ieee80211_vif *vif), 4371 void *data); 4372 4373 /** 4374 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces 4375 * 4376 * This function iterates over the interfaces associated with a given 4377 * hardware that are currently active and calls the callback for them. 4378 * This function requires the iterator callback function to be atomic, 4379 * if that is not desired, use @ieee80211_iterate_active_interfaces instead. 4380 * Does not iterate over a new interface during add_interface(). 4381 * 4382 * @hw: the hardware struct of which the interfaces should be iterated over 4383 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags 4384 * @iterator: the iterator function to call, cannot sleep 4385 * @data: first argument of the iterator function 4386 */ 4387 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw, 4388 u32 iter_flags, 4389 void (*iterator)(void *data, 4390 u8 *mac, 4391 struct ieee80211_vif *vif), 4392 void *data); 4393 4394 /** 4395 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces 4396 * 4397 * This function iterates over the interfaces associated with a given 4398 * hardware that are currently active and calls the callback for them. 4399 * This version can only be used while holding the RTNL. 4400 * 4401 * @hw: the hardware struct of which the interfaces should be iterated over 4402 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags 4403 * @iterator: the iterator function to call, cannot sleep 4404 * @data: first argument of the iterator function 4405 */ 4406 void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw, 4407 u32 iter_flags, 4408 void (*iterator)(void *data, 4409 u8 *mac, 4410 struct ieee80211_vif *vif), 4411 void *data); 4412 4413 /** 4414 * ieee80211_iterate_stations_atomic - iterate stations 4415 * 4416 * This function iterates over all stations associated with a given 4417 * hardware that are currently uploaded to the driver and calls the callback 4418 * function for them. 4419 * This function requires the iterator callback function to be atomic, 4420 * 4421 * @hw: the hardware struct of which the interfaces should be iterated over 4422 * @iterator: the iterator function to call, cannot sleep 4423 * @data: first argument of the iterator function 4424 */ 4425 void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw, 4426 void (*iterator)(void *data, 4427 struct ieee80211_sta *sta), 4428 void *data); 4429 /** 4430 * ieee80211_queue_work - add work onto the mac80211 workqueue 4431 * 4432 * Drivers and mac80211 use this to add work onto the mac80211 workqueue. 4433 * This helper ensures drivers are not queueing work when they should not be. 4434 * 4435 * @hw: the hardware struct for the interface we are adding work for 4436 * @work: the work we want to add onto the mac80211 workqueue 4437 */ 4438 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work); 4439 4440 /** 4441 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue 4442 * 4443 * Drivers and mac80211 use this to queue delayed work onto the mac80211 4444 * workqueue. 4445 * 4446 * @hw: the hardware struct for the interface we are adding work for 4447 * @dwork: delayable work to queue onto the mac80211 workqueue 4448 * @delay: number of jiffies to wait before queueing 4449 */ 4450 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw, 4451 struct delayed_work *dwork, 4452 unsigned long delay); 4453 4454 /** 4455 * ieee80211_start_tx_ba_session - Start a tx Block Ack session. 4456 * @sta: the station for which to start a BA session 4457 * @tid: the TID to BA on. 4458 * @timeout: session timeout value (in TUs) 4459 * 4460 * Return: success if addBA request was sent, failure otherwise 4461 * 4462 * Although mac80211/low level driver/user space application can estimate 4463 * the need to start aggregation on a certain RA/TID, the session level 4464 * will be managed by the mac80211. 4465 */ 4466 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid, 4467 u16 timeout); 4468 4469 /** 4470 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate. 4471 * @vif: &struct ieee80211_vif pointer from the add_interface callback 4472 * @ra: receiver address of the BA session recipient. 4473 * @tid: the TID to BA on. 4474 * 4475 * This function must be called by low level driver once it has 4476 * finished with preparations for the BA session. It can be called 4477 * from any context. 4478 */ 4479 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra, 4480 u16 tid); 4481 4482 /** 4483 * ieee80211_stop_tx_ba_session - Stop a Block Ack session. 4484 * @sta: the station whose BA session to stop 4485 * @tid: the TID to stop BA. 4486 * 4487 * Return: negative error if the TID is invalid, or no aggregation active 4488 * 4489 * Although mac80211/low level driver/user space application can estimate 4490 * the need to stop aggregation on a certain RA/TID, the session level 4491 * will be managed by the mac80211. 4492 */ 4493 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid); 4494 4495 /** 4496 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate. 4497 * @vif: &struct ieee80211_vif pointer from the add_interface callback 4498 * @ra: receiver address of the BA session recipient. 4499 * @tid: the desired TID to BA on. 4500 * 4501 * This function must be called by low level driver once it has 4502 * finished with preparations for the BA session tear down. It 4503 * can be called from any context. 4504 */ 4505 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra, 4506 u16 tid); 4507 4508 /** 4509 * ieee80211_find_sta - find a station 4510 * 4511 * @vif: virtual interface to look for station on 4512 * @addr: station's address 4513 * 4514 * Return: The station, if found. %NULL otherwise. 4515 * 4516 * Note: This function must be called under RCU lock and the 4517 * resulting pointer is only valid under RCU lock as well. 4518 */ 4519 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif, 4520 const u8 *addr); 4521 4522 /** 4523 * ieee80211_find_sta_by_ifaddr - find a station on hardware 4524 * 4525 * @hw: pointer as obtained from ieee80211_alloc_hw() 4526 * @addr: remote station's address 4527 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'. 4528 * 4529 * Return: The station, if found. %NULL otherwise. 4530 * 4531 * Note: This function must be called under RCU lock and the 4532 * resulting pointer is only valid under RCU lock as well. 4533 * 4534 * NOTE: You may pass NULL for localaddr, but then you will just get 4535 * the first STA that matches the remote address 'addr'. 4536 * We can have multiple STA associated with multiple 4537 * logical stations (e.g. consider a station connecting to another 4538 * BSSID on the same AP hardware without disconnecting first). 4539 * In this case, the result of this method with localaddr NULL 4540 * is not reliable. 4541 * 4542 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible. 4543 */ 4544 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw, 4545 const u8 *addr, 4546 const u8 *localaddr); 4547 4548 /** 4549 * ieee80211_sta_block_awake - block station from waking up 4550 * @hw: the hardware 4551 * @pubsta: the station 4552 * @block: whether to block or unblock 4553 * 4554 * Some devices require that all frames that are on the queues 4555 * for a specific station that went to sleep are flushed before 4556 * a poll response or frames after the station woke up can be 4557 * delivered to that it. Note that such frames must be rejected 4558 * by the driver as filtered, with the appropriate status flag. 4559 * 4560 * This function allows implementing this mode in a race-free 4561 * manner. 4562 * 4563 * To do this, a driver must keep track of the number of frames 4564 * still enqueued for a specific station. If this number is not 4565 * zero when the station goes to sleep, the driver must call 4566 * this function to force mac80211 to consider the station to 4567 * be asleep regardless of the station's actual state. Once the 4568 * number of outstanding frames reaches zero, the driver must 4569 * call this function again to unblock the station. That will 4570 * cause mac80211 to be able to send ps-poll responses, and if 4571 * the station queried in the meantime then frames will also 4572 * be sent out as a result of this. Additionally, the driver 4573 * will be notified that the station woke up some time after 4574 * it is unblocked, regardless of whether the station actually 4575 * woke up while blocked or not. 4576 */ 4577 void ieee80211_sta_block_awake(struct ieee80211_hw *hw, 4578 struct ieee80211_sta *pubsta, bool block); 4579 4580 /** 4581 * ieee80211_sta_eosp - notify mac80211 about end of SP 4582 * @pubsta: the station 4583 * 4584 * When a device transmits frames in a way that it can't tell 4585 * mac80211 in the TX status about the EOSP, it must clear the 4586 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead. 4587 * This applies for PS-Poll as well as uAPSD. 4588 * 4589 * Note that just like with _tx_status() and _rx() drivers must 4590 * not mix calls to irqsafe/non-irqsafe versions, this function 4591 * must not be mixed with those either. Use the all irqsafe, or 4592 * all non-irqsafe, don't mix! 4593 * 4594 * NB: the _irqsafe version of this function doesn't exist, no 4595 * driver needs it right now. Don't call this function if 4596 * you'd need the _irqsafe version, look at the git history 4597 * and restore the _irqsafe version! 4598 */ 4599 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta); 4600 4601 /** 4602 * ieee80211_iter_keys - iterate keys programmed into the device 4603 * @hw: pointer obtained from ieee80211_alloc_hw() 4604 * @vif: virtual interface to iterate, may be %NULL for all 4605 * @iter: iterator function that will be called for each key 4606 * @iter_data: custom data to pass to the iterator function 4607 * 4608 * This function can be used to iterate all the keys known to 4609 * mac80211, even those that weren't previously programmed into 4610 * the device. This is intended for use in WoWLAN if the device 4611 * needs reprogramming of the keys during suspend. Note that due 4612 * to locking reasons, it is also only safe to call this at few 4613 * spots since it must hold the RTNL and be able to sleep. 4614 * 4615 * The order in which the keys are iterated matches the order 4616 * in which they were originally installed and handed to the 4617 * set_key callback. 4618 */ 4619 void ieee80211_iter_keys(struct ieee80211_hw *hw, 4620 struct ieee80211_vif *vif, 4621 void (*iter)(struct ieee80211_hw *hw, 4622 struct ieee80211_vif *vif, 4623 struct ieee80211_sta *sta, 4624 struct ieee80211_key_conf *key, 4625 void *data), 4626 void *iter_data); 4627 4628 /** 4629 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts 4630 * @hw: pointre obtained from ieee80211_alloc_hw(). 4631 * @iter: iterator function 4632 * @iter_data: data passed to iterator function 4633 * 4634 * Iterate all active channel contexts. This function is atomic and 4635 * doesn't acquire any locks internally that might be held in other 4636 * places while calling into the driver. 4637 * 4638 * The iterator will not find a context that's being added (during 4639 * the driver callback to add it) but will find it while it's being 4640 * removed. 4641 * 4642 * Note that during hardware restart, all contexts that existed 4643 * before the restart are considered already present so will be 4644 * found while iterating, whether they've been re-added already 4645 * or not. 4646 */ 4647 void ieee80211_iter_chan_contexts_atomic( 4648 struct ieee80211_hw *hw, 4649 void (*iter)(struct ieee80211_hw *hw, 4650 struct ieee80211_chanctx_conf *chanctx_conf, 4651 void *data), 4652 void *iter_data); 4653 4654 /** 4655 * ieee80211_ap_probereq_get - retrieve a Probe Request template 4656 * @hw: pointer obtained from ieee80211_alloc_hw(). 4657 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 4658 * 4659 * Creates a Probe Request template which can, for example, be uploaded to 4660 * hardware. The template is filled with bssid, ssid and supported rate 4661 * information. This function must only be called from within the 4662 * .bss_info_changed callback function and only in managed mode. The function 4663 * is only useful when the interface is associated, otherwise it will return 4664 * %NULL. 4665 * 4666 * Return: The Probe Request template. %NULL on error. 4667 */ 4668 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw, 4669 struct ieee80211_vif *vif); 4670 4671 /** 4672 * ieee80211_beacon_loss - inform hardware does not receive beacons 4673 * 4674 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 4675 * 4676 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and 4677 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the 4678 * hardware is not receiving beacons with this function. 4679 */ 4680 void ieee80211_beacon_loss(struct ieee80211_vif *vif); 4681 4682 /** 4683 * ieee80211_connection_loss - inform hardware has lost connection to the AP 4684 * 4685 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 4686 * 4687 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and 4688 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver 4689 * needs to inform if the connection to the AP has been lost. 4690 * The function may also be called if the connection needs to be terminated 4691 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set. 4692 * 4693 * This function will cause immediate change to disassociated state, 4694 * without connection recovery attempts. 4695 */ 4696 void ieee80211_connection_loss(struct ieee80211_vif *vif); 4697 4698 /** 4699 * ieee80211_resume_disconnect - disconnect from AP after resume 4700 * 4701 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 4702 * 4703 * Instructs mac80211 to disconnect from the AP after resume. 4704 * Drivers can use this after WoWLAN if they know that the 4705 * connection cannot be kept up, for example because keys were 4706 * used while the device was asleep but the replay counters or 4707 * similar cannot be retrieved from the device during resume. 4708 * 4709 * Note that due to implementation issues, if the driver uses 4710 * the reconfiguration functionality during resume the interface 4711 * will still be added as associated first during resume and then 4712 * disconnect normally later. 4713 * 4714 * This function can only be called from the resume callback and 4715 * the driver must not be holding any of its own locks while it 4716 * calls this function, or at least not any locks it needs in the 4717 * key configuration paths (if it supports HW crypto). 4718 */ 4719 void ieee80211_resume_disconnect(struct ieee80211_vif *vif); 4720 4721 /** 4722 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring 4723 * rssi threshold triggered 4724 * 4725 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 4726 * @rssi_event: the RSSI trigger event type 4727 * @gfp: context flags 4728 * 4729 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality 4730 * monitoring is configured with an rssi threshold, the driver will inform 4731 * whenever the rssi level reaches the threshold. 4732 */ 4733 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif, 4734 enum nl80211_cqm_rssi_threshold_event rssi_event, 4735 gfp_t gfp); 4736 4737 /** 4738 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss 4739 * 4740 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 4741 * @gfp: context flags 4742 */ 4743 void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp); 4744 4745 /** 4746 * ieee80211_radar_detected - inform that a radar was detected 4747 * 4748 * @hw: pointer as obtained from ieee80211_alloc_hw() 4749 */ 4750 void ieee80211_radar_detected(struct ieee80211_hw *hw); 4751 4752 /** 4753 * ieee80211_chswitch_done - Complete channel switch process 4754 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 4755 * @success: make the channel switch successful or not 4756 * 4757 * Complete the channel switch post-process: set the new operational channel 4758 * and wake up the suspended queues. 4759 */ 4760 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success); 4761 4762 /** 4763 * ieee80211_request_smps - request SM PS transition 4764 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 4765 * @smps_mode: new SM PS mode 4766 * 4767 * This allows the driver to request an SM PS transition in managed 4768 * mode. This is useful when the driver has more information than 4769 * the stack about possible interference, for example by bluetooth. 4770 */ 4771 void ieee80211_request_smps(struct ieee80211_vif *vif, 4772 enum ieee80211_smps_mode smps_mode); 4773 4774 /** 4775 * ieee80211_ready_on_channel - notification of remain-on-channel start 4776 * @hw: pointer as obtained from ieee80211_alloc_hw() 4777 */ 4778 void ieee80211_ready_on_channel(struct ieee80211_hw *hw); 4779 4780 /** 4781 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired 4782 * @hw: pointer as obtained from ieee80211_alloc_hw() 4783 */ 4784 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw); 4785 4786 /** 4787 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions 4788 * 4789 * in order not to harm the system performance and user experience, the device 4790 * may request not to allow any rx ba session and tear down existing rx ba 4791 * sessions based on system constraints such as periodic BT activity that needs 4792 * to limit wlan activity (eg.sco or a2dp)." 4793 * in such cases, the intention is to limit the duration of the rx ppdu and 4794 * therefore prevent the peer device to use a-mpdu aggregation. 4795 * 4796 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 4797 * @ba_rx_bitmap: Bit map of open rx ba per tid 4798 * @addr: & to bssid mac address 4799 */ 4800 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap, 4801 const u8 *addr); 4802 4803 /** 4804 * ieee80211_send_bar - send a BlockAckReq frame 4805 * 4806 * can be used to flush pending frames from the peer's aggregation reorder 4807 * buffer. 4808 * 4809 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 4810 * @ra: the peer's destination address 4811 * @tid: the TID of the aggregation session 4812 * @ssn: the new starting sequence number for the receiver 4813 */ 4814 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn); 4815 4816 /** 4817 * ieee80211_start_rx_ba_session_offl - start a Rx BA session 4818 * 4819 * Some device drivers may offload part of the Rx aggregation flow including 4820 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx 4821 * reordering. 4822 * 4823 * Create structures responsible for reordering so device drivers may call here 4824 * when they complete AddBa negotiation. 4825 * 4826 * @vif: &struct ieee80211_vif pointer from the add_interface callback 4827 * @addr: station mac address 4828 * @tid: the rx tid 4829 */ 4830 void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif, 4831 const u8 *addr, u16 tid); 4832 4833 /** 4834 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session 4835 * 4836 * Some device drivers may offload part of the Rx aggregation flow including 4837 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx 4838 * reordering. 4839 * 4840 * Destroy structures responsible for reordering so device drivers may call here 4841 * when they complete DelBa negotiation. 4842 * 4843 * @vif: &struct ieee80211_vif pointer from the add_interface callback 4844 * @addr: station mac address 4845 * @tid: the rx tid 4846 */ 4847 void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif, 4848 const u8 *addr, u16 tid); 4849 4850 /* Rate control API */ 4851 4852 /** 4853 * struct ieee80211_tx_rate_control - rate control information for/from RC algo 4854 * 4855 * @hw: The hardware the algorithm is invoked for. 4856 * @sband: The band this frame is being transmitted on. 4857 * @bss_conf: the current BSS configuration 4858 * @skb: the skb that will be transmitted, the control information in it needs 4859 * to be filled in 4860 * @reported_rate: The rate control algorithm can fill this in to indicate 4861 * which rate should be reported to userspace as the current rate and 4862 * used for rate calculations in the mesh network. 4863 * @rts: whether RTS will be used for this frame because it is longer than the 4864 * RTS threshold 4865 * @short_preamble: whether mac80211 will request short-preamble transmission 4866 * if the selected rate supports it 4867 * @max_rate_idx: user-requested maximum (legacy) rate 4868 * (deprecated; this will be removed once drivers get updated to use 4869 * rate_idx_mask) 4870 * @rate_idx_mask: user-requested (legacy) rate mask 4871 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use) 4872 * @bss: whether this frame is sent out in AP or IBSS mode 4873 */ 4874 struct ieee80211_tx_rate_control { 4875 struct ieee80211_hw *hw; 4876 struct ieee80211_supported_band *sband; 4877 struct ieee80211_bss_conf *bss_conf; 4878 struct sk_buff *skb; 4879 struct ieee80211_tx_rate reported_rate; 4880 bool rts, short_preamble; 4881 u8 max_rate_idx; 4882 u32 rate_idx_mask; 4883 u8 *rate_idx_mcs_mask; 4884 bool bss; 4885 }; 4886 4887 struct rate_control_ops { 4888 const char *name; 4889 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir); 4890 void (*free)(void *priv); 4891 4892 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp); 4893 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband, 4894 struct cfg80211_chan_def *chandef, 4895 struct ieee80211_sta *sta, void *priv_sta); 4896 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband, 4897 struct cfg80211_chan_def *chandef, 4898 struct ieee80211_sta *sta, void *priv_sta, 4899 u32 changed); 4900 void (*free_sta)(void *priv, struct ieee80211_sta *sta, 4901 void *priv_sta); 4902 4903 void (*tx_status_noskb)(void *priv, 4904 struct ieee80211_supported_band *sband, 4905 struct ieee80211_sta *sta, void *priv_sta, 4906 struct ieee80211_tx_info *info); 4907 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband, 4908 struct ieee80211_sta *sta, void *priv_sta, 4909 struct sk_buff *skb); 4910 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta, 4911 struct ieee80211_tx_rate_control *txrc); 4912 4913 void (*add_sta_debugfs)(void *priv, void *priv_sta, 4914 struct dentry *dir); 4915 void (*remove_sta_debugfs)(void *priv, void *priv_sta); 4916 4917 u32 (*get_expected_throughput)(void *priv_sta); 4918 }; 4919 4920 static inline int rate_supported(struct ieee80211_sta *sta, 4921 enum ieee80211_band band, 4922 int index) 4923 { 4924 return (sta == NULL || sta->supp_rates[band] & BIT(index)); 4925 } 4926 4927 /** 4928 * rate_control_send_low - helper for drivers for management/no-ack frames 4929 * 4930 * Rate control algorithms that agree to use the lowest rate to 4931 * send management frames and NO_ACK data with the respective hw 4932 * retries should use this in the beginning of their mac80211 get_rate 4933 * callback. If true is returned the rate control can simply return. 4934 * If false is returned we guarantee that sta and sta and priv_sta is 4935 * not null. 4936 * 4937 * Rate control algorithms wishing to do more intelligent selection of 4938 * rate for multicast/broadcast frames may choose to not use this. 4939 * 4940 * @sta: &struct ieee80211_sta pointer to the target destination. Note 4941 * that this may be null. 4942 * @priv_sta: private rate control structure. This may be null. 4943 * @txrc: rate control information we sholud populate for mac80211. 4944 */ 4945 bool rate_control_send_low(struct ieee80211_sta *sta, 4946 void *priv_sta, 4947 struct ieee80211_tx_rate_control *txrc); 4948 4949 4950 static inline s8 4951 rate_lowest_index(struct ieee80211_supported_band *sband, 4952 struct ieee80211_sta *sta) 4953 { 4954 int i; 4955 4956 for (i = 0; i < sband->n_bitrates; i++) 4957 if (rate_supported(sta, sband->band, i)) 4958 return i; 4959 4960 /* warn when we cannot find a rate. */ 4961 WARN_ON_ONCE(1); 4962 4963 /* and return 0 (the lowest index) */ 4964 return 0; 4965 } 4966 4967 static inline 4968 bool rate_usable_index_exists(struct ieee80211_supported_band *sband, 4969 struct ieee80211_sta *sta) 4970 { 4971 unsigned int i; 4972 4973 for (i = 0; i < sband->n_bitrates; i++) 4974 if (rate_supported(sta, sband->band, i)) 4975 return true; 4976 return false; 4977 } 4978 4979 /** 4980 * rate_control_set_rates - pass the sta rate selection to mac80211/driver 4981 * 4982 * When not doing a rate control probe to test rates, rate control should pass 4983 * its rate selection to mac80211. If the driver supports receiving a station 4984 * rate table, it will use it to ensure that frames are always sent based on 4985 * the most recent rate control module decision. 4986 * 4987 * @hw: pointer as obtained from ieee80211_alloc_hw() 4988 * @pubsta: &struct ieee80211_sta pointer to the target destination. 4989 * @rates: new tx rate set to be used for this station. 4990 */ 4991 int rate_control_set_rates(struct ieee80211_hw *hw, 4992 struct ieee80211_sta *pubsta, 4993 struct ieee80211_sta_rates *rates); 4994 4995 int ieee80211_rate_control_register(const struct rate_control_ops *ops); 4996 void ieee80211_rate_control_unregister(const struct rate_control_ops *ops); 4997 4998 static inline bool 4999 conf_is_ht20(struct ieee80211_conf *conf) 5000 { 5001 return conf->chandef.width == NL80211_CHAN_WIDTH_20; 5002 } 5003 5004 static inline bool 5005 conf_is_ht40_minus(struct ieee80211_conf *conf) 5006 { 5007 return conf->chandef.width == NL80211_CHAN_WIDTH_40 && 5008 conf->chandef.center_freq1 < conf->chandef.chan->center_freq; 5009 } 5010 5011 static inline bool 5012 conf_is_ht40_plus(struct ieee80211_conf *conf) 5013 { 5014 return conf->chandef.width == NL80211_CHAN_WIDTH_40 && 5015 conf->chandef.center_freq1 > conf->chandef.chan->center_freq; 5016 } 5017 5018 static inline bool 5019 conf_is_ht40(struct ieee80211_conf *conf) 5020 { 5021 return conf->chandef.width == NL80211_CHAN_WIDTH_40; 5022 } 5023 5024 static inline bool 5025 conf_is_ht(struct ieee80211_conf *conf) 5026 { 5027 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) && 5028 (conf->chandef.width != NL80211_CHAN_WIDTH_10) && 5029 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT); 5030 } 5031 5032 static inline enum nl80211_iftype 5033 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p) 5034 { 5035 if (p2p) { 5036 switch (type) { 5037 case NL80211_IFTYPE_STATION: 5038 return NL80211_IFTYPE_P2P_CLIENT; 5039 case NL80211_IFTYPE_AP: 5040 return NL80211_IFTYPE_P2P_GO; 5041 default: 5042 break; 5043 } 5044 } 5045 return type; 5046 } 5047 5048 static inline enum nl80211_iftype 5049 ieee80211_vif_type_p2p(struct ieee80211_vif *vif) 5050 { 5051 return ieee80211_iftype_p2p(vif->type, vif->p2p); 5052 } 5053 5054 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif, 5055 int rssi_min_thold, 5056 int rssi_max_thold); 5057 5058 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif); 5059 5060 /** 5061 * ieee80211_ave_rssi - report the average RSSI for the specified interface 5062 * 5063 * @vif: the specified virtual interface 5064 * 5065 * Note: This function assumes that the given vif is valid. 5066 * 5067 * Return: The average RSSI value for the requested interface, or 0 if not 5068 * applicable. 5069 */ 5070 int ieee80211_ave_rssi(struct ieee80211_vif *vif); 5071 5072 /** 5073 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup 5074 * @vif: virtual interface 5075 * @wakeup: wakeup reason(s) 5076 * @gfp: allocation flags 5077 * 5078 * See cfg80211_report_wowlan_wakeup(). 5079 */ 5080 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif, 5081 struct cfg80211_wowlan_wakeup *wakeup, 5082 gfp_t gfp); 5083 5084 /** 5085 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission 5086 * @hw: pointer as obtained from ieee80211_alloc_hw() 5087 * @vif: virtual interface 5088 * @skb: frame to be sent from within the driver 5089 * @band: the band to transmit on 5090 * @sta: optional pointer to get the station to send the frame to 5091 * 5092 * Note: must be called under RCU lock 5093 */ 5094 bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw, 5095 struct ieee80211_vif *vif, struct sk_buff *skb, 5096 int band, struct ieee80211_sta **sta); 5097 5098 /** 5099 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state 5100 * 5101 * @next_tsf: TSF timestamp of the next absent state change 5102 * @has_next_tsf: next absent state change event pending 5103 * 5104 * @absent: descriptor bitmask, set if GO is currently absent 5105 * 5106 * private: 5107 * 5108 * @count: count fields from the NoA descriptors 5109 * @desc: adjusted data from the NoA 5110 */ 5111 struct ieee80211_noa_data { 5112 u32 next_tsf; 5113 bool has_next_tsf; 5114 5115 u8 absent; 5116 5117 u8 count[IEEE80211_P2P_NOA_DESC_MAX]; 5118 struct { 5119 u32 start; 5120 u32 duration; 5121 u32 interval; 5122 } desc[IEEE80211_P2P_NOA_DESC_MAX]; 5123 }; 5124 5125 /** 5126 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE 5127 * 5128 * @attr: P2P NoA IE 5129 * @data: NoA tracking data 5130 * @tsf: current TSF timestamp 5131 * 5132 * Return: number of successfully parsed descriptors 5133 */ 5134 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr, 5135 struct ieee80211_noa_data *data, u32 tsf); 5136 5137 /** 5138 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change 5139 * 5140 * @data: NoA tracking data 5141 * @tsf: current TSF timestamp 5142 */ 5143 void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf); 5144 5145 /** 5146 * ieee80211_tdls_oper - request userspace to perform a TDLS operation 5147 * @vif: virtual interface 5148 * @peer: the peer's destination address 5149 * @oper: the requested TDLS operation 5150 * @reason_code: reason code for the operation, valid for TDLS teardown 5151 * @gfp: allocation flags 5152 * 5153 * See cfg80211_tdls_oper_request(). 5154 */ 5155 void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer, 5156 enum nl80211_tdls_operation oper, 5157 u16 reason_code, gfp_t gfp); 5158 5159 /** 5160 * ieee80211_reserve_tid - request to reserve a specific TID 5161 * 5162 * There is sometimes a need (such as in TDLS) for blocking the driver from 5163 * using a specific TID so that the FW can use it for certain operations such 5164 * as sending PTI requests. To make sure that the driver doesn't use that TID, 5165 * this function must be called as it flushes out packets on this TID and marks 5166 * it as blocked, so that any transmit for the station on this TID will be 5167 * redirected to the alternative TID in the same AC. 5168 * 5169 * Note that this function blocks and may call back into the driver, so it 5170 * should be called without driver locks held. Also note this function should 5171 * only be called from the driver's @sta_state callback. 5172 * 5173 * @sta: the station to reserve the TID for 5174 * @tid: the TID to reserve 5175 * 5176 * Returns: 0 on success, else on failure 5177 */ 5178 int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid); 5179 5180 /** 5181 * ieee80211_unreserve_tid - request to unreserve a specific TID 5182 * 5183 * Once there is no longer any need for reserving a certain TID, this function 5184 * should be called, and no longer will packets have their TID modified for 5185 * preventing use of this TID in the driver. 5186 * 5187 * Note that this function blocks and acquires a lock, so it should be called 5188 * without driver locks held. Also note this function should only be called 5189 * from the driver's @sta_state callback. 5190 * 5191 * @sta: the station 5192 * @tid: the TID to unreserve 5193 */ 5194 void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid); 5195 5196 /** 5197 * ieee80211_ie_split - split an IE buffer according to ordering 5198 * 5199 * @ies: the IE buffer 5200 * @ielen: the length of the IE buffer 5201 * @ids: an array with element IDs that are allowed before 5202 * the split 5203 * @n_ids: the size of the element ID array 5204 * @offset: offset where to start splitting in the buffer 5205 * 5206 * This function splits an IE buffer by updating the @offset 5207 * variable to point to the location where the buffer should be 5208 * split. 5209 * 5210 * It assumes that the given IE buffer is well-formed, this 5211 * has to be guaranteed by the caller! 5212 * 5213 * It also assumes that the IEs in the buffer are ordered 5214 * correctly, if not the result of using this function will not 5215 * be ordered correctly either, i.e. it does no reordering. 5216 * 5217 * The function returns the offset where the next part of the 5218 * buffer starts, which may be @ielen if the entire (remainder) 5219 * of the buffer should be used. 5220 */ 5221 size_t ieee80211_ie_split(const u8 *ies, size_t ielen, 5222 const u8 *ids, int n_ids, size_t offset); 5223 #endif /* MAC80211_H */ 5224