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