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