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