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