1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * mac80211 <-> driver interface 4 * 5 * Copyright 2002-2005, Devicescape Software, Inc. 6 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz> 7 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net> 8 * Copyright 2013-2014 Intel Mobile Communications GmbH 9 * Copyright (C) 2015 - 2017 Intel Deutschland GmbH 10 * Copyright (C) 2018 - 2023 Intel Corporation 11 */ 12 13 #ifndef MAC80211_H 14 #define MAC80211_H 15 16 #include <linux/bug.h> 17 #include <linux/kernel.h> 18 #include <linux/if_ether.h> 19 #include <linux/skbuff.h> 20 #include <linux/ieee80211.h> 21 #include <linux/lockdep.h> 22 #include <net/cfg80211.h> 23 #include <net/codel.h> 24 #include <net/ieee80211_radiotap.h> 25 #include <asm/unaligned.h> 26 27 /** 28 * DOC: Introduction 29 * 30 * mac80211 is the Linux stack for 802.11 hardware that implements 31 * only partial functionality in hard- or firmware. This document 32 * defines the interface between mac80211 and low-level hardware 33 * drivers. 34 */ 35 36 /** 37 * DOC: Calling mac80211 from interrupts 38 * 39 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be 40 * called in hardware interrupt context. The low-level driver must not call any 41 * other functions in hardware interrupt context. If there is a need for such 42 * call, the low-level driver should first ACK the interrupt and perform the 43 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even 44 * tasklet function. 45 * 46 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also 47 * use the non-IRQ-safe functions! 48 */ 49 50 /** 51 * DOC: Warning 52 * 53 * If you're reading this document and not the header file itself, it will 54 * be incomplete because not all documentation has been converted yet. 55 */ 56 57 /** 58 * DOC: Frame format 59 * 60 * As a general rule, when frames are passed between mac80211 and the driver, 61 * they start with the IEEE 802.11 header and include the same octets that are 62 * sent over the air except for the FCS which should be calculated by the 63 * hardware. 64 * 65 * There are, however, various exceptions to this rule for advanced features: 66 * 67 * The first exception is for hardware encryption and decryption offload 68 * where the IV/ICV may or may not be generated in hardware. 69 * 70 * Secondly, when the hardware handles fragmentation, the frame handed to 71 * the driver from mac80211 is the MSDU, not the MPDU. 72 */ 73 74 /** 75 * DOC: mac80211 workqueue 76 * 77 * mac80211 provides its own workqueue for drivers and internal mac80211 use. 78 * The workqueue is a single threaded workqueue and can only be accessed by 79 * helpers for sanity checking. Drivers must ensure all work added onto the 80 * mac80211 workqueue should be cancelled on the driver stop() callback. 81 * 82 * mac80211 will flushed the workqueue upon interface removal and during 83 * suspend. 84 * 85 * All work performed on the mac80211 workqueue must not acquire the RTNL lock. 86 * 87 */ 88 89 /** 90 * DOC: mac80211 software tx queueing 91 * 92 * mac80211 uses an intermediate queueing implementation, designed to allow the 93 * driver to keep hardware queues short and to provide some fairness between 94 * different stations/interfaces. 95 * 96 * Drivers must provide the .wake_tx_queue driver operation by either 97 * linking it to ieee80211_handle_wake_tx_queue() or implementing a custom 98 * handler. 99 * 100 * Intermediate queues (struct ieee80211_txq) are kept per-sta per-tid, with 101 * another per-sta for non-data/non-mgmt and bufferable management frames, and 102 * a 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 internal TX queues (iTXQs) directly. 108 * Whenever mac80211 adds a new frame to a queue, it calls the .wake_tx_queue 109 * driver op. 110 * Drivers implementing a custom .wake_tx_queue op can get them by calling 111 * ieee80211_tx_dequeue(). Drivers using ieee80211_handle_wake_tx_queue() will 112 * simply get the individual frames pushed via the .tx driver operation. 113 * 114 * Drivers can optionally delegate responsibility for scheduling queues to 115 * mac80211, to take advantage of airtime fairness accounting. In this case, to 116 * obtain the next queue to pull frames from, the driver calls 117 * ieee80211_next_txq(). The driver is then expected to return the txq using 118 * ieee80211_return_txq(). 119 * 120 * For AP powersave TIM handling, the driver only needs to indicate if it has 121 * buffered packets in the driver specific data structures by calling 122 * ieee80211_sta_set_buffered(). For frames buffered in the ieee80211_txq 123 * struct, mac80211 sets the appropriate TIM PVB bits and calls 124 * .release_buffered_frames(). 125 * In that callback the driver is therefore expected to release its own 126 * buffered frames and afterwards also frames from the ieee80211_txq (obtained 127 * via the usual ieee80211_tx_dequeue). 128 */ 129 130 /** 131 * DOC: HW timestamping 132 * 133 * Timing Measurement and Fine Timing Measurement require accurate timestamps 134 * of the action frames TX/RX and their respective acks. 135 * 136 * To report hardware timestamps for Timing Measurement or Fine Timing 137 * Measurement frame RX, the low level driver should set the SKB's hwtstamp 138 * field to the frame RX timestamp and report the ack TX timestamp in the 139 * ieee80211_rx_status struct. 140 * 141 * Similarly, To report hardware timestamps for Timing Measurement or Fine 142 * Timing Measurement frame TX, the driver should set the SKB's hwtstamp field 143 * to the frame TX timestamp and report the ack RX timestamp in the 144 * ieee80211_tx_status struct. 145 */ 146 struct device; 147 148 /** 149 * enum ieee80211_max_queues - maximum number of queues 150 * 151 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues. 152 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set 153 */ 154 enum ieee80211_max_queues { 155 IEEE80211_MAX_QUEUES = 16, 156 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1, 157 }; 158 159 #define IEEE80211_INVAL_HW_QUEUE 0xff 160 161 /** 162 * enum ieee80211_ac_numbers - AC numbers as used in mac80211 163 * @IEEE80211_AC_VO: voice 164 * @IEEE80211_AC_VI: video 165 * @IEEE80211_AC_BE: best effort 166 * @IEEE80211_AC_BK: background 167 */ 168 enum ieee80211_ac_numbers { 169 IEEE80211_AC_VO = 0, 170 IEEE80211_AC_VI = 1, 171 IEEE80211_AC_BE = 2, 172 IEEE80211_AC_BK = 3, 173 }; 174 175 /** 176 * struct ieee80211_tx_queue_params - transmit queue configuration 177 * 178 * The information provided in this structure is required for QoS 179 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29. 180 * 181 * @aifs: arbitration interframe space [0..255] 182 * @cw_min: minimum contention window [a value of the form 183 * 2^n-1 in the range 1..32767] 184 * @cw_max: maximum contention window [like @cw_min] 185 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled 186 * @acm: is mandatory admission control required for the access category 187 * @uapsd: is U-APSD mode enabled for the queue 188 * @mu_edca: is the MU EDCA configured 189 * @mu_edca_param_rec: MU EDCA Parameter Record for HE 190 */ 191 struct ieee80211_tx_queue_params { 192 u16 txop; 193 u16 cw_min; 194 u16 cw_max; 195 u8 aifs; 196 bool acm; 197 bool uapsd; 198 bool mu_edca; 199 struct ieee80211_he_mu_edca_param_ac_rec mu_edca_param_rec; 200 }; 201 202 struct ieee80211_low_level_stats { 203 unsigned int dot11ACKFailureCount; 204 unsigned int dot11RTSFailureCount; 205 unsigned int dot11FCSErrorCount; 206 unsigned int dot11RTSSuccessCount; 207 }; 208 209 /** 210 * enum ieee80211_chanctx_change - change flag for channel context 211 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed 212 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed 213 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed 214 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel, 215 * this is used only with channel switching with CSA 216 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed 217 */ 218 enum ieee80211_chanctx_change { 219 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0), 220 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1), 221 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2), 222 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3), 223 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4), 224 }; 225 226 /** 227 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to 228 * 229 * This is the driver-visible part. The ieee80211_chanctx 230 * that contains it is visible in mac80211 only. 231 * 232 * @def: the channel definition 233 * @min_def: the minimum channel definition currently required. 234 * @rx_chains_static: The number of RX chains that must always be 235 * active on the channel to receive MIMO transmissions 236 * @rx_chains_dynamic: The number of RX chains that must be enabled 237 * after RTS/CTS handshake to receive SMPS MIMO transmissions; 238 * this will always be >= @rx_chains_static. 239 * @radar_enabled: whether radar detection is enabled on this channel. 240 * @drv_priv: data area for driver use, will always be aligned to 241 * sizeof(void *), size is determined in hw information. 242 */ 243 struct ieee80211_chanctx_conf { 244 struct cfg80211_chan_def def; 245 struct cfg80211_chan_def min_def; 246 247 u8 rx_chains_static, rx_chains_dynamic; 248 249 bool radar_enabled; 250 251 u8 drv_priv[] __aligned(sizeof(void *)); 252 }; 253 254 /** 255 * enum ieee80211_chanctx_switch_mode - channel context switch mode 256 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already 257 * exist (and will continue to exist), but the virtual interface 258 * needs to be switched from one to the other. 259 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop 260 * to exist with this call, the new context doesn't exist but 261 * will be active after this call, the virtual interface switches 262 * from the old to the new (note that the driver may of course 263 * implement this as an on-the-fly chandef switch of the existing 264 * hardware context, but the mac80211 pointer for the old context 265 * will cease to exist and only the new one will later be used 266 * for changes/removal.) 267 */ 268 enum ieee80211_chanctx_switch_mode { 269 CHANCTX_SWMODE_REASSIGN_VIF, 270 CHANCTX_SWMODE_SWAP_CONTEXTS, 271 }; 272 273 /** 274 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information 275 * 276 * This is structure is used to pass information about a vif that 277 * needs to switch from one chanctx to another. The 278 * &ieee80211_chanctx_switch_mode defines how the switch should be 279 * done. 280 * 281 * @vif: the vif that should be switched from old_ctx to new_ctx 282 * @link_conf: the link conf that's switching 283 * @old_ctx: the old context to which the vif was assigned 284 * @new_ctx: the new context to which the vif must be assigned 285 */ 286 struct ieee80211_vif_chanctx_switch { 287 struct ieee80211_vif *vif; 288 struct ieee80211_bss_conf *link_conf; 289 struct ieee80211_chanctx_conf *old_ctx; 290 struct ieee80211_chanctx_conf *new_ctx; 291 }; 292 293 /** 294 * enum ieee80211_bss_change - BSS change notification flags 295 * 296 * These flags are used with the bss_info_changed(), link_info_changed() 297 * and vif_cfg_changed() callbacks to indicate which parameter(s) changed. 298 * 299 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated), 300 * also implies a change in the AID. 301 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed 302 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed 303 * @BSS_CHANGED_ERP_SLOT: slot timing changed 304 * @BSS_CHANGED_HT: 802.11n parameters changed 305 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed 306 * @BSS_CHANGED_BEACON_INT: Beacon interval changed 307 * @BSS_CHANGED_BSSID: BSSID changed, for whatever 308 * reason (IBSS and managed mode) 309 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve 310 * new beacon (beaconing modes) 311 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be 312 * enabled/disabled (beaconing modes) 313 * @BSS_CHANGED_CQM: Connection quality monitor config changed 314 * @BSS_CHANGED_IBSS: IBSS join status changed 315 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed. 316 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note 317 * that it is only ever disabled for station mode. 318 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface. 319 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode) 320 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode) 321 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode) 322 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface 323 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS) 324 * changed 325 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available: 326 * currently dtim_period only is under consideration. 327 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed, 328 * note that this is only called when it changes after the channel 329 * context had been assigned. 330 * @BSS_CHANGED_OCB: OCB join status changed 331 * @BSS_CHANGED_MU_GROUPS: VHT MU-MIMO group id or user position changed 332 * @BSS_CHANGED_KEEP_ALIVE: keep alive options (idle period or protected 333 * keep alive) changed. 334 * @BSS_CHANGED_MCAST_RATE: Multicast Rate setting changed for this interface 335 * @BSS_CHANGED_FTM_RESPONDER: fine timing measurement request responder 336 * functionality changed for this BSS (AP mode). 337 * @BSS_CHANGED_TWT: TWT status changed 338 * @BSS_CHANGED_HE_OBSS_PD: OBSS Packet Detection status changed. 339 * @BSS_CHANGED_HE_BSS_COLOR: BSS Color has changed 340 * @BSS_CHANGED_FILS_DISCOVERY: FILS discovery status changed. 341 * @BSS_CHANGED_UNSOL_BCAST_PROBE_RESP: Unsolicited broadcast probe response 342 * status changed. 343 * @BSS_CHANGED_EHT_PUNCTURING: The channel puncturing bitmap changed. 344 * @BSS_CHANGED_MLD_VALID_LINKS: MLD valid links status changed. 345 */ 346 enum ieee80211_bss_change { 347 BSS_CHANGED_ASSOC = 1<<0, 348 BSS_CHANGED_ERP_CTS_PROT = 1<<1, 349 BSS_CHANGED_ERP_PREAMBLE = 1<<2, 350 BSS_CHANGED_ERP_SLOT = 1<<3, 351 BSS_CHANGED_HT = 1<<4, 352 BSS_CHANGED_BASIC_RATES = 1<<5, 353 BSS_CHANGED_BEACON_INT = 1<<6, 354 BSS_CHANGED_BSSID = 1<<7, 355 BSS_CHANGED_BEACON = 1<<8, 356 BSS_CHANGED_BEACON_ENABLED = 1<<9, 357 BSS_CHANGED_CQM = 1<<10, 358 BSS_CHANGED_IBSS = 1<<11, 359 BSS_CHANGED_ARP_FILTER = 1<<12, 360 BSS_CHANGED_QOS = 1<<13, 361 BSS_CHANGED_IDLE = 1<<14, 362 BSS_CHANGED_SSID = 1<<15, 363 BSS_CHANGED_AP_PROBE_RESP = 1<<16, 364 BSS_CHANGED_PS = 1<<17, 365 BSS_CHANGED_TXPOWER = 1<<18, 366 BSS_CHANGED_P2P_PS = 1<<19, 367 BSS_CHANGED_BEACON_INFO = 1<<20, 368 BSS_CHANGED_BANDWIDTH = 1<<21, 369 BSS_CHANGED_OCB = 1<<22, 370 BSS_CHANGED_MU_GROUPS = 1<<23, 371 BSS_CHANGED_KEEP_ALIVE = 1<<24, 372 BSS_CHANGED_MCAST_RATE = 1<<25, 373 BSS_CHANGED_FTM_RESPONDER = 1<<26, 374 BSS_CHANGED_TWT = 1<<27, 375 BSS_CHANGED_HE_OBSS_PD = 1<<28, 376 BSS_CHANGED_HE_BSS_COLOR = 1<<29, 377 BSS_CHANGED_FILS_DISCOVERY = 1<<30, 378 BSS_CHANGED_UNSOL_BCAST_PROBE_RESP = 1<<31, 379 BSS_CHANGED_EHT_PUNCTURING = BIT_ULL(32), 380 BSS_CHANGED_MLD_VALID_LINKS = BIT_ULL(33), 381 382 /* when adding here, make sure to change ieee80211_reconfig */ 383 }; 384 385 /* 386 * The maximum number of IPv4 addresses listed for ARP filtering. If the number 387 * of addresses for an interface increase beyond this value, hardware ARP 388 * filtering will be disabled. 389 */ 390 #define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4 391 392 /** 393 * enum ieee80211_event_type - event to be notified to the low level driver 394 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver. 395 * @MLME_EVENT: event related to MLME 396 * @BAR_RX_EVENT: a BAR was received 397 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because 398 * they timed out. This won't be called for each frame released, but only 399 * once each time the timeout triggers. 400 */ 401 enum ieee80211_event_type { 402 RSSI_EVENT, 403 MLME_EVENT, 404 BAR_RX_EVENT, 405 BA_FRAME_TIMEOUT, 406 }; 407 408 /** 409 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT 410 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver. 411 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver. 412 */ 413 enum ieee80211_rssi_event_data { 414 RSSI_EVENT_HIGH, 415 RSSI_EVENT_LOW, 416 }; 417 418 /** 419 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT 420 * @data: See &enum ieee80211_rssi_event_data 421 */ 422 struct ieee80211_rssi_event { 423 enum ieee80211_rssi_event_data data; 424 }; 425 426 /** 427 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT 428 * @AUTH_EVENT: the MLME operation is authentication 429 * @ASSOC_EVENT: the MLME operation is association 430 * @DEAUTH_RX_EVENT: deauth received.. 431 * @DEAUTH_TX_EVENT: deauth sent. 432 */ 433 enum ieee80211_mlme_event_data { 434 AUTH_EVENT, 435 ASSOC_EVENT, 436 DEAUTH_RX_EVENT, 437 DEAUTH_TX_EVENT, 438 }; 439 440 /** 441 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT 442 * @MLME_SUCCESS: the MLME operation completed successfully. 443 * @MLME_DENIED: the MLME operation was denied by the peer. 444 * @MLME_TIMEOUT: the MLME operation timed out. 445 */ 446 enum ieee80211_mlme_event_status { 447 MLME_SUCCESS, 448 MLME_DENIED, 449 MLME_TIMEOUT, 450 }; 451 452 /** 453 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT 454 * @data: See &enum ieee80211_mlme_event_data 455 * @status: See &enum ieee80211_mlme_event_status 456 * @reason: the reason code if applicable 457 */ 458 struct ieee80211_mlme_event { 459 enum ieee80211_mlme_event_data data; 460 enum ieee80211_mlme_event_status status; 461 u16 reason; 462 }; 463 464 /** 465 * struct ieee80211_ba_event - data attached for BlockAck related events 466 * @sta: pointer to the &ieee80211_sta to which this event relates 467 * @tid: the tid 468 * @ssn: the starting sequence number (for %BAR_RX_EVENT) 469 */ 470 struct ieee80211_ba_event { 471 struct ieee80211_sta *sta; 472 u16 tid; 473 u16 ssn; 474 }; 475 476 /** 477 * struct ieee80211_event - event to be sent to the driver 478 * @type: The event itself. See &enum ieee80211_event_type. 479 * @rssi: relevant if &type is %RSSI_EVENT 480 * @mlme: relevant if &type is %AUTH_EVENT 481 * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT 482 * @u:union holding the fields above 483 */ 484 struct ieee80211_event { 485 enum ieee80211_event_type type; 486 union { 487 struct ieee80211_rssi_event rssi; 488 struct ieee80211_mlme_event mlme; 489 struct ieee80211_ba_event ba; 490 } u; 491 }; 492 493 /** 494 * struct ieee80211_mu_group_data - STA's VHT MU-MIMO group data 495 * 496 * This structure describes the group id data of VHT MU-MIMO 497 * 498 * @membership: 64 bits array - a bit is set if station is member of the group 499 * @position: 2 bits per group id indicating the position in the group 500 */ 501 struct ieee80211_mu_group_data { 502 u8 membership[WLAN_MEMBERSHIP_LEN]; 503 u8 position[WLAN_USER_POSITION_LEN]; 504 }; 505 506 /** 507 * struct ieee80211_ftm_responder_params - FTM responder parameters 508 * 509 * @lci: LCI subelement content 510 * @civicloc: CIVIC location subelement content 511 * @lci_len: LCI data length 512 * @civicloc_len: Civic data length 513 */ 514 struct ieee80211_ftm_responder_params { 515 const u8 *lci; 516 const u8 *civicloc; 517 size_t lci_len; 518 size_t civicloc_len; 519 }; 520 521 /** 522 * struct ieee80211_fils_discovery - FILS discovery parameters from 523 * IEEE Std 802.11ai-2016, Annex C.3 MIB detail. 524 * 525 * @min_interval: Minimum packet interval in TUs (0 - 10000) 526 * @max_interval: Maximum packet interval in TUs (0 - 10000) 527 */ 528 struct ieee80211_fils_discovery { 529 u32 min_interval; 530 u32 max_interval; 531 }; 532 533 /** 534 * struct ieee80211_bss_conf - holds the BSS's changing parameters 535 * 536 * This structure keeps information about a BSS (and an association 537 * to that BSS) that can change during the lifetime of the BSS. 538 * 539 * @vif: reference to owning VIF 540 * @addr: (link) address used locally 541 * @link_id: link ID, or 0 for non-MLO 542 * @htc_trig_based_pkt_ext: default PE in 4us units, if BSS supports HE 543 * @uora_exists: is the UORA element advertised by AP 544 * @ack_enabled: indicates support to receive a multi-TID that solicits either 545 * ACK, BACK or both 546 * @uora_ocw_range: UORA element's OCW Range field 547 * @frame_time_rts_th: HE duration RTS threshold, in units of 32us 548 * @he_support: does this BSS support HE 549 * @twt_requester: does this BSS support TWT requester (relevant for managed 550 * mode only, set if the AP advertises TWT responder role) 551 * @twt_responder: does this BSS support TWT requester (relevant for managed 552 * mode only, set if the AP advertises TWT responder role) 553 * @twt_protected: does this BSS support protected TWT frames 554 * @twt_broadcast: does this BSS support broadcast TWT 555 * @use_cts_prot: use CTS protection 556 * @use_short_preamble: use 802.11b short preamble 557 * @use_short_slot: use short slot time (only relevant for ERP) 558 * @dtim_period: num of beacons before the next DTIM, for beaconing, 559 * valid in station mode only if after the driver was notified 560 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then. 561 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old 562 * as it may have been received during scanning long ago). If the 563 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can 564 * only come from a beacon, but might not become valid until after 565 * association when a beacon is received (which is notified with the 566 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice. 567 * @sync_device_ts: the device timestamp corresponding to the sync_tsf, 568 * the driver/device can use this to calculate synchronisation 569 * (see @sync_tsf). See also sync_dtim_count important notice. 570 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY 571 * is requested, see @sync_tsf/@sync_device_ts. 572 * IMPORTANT: These three sync_* parameters would possibly be out of sync 573 * by the time the driver will use them. The synchronized view is currently 574 * guaranteed only in certain callbacks. 575 * Note also that this is not used with MLD associations, mac80211 doesn't 576 * know how to track beacons for all of the links for this. 577 * @beacon_int: beacon interval 578 * @assoc_capability: capabilities taken from assoc resp 579 * @basic_rates: bitmap of basic rates, each bit stands for an 580 * index into the rate table configured by the driver in 581 * the current band. 582 * @beacon_rate: associated AP's beacon TX rate 583 * @mcast_rate: per-band multicast rate index + 1 (0: disabled) 584 * @bssid: The BSSID for this BSS 585 * @enable_beacon: whether beaconing should be enabled or not 586 * @chandef: Channel definition for this BSS -- the hardware might be 587 * configured a higher bandwidth than this BSS uses, for example. 588 * @mu_group: VHT MU-MIMO group membership data 589 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation. 590 * This field is only valid when the channel is a wide HT/VHT channel. 591 * Note that with TDLS this can be the case (channel is HT, protection must 592 * be used from this field) even when the BSS association isn't using HT. 593 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value 594 * implies disabled. As with the cfg80211 callback, a change here should 595 * cause an event to be sent indicating where the current value is in 596 * relation to the newly configured threshold. 597 * @cqm_rssi_low: Connection quality monitor RSSI lower threshold, a zero value 598 * implies disabled. This is an alternative mechanism to the single 599 * threshold event and can't be enabled simultaneously with it. 600 * @cqm_rssi_high: Connection quality monitor RSSI upper threshold. 601 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis 602 * @qos: This is a QoS-enabled BSS. 603 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode. 604 * @txpower: TX power in dBm. INT_MIN means not configured. 605 * @txpower_type: TX power adjustment used to control per packet Transmit 606 * Power Control (TPC) in lower driver for the current vif. In particular 607 * TPC is enabled if value passed in %txpower_type is 608 * NL80211_TX_POWER_LIMITED (allow using less than specified from 609 * userspace), whereas TPC is disabled if %txpower_type is set to 610 * NL80211_TX_POWER_FIXED (use value configured from userspace) 611 * @p2p_noa_attr: P2P NoA attribute for P2P powersave 612 * @allow_p2p_go_ps: indication for AP or P2P GO interface, whether it's allowed 613 * to use P2P PS mechanism or not. AP/P2P GO is not allowed to use P2P PS 614 * if it has associated clients without P2P PS support. 615 * @max_idle_period: the time period during which the station can refrain from 616 * transmitting frames to its associated AP without being disassociated. 617 * In units of 1000 TUs. Zero value indicates that the AP did not include 618 * a (valid) BSS Max Idle Period Element. 619 * @protected_keep_alive: if set, indicates that the station should send an RSN 620 * protected frame to the AP to reset the idle timer at the AP for the 621 * station. 622 * @ftm_responder: whether to enable or disable fine timing measurement FTM 623 * responder functionality. 624 * @ftmr_params: configurable lci/civic parameter when enabling FTM responder. 625 * @nontransmitted: this BSS is a nontransmitted BSS profile 626 * @transmitter_bssid: the address of transmitter AP 627 * @bssid_index: index inside the multiple BSSID set 628 * @bssid_indicator: 2^bssid_indicator is the maximum number of APs in set 629 * @ema_ap: AP supports enhancements of discovery and advertisement of 630 * nontransmitted BSSIDs 631 * @profile_periodicity: the least number of beacon frames need to be received 632 * in order to discover all the nontransmitted BSSIDs in the set. 633 * @he_oper: HE operation information of the BSS (AP/Mesh) or of the AP we are 634 * connected to (STA) 635 * @he_obss_pd: OBSS Packet Detection parameters. 636 * @he_bss_color: BSS coloring settings, if BSS supports HE 637 * @fils_discovery: FILS discovery configuration 638 * @unsol_bcast_probe_resp_interval: Unsolicited broadcast probe response 639 * interval. 640 * @beacon_tx_rate: The configured beacon transmit rate that needs to be passed 641 * to driver when rate control is offloaded to firmware. 642 * @power_type: power type of BSS for 6 GHz 643 * @tx_pwr_env: transmit power envelope array of BSS. 644 * @tx_pwr_env_num: number of @tx_pwr_env. 645 * @pwr_reduction: power constraint of BSS. 646 * @eht_support: does this BSS support EHT 647 * @eht_puncturing: bitmap to indicate which channels are punctured in this BSS 648 * @csa_active: marks whether a channel switch is going on. 649 * @csa_punct_bitmap: new puncturing bitmap for channel switch 650 * @mu_mimo_owner: indicates interface owns MU-MIMO capability 651 * @chanctx_conf: The channel context this interface is assigned to, or %NULL 652 * when it is not assigned. This pointer is RCU-protected due to the TX 653 * path needing to access it; even though the netdev carrier will always 654 * be off when it is %NULL there can still be races and packets could be 655 * processed after it switches back to %NULL. 656 * @color_change_active: marks whether a color change is ongoing. 657 * @color_change_color: the bss color that will be used after the change. 658 * @ht_ldpc: in AP mode, indicates interface has HT LDPC capability. 659 * @vht_ldpc: in AP mode, indicates interface has VHT LDPC capability. 660 * @he_ldpc: in AP mode, indicates interface has HE LDPC capability. 661 * @vht_su_beamformer: in AP mode, does this BSS support operation as an VHT SU 662 * beamformer 663 * @vht_su_beamformee: in AP mode, does this BSS support operation as an VHT SU 664 * beamformee 665 * @vht_mu_beamformer: in AP mode, does this BSS support operation as an VHT MU 666 * beamformer 667 * @vht_mu_beamformee: in AP mode, does this BSS support operation as an VHT MU 668 * beamformee 669 * @he_su_beamformer: in AP-mode, does this BSS support operation as an HE SU 670 * beamformer 671 * @he_su_beamformee: in AP-mode, does this BSS support operation as an HE SU 672 * beamformee 673 * @he_mu_beamformer: in AP-mode, does this BSS support operation as an HE MU 674 * beamformer 675 * @he_full_ul_mumimo: does this BSS support the reception (AP) or transmission 676 * (non-AP STA) of an HE TB PPDU on an RU that spans the entire PPDU 677 * bandwidth 678 * @eht_su_beamformer: in AP-mode, does this BSS enable operation as an EHT SU 679 * beamformer 680 * @eht_su_beamformee: in AP-mode, does this BSS enable operation as an EHT SU 681 * beamformee 682 * @eht_mu_beamformer: in AP-mode, does this BSS enable operation as an EHT MU 683 * beamformer 684 */ 685 struct ieee80211_bss_conf { 686 struct ieee80211_vif *vif; 687 688 const u8 *bssid; 689 unsigned int link_id; 690 u8 addr[ETH_ALEN] __aligned(2); 691 u8 htc_trig_based_pkt_ext; 692 bool uora_exists; 693 u8 uora_ocw_range; 694 u16 frame_time_rts_th; 695 bool he_support; 696 bool twt_requester; 697 bool twt_responder; 698 bool twt_protected; 699 bool twt_broadcast; 700 /* erp related data */ 701 bool use_cts_prot; 702 bool use_short_preamble; 703 bool use_short_slot; 704 bool enable_beacon; 705 u8 dtim_period; 706 u16 beacon_int; 707 u16 assoc_capability; 708 u64 sync_tsf; 709 u32 sync_device_ts; 710 u8 sync_dtim_count; 711 u32 basic_rates; 712 struct ieee80211_rate *beacon_rate; 713 int mcast_rate[NUM_NL80211_BANDS]; 714 u16 ht_operation_mode; 715 s32 cqm_rssi_thold; 716 u32 cqm_rssi_hyst; 717 s32 cqm_rssi_low; 718 s32 cqm_rssi_high; 719 struct cfg80211_chan_def chandef; 720 struct ieee80211_mu_group_data mu_group; 721 bool qos; 722 bool hidden_ssid; 723 int txpower; 724 enum nl80211_tx_power_setting txpower_type; 725 struct ieee80211_p2p_noa_attr p2p_noa_attr; 726 bool allow_p2p_go_ps; 727 u16 max_idle_period; 728 bool protected_keep_alive; 729 bool ftm_responder; 730 struct ieee80211_ftm_responder_params *ftmr_params; 731 /* Multiple BSSID data */ 732 bool nontransmitted; 733 u8 transmitter_bssid[ETH_ALEN]; 734 u8 bssid_index; 735 u8 bssid_indicator; 736 bool ema_ap; 737 u8 profile_periodicity; 738 struct { 739 u32 params; 740 u16 nss_set; 741 } he_oper; 742 struct ieee80211_he_obss_pd he_obss_pd; 743 struct cfg80211_he_bss_color he_bss_color; 744 struct ieee80211_fils_discovery fils_discovery; 745 u32 unsol_bcast_probe_resp_interval; 746 struct cfg80211_bitrate_mask beacon_tx_rate; 747 enum ieee80211_ap_reg_power power_type; 748 struct ieee80211_tx_pwr_env tx_pwr_env[IEEE80211_TPE_MAX_IE_COUNT]; 749 u8 tx_pwr_env_num; 750 u8 pwr_reduction; 751 bool eht_support; 752 u16 eht_puncturing; 753 754 bool csa_active; 755 u16 csa_punct_bitmap; 756 757 bool mu_mimo_owner; 758 struct ieee80211_chanctx_conf __rcu *chanctx_conf; 759 760 bool color_change_active; 761 u8 color_change_color; 762 763 bool ht_ldpc; 764 bool vht_ldpc; 765 bool he_ldpc; 766 bool vht_su_beamformer; 767 bool vht_su_beamformee; 768 bool vht_mu_beamformer; 769 bool vht_mu_beamformee; 770 bool he_su_beamformer; 771 bool he_su_beamformee; 772 bool he_mu_beamformer; 773 bool he_full_ul_mumimo; 774 bool eht_su_beamformer; 775 bool eht_su_beamformee; 776 bool eht_mu_beamformer; 777 }; 778 779 /** 780 * enum mac80211_tx_info_flags - flags to describe transmission information/status 781 * 782 * These flags are used with the @flags member of &ieee80211_tx_info. 783 * 784 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame. 785 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence 786 * number to this frame, taking care of not overwriting the fragment 787 * number and increasing the sequence number only when the 788 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly 789 * assign sequence numbers to QoS-data frames but cannot do so correctly 790 * for non-QoS-data and management frames because beacons need them from 791 * that counter as well and mac80211 cannot guarantee proper sequencing. 792 * If this flag is set, the driver should instruct the hardware to 793 * assign a sequence number to the frame or assign one itself. Cf. IEEE 794 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for 795 * beacons and always be clear for frames without a sequence number field. 796 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack 797 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination 798 * station 799 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame 800 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon 801 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU 802 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211. 803 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted 804 * because the destination STA was in powersave mode. Note that to 805 * avoid race conditions, the filter must be set by the hardware or 806 * firmware upon receiving a frame that indicates that the station 807 * went to sleep (must be done on device to filter frames already on 808 * the queue) and may only be unset after mac80211 gives the OK for 809 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above), 810 * since only then is it guaranteed that no more frames are in the 811 * hardware queue. 812 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged 813 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status 814 * is for the whole aggregation. 815 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned, 816 * so consider using block ack request (BAR). 817 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be 818 * set by rate control algorithms to indicate probe rate, will 819 * be cleared for fragmented frames (except on the last fragment) 820 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate 821 * that a frame can be transmitted while the queues are stopped for 822 * off-channel operation. 823 * @IEEE80211_TX_CTL_HW_80211_ENCAP: This frame uses hardware encapsulation 824 * (header conversion) 825 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211, 826 * used to indicate that a frame was already retried due to PS 827 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211, 828 * used to indicate frame should not be encrypted 829 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll 830 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must 831 * be sent although the station is in powersave mode. 832 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the 833 * transmit function after the current frame, this can be used 834 * by drivers to kick the DMA queue only if unset or when the 835 * queue gets full. 836 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted 837 * after TX status because the destination was asleep, it must not 838 * be modified again (no seqno assignment, crypto, etc.) 839 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME 840 * code for connection establishment, this indicates that its status 841 * should kick the MLME state machine. 842 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211 843 * MLME command (internal to mac80211 to figure out whether to send TX 844 * status to user space) 845 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame 846 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this 847 * frame and selects the maximum number of streams that it can use. 848 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on 849 * the off-channel channel when a remain-on-channel offload is done 850 * in hardware -- normal packets still flow and are expected to be 851 * handled properly by the device. 852 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP 853 * testing. It will be sent out with incorrect Michael MIC key to allow 854 * TKIP countermeasures to be tested. 855 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate. 856 * This flag is actually used for management frame especially for P2P 857 * frames not being sent at CCK rate in 2GHz band. 858 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period, 859 * when its status is reported the service period ends. For frames in 860 * an SP that mac80211 transmits, it is already set; for driver frames 861 * the driver may set this flag. It is also used to do the same for 862 * PS-Poll responses. 863 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate. 864 * This flag is used to send nullfunc frame at minimum rate when 865 * the nullfunc is used for connection monitoring purpose. 866 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it 867 * would be fragmented by size (this is optional, only used for 868 * monitor injection). 869 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with 870 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without 871 * any errors (like issues specific to the driver/HW). 872 * This flag must not be set for frames that don't request no-ack 873 * behaviour with IEEE80211_TX_CTL_NO_ACK. 874 * 875 * Note: If you have to add new flags to the enumeration, then don't 876 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary. 877 */ 878 enum mac80211_tx_info_flags { 879 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0), 880 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1), 881 IEEE80211_TX_CTL_NO_ACK = BIT(2), 882 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3), 883 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4), 884 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5), 885 IEEE80211_TX_CTL_AMPDU = BIT(6), 886 IEEE80211_TX_CTL_INJECTED = BIT(7), 887 IEEE80211_TX_STAT_TX_FILTERED = BIT(8), 888 IEEE80211_TX_STAT_ACK = BIT(9), 889 IEEE80211_TX_STAT_AMPDU = BIT(10), 890 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11), 891 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12), 892 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13), 893 IEEE80211_TX_CTL_HW_80211_ENCAP = BIT(14), 894 IEEE80211_TX_INTFL_RETRIED = BIT(15), 895 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16), 896 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17), 897 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18), 898 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19), 899 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20), 900 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21), 901 IEEE80211_TX_CTL_LDPC = BIT(22), 902 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24), 903 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25), 904 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26), 905 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27), 906 IEEE80211_TX_STATUS_EOSP = BIT(28), 907 IEEE80211_TX_CTL_USE_MINRATE = BIT(29), 908 IEEE80211_TX_CTL_DONTFRAG = BIT(30), 909 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31), 910 }; 911 912 #define IEEE80211_TX_CTL_STBC_SHIFT 23 913 914 #define IEEE80211_TX_RC_S1G_MCS IEEE80211_TX_RC_VHT_MCS 915 916 /** 917 * enum mac80211_tx_control_flags - flags to describe transmit control 918 * 919 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control 920 * protocol frame (e.g. EAP) 921 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll 922 * frame (PS-Poll or uAPSD). 923 * @IEEE80211_TX_CTRL_RATE_INJECT: This frame is injected with rate information 924 * @IEEE80211_TX_CTRL_AMSDU: This frame is an A-MSDU frame 925 * @IEEE80211_TX_CTRL_FAST_XMIT: This frame is going through the fast_xmit path 926 * @IEEE80211_TX_CTRL_SKIP_MPATH_LOOKUP: This frame skips mesh path lookup 927 * @IEEE80211_TX_INTCFL_NEED_TXPROCESSING: completely internal to mac80211, 928 * used to indicate that a pending frame requires TX processing before 929 * it can be sent out. 930 * @IEEE80211_TX_CTRL_NO_SEQNO: Do not overwrite the sequence number that 931 * has already been assigned to this frame. 932 * @IEEE80211_TX_CTRL_DONT_REORDER: This frame should not be reordered 933 * relative to other frames that have this flag set, independent 934 * of their QoS TID or other priority field values. 935 * @IEEE80211_TX_CTRL_MCAST_MLO_FIRST_TX: first MLO TX, used mostly internally 936 * for sequence number assignment 937 * @IEEE80211_TX_CTRL_MLO_LINK: If not @IEEE80211_LINK_UNSPECIFIED, this 938 * frame should be transmitted on the specific link. This really is 939 * only relevant for frames that do not have data present, and is 940 * also not used for 802.3 format frames. Note that even if the frame 941 * is on a specific link, address translation might still apply if 942 * it's intended for an MLD. 943 * 944 * These flags are used in tx_info->control.flags. 945 */ 946 enum mac80211_tx_control_flags { 947 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0), 948 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1), 949 IEEE80211_TX_CTRL_RATE_INJECT = BIT(2), 950 IEEE80211_TX_CTRL_AMSDU = BIT(3), 951 IEEE80211_TX_CTRL_FAST_XMIT = BIT(4), 952 IEEE80211_TX_CTRL_SKIP_MPATH_LOOKUP = BIT(5), 953 IEEE80211_TX_INTCFL_NEED_TXPROCESSING = BIT(6), 954 IEEE80211_TX_CTRL_NO_SEQNO = BIT(7), 955 IEEE80211_TX_CTRL_DONT_REORDER = BIT(8), 956 IEEE80211_TX_CTRL_MCAST_MLO_FIRST_TX = BIT(9), 957 IEEE80211_TX_CTRL_MLO_LINK = 0xf0000000, 958 }; 959 960 #define IEEE80211_LINK_UNSPECIFIED 0xf 961 #define IEEE80211_TX_CTRL_MLO_LINK_UNSPEC \ 962 u32_encode_bits(IEEE80211_LINK_UNSPECIFIED, \ 963 IEEE80211_TX_CTRL_MLO_LINK) 964 965 /** 966 * enum mac80211_tx_status_flags - flags to describe transmit status 967 * 968 * @IEEE80211_TX_STATUS_ACK_SIGNAL_VALID: ACK signal is valid 969 * 970 * These flags are used in tx_info->status.flags. 971 */ 972 enum mac80211_tx_status_flags { 973 IEEE80211_TX_STATUS_ACK_SIGNAL_VALID = BIT(0), 974 }; 975 976 /* 977 * This definition is used as a mask to clear all temporary flags, which are 978 * set by the tx handlers for each transmission attempt by the mac80211 stack. 979 */ 980 #define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \ 981 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \ 982 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \ 983 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \ 984 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \ 985 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \ 986 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \ 987 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP) 988 989 /** 990 * enum mac80211_rate_control_flags - per-rate flags set by the 991 * Rate Control algorithm. 992 * 993 * These flags are set by the Rate control algorithm for each rate during tx, 994 * in the @flags member of struct ieee80211_tx_rate. 995 * 996 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate. 997 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required. 998 * This is set if the current BSS requires ERP protection. 999 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble. 1000 * @IEEE80211_TX_RC_MCS: HT rate. 1001 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split 1002 * into a higher 4 bits (Nss) and lower 4 bits (MCS number) 1003 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in 1004 * Greenfield mode. 1005 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz. 1006 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission 1007 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission 1008 * (80+80 isn't supported yet) 1009 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the 1010 * adjacent 20 MHz channels, if the current channel type is 1011 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS. 1012 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate. 1013 */ 1014 enum mac80211_rate_control_flags { 1015 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0), 1016 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1), 1017 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2), 1018 1019 /* rate index is an HT/VHT MCS instead of an index */ 1020 IEEE80211_TX_RC_MCS = BIT(3), 1021 IEEE80211_TX_RC_GREEN_FIELD = BIT(4), 1022 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5), 1023 IEEE80211_TX_RC_DUP_DATA = BIT(6), 1024 IEEE80211_TX_RC_SHORT_GI = BIT(7), 1025 IEEE80211_TX_RC_VHT_MCS = BIT(8), 1026 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9), 1027 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10), 1028 }; 1029 1030 1031 /* there are 40 bytes if you don't need the rateset to be kept */ 1032 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40 1033 1034 /* if you do need the rateset, then you have less space */ 1035 #define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24 1036 1037 /* maximum number of rate stages */ 1038 #define IEEE80211_TX_MAX_RATES 4 1039 1040 /* maximum number of rate table entries */ 1041 #define IEEE80211_TX_RATE_TABLE_SIZE 4 1042 1043 /** 1044 * struct ieee80211_tx_rate - rate selection/status 1045 * 1046 * @idx: rate index to attempt to send with 1047 * @flags: rate control flags (&enum mac80211_rate_control_flags) 1048 * @count: number of tries in this rate before going to the next rate 1049 * 1050 * A value of -1 for @idx indicates an invalid rate and, if used 1051 * in an array of retry rates, that no more rates should be tried. 1052 * 1053 * When used for transmit status reporting, the driver should 1054 * always report the rate along with the flags it used. 1055 * 1056 * &struct ieee80211_tx_info contains an array of these structs 1057 * in the control information, and it will be filled by the rate 1058 * control algorithm according to what should be sent. For example, 1059 * if this array contains, in the format { <idx>, <count> } the 1060 * information:: 1061 * 1062 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 } 1063 * 1064 * then this means that the frame should be transmitted 1065 * up to twice at rate 3, up to twice at rate 2, and up to four 1066 * times at rate 1 if it doesn't get acknowledged. Say it gets 1067 * acknowledged by the peer after the fifth attempt, the status 1068 * information should then contain:: 1069 * 1070 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ... 1071 * 1072 * since it was transmitted twice at rate 3, twice at rate 2 1073 * and once at rate 1 after which we received an acknowledgement. 1074 */ 1075 struct ieee80211_tx_rate { 1076 s8 idx; 1077 u16 count:5, 1078 flags:11; 1079 } __packed; 1080 1081 #define IEEE80211_MAX_TX_RETRY 31 1082 1083 static inline bool ieee80211_rate_valid(struct ieee80211_tx_rate *rate) 1084 { 1085 return rate->idx >= 0 && rate->count > 0; 1086 } 1087 1088 static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate, 1089 u8 mcs, u8 nss) 1090 { 1091 WARN_ON(mcs & ~0xF); 1092 WARN_ON((nss - 1) & ~0x7); 1093 rate->idx = ((nss - 1) << 4) | mcs; 1094 } 1095 1096 static inline u8 1097 ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate) 1098 { 1099 return rate->idx & 0xF; 1100 } 1101 1102 static inline u8 1103 ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate) 1104 { 1105 return (rate->idx >> 4) + 1; 1106 } 1107 1108 /** 1109 * struct ieee80211_tx_info - skb transmit information 1110 * 1111 * This structure is placed in skb->cb for three uses: 1112 * (1) mac80211 TX control - mac80211 tells the driver what to do 1113 * (2) driver internal use (if applicable) 1114 * (3) TX status information - driver tells mac80211 what happened 1115 * 1116 * @flags: transmit info flags, defined above 1117 * @band: the band to transmit on (use e.g. for checking for races), 1118 * not valid if the interface is an MLD since we won't know which 1119 * link the frame will be transmitted on 1120 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC 1121 * @status_data: internal data for TX status handling, assigned privately, 1122 * see also &enum ieee80211_status_data for the internal documentation 1123 * @status_data_idr: indicates status data is IDR allocated ID for ack frame 1124 * @tx_time_est: TX time estimate in units of 4us, used internally 1125 * @control: union part for control data 1126 * @control.rates: TX rates array to try 1127 * @control.rts_cts_rate_idx: rate for RTS or CTS 1128 * @control.use_rts: use RTS 1129 * @control.use_cts_prot: use RTS/CTS 1130 * @control.short_preamble: use short preamble (CCK only) 1131 * @control.skip_table: skip externally configured rate table 1132 * @control.jiffies: timestamp for expiry on powersave clients 1133 * @control.vif: virtual interface (may be NULL) 1134 * @control.hw_key: key to encrypt with (may be NULL) 1135 * @control.flags: control flags, see &enum mac80211_tx_control_flags 1136 * @control.enqueue_time: enqueue time (for iTXQs) 1137 * @driver_rates: alias to @control.rates to reserve space 1138 * @pad: padding 1139 * @rate_driver_data: driver use area if driver needs @control.rates 1140 * @status: union part for status data 1141 * @status.rates: attempted rates 1142 * @status.ack_signal: ACK signal 1143 * @status.ampdu_ack_len: AMPDU ack length 1144 * @status.ampdu_len: AMPDU length 1145 * @status.antenna: (legacy, kept only for iwlegacy) 1146 * @status.tx_time: airtime consumed for transmission; note this is only 1147 * used for WMM AC, not for airtime fairness 1148 * @status.flags: status flags, see &enum mac80211_tx_status_flags 1149 * @status.status_driver_data: driver use area 1150 * @ack: union part for pure ACK data 1151 * @ack.cookie: cookie for the ACK 1152 * @driver_data: array of driver_data pointers 1153 * @ampdu_ack_len: number of acked aggregated frames. 1154 * relevant only if IEEE80211_TX_STAT_AMPDU was set. 1155 * @ampdu_len: number of aggregated frames. 1156 * relevant only if IEEE80211_TX_STAT_AMPDU was set. 1157 * @ack_signal: signal strength of the ACK frame 1158 */ 1159 struct ieee80211_tx_info { 1160 /* common information */ 1161 u32 flags; 1162 u32 band:3, 1163 status_data_idr:1, 1164 status_data:13, 1165 hw_queue:4, 1166 tx_time_est:10; 1167 /* 1 free bit */ 1168 1169 union { 1170 struct { 1171 union { 1172 /* rate control */ 1173 struct { 1174 struct ieee80211_tx_rate rates[ 1175 IEEE80211_TX_MAX_RATES]; 1176 s8 rts_cts_rate_idx; 1177 u8 use_rts:1; 1178 u8 use_cts_prot:1; 1179 u8 short_preamble:1; 1180 u8 skip_table:1; 1181 1182 /* for injection only (bitmap) */ 1183 u8 antennas:2; 1184 1185 /* 14 bits free */ 1186 }; 1187 /* only needed before rate control */ 1188 unsigned long jiffies; 1189 }; 1190 /* NB: vif can be NULL for injected frames */ 1191 struct ieee80211_vif *vif; 1192 struct ieee80211_key_conf *hw_key; 1193 u32 flags; 1194 codel_time_t enqueue_time; 1195 } control; 1196 struct { 1197 u64 cookie; 1198 } ack; 1199 struct { 1200 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES]; 1201 s32 ack_signal; 1202 u8 ampdu_ack_len; 1203 u8 ampdu_len; 1204 u8 antenna; 1205 u8 pad; 1206 u16 tx_time; 1207 u8 flags; 1208 u8 pad2; 1209 void *status_driver_data[16 / sizeof(void *)]; 1210 } status; 1211 struct { 1212 struct ieee80211_tx_rate driver_rates[ 1213 IEEE80211_TX_MAX_RATES]; 1214 u8 pad[4]; 1215 1216 void *rate_driver_data[ 1217 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)]; 1218 }; 1219 void *driver_data[ 1220 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)]; 1221 }; 1222 }; 1223 1224 static inline u16 1225 ieee80211_info_set_tx_time_est(struct ieee80211_tx_info *info, u16 tx_time_est) 1226 { 1227 /* We only have 10 bits in tx_time_est, so store airtime 1228 * in increments of 4us and clamp the maximum to 2**12-1 1229 */ 1230 info->tx_time_est = min_t(u16, tx_time_est, 4095) >> 2; 1231 return info->tx_time_est << 2; 1232 } 1233 1234 static inline u16 1235 ieee80211_info_get_tx_time_est(struct ieee80211_tx_info *info) 1236 { 1237 return info->tx_time_est << 2; 1238 } 1239 1240 /*** 1241 * struct ieee80211_rate_status - mrr stage for status path 1242 * 1243 * This struct is used in struct ieee80211_tx_status to provide drivers a 1244 * dynamic way to report about used rates and power levels per packet. 1245 * 1246 * @rate_idx The actual used rate. 1247 * @try_count How often the rate was tried. 1248 * @tx_power_idx An idx into the ieee80211_hw->tx_power_levels list of the 1249 * corresponding wifi hardware. The idx shall point to the power level 1250 * that was used when sending the packet. 1251 */ 1252 struct ieee80211_rate_status { 1253 struct rate_info rate_idx; 1254 u8 try_count; 1255 u8 tx_power_idx; 1256 }; 1257 1258 /** 1259 * struct ieee80211_tx_status - extended tx status info for rate control 1260 * 1261 * @sta: Station that the packet was transmitted for 1262 * @info: Basic tx status information 1263 * @skb: Packet skb (can be NULL if not provided by the driver) 1264 * @rates: Mrr stages that were used when sending the packet 1265 * @n_rates: Number of mrr stages (count of instances for @rates) 1266 * @free_list: list where processed skbs are stored to be free'd by the driver 1267 * @ack_hwtstamp: Hardware timestamp of the received ack in nanoseconds 1268 * Only needed for Timing measurement and Fine timing measurement action 1269 * frames. Only reported by devices that have timestamping enabled. 1270 */ 1271 struct ieee80211_tx_status { 1272 struct ieee80211_sta *sta; 1273 struct ieee80211_tx_info *info; 1274 struct sk_buff *skb; 1275 struct ieee80211_rate_status *rates; 1276 ktime_t ack_hwtstamp; 1277 u8 n_rates; 1278 1279 struct list_head *free_list; 1280 }; 1281 1282 /** 1283 * struct ieee80211_scan_ies - descriptors for different blocks of IEs 1284 * 1285 * This structure is used to point to different blocks of IEs in HW scan 1286 * and scheduled scan. These blocks contain the IEs passed by userspace 1287 * and the ones generated by mac80211. 1288 * 1289 * @ies: pointers to band specific IEs. 1290 * @len: lengths of band_specific IEs. 1291 * @common_ies: IEs for all bands (especially vendor specific ones) 1292 * @common_ie_len: length of the common_ies 1293 */ 1294 struct ieee80211_scan_ies { 1295 const u8 *ies[NUM_NL80211_BANDS]; 1296 size_t len[NUM_NL80211_BANDS]; 1297 const u8 *common_ies; 1298 size_t common_ie_len; 1299 }; 1300 1301 1302 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb) 1303 { 1304 return (struct ieee80211_tx_info *)skb->cb; 1305 } 1306 1307 static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb) 1308 { 1309 return (struct ieee80211_rx_status *)skb->cb; 1310 } 1311 1312 /** 1313 * ieee80211_tx_info_clear_status - clear TX status 1314 * 1315 * @info: The &struct ieee80211_tx_info to be cleared. 1316 * 1317 * When the driver passes an skb back to mac80211, it must report 1318 * a number of things in TX status. This function clears everything 1319 * in the TX status but the rate control information (it does clear 1320 * the count since you need to fill that in anyway). 1321 * 1322 * NOTE: While the rates array is kept intact, this will wipe all of the 1323 * driver_data fields in info, so it's up to the driver to restore 1324 * any fields it needs after calling this helper. 1325 */ 1326 static inline void 1327 ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info) 1328 { 1329 int i; 1330 1331 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 1332 offsetof(struct ieee80211_tx_info, control.rates)); 1333 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 1334 offsetof(struct ieee80211_tx_info, driver_rates)); 1335 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8); 1336 /* clear the rate counts */ 1337 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++) 1338 info->status.rates[i].count = 0; 1339 memset_after(&info->status, 0, rates); 1340 } 1341 1342 1343 /** 1344 * enum mac80211_rx_flags - receive flags 1345 * 1346 * These flags are used with the @flag member of &struct ieee80211_rx_status. 1347 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame. 1348 * Use together with %RX_FLAG_MMIC_STRIPPED. 1349 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware. 1350 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame, 1351 * verification has been done by the hardware. 1352 * @RX_FLAG_IV_STRIPPED: The IV and ICV are stripped from this frame. 1353 * If this flag is set, the stack cannot do any replay detection 1354 * hence the driver or hardware will have to do that. 1355 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this 1356 * flag indicates that the PN was verified for replay protection. 1357 * Note that this flag is also currently only supported when a frame 1358 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set) 1359 * @RX_FLAG_DUP_VALIDATED: The driver should set this flag if it did 1360 * de-duplication by itself. 1361 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on 1362 * the frame. 1363 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on 1364 * the frame. 1365 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime 1366 * field) is valid and contains the time the first symbol of the MPDU 1367 * was received. This is useful in monitor mode and for proper IBSS 1368 * merging. 1369 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime 1370 * field) is valid and contains the time the last symbol of the MPDU 1371 * (including FCS) was received. 1372 * @RX_FLAG_MACTIME_PLCP_START: The timestamp passed in the RX status (@mactime 1373 * field) is valid and contains the time the SYNC preamble was received. 1374 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present. 1375 * Valid only for data frames (mainly A-MPDU) 1376 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference 1377 * number (@ampdu_reference) must be populated and be a distinct number for 1378 * each A-MPDU 1379 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all 1380 * subframes of a single A-MPDU 1381 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU 1382 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected 1383 * on this subframe 1384 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC 1385 * is stored in the @ampdu_delimiter_crc field) 1386 * @RX_FLAG_MIC_STRIPPED: The mic was stripped of this packet. Decryption was 1387 * done by the hardware 1388 * @RX_FLAG_ONLY_MONITOR: Report frame only to monitor interfaces without 1389 * processing it in any regular way. 1390 * This is useful if drivers offload some frames but still want to report 1391 * them for sniffing purposes. 1392 * @RX_FLAG_SKIP_MONITOR: Process and report frame to all interfaces except 1393 * monitor interfaces. 1394 * This is useful if drivers offload some frames but still want to report 1395 * them for sniffing purposes. 1396 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU 1397 * subframes instead of a one huge frame for performance reasons. 1398 * All, but the last MSDU from an A-MSDU should have this flag set. E.g. 1399 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while 1400 * the 3rd (last) one must not have this flag set. The flag is used to 1401 * deal with retransmission/duplication recovery properly since A-MSDU 1402 * subframes share the same sequence number. Reported subframes can be 1403 * either regular MSDU or singly A-MSDUs. Subframes must not be 1404 * interleaved with other frames. 1405 * @RX_FLAG_RADIOTAP_TLV_AT_END: This frame contains radiotap TLVs in the 1406 * skb->data (before the 802.11 header). 1407 * If used, the SKB's mac_header pointer must be set to point 1408 * to the 802.11 header after the TLVs, and any padding added after TLV 1409 * data to align to 4 must be cleared by the driver putting the TLVs 1410 * in the skb. 1411 * @RX_FLAG_ALLOW_SAME_PN: Allow the same PN as same packet before. 1412 * This is used for AMSDU subframes which can have the same PN as 1413 * the first subframe. 1414 * @RX_FLAG_ICV_STRIPPED: The ICV is stripped from this frame. CRC checking must 1415 * be done in the hardware. 1416 * @RX_FLAG_AMPDU_EOF_BIT: Value of the EOF bit in the A-MPDU delimiter for this 1417 * frame 1418 * @RX_FLAG_AMPDU_EOF_BIT_KNOWN: The EOF value is known 1419 * @RX_FLAG_RADIOTAP_HE: HE radiotap data is present 1420 * (&struct ieee80211_radiotap_he, mac80211 will fill in 1421 * 1422 * - DATA3_DATA_MCS 1423 * - DATA3_DATA_DCM 1424 * - DATA3_CODING 1425 * - DATA5_GI 1426 * - DATA5_DATA_BW_RU_ALLOC 1427 * - DATA6_NSTS 1428 * - DATA3_STBC 1429 * 1430 * from the RX info data, so leave those zeroed when building this data) 1431 * @RX_FLAG_RADIOTAP_HE_MU: HE MU radiotap data is present 1432 * (&struct ieee80211_radiotap_he_mu) 1433 * @RX_FLAG_RADIOTAP_LSIG: L-SIG radiotap data is present 1434 * @RX_FLAG_NO_PSDU: use the frame only for radiotap reporting, with 1435 * the "0-length PSDU" field included there. The value for it is 1436 * in &struct ieee80211_rx_status. Note that if this value isn't 1437 * known the frame shouldn't be reported. 1438 * @RX_FLAG_8023: the frame has an 802.3 header (decap offload performed by 1439 * hardware or driver) 1440 */ 1441 enum mac80211_rx_flags { 1442 RX_FLAG_MMIC_ERROR = BIT(0), 1443 RX_FLAG_DECRYPTED = BIT(1), 1444 RX_FLAG_MACTIME_PLCP_START = BIT(2), 1445 RX_FLAG_MMIC_STRIPPED = BIT(3), 1446 RX_FLAG_IV_STRIPPED = BIT(4), 1447 RX_FLAG_FAILED_FCS_CRC = BIT(5), 1448 RX_FLAG_FAILED_PLCP_CRC = BIT(6), 1449 RX_FLAG_MACTIME_START = BIT(7), 1450 RX_FLAG_NO_SIGNAL_VAL = BIT(8), 1451 RX_FLAG_AMPDU_DETAILS = BIT(9), 1452 RX_FLAG_PN_VALIDATED = BIT(10), 1453 RX_FLAG_DUP_VALIDATED = BIT(11), 1454 RX_FLAG_AMPDU_LAST_KNOWN = BIT(12), 1455 RX_FLAG_AMPDU_IS_LAST = BIT(13), 1456 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(14), 1457 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(15), 1458 RX_FLAG_MACTIME_END = BIT(16), 1459 RX_FLAG_ONLY_MONITOR = BIT(17), 1460 RX_FLAG_SKIP_MONITOR = BIT(18), 1461 RX_FLAG_AMSDU_MORE = BIT(19), 1462 RX_FLAG_RADIOTAP_TLV_AT_END = BIT(20), 1463 RX_FLAG_MIC_STRIPPED = BIT(21), 1464 RX_FLAG_ALLOW_SAME_PN = BIT(22), 1465 RX_FLAG_ICV_STRIPPED = BIT(23), 1466 RX_FLAG_AMPDU_EOF_BIT = BIT(24), 1467 RX_FLAG_AMPDU_EOF_BIT_KNOWN = BIT(25), 1468 RX_FLAG_RADIOTAP_HE = BIT(26), 1469 RX_FLAG_RADIOTAP_HE_MU = BIT(27), 1470 RX_FLAG_RADIOTAP_LSIG = BIT(28), 1471 RX_FLAG_NO_PSDU = BIT(29), 1472 RX_FLAG_8023 = BIT(30), 1473 }; 1474 1475 /** 1476 * enum mac80211_rx_encoding_flags - MCS & bandwidth flags 1477 * 1478 * @RX_ENC_FLAG_SHORTPRE: Short preamble was used for this frame 1479 * @RX_ENC_FLAG_SHORT_GI: Short guard interval was used 1480 * @RX_ENC_FLAG_HT_GF: This frame was received in a HT-greenfield transmission, 1481 * if the driver fills this value it should add 1482 * %IEEE80211_RADIOTAP_MCS_HAVE_FMT 1483 * to @hw.radiotap_mcs_details to advertise that fact. 1484 * @RX_ENC_FLAG_LDPC: LDPC was used 1485 * @RX_ENC_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3 1486 * @RX_ENC_FLAG_BF: packet was beamformed 1487 */ 1488 enum mac80211_rx_encoding_flags { 1489 RX_ENC_FLAG_SHORTPRE = BIT(0), 1490 RX_ENC_FLAG_SHORT_GI = BIT(2), 1491 RX_ENC_FLAG_HT_GF = BIT(3), 1492 RX_ENC_FLAG_STBC_MASK = BIT(4) | BIT(5), 1493 RX_ENC_FLAG_LDPC = BIT(6), 1494 RX_ENC_FLAG_BF = BIT(7), 1495 }; 1496 1497 #define RX_ENC_FLAG_STBC_SHIFT 4 1498 1499 enum mac80211_rx_encoding { 1500 RX_ENC_LEGACY = 0, 1501 RX_ENC_HT, 1502 RX_ENC_VHT, 1503 RX_ENC_HE, 1504 RX_ENC_EHT, 1505 }; 1506 1507 /** 1508 * struct ieee80211_rx_status - receive status 1509 * 1510 * The low-level driver should provide this information (the subset 1511 * supported by hardware) to the 802.11 code with each received 1512 * frame, in the skb's control buffer (cb). 1513 * 1514 * @mactime: value in microseconds of the 64-bit Time Synchronization Function 1515 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware. 1516 * @boottime_ns: CLOCK_BOOTTIME timestamp the frame was received at, this is 1517 * needed only for beacons and probe responses that update the scan cache. 1518 * @ack_tx_hwtstamp: Hardware timestamp for the ack TX in nanoseconds. Only 1519 * needed for Timing measurement and Fine timing measurement action frames. 1520 * Only reported by devices that have timestamping enabled. 1521 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use 1522 * it but can store it and pass it back to the driver for synchronisation 1523 * @band: the active band when this frame was received 1524 * @freq: frequency the radio was tuned to when receiving this frame, in MHz 1525 * This field must be set for management frames, but isn't strictly needed 1526 * for data (other) frames - for those it only affects radiotap reporting. 1527 * @freq_offset: @freq has a positive offset of 500Khz. 1528 * @signal: signal strength when receiving this frame, either in dBm, in dB or 1529 * unspecified depending on the hardware capabilities flags 1530 * @IEEE80211_HW_SIGNAL_* 1531 * @chains: bitmask of receive chains for which separate signal strength 1532 * values were filled. 1533 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't 1534 * support dB or unspecified units) 1535 * @antenna: antenna used 1536 * @rate_idx: index of data rate into band's supported rates or MCS index if 1537 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT) 1538 * @nss: number of streams (VHT, HE and EHT only) 1539 * @flag: %RX_FLAG_\* 1540 * @encoding: &enum mac80211_rx_encoding 1541 * @bw: &enum rate_info_bw 1542 * @enc_flags: uses bits from &enum mac80211_rx_encoding_flags 1543 * @he_ru: HE RU, from &enum nl80211_he_ru_alloc 1544 * @he_gi: HE GI, from &enum nl80211_he_gi 1545 * @he_dcm: HE DCM value 1546 * @eht: EHT specific rate information 1547 * @eht.ru: EHT RU, from &enum nl80211_eht_ru_alloc 1548 * @eht.gi: EHT GI, from &enum nl80211_eht_gi 1549 * @rx_flags: internal RX flags for mac80211 1550 * @ampdu_reference: A-MPDU reference number, must be a different value for 1551 * each A-MPDU but the same for each subframe within one A-MPDU 1552 * @ampdu_delimiter_crc: A-MPDU delimiter CRC 1553 * @zero_length_psdu_type: radiotap type of the 0-length PSDU 1554 * @link_valid: if the link which is identified by @link_id is valid. This flag 1555 * is set only when connection is MLO. 1556 * @link_id: id of the link used to receive the packet. This is used along with 1557 * @link_valid. 1558 */ 1559 struct ieee80211_rx_status { 1560 u64 mactime; 1561 union { 1562 u64 boottime_ns; 1563 ktime_t ack_tx_hwtstamp; 1564 }; 1565 u32 device_timestamp; 1566 u32 ampdu_reference; 1567 u32 flag; 1568 u16 freq: 13, freq_offset: 1; 1569 u8 enc_flags; 1570 u8 encoding:3, bw:4; 1571 union { 1572 struct { 1573 u8 he_ru:3; 1574 u8 he_gi:2; 1575 u8 he_dcm:1; 1576 }; 1577 struct { 1578 u8 ru:4; 1579 u8 gi:2; 1580 } eht; 1581 }; 1582 u8 rate_idx; 1583 u8 nss; 1584 u8 rx_flags; 1585 u8 band; 1586 u8 antenna; 1587 s8 signal; 1588 u8 chains; 1589 s8 chain_signal[IEEE80211_MAX_CHAINS]; 1590 u8 ampdu_delimiter_crc; 1591 u8 zero_length_psdu_type; 1592 u8 link_valid:1, link_id:4; 1593 }; 1594 1595 static inline u32 1596 ieee80211_rx_status_to_khz(struct ieee80211_rx_status *rx_status) 1597 { 1598 return MHZ_TO_KHZ(rx_status->freq) + 1599 (rx_status->freq_offset ? 500 : 0); 1600 } 1601 1602 /** 1603 * enum ieee80211_conf_flags - configuration flags 1604 * 1605 * Flags to define PHY configuration options 1606 * 1607 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this 1608 * to determine for example whether to calculate timestamps for packets 1609 * or not, do not use instead of filter flags! 1610 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only). 1611 * This is the power save mode defined by IEEE 802.11-2007 section 11.2, 1612 * meaning that the hardware still wakes up for beacons, is able to 1613 * transmit frames and receive the possible acknowledgment frames. 1614 * Not to be confused with hardware specific wakeup/sleep states, 1615 * driver is responsible for that. See the section "Powersave support" 1616 * for more. 1617 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set 1618 * the driver should be prepared to handle configuration requests but 1619 * may turn the device off as much as possible. Typically, this flag will 1620 * be set when an interface is set UP but not associated or scanning, but 1621 * it can also be unset in that case when monitor interfaces are active. 1622 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main 1623 * operating channel. 1624 */ 1625 enum ieee80211_conf_flags { 1626 IEEE80211_CONF_MONITOR = (1<<0), 1627 IEEE80211_CONF_PS = (1<<1), 1628 IEEE80211_CONF_IDLE = (1<<2), 1629 IEEE80211_CONF_OFFCHANNEL = (1<<3), 1630 }; 1631 1632 1633 /** 1634 * enum ieee80211_conf_changed - denotes which configuration changed 1635 * 1636 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed 1637 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed 1638 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed 1639 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed 1640 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed 1641 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed 1642 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed 1643 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed 1644 * Note that this is only valid if channel contexts are not used, 1645 * otherwise each channel context has the number of chains listed. 1646 */ 1647 enum ieee80211_conf_changed { 1648 IEEE80211_CONF_CHANGE_SMPS = BIT(1), 1649 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2), 1650 IEEE80211_CONF_CHANGE_MONITOR = BIT(3), 1651 IEEE80211_CONF_CHANGE_PS = BIT(4), 1652 IEEE80211_CONF_CHANGE_POWER = BIT(5), 1653 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6), 1654 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7), 1655 IEEE80211_CONF_CHANGE_IDLE = BIT(8), 1656 }; 1657 1658 /** 1659 * enum ieee80211_smps_mode - spatial multiplexing power save mode 1660 * 1661 * @IEEE80211_SMPS_AUTOMATIC: automatic 1662 * @IEEE80211_SMPS_OFF: off 1663 * @IEEE80211_SMPS_STATIC: static 1664 * @IEEE80211_SMPS_DYNAMIC: dynamic 1665 * @IEEE80211_SMPS_NUM_MODES: internal, don't use 1666 */ 1667 enum ieee80211_smps_mode { 1668 IEEE80211_SMPS_AUTOMATIC, 1669 IEEE80211_SMPS_OFF, 1670 IEEE80211_SMPS_STATIC, 1671 IEEE80211_SMPS_DYNAMIC, 1672 1673 /* keep last */ 1674 IEEE80211_SMPS_NUM_MODES, 1675 }; 1676 1677 /** 1678 * struct ieee80211_conf - configuration of the device 1679 * 1680 * This struct indicates how the driver shall configure the hardware. 1681 * 1682 * @flags: configuration flags defined above 1683 * 1684 * @listen_interval: listen interval in units of beacon interval 1685 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use 1686 * in power saving. Power saving will not be enabled until a beacon 1687 * has been received and the DTIM period is known. 1688 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the 1689 * powersave documentation below. This variable is valid only when 1690 * the CONF_PS flag is set. 1691 * 1692 * @power_level: requested transmit power (in dBm), backward compatibility 1693 * value only that is set to the minimum of all interfaces 1694 * 1695 * @chandef: the channel definition to tune to 1696 * @radar_enabled: whether radar detection is enabled 1697 * 1698 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame 1699 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11, 1700 * but actually means the number of transmissions not the number of retries 1701 * @short_frame_max_tx_count: Maximum number of transmissions for a "short" 1702 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the 1703 * number of transmissions not the number of retries 1704 * 1705 * @smps_mode: spatial multiplexing powersave mode; note that 1706 * %IEEE80211_SMPS_STATIC is used when the device is not 1707 * configured for an HT channel. 1708 * Note that this is only valid if channel contexts are not used, 1709 * otherwise each channel context has the number of chains listed. 1710 */ 1711 struct ieee80211_conf { 1712 u32 flags; 1713 int power_level, dynamic_ps_timeout; 1714 1715 u16 listen_interval; 1716 u8 ps_dtim_period; 1717 1718 u8 long_frame_max_tx_count, short_frame_max_tx_count; 1719 1720 struct cfg80211_chan_def chandef; 1721 bool radar_enabled; 1722 enum ieee80211_smps_mode smps_mode; 1723 }; 1724 1725 /** 1726 * struct ieee80211_channel_switch - holds the channel switch data 1727 * 1728 * The information provided in this structure is required for channel switch 1729 * operation. 1730 * 1731 * @timestamp: value in microseconds of the 64-bit Time Synchronization 1732 * Function (TSF) timer when the frame containing the channel switch 1733 * announcement was received. This is simply the rx.mactime parameter 1734 * the driver passed into mac80211. 1735 * @device_timestamp: arbitrary timestamp for the device, this is the 1736 * rx.device_timestamp parameter the driver passed to mac80211. 1737 * @block_tx: Indicates whether transmission must be blocked before the 1738 * scheduled channel switch, as indicated by the AP. 1739 * @chandef: the new channel to switch to 1740 * @count: the number of TBTT's until the channel switch event 1741 * @delay: maximum delay between the time the AP transmitted the last beacon in 1742 * current channel and the expected time of the first beacon in the new 1743 * channel, expressed in TU. 1744 */ 1745 struct ieee80211_channel_switch { 1746 u64 timestamp; 1747 u32 device_timestamp; 1748 bool block_tx; 1749 struct cfg80211_chan_def chandef; 1750 u8 count; 1751 u32 delay; 1752 }; 1753 1754 /** 1755 * enum ieee80211_vif_flags - virtual interface flags 1756 * 1757 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering 1758 * on this virtual interface to avoid unnecessary CPU wakeups 1759 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality 1760 * monitoring on this virtual interface -- i.e. it can monitor 1761 * connection quality related parameters, such as the RSSI level and 1762 * provide notifications if configured trigger levels are reached. 1763 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this 1764 * interface. This flag should be set during interface addition, 1765 * but may be set/cleared as late as authentication to an AP. It is 1766 * only valid for managed/station mode interfaces. 1767 * @IEEE80211_VIF_GET_NOA_UPDATE: request to handle NOA attributes 1768 * and send P2P_PS notification to the driver if NOA changed, even 1769 * this is not pure P2P vif. 1770 * @IEEE80211_VIF_DISABLE_SMPS_OVERRIDE: disable user configuration of 1771 * SMPS mode via debugfs. 1772 */ 1773 enum ieee80211_vif_flags { 1774 IEEE80211_VIF_BEACON_FILTER = BIT(0), 1775 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1), 1776 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2), 1777 IEEE80211_VIF_GET_NOA_UPDATE = BIT(3), 1778 IEEE80211_VIF_DISABLE_SMPS_OVERRIDE = BIT(4), 1779 }; 1780 1781 1782 /** 1783 * enum ieee80211_offload_flags - virtual interface offload flags 1784 * 1785 * @IEEE80211_OFFLOAD_ENCAP_ENABLED: tx encapsulation offload is enabled 1786 * The driver supports sending frames passed as 802.3 frames by mac80211. 1787 * It must also support sending 802.11 packets for the same interface. 1788 * @IEEE80211_OFFLOAD_ENCAP_4ADDR: support 4-address mode encapsulation offload 1789 * @IEEE80211_OFFLOAD_DECAP_ENABLED: rx encapsulation offload is enabled 1790 * The driver supports passing received 802.11 frames as 802.3 frames to 1791 * mac80211. 1792 */ 1793 1794 enum ieee80211_offload_flags { 1795 IEEE80211_OFFLOAD_ENCAP_ENABLED = BIT(0), 1796 IEEE80211_OFFLOAD_ENCAP_4ADDR = BIT(1), 1797 IEEE80211_OFFLOAD_DECAP_ENABLED = BIT(2), 1798 }; 1799 1800 /** 1801 * struct ieee80211_vif_cfg - interface configuration 1802 * @assoc: association status 1803 * @ibss_joined: indicates whether this station is part of an IBSS or not 1804 * @ibss_creator: indicates if a new IBSS network is being created 1805 * @ps: power-save mode (STA only). This flag is NOT affected by 1806 * offchannel/dynamic_ps operations. 1807 * @aid: association ID number, valid only when @assoc is true 1808 * @eml_cap: EML capabilities as described in P802.11be_D2.2 Figure 9-1002k. 1809 * @eml_med_sync_delay: Medium Synchronization delay as described in 1810 * P802.11be_D2.2 Figure 9-1002j. 1811 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The 1812 * may filter ARP queries targeted for other addresses than listed here. 1813 * The driver must allow ARP queries targeted for all address listed here 1814 * to pass through. An empty list implies no ARP queries need to pass. 1815 * @arp_addr_cnt: Number of addresses currently on the list. Note that this 1816 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list 1817 * array size), it's up to the driver what to do in that case. 1818 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode. 1819 * @ssid_len: Length of SSID given in @ssid. 1820 * @s1g: BSS is S1G BSS (affects Association Request format). 1821 * @idle: This interface is idle. There's also a global idle flag in the 1822 * hardware config which may be more appropriate depending on what 1823 * your driver/device needs to do. 1824 * @ap_addr: AP MLD address, or BSSID for non-MLO connections 1825 * (station mode only) 1826 */ 1827 struct ieee80211_vif_cfg { 1828 /* association related data */ 1829 bool assoc, ibss_joined; 1830 bool ibss_creator; 1831 bool ps; 1832 u16 aid; 1833 u16 eml_cap; 1834 u16 eml_med_sync_delay; 1835 1836 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN]; 1837 int arp_addr_cnt; 1838 u8 ssid[IEEE80211_MAX_SSID_LEN]; 1839 size_t ssid_len; 1840 bool s1g; 1841 bool idle; 1842 u8 ap_addr[ETH_ALEN] __aligned(2); 1843 }; 1844 1845 /** 1846 * struct ieee80211_vif - per-interface data 1847 * 1848 * Data in this structure is continually present for driver 1849 * use during the life of a virtual interface. 1850 * 1851 * @type: type of this virtual interface 1852 * @cfg: vif configuration, see &struct ieee80211_vif_cfg 1853 * @bss_conf: BSS configuration for this interface, either our own 1854 * or the BSS we're associated to 1855 * @link_conf: in case of MLD, the per-link BSS configuration, 1856 * indexed by link ID 1857 * @valid_links: bitmap of valid links, or 0 for non-MLO. 1858 * @active_links: The bitmap of active links, or 0 for non-MLO. 1859 * The driver shouldn't change this directly, but use the 1860 * API calls meant for that purpose. 1861 * @dormant_links: bitmap of valid but disabled links, or 0 for non-MLO. 1862 * Must be a subset of valid_links. 1863 * @addr: address of this interface 1864 * @p2p: indicates whether this AP or STA interface is a p2p 1865 * interface, i.e. a GO or p2p-sta respectively 1866 * @netdev_features: tx netdev features supported by the hardware for this 1867 * vif. mac80211 initializes this to hw->netdev_features, and the driver 1868 * can mask out specific tx features. mac80211 will handle software fixup 1869 * for masked offloads (GSO, CSUM) 1870 * @driver_flags: flags/capabilities the driver has for this interface, 1871 * these need to be set (or cleared) when the interface is added 1872 * or, if supported by the driver, the interface type is changed 1873 * at runtime, mac80211 will never touch this field 1874 * @offload_flags: hardware offload capabilities/flags for this interface. 1875 * These are initialized by mac80211 before calling .add_interface, 1876 * .change_interface or .update_vif_offload and updated by the driver 1877 * within these ops, based on supported features or runtime change 1878 * restrictions. 1879 * @hw_queue: hardware queue for each AC 1880 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only 1881 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per 1882 * interface debug files. Note that it will be NULL for the virtual 1883 * monitor interface (if that is requested.) 1884 * @probe_req_reg: probe requests should be reported to mac80211 for this 1885 * interface. 1886 * @rx_mcast_action_reg: multicast Action frames should be reported to mac80211 1887 * for this interface. 1888 * @drv_priv: data area for driver use, will always be aligned to 1889 * sizeof(void \*). 1890 * @txq: the multicast data TX queue 1891 * @offload_flags: 802.3 -> 802.11 enapsulation offload flags, see 1892 * &enum ieee80211_offload_flags. 1893 * @mbssid_tx_vif: Pointer to the transmitting interface if MBSSID is enabled. 1894 */ 1895 struct ieee80211_vif { 1896 enum nl80211_iftype type; 1897 struct ieee80211_vif_cfg cfg; 1898 struct ieee80211_bss_conf bss_conf; 1899 struct ieee80211_bss_conf __rcu *link_conf[IEEE80211_MLD_MAX_NUM_LINKS]; 1900 u16 valid_links, active_links, dormant_links; 1901 u8 addr[ETH_ALEN] __aligned(2); 1902 bool p2p; 1903 1904 u8 cab_queue; 1905 u8 hw_queue[IEEE80211_NUM_ACS]; 1906 1907 struct ieee80211_txq *txq; 1908 1909 netdev_features_t netdev_features; 1910 u32 driver_flags; 1911 u32 offload_flags; 1912 1913 #ifdef CONFIG_MAC80211_DEBUGFS 1914 struct dentry *debugfs_dir; 1915 #endif 1916 1917 bool probe_req_reg; 1918 bool rx_mcast_action_reg; 1919 1920 struct ieee80211_vif *mbssid_tx_vif; 1921 1922 /* must be last */ 1923 u8 drv_priv[] __aligned(sizeof(void *)); 1924 }; 1925 1926 /** 1927 * ieee80211_vif_usable_links - Return the usable links for the vif 1928 * @vif: the vif for which the usable links are requested 1929 * Return: the usable link bitmap 1930 */ 1931 static inline u16 ieee80211_vif_usable_links(const struct ieee80211_vif *vif) 1932 { 1933 return vif->valid_links & ~vif->dormant_links; 1934 } 1935 1936 /** 1937 * ieee80211_vif_is_mld - Returns true iff the vif is an MLD one 1938 * @vif: the vif 1939 * Return: %true if the vif is an MLD, %false otherwise. 1940 */ 1941 static inline bool ieee80211_vif_is_mld(const struct ieee80211_vif *vif) 1942 { 1943 /* valid_links != 0 indicates this vif is an MLD */ 1944 return vif->valid_links != 0; 1945 } 1946 1947 #define for_each_vif_active_link(vif, link, link_id) \ 1948 for (link_id = 0; link_id < ARRAY_SIZE((vif)->link_conf); link_id++) \ 1949 if ((!(vif)->active_links || \ 1950 (vif)->active_links & BIT(link_id)) && \ 1951 (link = link_conf_dereference_check(vif, link_id))) 1952 1953 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif) 1954 { 1955 #ifdef CONFIG_MAC80211_MESH 1956 return vif->type == NL80211_IFTYPE_MESH_POINT; 1957 #endif 1958 return false; 1959 } 1960 1961 /** 1962 * wdev_to_ieee80211_vif - return a vif struct from a wdev 1963 * @wdev: the wdev to get the vif for 1964 * 1965 * This can be used by mac80211 drivers with direct cfg80211 APIs 1966 * (like the vendor commands) that get a wdev. 1967 * 1968 * Note that this function may return %NULL if the given wdev isn't 1969 * associated with a vif that the driver knows about (e.g. monitor 1970 * or AP_VLAN interfaces.) 1971 */ 1972 struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev); 1973 1974 /** 1975 * ieee80211_vif_to_wdev - return a wdev struct from a vif 1976 * @vif: the vif to get the wdev for 1977 * 1978 * This can be used by mac80211 drivers with direct cfg80211 APIs 1979 * (like the vendor commands) that needs to get the wdev for a vif. 1980 * This can also be useful to get the netdev associated to a vif. 1981 */ 1982 struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif); 1983 1984 static inline bool lockdep_vif_wiphy_mutex_held(struct ieee80211_vif *vif) 1985 { 1986 return lockdep_is_held(&ieee80211_vif_to_wdev(vif)->wiphy->mtx); 1987 } 1988 1989 #define link_conf_dereference_protected(vif, link_id) \ 1990 rcu_dereference_protected((vif)->link_conf[link_id], \ 1991 lockdep_vif_wiphy_mutex_held(vif)) 1992 1993 #define link_conf_dereference_check(vif, link_id) \ 1994 rcu_dereference_check((vif)->link_conf[link_id], \ 1995 lockdep_vif_wiphy_mutex_held(vif)) 1996 1997 /** 1998 * enum ieee80211_key_flags - key flags 1999 * 2000 * These flags are used for communication about keys between the driver 2001 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf. 2002 * 2003 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the 2004 * driver to indicate that it requires IV generation for this 2005 * particular key. Setting this flag does not necessarily mean that SKBs 2006 * will have sufficient tailroom for ICV or MIC. 2007 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by 2008 * the driver for a TKIP key if it requires Michael MIC 2009 * generation in software. 2010 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates 2011 * that the key is pairwise rather then a shared key. 2012 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a 2013 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames 2014 * (MFP) to be done in software. 2015 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver 2016 * if space should be prepared for the IV, but the IV 2017 * itself should not be generated. Do not set together with 2018 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does 2019 * not necessarily mean that SKBs will have sufficient tailroom for ICV or 2020 * MIC. 2021 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received 2022 * management frames. The flag can help drivers that have a hardware 2023 * crypto implementation that doesn't deal with management frames 2024 * properly by allowing them to not upload the keys to hardware and 2025 * fall back to software crypto. Note that this flag deals only with 2026 * RX, if your crypto engine can't deal with TX you can also set the 2027 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW. 2028 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the 2029 * driver for a CCMP/GCMP key to indicate that is requires IV generation 2030 * only for management frames (MFP). 2031 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the 2032 * driver for a key to indicate that sufficient tailroom must always 2033 * be reserved for ICV or MIC, even when HW encryption is enabled. 2034 * @IEEE80211_KEY_FLAG_PUT_MIC_SPACE: This flag should be set by the driver for 2035 * a TKIP key if it only requires MIC space. Do not set together with 2036 * @IEEE80211_KEY_FLAG_GENERATE_MMIC on the same key. 2037 * @IEEE80211_KEY_FLAG_NO_AUTO_TX: Key needs explicit Tx activation. 2038 * @IEEE80211_KEY_FLAG_GENERATE_MMIE: This flag should be set by the driver 2039 * for a AES_CMAC key to indicate that it requires sequence number 2040 * generation only 2041 */ 2042 enum ieee80211_key_flags { 2043 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0), 2044 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1), 2045 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2), 2046 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3), 2047 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4), 2048 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5), 2049 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6), 2050 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7), 2051 IEEE80211_KEY_FLAG_PUT_MIC_SPACE = BIT(8), 2052 IEEE80211_KEY_FLAG_NO_AUTO_TX = BIT(9), 2053 IEEE80211_KEY_FLAG_GENERATE_MMIE = BIT(10), 2054 }; 2055 2056 /** 2057 * struct ieee80211_key_conf - key information 2058 * 2059 * This key information is given by mac80211 to the driver by 2060 * the set_key() callback in &struct ieee80211_ops. 2061 * 2062 * @hw_key_idx: To be set by the driver, this is the key index the driver 2063 * wants to be given when a frame is transmitted and needs to be 2064 * encrypted in hardware. 2065 * @cipher: The key's cipher suite selector. 2066 * @tx_pn: PN used for TX keys, may be used by the driver as well if it 2067 * needs to do software PN assignment by itself (e.g. due to TSO) 2068 * @flags: key flags, see &enum ieee80211_key_flags. 2069 * @keyidx: the key index (0-3) 2070 * @keylen: key material length 2071 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte) 2072 * data block: 2073 * - Temporal Encryption Key (128 bits) 2074 * - Temporal Authenticator Tx MIC Key (64 bits) 2075 * - Temporal Authenticator Rx MIC Key (64 bits) 2076 * @icv_len: The ICV length for this key type 2077 * @iv_len: The IV length for this key type 2078 * @link_id: the link ID for MLO, or -1 for non-MLO or pairwise keys 2079 */ 2080 struct ieee80211_key_conf { 2081 atomic64_t tx_pn; 2082 u32 cipher; 2083 u8 icv_len; 2084 u8 iv_len; 2085 u8 hw_key_idx; 2086 s8 keyidx; 2087 u16 flags; 2088 s8 link_id; 2089 u8 keylen; 2090 u8 key[]; 2091 }; 2092 2093 #define IEEE80211_MAX_PN_LEN 16 2094 2095 #define TKIP_PN_TO_IV16(pn) ((u16)(pn & 0xffff)) 2096 #define TKIP_PN_TO_IV32(pn) ((u32)((pn >> 16) & 0xffffffff)) 2097 2098 /** 2099 * struct ieee80211_key_seq - key sequence counter 2100 * 2101 * @tkip: TKIP data, containing IV32 and IV16 in host byte order 2102 * @ccmp: PN data, most significant byte first (big endian, 2103 * reverse order than in packet) 2104 * @aes_cmac: PN data, most significant byte first (big endian, 2105 * reverse order than in packet) 2106 * @aes_gmac: PN data, most significant byte first (big endian, 2107 * reverse order than in packet) 2108 * @gcmp: PN data, most significant byte first (big endian, 2109 * reverse order than in packet) 2110 * @hw: data for HW-only (e.g. cipher scheme) keys 2111 */ 2112 struct ieee80211_key_seq { 2113 union { 2114 struct { 2115 u32 iv32; 2116 u16 iv16; 2117 } tkip; 2118 struct { 2119 u8 pn[6]; 2120 } ccmp; 2121 struct { 2122 u8 pn[6]; 2123 } aes_cmac; 2124 struct { 2125 u8 pn[6]; 2126 } aes_gmac; 2127 struct { 2128 u8 pn[6]; 2129 } gcmp; 2130 struct { 2131 u8 seq[IEEE80211_MAX_PN_LEN]; 2132 u8 seq_len; 2133 } hw; 2134 }; 2135 }; 2136 2137 /** 2138 * enum set_key_cmd - key command 2139 * 2140 * Used with the set_key() callback in &struct ieee80211_ops, this 2141 * indicates whether a key is being removed or added. 2142 * 2143 * @SET_KEY: a key is set 2144 * @DISABLE_KEY: a key must be disabled 2145 */ 2146 enum set_key_cmd { 2147 SET_KEY, DISABLE_KEY, 2148 }; 2149 2150 /** 2151 * enum ieee80211_sta_state - station state 2152 * 2153 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all, 2154 * this is a special state for add/remove transitions 2155 * @IEEE80211_STA_NONE: station exists without special state 2156 * @IEEE80211_STA_AUTH: station is authenticated 2157 * @IEEE80211_STA_ASSOC: station is associated 2158 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X) 2159 */ 2160 enum ieee80211_sta_state { 2161 /* NOTE: These need to be ordered correctly! */ 2162 IEEE80211_STA_NOTEXIST, 2163 IEEE80211_STA_NONE, 2164 IEEE80211_STA_AUTH, 2165 IEEE80211_STA_ASSOC, 2166 IEEE80211_STA_AUTHORIZED, 2167 }; 2168 2169 /** 2170 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth 2171 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz 2172 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz 2173 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz 2174 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz 2175 * (including 80+80 MHz) 2176 * @IEEE80211_STA_RX_BW_320: station can receive up to 320 MHz 2177 * 2178 * Implementation note: 20 must be zero to be initialized 2179 * correctly, the values must be sorted. 2180 */ 2181 enum ieee80211_sta_rx_bandwidth { 2182 IEEE80211_STA_RX_BW_20 = 0, 2183 IEEE80211_STA_RX_BW_40, 2184 IEEE80211_STA_RX_BW_80, 2185 IEEE80211_STA_RX_BW_160, 2186 IEEE80211_STA_RX_BW_320, 2187 }; 2188 2189 /** 2190 * struct ieee80211_sta_rates - station rate selection table 2191 * 2192 * @rcu_head: RCU head used for freeing the table on update 2193 * @rate: transmit rates/flags to be used by default. 2194 * Overriding entries per-packet is possible by using cb tx control. 2195 */ 2196 struct ieee80211_sta_rates { 2197 struct rcu_head rcu_head; 2198 struct { 2199 s8 idx; 2200 u8 count; 2201 u8 count_cts; 2202 u8 count_rts; 2203 u16 flags; 2204 } rate[IEEE80211_TX_RATE_TABLE_SIZE]; 2205 }; 2206 2207 /** 2208 * struct ieee80211_sta_txpwr - station txpower configuration 2209 * 2210 * Used to configure txpower for station. 2211 * 2212 * @power: indicates the tx power, in dBm, to be used when sending data frames 2213 * to the STA. 2214 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power 2215 * will be less than or equal to specified from userspace, whereas if TPC 2216 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power. 2217 * NL80211_TX_POWER_FIXED is not a valid configuration option for 2218 * per peer TPC. 2219 */ 2220 struct ieee80211_sta_txpwr { 2221 s16 power; 2222 enum nl80211_tx_power_setting type; 2223 }; 2224 2225 /** 2226 * struct ieee80211_sta_aggregates - info that is aggregated from active links 2227 * 2228 * Used for any per-link data that needs to be aggregated and updated in the 2229 * main &struct ieee80211_sta when updated or the active links change. 2230 * 2231 * @max_amsdu_len: indicates the maximal length of an A-MSDU in bytes. 2232 * This field is always valid for packets with a VHT preamble. 2233 * For packets with a HT preamble, additional limits apply: 2234 * 2235 * * If the skb is transmitted as part of a BA agreement, the 2236 * A-MSDU maximal size is min(max_amsdu_len, 4065) bytes. 2237 * * If the skb is not part of a BA agreement, the A-MSDU maximal 2238 * size is min(max_amsdu_len, 7935) bytes. 2239 * 2240 * Both additional HT limits must be enforced by the low level 2241 * driver. This is defined by the spec (IEEE 802.11-2012 section 2242 * 8.3.2.2 NOTE 2). 2243 * @max_rc_amsdu_len: Maximum A-MSDU size in bytes recommended by rate control. 2244 * @max_tid_amsdu_len: Maximum A-MSDU size in bytes for this TID 2245 */ 2246 struct ieee80211_sta_aggregates { 2247 u16 max_amsdu_len; 2248 2249 u16 max_rc_amsdu_len; 2250 u16 max_tid_amsdu_len[IEEE80211_NUM_TIDS]; 2251 }; 2252 2253 /** 2254 * struct ieee80211_link_sta - station Link specific info 2255 * All link specific info for a STA link for a non MLD STA(single) 2256 * or a MLD STA(multiple entries) are stored here. 2257 * 2258 * @sta: reference to owning STA 2259 * @addr: MAC address of the Link STA. For non-MLO STA this is same as the addr 2260 * in ieee80211_sta. For MLO Link STA this addr can be same or different 2261 * from addr in ieee80211_sta (representing MLD STA addr) 2262 * @link_id: the link ID for this link STA (0 for deflink) 2263 * @smps_mode: current SMPS mode (off, static or dynamic) 2264 * @supp_rates: Bitmap of supported rates 2265 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities 2266 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities 2267 * @he_cap: HE capabilities of this STA 2268 * @he_6ghz_capa: on 6 GHz, holds the HE 6 GHz band capabilities 2269 * @eht_cap: EHT capabilities of this STA 2270 * @agg: per-link data for multi-link aggregation 2271 * @bandwidth: current bandwidth the station can receive with 2272 * @rx_nss: in HT/VHT, the maximum number of spatial streams the 2273 * station can receive at the moment, changed by operating mode 2274 * notifications and capabilities. The value is only valid after 2275 * the station moves to associated state. 2276 * @txpwr: the station tx power configuration 2277 * 2278 */ 2279 struct ieee80211_link_sta { 2280 struct ieee80211_sta *sta; 2281 2282 u8 addr[ETH_ALEN]; 2283 u8 link_id; 2284 enum ieee80211_smps_mode smps_mode; 2285 2286 u32 supp_rates[NUM_NL80211_BANDS]; 2287 struct ieee80211_sta_ht_cap ht_cap; 2288 struct ieee80211_sta_vht_cap vht_cap; 2289 struct ieee80211_sta_he_cap he_cap; 2290 struct ieee80211_he_6ghz_capa he_6ghz_capa; 2291 struct ieee80211_sta_eht_cap eht_cap; 2292 2293 struct ieee80211_sta_aggregates agg; 2294 2295 u8 rx_nss; 2296 enum ieee80211_sta_rx_bandwidth bandwidth; 2297 struct ieee80211_sta_txpwr txpwr; 2298 }; 2299 2300 /** 2301 * struct ieee80211_sta - station table entry 2302 * 2303 * A station table entry represents a station we are possibly 2304 * communicating with. Since stations are RCU-managed in 2305 * mac80211, any ieee80211_sta pointer you get access to must 2306 * either be protected by rcu_read_lock() explicitly or implicitly, 2307 * or you must take good care to not use such a pointer after a 2308 * call to your sta_remove callback that removed it. 2309 * This also represents the MLD STA in case of MLO association 2310 * and holds pointers to various link STA's 2311 * 2312 * @addr: MAC address 2313 * @aid: AID we assigned to the station if we're an AP 2314 * @max_rx_aggregation_subframes: maximal amount of frames in a single AMPDU 2315 * that this station is allowed to transmit to us. 2316 * Can be modified by driver. 2317 * @wme: indicates whether the STA supports QoS/WME (if local devices does, 2318 * otherwise always false) 2319 * @drv_priv: data area for driver use, will always be aligned to 2320 * sizeof(void \*), size is determined in hw information. 2321 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid 2322 * if wme is supported. The bits order is like in 2323 * IEEE80211_WMM_IE_STA_QOSINFO_AC_*. 2324 * @max_sp: max Service Period. Only valid if wme is supported. 2325 * @rates: rate control selection table 2326 * @tdls: indicates whether the STA is a TDLS peer 2327 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only 2328 * valid if the STA is a TDLS peer in the first place. 2329 * @mfp: indicates whether the STA uses management frame protection or not. 2330 * @mlo: indicates whether the STA is MLO station. 2331 * @max_amsdu_subframes: indicates the maximal number of MSDUs in a single 2332 * A-MSDU. Taken from the Extended Capabilities element. 0 means 2333 * unlimited. 2334 * @cur: currently valid data as aggregated from the active links 2335 * For non MLO STA it will point to the deflink data. For MLO STA 2336 * ieee80211_sta_recalc_aggregates() must be called to update it. 2337 * @support_p2p_ps: indicates whether the STA supports P2P PS mechanism or not. 2338 * @txq: per-TID data TX queues; note that the last entry (%IEEE80211_NUM_TIDS) 2339 * is used for non-data frames 2340 * @deflink: This holds the default link STA information, for non MLO STA all link 2341 * specific STA information is accessed through @deflink or through 2342 * link[0] which points to address of @deflink. For MLO Link STA 2343 * the first added link STA will point to deflink. 2344 * @link: reference to Link Sta entries. For Non MLO STA, except 1st link, 2345 * i.e link[0] all links would be assigned to NULL by default and 2346 * would access link information via @deflink or link[0]. For MLO 2347 * STA, first link STA being added will point its link pointer to 2348 * @deflink address and remaining would be allocated and the address 2349 * would be assigned to link[link_id] where link_id is the id assigned 2350 * by the AP. 2351 * @valid_links: bitmap of valid links, or 0 for non-MLO 2352 */ 2353 struct ieee80211_sta { 2354 u8 addr[ETH_ALEN]; 2355 u16 aid; 2356 u16 max_rx_aggregation_subframes; 2357 bool wme; 2358 u8 uapsd_queues; 2359 u8 max_sp; 2360 struct ieee80211_sta_rates __rcu *rates; 2361 bool tdls; 2362 bool tdls_initiator; 2363 bool mfp; 2364 bool mlo; 2365 u8 max_amsdu_subframes; 2366 2367 struct ieee80211_sta_aggregates *cur; 2368 2369 bool support_p2p_ps; 2370 2371 struct ieee80211_txq *txq[IEEE80211_NUM_TIDS + 1]; 2372 2373 u16 valid_links; 2374 struct ieee80211_link_sta deflink; 2375 struct ieee80211_link_sta __rcu *link[IEEE80211_MLD_MAX_NUM_LINKS]; 2376 2377 /* must be last */ 2378 u8 drv_priv[] __aligned(sizeof(void *)); 2379 }; 2380 2381 #ifdef CONFIG_LOCKDEP 2382 bool lockdep_sta_mutex_held(struct ieee80211_sta *pubsta); 2383 #else 2384 static inline bool lockdep_sta_mutex_held(struct ieee80211_sta *pubsta) 2385 { 2386 return true; 2387 } 2388 #endif 2389 2390 #define link_sta_dereference_protected(sta, link_id) \ 2391 rcu_dereference_protected((sta)->link[link_id], \ 2392 lockdep_sta_mutex_held(sta)) 2393 2394 #define link_sta_dereference_check(sta, link_id) \ 2395 rcu_dereference_check((sta)->link[link_id], \ 2396 lockdep_sta_mutex_held(sta)) 2397 2398 #define for_each_sta_active_link(vif, sta, link_sta, link_id) \ 2399 for (link_id = 0; link_id < ARRAY_SIZE((sta)->link); link_id++) \ 2400 if ((!(vif)->active_links || \ 2401 (vif)->active_links & BIT(link_id)) && \ 2402 ((link_sta) = link_sta_dereference_check(sta, link_id))) 2403 2404 /** 2405 * enum sta_notify_cmd - sta notify command 2406 * 2407 * Used with the sta_notify() callback in &struct ieee80211_ops, this 2408 * indicates if an associated station made a power state transition. 2409 * 2410 * @STA_NOTIFY_SLEEP: a station is now sleeping 2411 * @STA_NOTIFY_AWAKE: a sleeping station woke up 2412 */ 2413 enum sta_notify_cmd { 2414 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE, 2415 }; 2416 2417 /** 2418 * struct ieee80211_tx_control - TX control data 2419 * 2420 * @sta: station table entry, this sta pointer may be NULL and 2421 * it is not allowed to copy the pointer, due to RCU. 2422 */ 2423 struct ieee80211_tx_control { 2424 struct ieee80211_sta *sta; 2425 }; 2426 2427 /** 2428 * struct ieee80211_txq - Software intermediate tx queue 2429 * 2430 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 2431 * @sta: station table entry, %NULL for per-vif queue 2432 * @tid: the TID for this queue (unused for per-vif queue), 2433 * %IEEE80211_NUM_TIDS for non-data (if enabled) 2434 * @ac: the AC for this queue 2435 * @drv_priv: driver private area, sized by hw->txq_data_size 2436 * 2437 * The driver can obtain packets from this queue by calling 2438 * ieee80211_tx_dequeue(). 2439 */ 2440 struct ieee80211_txq { 2441 struct ieee80211_vif *vif; 2442 struct ieee80211_sta *sta; 2443 u8 tid; 2444 u8 ac; 2445 2446 /* must be last */ 2447 u8 drv_priv[] __aligned(sizeof(void *)); 2448 }; 2449 2450 /** 2451 * enum ieee80211_hw_flags - hardware flags 2452 * 2453 * These flags are used to indicate hardware capabilities to 2454 * the stack. Generally, flags here should have their meaning 2455 * done in a way that the simplest hardware doesn't need setting 2456 * any particular flags. There are some exceptions to this rule, 2457 * however, so you are advised to review these flags carefully. 2458 * 2459 * @IEEE80211_HW_HAS_RATE_CONTROL: 2460 * The hardware or firmware includes rate control, and cannot be 2461 * controlled by the stack. As such, no rate control algorithm 2462 * should be instantiated, and the TX rate reported to userspace 2463 * will be taken from the TX status instead of the rate control 2464 * algorithm. 2465 * Note that this requires that the driver implement a number of 2466 * callbacks so it has the correct information, it needs to have 2467 * the @set_rts_threshold callback and must look at the BSS config 2468 * @use_cts_prot for G/N protection, @use_short_slot for slot 2469 * timing in 2.4 GHz and @use_short_preamble for preambles for 2470 * CCK frames. 2471 * 2472 * @IEEE80211_HW_RX_INCLUDES_FCS: 2473 * Indicates that received frames passed to the stack include 2474 * the FCS at the end. 2475 * 2476 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING: 2477 * Some wireless LAN chipsets buffer broadcast/multicast frames 2478 * for power saving stations in the hardware/firmware and others 2479 * rely on the host system for such buffering. This option is used 2480 * to configure the IEEE 802.11 upper layer to buffer broadcast and 2481 * multicast frames when there are power saving stations so that 2482 * the driver can fetch them with ieee80211_get_buffered_bc(). 2483 * 2484 * @IEEE80211_HW_SIGNAL_UNSPEC: 2485 * Hardware can provide signal values but we don't know its units. We 2486 * expect values between 0 and @max_signal. 2487 * If possible please provide dB or dBm instead. 2488 * 2489 * @IEEE80211_HW_SIGNAL_DBM: 2490 * Hardware gives signal values in dBm, decibel difference from 2491 * one milliwatt. This is the preferred method since it is standardized 2492 * between different devices. @max_signal does not need to be set. 2493 * 2494 * @IEEE80211_HW_SPECTRUM_MGMT: 2495 * Hardware supports spectrum management defined in 802.11h 2496 * Measurement, Channel Switch, Quieting, TPC 2497 * 2498 * @IEEE80211_HW_AMPDU_AGGREGATION: 2499 * Hardware supports 11n A-MPDU aggregation. 2500 * 2501 * @IEEE80211_HW_SUPPORTS_PS: 2502 * Hardware has power save support (i.e. can go to sleep). 2503 * 2504 * @IEEE80211_HW_PS_NULLFUNC_STACK: 2505 * Hardware requires nullfunc frame handling in stack, implies 2506 * stack support for dynamic PS. 2507 * 2508 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS: 2509 * Hardware has support for dynamic PS. 2510 * 2511 * @IEEE80211_HW_MFP_CAPABLE: 2512 * Hardware supports management frame protection (MFP, IEEE 802.11w). 2513 * 2514 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS: 2515 * Hardware can provide ack status reports of Tx frames to 2516 * the stack. 2517 * 2518 * @IEEE80211_HW_CONNECTION_MONITOR: 2519 * The hardware performs its own connection monitoring, including 2520 * periodic keep-alives to the AP and probing the AP on beacon loss. 2521 * 2522 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC: 2523 * This device needs to get data from beacon before association (i.e. 2524 * dtim_period). 2525 * 2526 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports 2527 * per-station GTKs as used by IBSS RSN or during fast transition. If 2528 * the device doesn't support per-station GTKs, but can be asked not 2529 * to decrypt group addressed frames, then IBSS RSN support is still 2530 * possible but software crypto will be used. Advertise the wiphy flag 2531 * only in that case. 2532 * 2533 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device 2534 * autonomously manages the PS status of connected stations. When 2535 * this flag is set mac80211 will not trigger PS mode for connected 2536 * stations based on the PM bit of incoming frames. 2537 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure 2538 * the PS mode of connected stations. 2539 * 2540 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session 2541 * setup strictly in HW. mac80211 should not attempt to do this in 2542 * software. 2543 * 2544 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of 2545 * a virtual monitor interface when monitor interfaces are the only 2546 * active interfaces. 2547 * 2548 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to 2549 * be created. It is expected user-space will create vifs as 2550 * desired (and thus have them named as desired). 2551 * 2552 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the 2553 * crypto algorithms can be done in software - so don't automatically 2554 * try to fall back to it if hardware crypto fails, but do so only if 2555 * the driver returns 1. This also forces the driver to advertise its 2556 * supported cipher suites. 2557 * 2558 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit, 2559 * this currently requires only the ability to calculate the duration 2560 * for frames. 2561 * 2562 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface 2563 * queue mapping in order to use different queues (not just one per AC) 2564 * for different virtual interfaces. See the doc section on HW queue 2565 * control for more details. 2566 * 2567 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate 2568 * selection table provided by the rate control algorithm. 2569 * 2570 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any 2571 * P2P Interface. This will be honoured even if more than one interface 2572 * is supported. 2573 * 2574 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames 2575 * only, to allow getting TBTT of a DTIM beacon. 2576 * 2577 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates 2578 * and can cope with CCK rates in an aggregation session (e.g. by not 2579 * using aggregation for such frames.) 2580 * 2581 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA) 2582 * for a single active channel while using channel contexts. When support 2583 * is not enabled the default action is to disconnect when getting the 2584 * CSA frame. 2585 * 2586 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload 2587 * or tailroom of TX skbs without copying them first. 2588 * 2589 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands 2590 * in one command, mac80211 doesn't have to run separate scans per band. 2591 * 2592 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth 2593 * than then BSS bandwidth for a TDLS link on the base channel. 2594 * 2595 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs 2596 * within A-MPDU. 2597 * 2598 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status 2599 * for sent beacons. 2600 * 2601 * @IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR: Hardware (or driver) requires that each 2602 * station has a unique address, i.e. each station entry can be identified 2603 * by just its MAC address; this prevents, for example, the same station 2604 * from connecting to two virtual AP interfaces at the same time. 2605 * 2606 * @IEEE80211_HW_SUPPORTS_REORDERING_BUFFER: Hardware (or driver) manages the 2607 * reordering buffer internally, guaranteeing mac80211 receives frames in 2608 * order and does not need to manage its own reorder buffer or BA session 2609 * timeout. 2610 * 2611 * @IEEE80211_HW_USES_RSS: The device uses RSS and thus requires parallel RX, 2612 * which implies using per-CPU station statistics. 2613 * 2614 * @IEEE80211_HW_TX_AMSDU: Hardware (or driver) supports software aggregated 2615 * A-MSDU frames. Requires software tx queueing and fast-xmit support. 2616 * When not using minstrel/minstrel_ht rate control, the driver must 2617 * limit the maximum A-MSDU size based on the current tx rate by setting 2618 * max_rc_amsdu_len in struct ieee80211_sta. 2619 * 2620 * @IEEE80211_HW_TX_FRAG_LIST: Hardware (or driver) supports sending frag_list 2621 * skbs, needed for zero-copy software A-MSDU. 2622 * 2623 * @IEEE80211_HW_REPORTS_LOW_ACK: The driver (or firmware) reports low ack event 2624 * by ieee80211_report_low_ack() based on its own algorithm. For such 2625 * drivers, mac80211 packet loss mechanism will not be triggered and driver 2626 * is completely depending on firmware event for station kickout. 2627 * 2628 * @IEEE80211_HW_SUPPORTS_TX_FRAG: Hardware does fragmentation by itself. 2629 * The stack will not do fragmentation. 2630 * The callback for @set_frag_threshold should be set as well. 2631 * 2632 * @IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA: Hardware supports buffer STA on 2633 * TDLS links. 2634 * 2635 * @IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP: The driver requires the 2636 * mgd_prepare_tx() callback to be called before transmission of a 2637 * deauthentication frame in case the association was completed but no 2638 * beacon was heard. This is required in multi-channel scenarios, where the 2639 * virtual interface might not be given air time for the transmission of 2640 * the frame, as it is not synced with the AP/P2P GO yet, and thus the 2641 * deauthentication frame might not be transmitted. 2642 * 2643 * @IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP: The driver (or firmware) doesn't 2644 * support QoS NDP for AP probing - that's most likely a driver bug. 2645 * 2646 * @IEEE80211_HW_BUFF_MMPDU_TXQ: use the TXQ for bufferable MMPDUs, this of 2647 * course requires the driver to use TXQs to start with. 2648 * 2649 * @IEEE80211_HW_SUPPORTS_VHT_EXT_NSS_BW: (Hardware) rate control supports VHT 2650 * extended NSS BW (dot11VHTExtendedNSSBWCapable). This flag will be set if 2651 * the selected rate control algorithm sets %RATE_CTRL_CAPA_VHT_EXT_NSS_BW 2652 * but if the rate control is built-in then it must be set by the driver. 2653 * See also the documentation for that flag. 2654 * 2655 * @IEEE80211_HW_STA_MMPDU_TXQ: use the extra non-TID per-station TXQ for all 2656 * MMPDUs on station interfaces. This of course requires the driver to use 2657 * TXQs to start with. 2658 * 2659 * @IEEE80211_HW_TX_STATUS_NO_AMPDU_LEN: Driver does not report accurate A-MPDU 2660 * length in tx status information 2661 * 2662 * @IEEE80211_HW_SUPPORTS_MULTI_BSSID: Hardware supports multi BSSID 2663 * 2664 * @IEEE80211_HW_SUPPORTS_ONLY_HE_MULTI_BSSID: Hardware supports multi BSSID 2665 * only for HE APs. Applies if @IEEE80211_HW_SUPPORTS_MULTI_BSSID is set. 2666 * 2667 * @IEEE80211_HW_AMPDU_KEYBORDER_SUPPORT: The card and driver is only 2668 * aggregating MPDUs with the same keyid, allowing mac80211 to keep Tx 2669 * A-MPDU sessions active while rekeying with Extended Key ID. 2670 * 2671 * @IEEE80211_HW_SUPPORTS_TX_ENCAP_OFFLOAD: Hardware supports tx encapsulation 2672 * offload 2673 * 2674 * @IEEE80211_HW_SUPPORTS_RX_DECAP_OFFLOAD: Hardware supports rx decapsulation 2675 * offload 2676 * 2677 * @IEEE80211_HW_SUPPORTS_CONC_MON_RX_DECAP: Hardware supports concurrent rx 2678 * decapsulation offload and passing raw 802.11 frames for monitor iface. 2679 * If this is supported, the driver must pass both 802.3 frames for real 2680 * usage and 802.11 frames with %RX_FLAG_ONLY_MONITOR set for monitor to 2681 * the stack. 2682 * 2683 * @IEEE80211_HW_DETECTS_COLOR_COLLISION: HW/driver has support for BSS color 2684 * collision detection and doesn't need it in software. 2685 * 2686 * @IEEE80211_HW_MLO_MCAST_MULTI_LINK_TX: Hardware/driver handles transmitting 2687 * multicast frames on all links, mac80211 should not do that. 2688 * 2689 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays 2690 */ 2691 enum ieee80211_hw_flags { 2692 IEEE80211_HW_HAS_RATE_CONTROL, 2693 IEEE80211_HW_RX_INCLUDES_FCS, 2694 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING, 2695 IEEE80211_HW_SIGNAL_UNSPEC, 2696 IEEE80211_HW_SIGNAL_DBM, 2697 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC, 2698 IEEE80211_HW_SPECTRUM_MGMT, 2699 IEEE80211_HW_AMPDU_AGGREGATION, 2700 IEEE80211_HW_SUPPORTS_PS, 2701 IEEE80211_HW_PS_NULLFUNC_STACK, 2702 IEEE80211_HW_SUPPORTS_DYNAMIC_PS, 2703 IEEE80211_HW_MFP_CAPABLE, 2704 IEEE80211_HW_WANT_MONITOR_VIF, 2705 IEEE80211_HW_NO_AUTO_VIF, 2706 IEEE80211_HW_SW_CRYPTO_CONTROL, 2707 IEEE80211_HW_SUPPORT_FAST_XMIT, 2708 IEEE80211_HW_REPORTS_TX_ACK_STATUS, 2709 IEEE80211_HW_CONNECTION_MONITOR, 2710 IEEE80211_HW_QUEUE_CONTROL, 2711 IEEE80211_HW_SUPPORTS_PER_STA_GTK, 2712 IEEE80211_HW_AP_LINK_PS, 2713 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW, 2714 IEEE80211_HW_SUPPORTS_RC_TABLE, 2715 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF, 2716 IEEE80211_HW_TIMING_BEACON_ONLY, 2717 IEEE80211_HW_SUPPORTS_HT_CCK_RATES, 2718 IEEE80211_HW_CHANCTX_STA_CSA, 2719 IEEE80211_HW_SUPPORTS_CLONED_SKBS, 2720 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS, 2721 IEEE80211_HW_TDLS_WIDER_BW, 2722 IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU, 2723 IEEE80211_HW_BEACON_TX_STATUS, 2724 IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR, 2725 IEEE80211_HW_SUPPORTS_REORDERING_BUFFER, 2726 IEEE80211_HW_USES_RSS, 2727 IEEE80211_HW_TX_AMSDU, 2728 IEEE80211_HW_TX_FRAG_LIST, 2729 IEEE80211_HW_REPORTS_LOW_ACK, 2730 IEEE80211_HW_SUPPORTS_TX_FRAG, 2731 IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA, 2732 IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP, 2733 IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP, 2734 IEEE80211_HW_BUFF_MMPDU_TXQ, 2735 IEEE80211_HW_SUPPORTS_VHT_EXT_NSS_BW, 2736 IEEE80211_HW_STA_MMPDU_TXQ, 2737 IEEE80211_HW_TX_STATUS_NO_AMPDU_LEN, 2738 IEEE80211_HW_SUPPORTS_MULTI_BSSID, 2739 IEEE80211_HW_SUPPORTS_ONLY_HE_MULTI_BSSID, 2740 IEEE80211_HW_AMPDU_KEYBORDER_SUPPORT, 2741 IEEE80211_HW_SUPPORTS_TX_ENCAP_OFFLOAD, 2742 IEEE80211_HW_SUPPORTS_RX_DECAP_OFFLOAD, 2743 IEEE80211_HW_SUPPORTS_CONC_MON_RX_DECAP, 2744 IEEE80211_HW_DETECTS_COLOR_COLLISION, 2745 IEEE80211_HW_MLO_MCAST_MULTI_LINK_TX, 2746 2747 /* keep last, obviously */ 2748 NUM_IEEE80211_HW_FLAGS 2749 }; 2750 2751 /** 2752 * struct ieee80211_hw - hardware information and state 2753 * 2754 * This structure contains the configuration and hardware 2755 * information for an 802.11 PHY. 2756 * 2757 * @wiphy: This points to the &struct wiphy allocated for this 2758 * 802.11 PHY. You must fill in the @perm_addr and @dev 2759 * members of this structure using SET_IEEE80211_DEV() 2760 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported 2761 * bands (with channels, bitrates) are registered here. 2762 * 2763 * @conf: &struct ieee80211_conf, device configuration, don't use. 2764 * 2765 * @priv: pointer to private area that was allocated for driver use 2766 * along with this structure. 2767 * 2768 * @flags: hardware flags, see &enum ieee80211_hw_flags. 2769 * 2770 * @extra_tx_headroom: headroom to reserve in each transmit skb 2771 * for use by the driver (e.g. for transmit headers.) 2772 * 2773 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb. 2774 * Can be used by drivers to add extra IEs. 2775 * 2776 * @max_signal: Maximum value for signal (rssi) in RX information, used 2777 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB 2778 * 2779 * @max_listen_interval: max listen interval in units of beacon interval 2780 * that HW supports 2781 * 2782 * @queues: number of available hardware transmit queues for 2783 * data packets. WMM/QoS requires at least four, these 2784 * queues need to have configurable access parameters. 2785 * 2786 * @rate_control_algorithm: rate control algorithm for this hardware. 2787 * If unset (NULL), the default algorithm will be used. Must be 2788 * set before calling ieee80211_register_hw(). 2789 * 2790 * @vif_data_size: size (in bytes) of the drv_priv data area 2791 * within &struct ieee80211_vif. 2792 * @sta_data_size: size (in bytes) of the drv_priv data area 2793 * within &struct ieee80211_sta. 2794 * @chanctx_data_size: size (in bytes) of the drv_priv data area 2795 * within &struct ieee80211_chanctx_conf. 2796 * @txq_data_size: size (in bytes) of the drv_priv data area 2797 * within @struct ieee80211_txq. 2798 * 2799 * @max_rates: maximum number of alternate rate retry stages the hw 2800 * can handle. 2801 * @max_report_rates: maximum number of alternate rate retry stages 2802 * the hw can report back. 2803 * @max_rate_tries: maximum number of tries for each stage 2804 * 2805 * @max_rx_aggregation_subframes: maximum buffer size (number of 2806 * sub-frames) to be used for A-MPDU block ack receiver 2807 * aggregation. 2808 * This is only relevant if the device has restrictions on the 2809 * number of subframes, if it relies on mac80211 to do reordering 2810 * it shouldn't be set. 2811 * 2812 * @max_tx_aggregation_subframes: maximum number of subframes in an 2813 * aggregate an HT/HE device will transmit. In HT AddBA we'll 2814 * advertise a constant value of 64 as some older APs crash if 2815 * the window size is smaller (an example is LinkSys WRT120N 2816 * with FW v1.0.07 build 002 Jun 18 2012). 2817 * For AddBA to HE capable peers this value will be used. 2818 * 2819 * @max_tx_fragments: maximum number of tx buffers per (A)-MSDU, sum 2820 * of 1 + skb_shinfo(skb)->nr_frags for each skb in the frag_list. 2821 * 2822 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX 2823 * (if %IEEE80211_HW_QUEUE_CONTROL is set) 2824 * 2825 * @radiotap_mcs_details: lists which MCS information can the HW 2826 * reports, by default it is set to _MCS, _GI and _BW but doesn't 2827 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_\* values, only 2828 * adding _BW is supported today. 2829 * 2830 * @radiotap_vht_details: lists which VHT MCS information the HW reports, 2831 * the default is _GI | _BANDWIDTH. 2832 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_\* values. 2833 * 2834 * @radiotap_he: HE radiotap validity flags 2835 * 2836 * @radiotap_timestamp: Information for the radiotap timestamp field; if the 2837 * @units_pos member is set to a non-negative value then the timestamp 2838 * field will be added and populated from the &struct ieee80211_rx_status 2839 * device_timestamp. 2840 * @radiotap_timestamp.units_pos: Must be set to a combination of a 2841 * IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a 2842 * IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value. 2843 * @radiotap_timestamp.accuracy: If non-negative, fills the accuracy in the 2844 * radiotap field and the accuracy known flag will be set. 2845 * 2846 * @netdev_features: netdev features to be set in each netdev created 2847 * from this HW. Note that not all features are usable with mac80211, 2848 * other features will be rejected during HW registration. 2849 * 2850 * @uapsd_queues: This bitmap is included in (re)association frame to indicate 2851 * for each access category if it is uAPSD trigger-enabled and delivery- 2852 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap. 2853 * Each bit corresponds to different AC. Value '1' in specific bit means 2854 * that corresponding AC is both trigger- and delivery-enabled. '0' means 2855 * neither enabled. 2856 * 2857 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may 2858 * deliver to a WMM STA during any Service Period triggered by the WMM STA. 2859 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values. 2860 * 2861 * @max_nan_de_entries: maximum number of NAN DE functions supported by the 2862 * device. 2863 * 2864 * @tx_sk_pacing_shift: Pacing shift to set on TCP sockets when frames from 2865 * them are encountered. The default should typically not be changed, 2866 * unless the driver has good reasons for needing more buffers. 2867 * 2868 * @weight_multiplier: Driver specific airtime weight multiplier used while 2869 * refilling deficit of each TXQ. 2870 * 2871 * @max_mtu: the max mtu could be set. 2872 * 2873 * @tx_power_levels: a list of power levels supported by the wifi hardware. 2874 * The power levels can be specified either as integer or fractions. 2875 * The power level at idx 0 shall be the maximum positive power level. 2876 * 2877 * @max_txpwr_levels_idx: the maximum valid idx of 'tx_power_levels' list. 2878 */ 2879 struct ieee80211_hw { 2880 struct ieee80211_conf conf; 2881 struct wiphy *wiphy; 2882 const char *rate_control_algorithm; 2883 void *priv; 2884 unsigned long flags[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS)]; 2885 unsigned int extra_tx_headroom; 2886 unsigned int extra_beacon_tailroom; 2887 int vif_data_size; 2888 int sta_data_size; 2889 int chanctx_data_size; 2890 int txq_data_size; 2891 u16 queues; 2892 u16 max_listen_interval; 2893 s8 max_signal; 2894 u8 max_rates; 2895 u8 max_report_rates; 2896 u8 max_rate_tries; 2897 u16 max_rx_aggregation_subframes; 2898 u16 max_tx_aggregation_subframes; 2899 u8 max_tx_fragments; 2900 u8 offchannel_tx_hw_queue; 2901 u8 radiotap_mcs_details; 2902 u16 radiotap_vht_details; 2903 struct { 2904 int units_pos; 2905 s16 accuracy; 2906 } radiotap_timestamp; 2907 netdev_features_t netdev_features; 2908 u8 uapsd_queues; 2909 u8 uapsd_max_sp_len; 2910 u8 max_nan_de_entries; 2911 u8 tx_sk_pacing_shift; 2912 u8 weight_multiplier; 2913 u32 max_mtu; 2914 const s8 *tx_power_levels; 2915 u8 max_txpwr_levels_idx; 2916 }; 2917 2918 static inline bool _ieee80211_hw_check(struct ieee80211_hw *hw, 2919 enum ieee80211_hw_flags flg) 2920 { 2921 return test_bit(flg, hw->flags); 2922 } 2923 #define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg) 2924 2925 static inline void _ieee80211_hw_set(struct ieee80211_hw *hw, 2926 enum ieee80211_hw_flags flg) 2927 { 2928 return __set_bit(flg, hw->flags); 2929 } 2930 #define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg) 2931 2932 /** 2933 * struct ieee80211_scan_request - hw scan request 2934 * 2935 * @ies: pointers different parts of IEs (in req.ie) 2936 * @req: cfg80211 request. 2937 */ 2938 struct ieee80211_scan_request { 2939 struct ieee80211_scan_ies ies; 2940 2941 /* Keep last */ 2942 struct cfg80211_scan_request req; 2943 }; 2944 2945 /** 2946 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters 2947 * 2948 * @sta: peer this TDLS channel-switch request/response came from 2949 * @chandef: channel referenced in a TDLS channel-switch request 2950 * @action_code: see &enum ieee80211_tdls_actioncode 2951 * @status: channel-switch response status 2952 * @timestamp: time at which the frame was received 2953 * @switch_time: switch-timing parameter received in the frame 2954 * @switch_timeout: switch-timing parameter received in the frame 2955 * @tmpl_skb: TDLS switch-channel response template 2956 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb 2957 */ 2958 struct ieee80211_tdls_ch_sw_params { 2959 struct ieee80211_sta *sta; 2960 struct cfg80211_chan_def *chandef; 2961 u8 action_code; 2962 u32 status; 2963 u32 timestamp; 2964 u16 switch_time; 2965 u16 switch_timeout; 2966 struct sk_buff *tmpl_skb; 2967 u32 ch_sw_tm_ie; 2968 }; 2969 2970 /** 2971 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy 2972 * 2973 * @wiphy: the &struct wiphy which we want to query 2974 * 2975 * mac80211 drivers can use this to get to their respective 2976 * &struct ieee80211_hw. Drivers wishing to get to their own private 2977 * structure can then access it via hw->priv. Note that mac802111 drivers should 2978 * not use wiphy_priv() to try to get their private driver structure as this 2979 * is already used internally by mac80211. 2980 * 2981 * Return: The mac80211 driver hw struct of @wiphy. 2982 */ 2983 struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy); 2984 2985 /** 2986 * SET_IEEE80211_DEV - set device for 802.11 hardware 2987 * 2988 * @hw: the &struct ieee80211_hw to set the device for 2989 * @dev: the &struct device of this 802.11 device 2990 */ 2991 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev) 2992 { 2993 set_wiphy_dev(hw->wiphy, dev); 2994 } 2995 2996 /** 2997 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware 2998 * 2999 * @hw: the &struct ieee80211_hw to set the MAC address for 3000 * @addr: the address to set 3001 */ 3002 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, const u8 *addr) 3003 { 3004 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN); 3005 } 3006 3007 static inline struct ieee80211_rate * 3008 ieee80211_get_tx_rate(const struct ieee80211_hw *hw, 3009 const struct ieee80211_tx_info *c) 3010 { 3011 if (WARN_ON_ONCE(c->control.rates[0].idx < 0)) 3012 return NULL; 3013 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx]; 3014 } 3015 3016 static inline struct ieee80211_rate * 3017 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw, 3018 const struct ieee80211_tx_info *c) 3019 { 3020 if (c->control.rts_cts_rate_idx < 0) 3021 return NULL; 3022 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx]; 3023 } 3024 3025 static inline struct ieee80211_rate * 3026 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw, 3027 const struct ieee80211_tx_info *c, int idx) 3028 { 3029 if (c->control.rates[idx + 1].idx < 0) 3030 return NULL; 3031 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx]; 3032 } 3033 3034 /** 3035 * ieee80211_free_txskb - free TX skb 3036 * @hw: the hardware 3037 * @skb: the skb 3038 * 3039 * Free a transmit skb. Use this function when some failure 3040 * to transmit happened and thus status cannot be reported. 3041 */ 3042 void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb); 3043 3044 /** 3045 * DOC: Hardware crypto acceleration 3046 * 3047 * mac80211 is capable of taking advantage of many hardware 3048 * acceleration designs for encryption and decryption operations. 3049 * 3050 * The set_key() callback in the &struct ieee80211_ops for a given 3051 * device is called to enable hardware acceleration of encryption and 3052 * decryption. The callback takes a @sta parameter that will be NULL 3053 * for default keys or keys used for transmission only, or point to 3054 * the station information for the peer for individual keys. 3055 * Multiple transmission keys with the same key index may be used when 3056 * VLANs are configured for an access point. 3057 * 3058 * When transmitting, the TX control data will use the @hw_key_idx 3059 * selected by the driver by modifying the &struct ieee80211_key_conf 3060 * pointed to by the @key parameter to the set_key() function. 3061 * 3062 * The set_key() call for the %SET_KEY command should return 0 if 3063 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be 3064 * added; if you return 0 then hw_key_idx must be assigned to the 3065 * hardware key index, you are free to use the full u8 range. 3066 * 3067 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is 3068 * set, mac80211 will not automatically fall back to software crypto if 3069 * enabling hardware crypto failed. The set_key() call may also return the 3070 * value 1 to permit this specific key/algorithm to be done in software. 3071 * 3072 * When the cmd is %DISABLE_KEY then it must succeed. 3073 * 3074 * Note that it is permissible to not decrypt a frame even if a key 3075 * for it has been uploaded to hardware, the stack will not make any 3076 * decision based on whether a key has been uploaded or not but rather 3077 * based on the receive flags. 3078 * 3079 * The &struct ieee80211_key_conf structure pointed to by the @key 3080 * parameter is guaranteed to be valid until another call to set_key() 3081 * removes it, but it can only be used as a cookie to differentiate 3082 * keys. 3083 * 3084 * In TKIP some HW need to be provided a phase 1 key, for RX decryption 3085 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key 3086 * handler. 3087 * The update_tkip_key() call updates the driver with the new phase 1 key. 3088 * This happens every time the iv16 wraps around (every 65536 packets). The 3089 * set_key() call will happen only once for each key (unless the AP did 3090 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is 3091 * provided by update_tkip_key only. The trigger that makes mac80211 call this 3092 * handler is software decryption with wrap around of iv16. 3093 * 3094 * The set_default_unicast_key() call updates the default WEP key index 3095 * configured to the hardware for WEP encryption type. This is required 3096 * for devices that support offload of data packets (e.g. ARP responses). 3097 * 3098 * Mac80211 drivers should set the @NL80211_EXT_FEATURE_CAN_REPLACE_PTK0 flag 3099 * when they are able to replace in-use PTK keys according to the following 3100 * requirements: 3101 * 1) They do not hand over frames decrypted with the old key to mac80211 3102 once the call to set_key() with command %DISABLE_KEY has been completed, 3103 2) either drop or continue to use the old key for any outgoing frames queued 3104 at the time of the key deletion (including re-transmits), 3105 3) never send out a frame queued prior to the set_key() %SET_KEY command 3106 encrypted with the new key when also needing 3107 @IEEE80211_KEY_FLAG_GENERATE_IV and 3108 4) never send out a frame unencrypted when it should be encrypted. 3109 Mac80211 will not queue any new frames for a deleted key to the driver. 3110 */ 3111 3112 /** 3113 * DOC: Powersave support 3114 * 3115 * mac80211 has support for various powersave implementations. 3116 * 3117 * First, it can support hardware that handles all powersaving by itself, 3118 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware 3119 * flag. In that case, it will be told about the desired powersave mode 3120 * with the %IEEE80211_CONF_PS flag depending on the association status. 3121 * The hardware must take care of sending nullfunc frames when necessary, 3122 * i.e. when entering and leaving powersave mode. The hardware is required 3123 * to look at the AID in beacons and signal to the AP that it woke up when 3124 * it finds traffic directed to it. 3125 * 3126 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in 3127 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused 3128 * with hardware wakeup and sleep states. Driver is responsible for waking 3129 * up the hardware before issuing commands to the hardware and putting it 3130 * back to sleep at appropriate times. 3131 * 3132 * When PS is enabled, hardware needs to wakeup for beacons and receive the 3133 * buffered multicast/broadcast frames after the beacon. Also it must be 3134 * possible to send frames and receive the acknowledment frame. 3135 * 3136 * Other hardware designs cannot send nullfunc frames by themselves and also 3137 * need software support for parsing the TIM bitmap. This is also supported 3138 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and 3139 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still 3140 * required to pass up beacons. The hardware is still required to handle 3141 * waking up for multicast traffic; if it cannot the driver must handle that 3142 * as best as it can, mac80211 is too slow to do that. 3143 * 3144 * Dynamic powersave is an extension to normal powersave in which the 3145 * hardware stays awake for a user-specified period of time after sending a 3146 * frame so that reply frames need not be buffered and therefore delayed to 3147 * the next wakeup. It's compromise of getting good enough latency when 3148 * there's data traffic and still saving significantly power in idle 3149 * periods. 3150 * 3151 * Dynamic powersave is simply supported by mac80211 enabling and disabling 3152 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS 3153 * flag and mac80211 will handle everything automatically. Additionally, 3154 * hardware having support for the dynamic PS feature may set the 3155 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support 3156 * dynamic PS mode itself. The driver needs to look at the 3157 * @dynamic_ps_timeout hardware configuration value and use it that value 3158 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable 3159 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS 3160 * enabled whenever user has enabled powersave. 3161 * 3162 * Driver informs U-APSD client support by enabling 3163 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the 3164 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS 3165 * Nullfunc frames and stay awake until the service period has ended. To 3166 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames 3167 * from that AC are transmitted with powersave enabled. 3168 * 3169 * Note: U-APSD client mode is not yet supported with 3170 * %IEEE80211_HW_PS_NULLFUNC_STACK. 3171 */ 3172 3173 /** 3174 * DOC: Beacon filter support 3175 * 3176 * Some hardware have beacon filter support to reduce host cpu wakeups 3177 * which will reduce system power consumption. It usually works so that 3178 * the firmware creates a checksum of the beacon but omits all constantly 3179 * changing elements (TSF, TIM etc). Whenever the checksum changes the 3180 * beacon is forwarded to the host, otherwise it will be just dropped. That 3181 * way the host will only receive beacons where some relevant information 3182 * (for example ERP protection or WMM settings) have changed. 3183 * 3184 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER 3185 * interface capability. The driver needs to enable beacon filter support 3186 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When 3187 * power save is enabled, the stack will not check for beacon loss and the 3188 * driver needs to notify about loss of beacons with ieee80211_beacon_loss(). 3189 * 3190 * The time (or number of beacons missed) until the firmware notifies the 3191 * driver of a beacon loss event (which in turn causes the driver to call 3192 * ieee80211_beacon_loss()) should be configurable and will be controlled 3193 * by mac80211 and the roaming algorithm in the future. 3194 * 3195 * Since there may be constantly changing information elements that nothing 3196 * in the software stack cares about, we will, in the future, have mac80211 3197 * tell the driver which information elements are interesting in the sense 3198 * that we want to see changes in them. This will include 3199 * 3200 * - a list of information element IDs 3201 * - a list of OUIs for the vendor information element 3202 * 3203 * Ideally, the hardware would filter out any beacons without changes in the 3204 * requested elements, but if it cannot support that it may, at the expense 3205 * of some efficiency, filter out only a subset. For example, if the device 3206 * doesn't support checking for OUIs it should pass up all changes in all 3207 * vendor information elements. 3208 * 3209 * Note that change, for the sake of simplification, also includes information 3210 * elements appearing or disappearing from the beacon. 3211 * 3212 * Some hardware supports an "ignore list" instead, just make sure nothing 3213 * that was requested is on the ignore list, and include commonly changing 3214 * information element IDs in the ignore list, for example 11 (BSS load) and 3215 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136, 3216 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility 3217 * it could also include some currently unused IDs. 3218 * 3219 * 3220 * In addition to these capabilities, hardware should support notifying the 3221 * host of changes in the beacon RSSI. This is relevant to implement roaming 3222 * when no traffic is flowing (when traffic is flowing we see the RSSI of 3223 * the received data packets). This can consist in notifying the host when 3224 * the RSSI changes significantly or when it drops below or rises above 3225 * configurable thresholds. In the future these thresholds will also be 3226 * configured by mac80211 (which gets them from userspace) to implement 3227 * them as the roaming algorithm requires. 3228 * 3229 * If the hardware cannot implement this, the driver should ask it to 3230 * periodically pass beacon frames to the host so that software can do the 3231 * signal strength threshold checking. 3232 */ 3233 3234 /** 3235 * DOC: Spatial multiplexing power save 3236 * 3237 * SMPS (Spatial multiplexing power save) is a mechanism to conserve 3238 * power in an 802.11n implementation. For details on the mechanism 3239 * and rationale, please refer to 802.11 (as amended by 802.11n-2009) 3240 * "11.2.3 SM power save". 3241 * 3242 * The mac80211 implementation is capable of sending action frames 3243 * to update the AP about the station's SMPS mode, and will instruct 3244 * the driver to enter the specific mode. It will also announce the 3245 * requested SMPS mode during the association handshake. Hardware 3246 * support for this feature is required, and can be indicated by 3247 * hardware flags. 3248 * 3249 * The default mode will be "automatic", which nl80211/cfg80211 3250 * defines to be dynamic SMPS in (regular) powersave, and SMPS 3251 * turned off otherwise. 3252 * 3253 * To support this feature, the driver must set the appropriate 3254 * hardware support flags, and handle the SMPS flag to the config() 3255 * operation. It will then with this mechanism be instructed to 3256 * enter the requested SMPS mode while associated to an HT AP. 3257 */ 3258 3259 /** 3260 * DOC: Frame filtering 3261 * 3262 * mac80211 requires to see many management frames for proper 3263 * operation, and users may want to see many more frames when 3264 * in monitor mode. However, for best CPU usage and power consumption, 3265 * having as few frames as possible percolate through the stack is 3266 * desirable. Hence, the hardware should filter as much as possible. 3267 * 3268 * To achieve this, mac80211 uses filter flags (see below) to tell 3269 * the driver's configure_filter() function which frames should be 3270 * passed to mac80211 and which should be filtered out. 3271 * 3272 * Before configure_filter() is invoked, the prepare_multicast() 3273 * callback is invoked with the parameters @mc_count and @mc_list 3274 * for the combined multicast address list of all virtual interfaces. 3275 * It's use is optional, and it returns a u64 that is passed to 3276 * configure_filter(). Additionally, configure_filter() has the 3277 * arguments @changed_flags telling which flags were changed and 3278 * @total_flags with the new flag states. 3279 * 3280 * If your device has no multicast address filters your driver will 3281 * need to check both the %FIF_ALLMULTI flag and the @mc_count 3282 * parameter to see whether multicast frames should be accepted 3283 * or dropped. 3284 * 3285 * All unsupported flags in @total_flags must be cleared. 3286 * Hardware does not support a flag if it is incapable of _passing_ 3287 * the frame to the stack. Otherwise the driver must ignore 3288 * the flag, but not clear it. 3289 * You must _only_ clear the flag (announce no support for the 3290 * flag to mac80211) if you are not able to pass the packet type 3291 * to the stack (so the hardware always filters it). 3292 * So for example, you should clear @FIF_CONTROL, if your hardware 3293 * always filters control frames. If your hardware always passes 3294 * control frames to the kernel and is incapable of filtering them, 3295 * you do _not_ clear the @FIF_CONTROL flag. 3296 * This rule applies to all other FIF flags as well. 3297 */ 3298 3299 /** 3300 * DOC: AP support for powersaving clients 3301 * 3302 * In order to implement AP and P2P GO modes, mac80211 has support for 3303 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD. 3304 * There currently is no support for sAPSD. 3305 * 3306 * There is one assumption that mac80211 makes, namely that a client 3307 * will not poll with PS-Poll and trigger with uAPSD at the same time. 3308 * Both are supported, and both can be used by the same client, but 3309 * they can't be used concurrently by the same client. This simplifies 3310 * the driver code. 3311 * 3312 * The first thing to keep in mind is that there is a flag for complete 3313 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set, 3314 * mac80211 expects the driver to handle most of the state machine for 3315 * powersaving clients and will ignore the PM bit in incoming frames. 3316 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of 3317 * stations' powersave transitions. In this mode, mac80211 also doesn't 3318 * handle PS-Poll/uAPSD. 3319 * 3320 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the 3321 * PM bit in incoming frames for client powersave transitions. When a 3322 * station goes to sleep, we will stop transmitting to it. There is, 3323 * however, a race condition: a station might go to sleep while there is 3324 * data buffered on hardware queues. If the device has support for this 3325 * it will reject frames, and the driver should give the frames back to 3326 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will 3327 * cause mac80211 to retry the frame when the station wakes up. The 3328 * driver is also notified of powersave transitions by calling its 3329 * @sta_notify callback. 3330 * 3331 * When the station is asleep, it has three choices: it can wake up, 3332 * it can PS-Poll, or it can possibly start a uAPSD service period. 3333 * Waking up is implemented by simply transmitting all buffered (and 3334 * filtered) frames to the station. This is the easiest case. When 3335 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211 3336 * will inform the driver of this with the @allow_buffered_frames 3337 * callback; this callback is optional. mac80211 will then transmit 3338 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER 3339 * on each frame. The last frame in the service period (or the only 3340 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to 3341 * indicate that it ends the service period; as this frame must have 3342 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS. 3343 * When TX status is reported for this frame, the service period is 3344 * marked has having ended and a new one can be started by the peer. 3345 * 3346 * Additionally, non-bufferable MMPDUs can also be transmitted by 3347 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them. 3348 * 3349 * Another race condition can happen on some devices like iwlwifi 3350 * when there are frames queued for the station and it wakes up 3351 * or polls; the frames that are already queued could end up being 3352 * transmitted first instead, causing reordering and/or wrong 3353 * processing of the EOSP. The cause is that allowing frames to be 3354 * transmitted to a certain station is out-of-band communication to 3355 * the device. To allow this problem to be solved, the driver can 3356 * call ieee80211_sta_block_awake() if frames are buffered when it 3357 * is notified that the station went to sleep. When all these frames 3358 * have been filtered (see above), it must call the function again 3359 * to indicate that the station is no longer blocked. 3360 * 3361 * If the driver buffers frames in the driver for aggregation in any 3362 * way, it must use the ieee80211_sta_set_buffered() call when it is 3363 * notified of the station going to sleep to inform mac80211 of any 3364 * TIDs that have frames buffered. Note that when a station wakes up 3365 * this information is reset (hence the requirement to call it when 3366 * informed of the station going to sleep). Then, when a service 3367 * period starts for any reason, @release_buffered_frames is called 3368 * with the number of frames to be released and which TIDs they are 3369 * to come from. In this case, the driver is responsible for setting 3370 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames, 3371 * to help the @more_data parameter is passed to tell the driver if 3372 * there is more data on other TIDs -- the TIDs to release frames 3373 * from are ignored since mac80211 doesn't know how many frames the 3374 * buffers for those TIDs contain. 3375 * 3376 * If the driver also implement GO mode, where absence periods may 3377 * shorten service periods (or abort PS-Poll responses), it must 3378 * filter those response frames except in the case of frames that 3379 * are buffered in the driver -- those must remain buffered to avoid 3380 * reordering. Because it is possible that no frames are released 3381 * in this case, the driver must call ieee80211_sta_eosp() 3382 * to indicate to mac80211 that the service period ended anyway. 3383 * 3384 * Finally, if frames from multiple TIDs are released from mac80211 3385 * but the driver might reorder them, it must clear & set the flags 3386 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP) 3387 * and also take care of the EOSP and MORE_DATA bits in the frame. 3388 * The driver may also use ieee80211_sta_eosp() in this case. 3389 * 3390 * Note that if the driver ever buffers frames other than QoS-data 3391 * frames, it must take care to never send a non-QoS-data frame as 3392 * the last frame in a service period, adding a QoS-nulldata frame 3393 * after a non-QoS-data frame if needed. 3394 */ 3395 3396 /** 3397 * DOC: HW queue control 3398 * 3399 * Before HW queue control was introduced, mac80211 only had a single static 3400 * assignment of per-interface AC software queues to hardware queues. This 3401 * was problematic for a few reasons: 3402 * 1) off-channel transmissions might get stuck behind other frames 3403 * 2) multiple virtual interfaces couldn't be handled correctly 3404 * 3) after-DTIM frames could get stuck behind other frames 3405 * 3406 * To solve this, hardware typically uses multiple different queues for all 3407 * the different usages, and this needs to be propagated into mac80211 so it 3408 * won't have the same problem with the software queues. 3409 * 3410 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability 3411 * flag that tells it that the driver implements its own queue control. To do 3412 * so, the driver will set up the various queues in each &struct ieee80211_vif 3413 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will 3414 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and 3415 * if necessary will queue the frame on the right software queue that mirrors 3416 * the hardware queue. 3417 * Additionally, the driver has to then use these HW queue IDs for the queue 3418 * management functions (ieee80211_stop_queue() et al.) 3419 * 3420 * The driver is free to set up the queue mappings as needed, multiple virtual 3421 * interfaces may map to the same hardware queues if needed. The setup has to 3422 * happen during add_interface or change_interface callbacks. For example, a 3423 * driver supporting station+station and station+AP modes might decide to have 3424 * 10 hardware queues to handle different scenarios: 3425 * 3426 * 4 AC HW queues for 1st vif: 0, 1, 2, 3 3427 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7 3428 * after-DTIM queue for AP: 8 3429 * off-channel queue: 9 3430 * 3431 * It would then set up the hardware like this: 3432 * hw.offchannel_tx_hw_queue = 9 3433 * 3434 * and the first virtual interface that is added as follows: 3435 * vif.hw_queue[IEEE80211_AC_VO] = 0 3436 * vif.hw_queue[IEEE80211_AC_VI] = 1 3437 * vif.hw_queue[IEEE80211_AC_BE] = 2 3438 * vif.hw_queue[IEEE80211_AC_BK] = 3 3439 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE 3440 * and the second virtual interface with 4-7. 3441 * 3442 * If queue 6 gets full, for example, mac80211 would only stop the second 3443 * virtual interface's BE queue since virtual interface queues are per AC. 3444 * 3445 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE 3446 * whenever the queue is not used (i.e. the interface is not in AP mode) if the 3447 * queue could potentially be shared since mac80211 will look at cab_queue when 3448 * a queue is stopped/woken even if the interface is not in AP mode. 3449 */ 3450 3451 /** 3452 * enum ieee80211_filter_flags - hardware filter flags 3453 * 3454 * These flags determine what the filter in hardware should be 3455 * programmed to let through and what should not be passed to the 3456 * stack. It is always safe to pass more frames than requested, 3457 * but this has negative impact on power consumption. 3458 * 3459 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested 3460 * by the user or if the hardware is not capable of filtering by 3461 * multicast address. 3462 * 3463 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the 3464 * %RX_FLAG_FAILED_FCS_CRC for them) 3465 * 3466 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set 3467 * the %RX_FLAG_FAILED_PLCP_CRC for them 3468 * 3469 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate 3470 * to the hardware that it should not filter beacons or probe responses 3471 * by BSSID. Filtering them can greatly reduce the amount of processing 3472 * mac80211 needs to do and the amount of CPU wakeups, so you should 3473 * honour this flag if possible. 3474 * 3475 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this 3476 * station 3477 * 3478 * @FIF_OTHER_BSS: pass frames destined to other BSSes 3479 * 3480 * @FIF_PSPOLL: pass PS Poll frames 3481 * 3482 * @FIF_PROBE_REQ: pass probe request frames 3483 * 3484 * @FIF_MCAST_ACTION: pass multicast Action frames 3485 */ 3486 enum ieee80211_filter_flags { 3487 FIF_ALLMULTI = 1<<1, 3488 FIF_FCSFAIL = 1<<2, 3489 FIF_PLCPFAIL = 1<<3, 3490 FIF_BCN_PRBRESP_PROMISC = 1<<4, 3491 FIF_CONTROL = 1<<5, 3492 FIF_OTHER_BSS = 1<<6, 3493 FIF_PSPOLL = 1<<7, 3494 FIF_PROBE_REQ = 1<<8, 3495 FIF_MCAST_ACTION = 1<<9, 3496 }; 3497 3498 /** 3499 * enum ieee80211_ampdu_mlme_action - A-MPDU actions 3500 * 3501 * These flags are used with the ampdu_action() callback in 3502 * &struct ieee80211_ops to indicate which action is needed. 3503 * 3504 * Note that drivers MUST be able to deal with a TX aggregation 3505 * session being stopped even before they OK'ed starting it by 3506 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer 3507 * might receive the addBA frame and send a delBA right away! 3508 * 3509 * @IEEE80211_AMPDU_RX_START: start RX aggregation 3510 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation 3511 * @IEEE80211_AMPDU_TX_START: start TX aggregation, the driver must either 3512 * call ieee80211_start_tx_ba_cb_irqsafe() or 3513 * call ieee80211_start_tx_ba_cb_irqsafe() with status 3514 * %IEEE80211_AMPDU_TX_START_DELAY_ADDBA to delay addba after 3515 * ieee80211_start_tx_ba_cb_irqsafe is called, or just return the special 3516 * status %IEEE80211_AMPDU_TX_START_IMMEDIATE. 3517 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational 3518 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting 3519 * queued packets, now unaggregated. After all packets are transmitted the 3520 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe(). 3521 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets, 3522 * called when the station is removed. There's no need or reason to call 3523 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the 3524 * session is gone and removes the station. 3525 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped 3526 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and 3527 * now the connection is dropped and the station will be removed. Drivers 3528 * should clean up and drop remaining packets when this is called. 3529 */ 3530 enum ieee80211_ampdu_mlme_action { 3531 IEEE80211_AMPDU_RX_START, 3532 IEEE80211_AMPDU_RX_STOP, 3533 IEEE80211_AMPDU_TX_START, 3534 IEEE80211_AMPDU_TX_STOP_CONT, 3535 IEEE80211_AMPDU_TX_STOP_FLUSH, 3536 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT, 3537 IEEE80211_AMPDU_TX_OPERATIONAL, 3538 }; 3539 3540 #define IEEE80211_AMPDU_TX_START_IMMEDIATE 1 3541 #define IEEE80211_AMPDU_TX_START_DELAY_ADDBA 2 3542 3543 /** 3544 * struct ieee80211_ampdu_params - AMPDU action parameters 3545 * 3546 * @action: the ampdu action, value from %ieee80211_ampdu_mlme_action. 3547 * @sta: peer of this AMPDU session 3548 * @tid: tid of the BA session 3549 * @ssn: start sequence number of the session. TX/RX_STOP can pass 0. When 3550 * action is set to %IEEE80211_AMPDU_RX_START the driver passes back the 3551 * actual ssn value used to start the session and writes the value here. 3552 * @buf_size: reorder buffer size (number of subframes). Valid only when the 3553 * action is set to %IEEE80211_AMPDU_RX_START or 3554 * %IEEE80211_AMPDU_TX_OPERATIONAL 3555 * @amsdu: indicates the peer's ability to receive A-MSDU within A-MPDU. 3556 * valid when the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL 3557 * @timeout: BA session timeout. Valid only when the action is set to 3558 * %IEEE80211_AMPDU_RX_START 3559 */ 3560 struct ieee80211_ampdu_params { 3561 enum ieee80211_ampdu_mlme_action action; 3562 struct ieee80211_sta *sta; 3563 u16 tid; 3564 u16 ssn; 3565 u16 buf_size; 3566 bool amsdu; 3567 u16 timeout; 3568 }; 3569 3570 /** 3571 * enum ieee80211_frame_release_type - frame release reason 3572 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll 3573 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to 3574 * frame received on trigger-enabled AC 3575 */ 3576 enum ieee80211_frame_release_type { 3577 IEEE80211_FRAME_RELEASE_PSPOLL, 3578 IEEE80211_FRAME_RELEASE_UAPSD, 3579 }; 3580 3581 /** 3582 * enum ieee80211_rate_control_changed - flags to indicate what changed 3583 * 3584 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit 3585 * to this station changed. The actual bandwidth is in the station 3586 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40 3587 * flag changes, for HT and VHT the bandwidth field changes. 3588 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed. 3589 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer 3590 * changed (in IBSS mode) due to discovering more information about 3591 * the peer. 3592 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed 3593 * by the peer 3594 */ 3595 enum ieee80211_rate_control_changed { 3596 IEEE80211_RC_BW_CHANGED = BIT(0), 3597 IEEE80211_RC_SMPS_CHANGED = BIT(1), 3598 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2), 3599 IEEE80211_RC_NSS_CHANGED = BIT(3), 3600 }; 3601 3602 /** 3603 * enum ieee80211_roc_type - remain on channel type 3604 * 3605 * With the support for multi channel contexts and multi channel operations, 3606 * remain on channel operations might be limited/deferred/aborted by other 3607 * flows/operations which have higher priority (and vice versa). 3608 * Specifying the ROC type can be used by devices to prioritize the ROC 3609 * operations compared to other operations/flows. 3610 * 3611 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC. 3612 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required 3613 * for sending management frames offchannel. 3614 */ 3615 enum ieee80211_roc_type { 3616 IEEE80211_ROC_TYPE_NORMAL = 0, 3617 IEEE80211_ROC_TYPE_MGMT_TX, 3618 }; 3619 3620 /** 3621 * enum ieee80211_reconfig_type - reconfig type 3622 * 3623 * This enum is used by the reconfig_complete() callback to indicate what 3624 * reconfiguration type was completed. 3625 * 3626 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type 3627 * (also due to resume() callback returning 1) 3628 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless 3629 * of wowlan configuration) 3630 */ 3631 enum ieee80211_reconfig_type { 3632 IEEE80211_RECONFIG_TYPE_RESTART, 3633 IEEE80211_RECONFIG_TYPE_SUSPEND, 3634 }; 3635 3636 /** 3637 * struct ieee80211_prep_tx_info - prepare TX information 3638 * @duration: if non-zero, hint about the required duration, 3639 * only used with the mgd_prepare_tx() method. 3640 * @subtype: frame subtype (auth, (re)assoc, deauth, disassoc) 3641 * @success: whether the frame exchange was successful, only 3642 * used with the mgd_complete_tx() method, and then only 3643 * valid for auth and (re)assoc. 3644 */ 3645 struct ieee80211_prep_tx_info { 3646 u16 duration; 3647 u16 subtype; 3648 u8 success:1; 3649 }; 3650 3651 /** 3652 * struct ieee80211_ops - callbacks from mac80211 to the driver 3653 * 3654 * This structure contains various callbacks that the driver may 3655 * handle or, in some cases, must handle, for example to configure 3656 * the hardware to a new channel or to transmit a frame. 3657 * 3658 * @tx: Handler that 802.11 module calls for each transmitted frame. 3659 * skb contains the buffer starting from the IEEE 802.11 header. 3660 * The low-level driver should send the frame out based on 3661 * configuration in the TX control data. This handler should, 3662 * preferably, never fail and stop queues appropriately. 3663 * Must be atomic. 3664 * 3665 * @start: Called before the first netdevice attached to the hardware 3666 * is enabled. This should turn on the hardware and must turn on 3667 * frame reception (for possibly enabled monitor interfaces.) 3668 * Returns negative error codes, these may be seen in userspace, 3669 * or zero. 3670 * When the device is started it should not have a MAC address 3671 * to avoid acknowledging frames before a non-monitor device 3672 * is added. 3673 * Must be implemented and can sleep. 3674 * 3675 * @stop: Called after last netdevice attached to the hardware 3676 * is disabled. This should turn off the hardware (at least 3677 * it must turn off frame reception.) 3678 * May be called right after add_interface if that rejects 3679 * an interface. If you added any work onto the mac80211 workqueue 3680 * you should ensure to cancel it on this callback. 3681 * Must be implemented and can sleep. 3682 * 3683 * @suspend: Suspend the device; mac80211 itself will quiesce before and 3684 * stop transmitting and doing any other configuration, and then 3685 * ask the device to suspend. This is only invoked when WoWLAN is 3686 * configured, otherwise the device is deconfigured completely and 3687 * reconfigured at resume time. 3688 * The driver may also impose special conditions under which it 3689 * wants to use the "normal" suspend (deconfigure), say if it only 3690 * supports WoWLAN when the device is associated. In this case, it 3691 * must return 1 from this function. 3692 * 3693 * @resume: If WoWLAN was configured, this indicates that mac80211 is 3694 * now resuming its operation, after this the device must be fully 3695 * functional again. If this returns an error, the only way out is 3696 * to also unregister the device. If it returns 1, then mac80211 3697 * will also go through the regular complete restart on resume. 3698 * 3699 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is 3700 * modified. The reason is that device_set_wakeup_enable() is 3701 * supposed to be called when the configuration changes, not only 3702 * in suspend(). 3703 * 3704 * @add_interface: Called when a netdevice attached to the hardware is 3705 * enabled. Because it is not called for monitor mode devices, @start 3706 * and @stop must be implemented. 3707 * The driver should perform any initialization it needs before 3708 * the device can be enabled. The initial configuration for the 3709 * interface is given in the conf parameter. 3710 * The callback may refuse to add an interface by returning a 3711 * negative error code (which will be seen in userspace.) 3712 * Must be implemented and can sleep. 3713 * 3714 * @change_interface: Called when a netdevice changes type. This callback 3715 * is optional, but only if it is supported can interface types be 3716 * switched while the interface is UP. The callback may sleep. 3717 * Note that while an interface is being switched, it will not be 3718 * found by the interface iteration callbacks. 3719 * 3720 * @remove_interface: Notifies a driver that an interface is going down. 3721 * The @stop callback is called after this if it is the last interface 3722 * and no monitor interfaces are present. 3723 * When all interfaces are removed, the MAC address in the hardware 3724 * must be cleared so the device no longer acknowledges packets, 3725 * the mac_addr member of the conf structure is, however, set to the 3726 * MAC address of the device going away. 3727 * Hence, this callback must be implemented. It can sleep. 3728 * 3729 * @config: Handler for configuration requests. IEEE 802.11 code calls this 3730 * function to change hardware configuration, e.g., channel. 3731 * This function should never fail but returns a negative error code 3732 * if it does. The callback can sleep. 3733 * 3734 * @bss_info_changed: Handler for configuration requests related to BSS 3735 * parameters that may vary during BSS's lifespan, and may affect low 3736 * level driver (e.g. assoc/disassoc status, erp parameters). 3737 * This function should not be used if no BSS has been set, unless 3738 * for association indication. The @changed parameter indicates which 3739 * of the bss parameters has changed when a call is made. The callback 3740 * can sleep. 3741 * Note: this callback is called if @vif_cfg_changed or @link_info_changed 3742 * are not implemented. 3743 * 3744 * @vif_cfg_changed: Handler for configuration requests related to interface 3745 * (MLD) parameters from &struct ieee80211_vif_cfg that vary during the 3746 * lifetime of the interface (e.g. assoc status, IP addresses, etc.) 3747 * The @changed parameter indicates which value changed. 3748 * The callback can sleep. 3749 * 3750 * @link_info_changed: Handler for configuration requests related to link 3751 * parameters from &struct ieee80211_bss_conf that are related to an 3752 * individual link. e.g. legacy/HT/VHT/... rate information. 3753 * The @changed parameter indicates which value changed, and the @link_id 3754 * parameter indicates the link ID. Note that the @link_id will be 0 for 3755 * non-MLO connections. 3756 * The callback can sleep. 3757 * 3758 * @prepare_multicast: Prepare for multicast filter configuration. 3759 * This callback is optional, and its return value is passed 3760 * to configure_filter(). This callback must be atomic. 3761 * 3762 * @configure_filter: Configure the device's RX filter. 3763 * See the section "Frame filtering" for more information. 3764 * This callback must be implemented and can sleep. 3765 * 3766 * @config_iface_filter: Configure the interface's RX filter. 3767 * This callback is optional and is used to configure which frames 3768 * should be passed to mac80211. The filter_flags is the combination 3769 * of FIF_* flags. The changed_flags is a bit mask that indicates 3770 * which flags are changed. 3771 * This callback can sleep. 3772 * 3773 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit 3774 * must be set or cleared for a given STA. Must be atomic. 3775 * 3776 * @set_key: See the section "Hardware crypto acceleration" 3777 * This callback is only called between add_interface and 3778 * remove_interface calls, i.e. while the given virtual interface 3779 * is enabled. 3780 * Returns a negative error code if the key can't be added. 3781 * The callback can sleep. 3782 * 3783 * @update_tkip_key: See the section "Hardware crypto acceleration" 3784 * This callback will be called in the context of Rx. Called for drivers 3785 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY. 3786 * The callback must be atomic. 3787 * 3788 * @set_rekey_data: If the device supports GTK rekeying, for example while the 3789 * host is suspended, it can assign this callback to retrieve the data 3790 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter. 3791 * After rekeying was done it should (for example during resume) notify 3792 * userspace of the new replay counter using ieee80211_gtk_rekey_notify(). 3793 * 3794 * @set_default_unicast_key: Set the default (unicast) key index, useful for 3795 * WEP when the device sends data packets autonomously, e.g. for ARP 3796 * offloading. The index can be 0-3, or -1 for unsetting it. 3797 * 3798 * @hw_scan: Ask the hardware to service the scan request, no need to start 3799 * the scan state machine in stack. The scan must honour the channel 3800 * configuration done by the regulatory agent in the wiphy's 3801 * registered bands. The hardware (or the driver) needs to make sure 3802 * that power save is disabled. 3803 * The @req ie/ie_len members are rewritten by mac80211 to contain the 3804 * entire IEs after the SSID, so that drivers need not look at these 3805 * at all but just send them after the SSID -- mac80211 includes the 3806 * (extended) supported rates and HT information (where applicable). 3807 * When the scan finishes, ieee80211_scan_completed() must be called; 3808 * note that it also must be called when the scan cannot finish due to 3809 * any error unless this callback returned a negative error code. 3810 * This callback is also allowed to return the special return value 1, 3811 * this indicates that hardware scan isn't desirable right now and a 3812 * software scan should be done instead. A driver wishing to use this 3813 * capability must ensure its (hardware) scan capabilities aren't 3814 * advertised as more capable than mac80211's software scan is. 3815 * The callback can sleep. 3816 * 3817 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan. 3818 * The driver should ask the hardware to cancel the scan (if possible), 3819 * but the scan will be completed only after the driver will call 3820 * ieee80211_scan_completed(). 3821 * This callback is needed for wowlan, to prevent enqueueing a new 3822 * scan_work after the low-level driver was already suspended. 3823 * The callback can sleep. 3824 * 3825 * @sched_scan_start: Ask the hardware to start scanning repeatedly at 3826 * specific intervals. The driver must call the 3827 * ieee80211_sched_scan_results() function whenever it finds results. 3828 * This process will continue until sched_scan_stop is called. 3829 * 3830 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan. 3831 * In this case, ieee80211_sched_scan_stopped() must not be called. 3832 * 3833 * @sw_scan_start: Notifier function that is called just before a software scan 3834 * is started. Can be NULL, if the driver doesn't need this notification. 3835 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR, 3836 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it 3837 * can use this parameter. The callback can sleep. 3838 * 3839 * @sw_scan_complete: Notifier function that is called just after a 3840 * software scan finished. Can be NULL, if the driver doesn't need 3841 * this notification. 3842 * The callback can sleep. 3843 * 3844 * @get_stats: Return low-level statistics. 3845 * Returns zero if statistics are available. 3846 * The callback can sleep. 3847 * 3848 * @get_key_seq: If your device implements encryption in hardware and does 3849 * IV/PN assignment then this callback should be provided to read the 3850 * IV/PN for the given key from hardware. 3851 * The callback must be atomic. 3852 * 3853 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this 3854 * if the device does fragmentation by itself. Note that to prevent the 3855 * stack from doing fragmentation IEEE80211_HW_SUPPORTS_TX_FRAG 3856 * should be set as well. 3857 * The callback can sleep. 3858 * 3859 * @set_rts_threshold: Configuration of RTS threshold (if device needs it) 3860 * The callback can sleep. 3861 * 3862 * @sta_add: Notifies low level driver about addition of an associated station, 3863 * AP, IBSS/WDS/mesh peer etc. This callback can sleep. 3864 * 3865 * @sta_remove: Notifies low level driver about removal of an associated 3866 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback 3867 * returns it isn't safe to use the pointer, not even RCU protected; 3868 * no RCU grace period is guaranteed between returning here and freeing 3869 * the station. See @sta_pre_rcu_remove if needed. 3870 * This callback can sleep. 3871 * 3872 * @link_add_debugfs: Drivers can use this callback to add debugfs files 3873 * when a link is added to a mac80211 vif. This callback should be within 3874 * a CONFIG_MAC80211_DEBUGFS conditional. This callback can sleep. 3875 * For non-MLO the callback will be called once for the default bss_conf 3876 * with the vif's directory rather than a separate subdirectory. 3877 * 3878 * @sta_add_debugfs: Drivers can use this callback to add debugfs files 3879 * when a station is added to mac80211's station list. This callback 3880 * should be within a CONFIG_MAC80211_DEBUGFS conditional. This 3881 * callback can sleep. 3882 * 3883 * @link_sta_add_debugfs: Drivers can use this callback to add debugfs files 3884 * when a link is added to a mac80211 station. This callback 3885 * should be within a CONFIG_MAC80211_DEBUGFS conditional. This 3886 * callback can sleep. 3887 * For non-MLO the callback will be called once for the deflink with the 3888 * station's directory rather than a separate subdirectory. 3889 * 3890 * @sta_notify: Notifies low level driver about power state transition of an 3891 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating 3892 * in AP mode, this callback will not be called when the flag 3893 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic. 3894 * 3895 * @sta_set_txpwr: Configure the station tx power. This callback set the tx 3896 * power for the station. 3897 * This callback can sleep. 3898 * 3899 * @sta_state: Notifies low level driver about state transition of a 3900 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.) 3901 * This callback is mutually exclusive with @sta_add/@sta_remove. 3902 * It must not fail for down transitions but may fail for transitions 3903 * up the list of states. Also note that after the callback returns it 3904 * isn't safe to use the pointer, not even RCU protected - no RCU grace 3905 * period is guaranteed between returning here and freeing the station. 3906 * See @sta_pre_rcu_remove if needed. 3907 * The callback can sleep. 3908 * 3909 * @sta_pre_rcu_remove: Notify driver about station removal before RCU 3910 * synchronisation. This is useful if a driver needs to have station 3911 * pointers protected using RCU, it can then use this call to clear 3912 * the pointers instead of waiting for an RCU grace period to elapse 3913 * in @sta_state. 3914 * The callback can sleep. 3915 * 3916 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be 3917 * used to transmit to the station. The changes are advertised with bits 3918 * from &enum ieee80211_rate_control_changed and the values are reflected 3919 * in the station data. This callback should only be used when the driver 3920 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since 3921 * otherwise the rate control algorithm is notified directly. 3922 * Must be atomic. 3923 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This 3924 * is only used if the configured rate control algorithm actually uses 3925 * the new rate table API, and is therefore optional. Must be atomic. 3926 * 3927 * @sta_statistics: Get statistics for this station. For example with beacon 3928 * filtering, the statistics kept by mac80211 might not be accurate, so 3929 * let the driver pre-fill the statistics. The driver can fill most of 3930 * the values (indicating which by setting the filled bitmap), but not 3931 * all of them make sense - see the source for which ones are possible. 3932 * Statistics that the driver doesn't fill will be filled by mac80211. 3933 * The callback can sleep. 3934 * 3935 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max), 3936 * bursting) for a hardware TX queue. 3937 * Returns a negative error code on failure. 3938 * The callback can sleep. 3939 * 3940 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently, 3941 * this is only used for IBSS mode BSSID merging and debugging. Is not a 3942 * required function. 3943 * The callback can sleep. 3944 * 3945 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware. 3946 * Currently, this is only used for IBSS mode debugging. Is not a 3947 * required function. 3948 * The callback can sleep. 3949 * 3950 * @offset_tsf: Offset the TSF timer by the specified value in the 3951 * firmware/hardware. Preferred to set_tsf as it avoids delay between 3952 * calling set_tsf() and hardware getting programmed, which will show up 3953 * as TSF delay. Is not a required function. 3954 * The callback can sleep. 3955 * 3956 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize 3957 * with other STAs in the IBSS. This is only used in IBSS mode. This 3958 * function is optional if the firmware/hardware takes full care of 3959 * TSF synchronization. 3960 * The callback can sleep. 3961 * 3962 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us. 3963 * This is needed only for IBSS mode and the result of this function is 3964 * used to determine whether to reply to Probe Requests. 3965 * Returns non-zero if this device sent the last beacon. 3966 * The callback can sleep. 3967 * 3968 * @get_survey: Return per-channel survey information 3969 * 3970 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also 3971 * need to set wiphy->rfkill_poll to %true before registration, 3972 * and need to call wiphy_rfkill_set_hw_state() in the callback. 3973 * The callback can sleep. 3974 * 3975 * @set_coverage_class: Set slot time for given coverage class as specified 3976 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout 3977 * accordingly; coverage class equals to -1 to enable ACK timeout 3978 * estimation algorithm (dynack). To disable dynack set valid value for 3979 * coverage class. This callback is not required and may sleep. 3980 * 3981 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may 3982 * be %NULL. The callback can sleep. 3983 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep. 3984 * 3985 * @flush: Flush all pending frames from the hardware queue, making sure 3986 * that the hardware queues are empty. The @queues parameter is a bitmap 3987 * of queues to flush, which is useful if different virtual interfaces 3988 * use different hardware queues; it may also indicate all queues. 3989 * If the parameter @drop is set to %true, pending frames may be dropped. 3990 * Note that vif can be NULL. 3991 * The callback can sleep. 3992 * 3993 * @flush_sta: Flush or drop all pending frames from the hardware queue(s) for 3994 * the given station, as it's about to be removed. 3995 * The callback can sleep. 3996 * 3997 * @channel_switch: Drivers that need (or want) to offload the channel 3998 * switch operation for CSAs received from the AP may implement this 3999 * callback. They must then call ieee80211_chswitch_done() to indicate 4000 * completion of the channel switch. 4001 * 4002 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device. 4003 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may 4004 * reject TX/RX mask combinations they cannot support by returning -EINVAL 4005 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX). 4006 * 4007 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant). 4008 * 4009 * @remain_on_channel: Starts an off-channel period on the given channel, must 4010 * call back to ieee80211_ready_on_channel() when on that channel. Note 4011 * that normal channel traffic is not stopped as this is intended for hw 4012 * offload. Frames to transmit on the off-channel channel are transmitted 4013 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the 4014 * duration (which will always be non-zero) expires, the driver must call 4015 * ieee80211_remain_on_channel_expired(). 4016 * Note that this callback may be called while the device is in IDLE and 4017 * must be accepted in this case. 4018 * This callback may sleep. 4019 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is 4020 * aborted before it expires. This callback may sleep. 4021 * 4022 * @set_ringparam: Set tx and rx ring sizes. 4023 * 4024 * @get_ringparam: Get tx and rx ring current and maximum sizes. 4025 * 4026 * @tx_frames_pending: Check if there is any pending frame in the hardware 4027 * queues before entering power save. 4028 * 4029 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection 4030 * when transmitting a frame. Currently only legacy rates are handled. 4031 * The callback can sleep. 4032 * @event_callback: Notify driver about any event in mac80211. See 4033 * &enum ieee80211_event_type for the different types. 4034 * The callback must be atomic. 4035 * 4036 * @release_buffered_frames: Release buffered frames according to the given 4037 * parameters. In the case where the driver buffers some frames for 4038 * sleeping stations mac80211 will use this callback to tell the driver 4039 * to release some frames, either for PS-poll or uAPSD. 4040 * Note that if the @more_data parameter is %false the driver must check 4041 * if there are more frames on the given TIDs, and if there are more than 4042 * the frames being released then it must still set the more-data bit in 4043 * the frame. If the @more_data parameter is %true, then of course the 4044 * more-data bit must always be set. 4045 * The @tids parameter tells the driver which TIDs to release frames 4046 * from, for PS-poll it will always have only a single bit set. 4047 * In the case this is used for a PS-poll initiated release, the 4048 * @num_frames parameter will always be 1 so code can be shared. In 4049 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag 4050 * on the TX status (and must report TX status) so that the PS-poll 4051 * period is properly ended. This is used to avoid sending multiple 4052 * responses for a retried PS-poll frame. 4053 * In the case this is used for uAPSD, the @num_frames parameter may be 4054 * bigger than one, but the driver may send fewer frames (it must send 4055 * at least one, however). In this case it is also responsible for 4056 * setting the EOSP flag in the QoS header of the frames. Also, when the 4057 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP 4058 * on the last frame in the SP. Alternatively, it may call the function 4059 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP. 4060 * This callback must be atomic. 4061 * @allow_buffered_frames: Prepare device to allow the given number of frames 4062 * to go out to the given station. The frames will be sent by mac80211 4063 * via the usual TX path after this call. The TX information for frames 4064 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set 4065 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case 4066 * frames from multiple TIDs are released and the driver might reorder 4067 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag 4068 * on the last frame and clear it on all others and also handle the EOSP 4069 * bit in the QoS header correctly. Alternatively, it can also call the 4070 * ieee80211_sta_eosp() function. 4071 * The @tids parameter is a bitmap and tells the driver which TIDs the 4072 * frames will be on; it will at most have two bits set. 4073 * This callback must be atomic. 4074 * 4075 * @get_et_sset_count: Ethtool API to get string-set count. 4076 * Note that the wiphy mutex is not held for this callback since it's 4077 * expected to return a static value. 4078 * 4079 * @get_et_stats: Ethtool API to get a set of u64 stats. 4080 * 4081 * @get_et_strings: Ethtool API to get a set of strings to describe stats 4082 * and perhaps other supported types of ethtool data-sets. 4083 * Note that the wiphy mutex is not held for this callback since it's 4084 * expected to return a static value. 4085 * 4086 * @mgd_prepare_tx: Prepare for transmitting a management frame for association 4087 * before associated. In multi-channel scenarios, a virtual interface is 4088 * bound to a channel before it is associated, but as it isn't associated 4089 * yet it need not necessarily be given airtime, in particular since any 4090 * transmission to a P2P GO needs to be synchronized against the GO's 4091 * powersave state. mac80211 will call this function before transmitting a 4092 * management frame prior to having successfully associated to allow the 4093 * driver to give it channel time for the transmission, to get a response 4094 * and to be able to synchronize with the GO. 4095 * For drivers that set %IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP, mac80211 4096 * would also call this function before transmitting a deauthentication 4097 * frame in case that no beacon was heard from the AP/P2P GO. 4098 * The callback will be called before each transmission and upon return 4099 * mac80211 will transmit the frame right away. 4100 * Additional information is passed in the &struct ieee80211_prep_tx_info 4101 * data. If duration there is greater than zero, mac80211 hints to the 4102 * driver the duration for which the operation is requested. 4103 * The callback is optional and can (should!) sleep. 4104 * @mgd_complete_tx: Notify the driver that the response frame for a previously 4105 * transmitted frame announced with @mgd_prepare_tx was received, the data 4106 * is filled similarly to @mgd_prepare_tx though the duration is not used. 4107 * 4108 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending 4109 * a TDLS discovery-request, we expect a reply to arrive on the AP's 4110 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS 4111 * setup-response is a direct packet not buffered by the AP. 4112 * mac80211 will call this function just before the transmission of a TDLS 4113 * discovery-request. The recommended period of protection is at least 4114 * 2 * (DTIM period). 4115 * The callback is optional and can sleep. 4116 * 4117 * @add_chanctx: Notifies device driver about new channel context creation. 4118 * This callback may sleep. 4119 * @remove_chanctx: Notifies device driver about channel context destruction. 4120 * This callback may sleep. 4121 * @change_chanctx: Notifies device driver about channel context changes that 4122 * may happen when combining different virtual interfaces on the same 4123 * channel context with different settings 4124 * This callback may sleep. 4125 * @assign_vif_chanctx: Notifies device driver about channel context being bound 4126 * to vif. Possible use is for hw queue remapping. 4127 * This callback may sleep. 4128 * @unassign_vif_chanctx: Notifies device driver about channel context being 4129 * unbound from vif. 4130 * This callback may sleep. 4131 * @switch_vif_chanctx: switch a number of vifs from one chanctx to 4132 * another, as specified in the list of 4133 * @ieee80211_vif_chanctx_switch passed to the driver, according 4134 * to the mode defined in &ieee80211_chanctx_switch_mode. 4135 * This callback may sleep. 4136 * 4137 * @start_ap: Start operation on the AP interface, this is called after all the 4138 * information in bss_conf is set and beacon can be retrieved. A channel 4139 * context is bound before this is called. Note that if the driver uses 4140 * software scan or ROC, this (and @stop_ap) isn't called when the AP is 4141 * just "paused" for scanning/ROC, which is indicated by the beacon being 4142 * disabled/enabled via @bss_info_changed. 4143 * @stop_ap: Stop operation on the AP interface. 4144 * 4145 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and 4146 * during resume, when the reconfiguration has completed. 4147 * This can help the driver implement the reconfiguration step (and 4148 * indicate mac80211 is ready to receive frames). 4149 * This callback may sleep. 4150 * 4151 * @ipv6_addr_change: IPv6 address assignment on the given interface changed. 4152 * Currently, this is only called for managed or P2P client interfaces. 4153 * This callback is optional; it must not sleep. 4154 * 4155 * @channel_switch_beacon: Starts a channel switch to a new channel. 4156 * Beacons are modified to include CSA or ECSA IEs before calling this 4157 * function. The corresponding count fields in these IEs must be 4158 * decremented, and when they reach 1 the driver must call 4159 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get() 4160 * get the csa counter decremented by mac80211, but must check if it is 4161 * 1 using ieee80211_beacon_counter_is_complete() after the beacon has been 4162 * transmitted and then call ieee80211_csa_finish(). 4163 * If the CSA count starts as zero or 1, this function will not be called, 4164 * since there won't be any time to beacon before the switch anyway. 4165 * @pre_channel_switch: This is an optional callback that is called 4166 * before a channel switch procedure is started (ie. when a STA 4167 * gets a CSA or a userspace initiated channel-switch), allowing 4168 * the driver to prepare for the channel switch. 4169 * @post_channel_switch: This is an optional callback that is called 4170 * after a channel switch procedure is completed, allowing the 4171 * driver to go back to a normal configuration. 4172 * @abort_channel_switch: This is an optional callback that is called 4173 * when channel switch procedure was completed, allowing the 4174 * driver to go back to a normal configuration. 4175 * @channel_switch_rx_beacon: This is an optional callback that is called 4176 * when channel switch procedure is in progress and additional beacon with 4177 * CSA IE was received, allowing driver to track changes in count. 4178 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all 4179 * information in bss_conf is set up and the beacon can be retrieved. A 4180 * channel context is bound before this is called. 4181 * @leave_ibss: Leave the IBSS again. 4182 * 4183 * @get_expected_throughput: extract the expected throughput towards the 4184 * specified station. The returned value is expressed in Kbps. It returns 0 4185 * if the RC algorithm does not have proper data to provide. 4186 * 4187 * @get_txpower: get current maximum tx power (in dBm) based on configuration 4188 * and hardware limits. 4189 * 4190 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver 4191 * is responsible for continually initiating channel-switching operations 4192 * and returning to the base channel for communication with the AP. The 4193 * driver receives a channel-switch request template and the location of 4194 * the switch-timing IE within the template as part of the invocation. 4195 * The template is valid only within the call, and the driver can 4196 * optionally copy the skb for further re-use. 4197 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both 4198 * peers must be on the base channel when the call completes. 4199 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or 4200 * response) has been received from a remote peer. The driver gets 4201 * parameters parsed from the incoming frame and may use them to continue 4202 * an ongoing channel-switch operation. In addition, a channel-switch 4203 * response template is provided, together with the location of the 4204 * switch-timing IE within the template. The skb can only be used within 4205 * the function call. 4206 * 4207 * @wake_tx_queue: Called when new packets have been added to the queue. 4208 * @sync_rx_queues: Process all pending frames in RSS queues. This is a 4209 * synchronization which is needed in case driver has in its RSS queues 4210 * pending frames that were received prior to the control path action 4211 * currently taken (e.g. disassociation) but are not processed yet. 4212 * 4213 * @start_nan: join an existing NAN cluster, or create a new one. 4214 * @stop_nan: leave the NAN cluster. 4215 * @nan_change_conf: change NAN configuration. The data in cfg80211_nan_conf 4216 * contains full new configuration and changes specify which parameters 4217 * are changed with respect to the last NAN config. 4218 * The driver gets both full configuration and the changed parameters since 4219 * some devices may need the full configuration while others need only the 4220 * changed parameters. 4221 * @add_nan_func: Add a NAN function. Returns 0 on success. The data in 4222 * cfg80211_nan_func must not be referenced outside the scope of 4223 * this call. 4224 * @del_nan_func: Remove a NAN function. The driver must call 4225 * ieee80211_nan_func_terminated() with 4226 * NL80211_NAN_FUNC_TERM_REASON_USER_REQUEST reason code upon removal. 4227 * @can_aggregate_in_amsdu: Called in order to determine if HW supports 4228 * aggregating two specific frames in the same A-MSDU. The relation 4229 * between the skbs should be symmetric and transitive. Note that while 4230 * skb is always a real frame, head may or may not be an A-MSDU. 4231 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available. 4232 * Statistics should be cumulative, currently no way to reset is provided. 4233 * 4234 * @start_pmsr: start peer measurement (e.g. FTM) (this call can sleep) 4235 * @abort_pmsr: abort peer measurement (this call can sleep) 4236 * @set_tid_config: Apply TID specific configurations. This callback may sleep. 4237 * @reset_tid_config: Reset TID specific configuration for the peer. 4238 * This callback may sleep. 4239 * @update_vif_offload: Update virtual interface offload flags 4240 * This callback may sleep. 4241 * @sta_set_4addr: Called to notify the driver when a station starts/stops using 4242 * 4-address mode 4243 * @set_sar_specs: Update the SAR (TX power) settings. 4244 * @sta_set_decap_offload: Called to notify the driver when a station is allowed 4245 * to use rx decapsulation offload 4246 * @add_twt_setup: Update hw with TWT agreement parameters received from the peer. 4247 * This callback allows the hw to check if requested parameters 4248 * are supported and if there is enough room for a new agreement. 4249 * The hw is expected to set agreement result in the req_type field of 4250 * twt structure. 4251 * @twt_teardown_request: Update the hw with TWT teardown request received 4252 * from the peer. 4253 * @set_radar_background: Configure dedicated offchannel chain available for 4254 * radar/CAC detection on some hw. This chain can't be used to transmit 4255 * or receive frames and it is bounded to a running wdev. 4256 * Background radar/CAC detection allows to avoid the CAC downtime 4257 * switching to a different channel during CAC detection on the selected 4258 * radar channel. 4259 * The caller is expected to set chandef pointer to NULL in order to 4260 * disable background CAC/radar detection. 4261 * @net_fill_forward_path: Called from .ndo_fill_forward_path in order to 4262 * resolve a path for hardware flow offloading 4263 * @change_vif_links: Change the valid links on an interface, note that while 4264 * removing the old link information is still valid (link_conf pointer), 4265 * but may immediately disappear after the function returns. The old or 4266 * new links bitmaps may be 0 if going from/to a non-MLO situation. 4267 * The @old array contains pointers to the old bss_conf structures 4268 * that were already removed, in case they're needed. 4269 * This callback can sleep. 4270 * @change_sta_links: Change the valid links of a station, similar to 4271 * @change_vif_links. This callback can sleep. 4272 * Note that a sta can also be inserted or removed with valid links, 4273 * i.e. passed to @sta_add/@sta_state with sta->valid_links not zero. 4274 * In fact, cannot change from having valid_links and not having them. 4275 * @set_hw_timestamp: Enable/disable HW timestamping of TM/FTM frames. This is 4276 * not restored at HW reset by mac80211 so drivers need to take care of 4277 * that. 4278 * @net_setup_tc: Called from .ndo_setup_tc in order to prepare hardware 4279 * flow offloading for flows originating from the vif. 4280 * Note that the driver must not assume that the vif driver_data is valid 4281 * at this point, since the callback can be called during netdev teardown. 4282 */ 4283 struct ieee80211_ops { 4284 void (*tx)(struct ieee80211_hw *hw, 4285 struct ieee80211_tx_control *control, 4286 struct sk_buff *skb); 4287 int (*start)(struct ieee80211_hw *hw); 4288 void (*stop)(struct ieee80211_hw *hw); 4289 #ifdef CONFIG_PM 4290 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan); 4291 int (*resume)(struct ieee80211_hw *hw); 4292 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled); 4293 #endif 4294 int (*add_interface)(struct ieee80211_hw *hw, 4295 struct ieee80211_vif *vif); 4296 int (*change_interface)(struct ieee80211_hw *hw, 4297 struct ieee80211_vif *vif, 4298 enum nl80211_iftype new_type, bool p2p); 4299 void (*remove_interface)(struct ieee80211_hw *hw, 4300 struct ieee80211_vif *vif); 4301 int (*config)(struct ieee80211_hw *hw, u32 changed); 4302 void (*bss_info_changed)(struct ieee80211_hw *hw, 4303 struct ieee80211_vif *vif, 4304 struct ieee80211_bss_conf *info, 4305 u64 changed); 4306 void (*vif_cfg_changed)(struct ieee80211_hw *hw, 4307 struct ieee80211_vif *vif, 4308 u64 changed); 4309 void (*link_info_changed)(struct ieee80211_hw *hw, 4310 struct ieee80211_vif *vif, 4311 struct ieee80211_bss_conf *info, 4312 u64 changed); 4313 4314 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 4315 struct ieee80211_bss_conf *link_conf); 4316 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 4317 struct ieee80211_bss_conf *link_conf); 4318 4319 u64 (*prepare_multicast)(struct ieee80211_hw *hw, 4320 struct netdev_hw_addr_list *mc_list); 4321 void (*configure_filter)(struct ieee80211_hw *hw, 4322 unsigned int changed_flags, 4323 unsigned int *total_flags, 4324 u64 multicast); 4325 void (*config_iface_filter)(struct ieee80211_hw *hw, 4326 struct ieee80211_vif *vif, 4327 unsigned int filter_flags, 4328 unsigned int changed_flags); 4329 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta, 4330 bool set); 4331 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd, 4332 struct ieee80211_vif *vif, struct ieee80211_sta *sta, 4333 struct ieee80211_key_conf *key); 4334 void (*update_tkip_key)(struct ieee80211_hw *hw, 4335 struct ieee80211_vif *vif, 4336 struct ieee80211_key_conf *conf, 4337 struct ieee80211_sta *sta, 4338 u32 iv32, u16 *phase1key); 4339 void (*set_rekey_data)(struct ieee80211_hw *hw, 4340 struct ieee80211_vif *vif, 4341 struct cfg80211_gtk_rekey_data *data); 4342 void (*set_default_unicast_key)(struct ieee80211_hw *hw, 4343 struct ieee80211_vif *vif, int idx); 4344 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 4345 struct ieee80211_scan_request *req); 4346 void (*cancel_hw_scan)(struct ieee80211_hw *hw, 4347 struct ieee80211_vif *vif); 4348 int (*sched_scan_start)(struct ieee80211_hw *hw, 4349 struct ieee80211_vif *vif, 4350 struct cfg80211_sched_scan_request *req, 4351 struct ieee80211_scan_ies *ies); 4352 int (*sched_scan_stop)(struct ieee80211_hw *hw, 4353 struct ieee80211_vif *vif); 4354 void (*sw_scan_start)(struct ieee80211_hw *hw, 4355 struct ieee80211_vif *vif, 4356 const u8 *mac_addr); 4357 void (*sw_scan_complete)(struct ieee80211_hw *hw, 4358 struct ieee80211_vif *vif); 4359 int (*get_stats)(struct ieee80211_hw *hw, 4360 struct ieee80211_low_level_stats *stats); 4361 void (*get_key_seq)(struct ieee80211_hw *hw, 4362 struct ieee80211_key_conf *key, 4363 struct ieee80211_key_seq *seq); 4364 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value); 4365 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value); 4366 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 4367 struct ieee80211_sta *sta); 4368 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 4369 struct ieee80211_sta *sta); 4370 #ifdef CONFIG_MAC80211_DEBUGFS 4371 void (*link_add_debugfs)(struct ieee80211_hw *hw, 4372 struct ieee80211_vif *vif, 4373 struct ieee80211_bss_conf *link_conf, 4374 struct dentry *dir); 4375 void (*sta_add_debugfs)(struct ieee80211_hw *hw, 4376 struct ieee80211_vif *vif, 4377 struct ieee80211_sta *sta, 4378 struct dentry *dir); 4379 void (*link_sta_add_debugfs)(struct ieee80211_hw *hw, 4380 struct ieee80211_vif *vif, 4381 struct ieee80211_link_sta *link_sta, 4382 struct dentry *dir); 4383 #endif 4384 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 4385 enum sta_notify_cmd, struct ieee80211_sta *sta); 4386 int (*sta_set_txpwr)(struct ieee80211_hw *hw, 4387 struct ieee80211_vif *vif, 4388 struct ieee80211_sta *sta); 4389 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 4390 struct ieee80211_sta *sta, 4391 enum ieee80211_sta_state old_state, 4392 enum ieee80211_sta_state new_state); 4393 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw, 4394 struct ieee80211_vif *vif, 4395 struct ieee80211_sta *sta); 4396 void (*sta_rc_update)(struct ieee80211_hw *hw, 4397 struct ieee80211_vif *vif, 4398 struct ieee80211_sta *sta, 4399 u32 changed); 4400 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw, 4401 struct ieee80211_vif *vif, 4402 struct ieee80211_sta *sta); 4403 void (*sta_statistics)(struct ieee80211_hw *hw, 4404 struct ieee80211_vif *vif, 4405 struct ieee80211_sta *sta, 4406 struct station_info *sinfo); 4407 int (*conf_tx)(struct ieee80211_hw *hw, 4408 struct ieee80211_vif *vif, 4409 unsigned int link_id, u16 ac, 4410 const struct ieee80211_tx_queue_params *params); 4411 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif); 4412 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 4413 u64 tsf); 4414 void (*offset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 4415 s64 offset); 4416 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif); 4417 int (*tx_last_beacon)(struct ieee80211_hw *hw); 4418 4419 /** 4420 * @ampdu_action: 4421 * Perform a certain A-MPDU action. 4422 * The RA/TID combination determines the destination and TID we want 4423 * the ampdu action to be performed for. The action is defined through 4424 * ieee80211_ampdu_mlme_action. 4425 * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver 4426 * may neither send aggregates containing more subframes than @buf_size 4427 * nor send aggregates in a way that lost frames would exceed the 4428 * buffer size. If just limiting the aggregate size, this would be 4429 * possible with a buf_size of 8: 4430 * 4431 * - ``TX: 1.....7`` 4432 * - ``RX: 2....7`` (lost frame #1) 4433 * - ``TX: 8..1...`` 4434 * 4435 * which is invalid since #1 was now re-transmitted well past the 4436 * buffer size of 8. Correct ways to retransmit #1 would be: 4437 * 4438 * - ``TX: 1 or`` 4439 * - ``TX: 18 or`` 4440 * - ``TX: 81`` 4441 * 4442 * Even ``189`` would be wrong since 1 could be lost again. 4443 * 4444 * Returns a negative error code on failure. The driver may return 4445 * %IEEE80211_AMPDU_TX_START_IMMEDIATE for %IEEE80211_AMPDU_TX_START 4446 * if the session can start immediately. 4447 * 4448 * The callback can sleep. 4449 */ 4450 int (*ampdu_action)(struct ieee80211_hw *hw, 4451 struct ieee80211_vif *vif, 4452 struct ieee80211_ampdu_params *params); 4453 int (*get_survey)(struct ieee80211_hw *hw, int idx, 4454 struct survey_info *survey); 4455 void (*rfkill_poll)(struct ieee80211_hw *hw); 4456 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class); 4457 #ifdef CONFIG_NL80211_TESTMODE 4458 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 4459 void *data, int len); 4460 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb, 4461 struct netlink_callback *cb, 4462 void *data, int len); 4463 #endif 4464 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 4465 u32 queues, bool drop); 4466 void (*flush_sta)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 4467 struct ieee80211_sta *sta); 4468 void (*channel_switch)(struct ieee80211_hw *hw, 4469 struct ieee80211_vif *vif, 4470 struct ieee80211_channel_switch *ch_switch); 4471 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant); 4472 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant); 4473 4474 int (*remain_on_channel)(struct ieee80211_hw *hw, 4475 struct ieee80211_vif *vif, 4476 struct ieee80211_channel *chan, 4477 int duration, 4478 enum ieee80211_roc_type type); 4479 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw, 4480 struct ieee80211_vif *vif); 4481 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx); 4482 void (*get_ringparam)(struct ieee80211_hw *hw, 4483 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max); 4484 bool (*tx_frames_pending)(struct ieee80211_hw *hw); 4485 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 4486 const struct cfg80211_bitrate_mask *mask); 4487 void (*event_callback)(struct ieee80211_hw *hw, 4488 struct ieee80211_vif *vif, 4489 const struct ieee80211_event *event); 4490 4491 void (*allow_buffered_frames)(struct ieee80211_hw *hw, 4492 struct ieee80211_sta *sta, 4493 u16 tids, int num_frames, 4494 enum ieee80211_frame_release_type reason, 4495 bool more_data); 4496 void (*release_buffered_frames)(struct ieee80211_hw *hw, 4497 struct ieee80211_sta *sta, 4498 u16 tids, int num_frames, 4499 enum ieee80211_frame_release_type reason, 4500 bool more_data); 4501 4502 int (*get_et_sset_count)(struct ieee80211_hw *hw, 4503 struct ieee80211_vif *vif, int sset); 4504 void (*get_et_stats)(struct ieee80211_hw *hw, 4505 struct ieee80211_vif *vif, 4506 struct ethtool_stats *stats, u64 *data); 4507 void (*get_et_strings)(struct ieee80211_hw *hw, 4508 struct ieee80211_vif *vif, 4509 u32 sset, u8 *data); 4510 4511 void (*mgd_prepare_tx)(struct ieee80211_hw *hw, 4512 struct ieee80211_vif *vif, 4513 struct ieee80211_prep_tx_info *info); 4514 void (*mgd_complete_tx)(struct ieee80211_hw *hw, 4515 struct ieee80211_vif *vif, 4516 struct ieee80211_prep_tx_info *info); 4517 4518 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw, 4519 struct ieee80211_vif *vif); 4520 4521 int (*add_chanctx)(struct ieee80211_hw *hw, 4522 struct ieee80211_chanctx_conf *ctx); 4523 void (*remove_chanctx)(struct ieee80211_hw *hw, 4524 struct ieee80211_chanctx_conf *ctx); 4525 void (*change_chanctx)(struct ieee80211_hw *hw, 4526 struct ieee80211_chanctx_conf *ctx, 4527 u32 changed); 4528 int (*assign_vif_chanctx)(struct ieee80211_hw *hw, 4529 struct ieee80211_vif *vif, 4530 struct ieee80211_bss_conf *link_conf, 4531 struct ieee80211_chanctx_conf *ctx); 4532 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw, 4533 struct ieee80211_vif *vif, 4534 struct ieee80211_bss_conf *link_conf, 4535 struct ieee80211_chanctx_conf *ctx); 4536 int (*switch_vif_chanctx)(struct ieee80211_hw *hw, 4537 struct ieee80211_vif_chanctx_switch *vifs, 4538 int n_vifs, 4539 enum ieee80211_chanctx_switch_mode mode); 4540 4541 void (*reconfig_complete)(struct ieee80211_hw *hw, 4542 enum ieee80211_reconfig_type reconfig_type); 4543 4544 #if IS_ENABLED(CONFIG_IPV6) 4545 void (*ipv6_addr_change)(struct ieee80211_hw *hw, 4546 struct ieee80211_vif *vif, 4547 struct inet6_dev *idev); 4548 #endif 4549 void (*channel_switch_beacon)(struct ieee80211_hw *hw, 4550 struct ieee80211_vif *vif, 4551 struct cfg80211_chan_def *chandef); 4552 int (*pre_channel_switch)(struct ieee80211_hw *hw, 4553 struct ieee80211_vif *vif, 4554 struct ieee80211_channel_switch *ch_switch); 4555 4556 int (*post_channel_switch)(struct ieee80211_hw *hw, 4557 struct ieee80211_vif *vif, 4558 struct ieee80211_bss_conf *link_conf); 4559 void (*abort_channel_switch)(struct ieee80211_hw *hw, 4560 struct ieee80211_vif *vif); 4561 void (*channel_switch_rx_beacon)(struct ieee80211_hw *hw, 4562 struct ieee80211_vif *vif, 4563 struct ieee80211_channel_switch *ch_switch); 4564 4565 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif); 4566 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif); 4567 u32 (*get_expected_throughput)(struct ieee80211_hw *hw, 4568 struct ieee80211_sta *sta); 4569 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 4570 int *dbm); 4571 4572 int (*tdls_channel_switch)(struct ieee80211_hw *hw, 4573 struct ieee80211_vif *vif, 4574 struct ieee80211_sta *sta, u8 oper_class, 4575 struct cfg80211_chan_def *chandef, 4576 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie); 4577 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw, 4578 struct ieee80211_vif *vif, 4579 struct ieee80211_sta *sta); 4580 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw, 4581 struct ieee80211_vif *vif, 4582 struct ieee80211_tdls_ch_sw_params *params); 4583 4584 void (*wake_tx_queue)(struct ieee80211_hw *hw, 4585 struct ieee80211_txq *txq); 4586 void (*sync_rx_queues)(struct ieee80211_hw *hw); 4587 4588 int (*start_nan)(struct ieee80211_hw *hw, 4589 struct ieee80211_vif *vif, 4590 struct cfg80211_nan_conf *conf); 4591 int (*stop_nan)(struct ieee80211_hw *hw, 4592 struct ieee80211_vif *vif); 4593 int (*nan_change_conf)(struct ieee80211_hw *hw, 4594 struct ieee80211_vif *vif, 4595 struct cfg80211_nan_conf *conf, u32 changes); 4596 int (*add_nan_func)(struct ieee80211_hw *hw, 4597 struct ieee80211_vif *vif, 4598 const struct cfg80211_nan_func *nan_func); 4599 void (*del_nan_func)(struct ieee80211_hw *hw, 4600 struct ieee80211_vif *vif, 4601 u8 instance_id); 4602 bool (*can_aggregate_in_amsdu)(struct ieee80211_hw *hw, 4603 struct sk_buff *head, 4604 struct sk_buff *skb); 4605 int (*get_ftm_responder_stats)(struct ieee80211_hw *hw, 4606 struct ieee80211_vif *vif, 4607 struct cfg80211_ftm_responder_stats *ftm_stats); 4608 int (*start_pmsr)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 4609 struct cfg80211_pmsr_request *request); 4610 void (*abort_pmsr)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 4611 struct cfg80211_pmsr_request *request); 4612 int (*set_tid_config)(struct ieee80211_hw *hw, 4613 struct ieee80211_vif *vif, 4614 struct ieee80211_sta *sta, 4615 struct cfg80211_tid_config *tid_conf); 4616 int (*reset_tid_config)(struct ieee80211_hw *hw, 4617 struct ieee80211_vif *vif, 4618 struct ieee80211_sta *sta, u8 tids); 4619 void (*update_vif_offload)(struct ieee80211_hw *hw, 4620 struct ieee80211_vif *vif); 4621 void (*sta_set_4addr)(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 4622 struct ieee80211_sta *sta, bool enabled); 4623 int (*set_sar_specs)(struct ieee80211_hw *hw, 4624 const struct cfg80211_sar_specs *sar); 4625 void (*sta_set_decap_offload)(struct ieee80211_hw *hw, 4626 struct ieee80211_vif *vif, 4627 struct ieee80211_sta *sta, bool enabled); 4628 void (*add_twt_setup)(struct ieee80211_hw *hw, 4629 struct ieee80211_sta *sta, 4630 struct ieee80211_twt_setup *twt); 4631 void (*twt_teardown_request)(struct ieee80211_hw *hw, 4632 struct ieee80211_sta *sta, u8 flowid); 4633 int (*set_radar_background)(struct ieee80211_hw *hw, 4634 struct cfg80211_chan_def *chandef); 4635 int (*net_fill_forward_path)(struct ieee80211_hw *hw, 4636 struct ieee80211_vif *vif, 4637 struct ieee80211_sta *sta, 4638 struct net_device_path_ctx *ctx, 4639 struct net_device_path *path); 4640 int (*change_vif_links)(struct ieee80211_hw *hw, 4641 struct ieee80211_vif *vif, 4642 u16 old_links, u16 new_links, 4643 struct ieee80211_bss_conf *old[IEEE80211_MLD_MAX_NUM_LINKS]); 4644 int (*change_sta_links)(struct ieee80211_hw *hw, 4645 struct ieee80211_vif *vif, 4646 struct ieee80211_sta *sta, 4647 u16 old_links, u16 new_links); 4648 int (*set_hw_timestamp)(struct ieee80211_hw *hw, 4649 struct ieee80211_vif *vif, 4650 struct cfg80211_set_hw_timestamp *hwts); 4651 int (*net_setup_tc)(struct ieee80211_hw *hw, 4652 struct ieee80211_vif *vif, 4653 struct net_device *dev, 4654 enum tc_setup_type type, 4655 void *type_data); 4656 }; 4657 4658 /** 4659 * ieee80211_alloc_hw_nm - Allocate a new hardware device 4660 * 4661 * This must be called once for each hardware device. The returned pointer 4662 * must be used to refer to this device when calling other functions. 4663 * mac80211 allocates a private data area for the driver pointed to by 4664 * @priv in &struct ieee80211_hw, the size of this area is given as 4665 * @priv_data_len. 4666 * 4667 * @priv_data_len: length of private data 4668 * @ops: callbacks for this device 4669 * @requested_name: Requested name for this device. 4670 * NULL is valid value, and means use the default naming (phy%d) 4671 * 4672 * Return: A pointer to the new hardware device, or %NULL on error. 4673 */ 4674 struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len, 4675 const struct ieee80211_ops *ops, 4676 const char *requested_name); 4677 4678 /** 4679 * ieee80211_alloc_hw - Allocate a new hardware device 4680 * 4681 * This must be called once for each hardware device. The returned pointer 4682 * must be used to refer to this device when calling other functions. 4683 * mac80211 allocates a private data area for the driver pointed to by 4684 * @priv in &struct ieee80211_hw, the size of this area is given as 4685 * @priv_data_len. 4686 * 4687 * @priv_data_len: length of private data 4688 * @ops: callbacks for this device 4689 * 4690 * Return: A pointer to the new hardware device, or %NULL on error. 4691 */ 4692 static inline 4693 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len, 4694 const struct ieee80211_ops *ops) 4695 { 4696 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL); 4697 } 4698 4699 /** 4700 * ieee80211_register_hw - Register hardware device 4701 * 4702 * You must call this function before any other functions in 4703 * mac80211. Note that before a hardware can be registered, you 4704 * need to fill the contained wiphy's information. 4705 * 4706 * @hw: the device to register as returned by ieee80211_alloc_hw() 4707 * 4708 * Return: 0 on success. An error code otherwise. 4709 */ 4710 int ieee80211_register_hw(struct ieee80211_hw *hw); 4711 4712 /** 4713 * struct ieee80211_tpt_blink - throughput blink description 4714 * @throughput: throughput in Kbit/sec 4715 * @blink_time: blink time in milliseconds 4716 * (full cycle, ie. one off + one on period) 4717 */ 4718 struct ieee80211_tpt_blink { 4719 int throughput; 4720 int blink_time; 4721 }; 4722 4723 /** 4724 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags 4725 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio 4726 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working 4727 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one 4728 * interface is connected in some way, including being an AP 4729 */ 4730 enum ieee80211_tpt_led_trigger_flags { 4731 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0), 4732 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1), 4733 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2), 4734 }; 4735 4736 #ifdef CONFIG_MAC80211_LEDS 4737 const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw); 4738 const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw); 4739 const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw); 4740 const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw); 4741 const char * 4742 __ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, 4743 unsigned int flags, 4744 const struct ieee80211_tpt_blink *blink_table, 4745 unsigned int blink_table_len); 4746 #endif 4747 /** 4748 * ieee80211_get_tx_led_name - get name of TX LED 4749 * 4750 * mac80211 creates a transmit LED trigger for each wireless hardware 4751 * that can be used to drive LEDs if your driver registers a LED device. 4752 * This function returns the name (or %NULL if not configured for LEDs) 4753 * of the trigger so you can automatically link the LED device. 4754 * 4755 * @hw: the hardware to get the LED trigger name for 4756 * 4757 * Return: The name of the LED trigger. %NULL if not configured for LEDs. 4758 */ 4759 static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw) 4760 { 4761 #ifdef CONFIG_MAC80211_LEDS 4762 return __ieee80211_get_tx_led_name(hw); 4763 #else 4764 return NULL; 4765 #endif 4766 } 4767 4768 /** 4769 * ieee80211_get_rx_led_name - get name of RX LED 4770 * 4771 * mac80211 creates a receive LED trigger for each wireless hardware 4772 * that can be used to drive LEDs if your driver registers a LED device. 4773 * This function returns the name (or %NULL if not configured for LEDs) 4774 * of the trigger so you can automatically link the LED device. 4775 * 4776 * @hw: the hardware to get the LED trigger name for 4777 * 4778 * Return: The name of the LED trigger. %NULL if not configured for LEDs. 4779 */ 4780 static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw) 4781 { 4782 #ifdef CONFIG_MAC80211_LEDS 4783 return __ieee80211_get_rx_led_name(hw); 4784 #else 4785 return NULL; 4786 #endif 4787 } 4788 4789 /** 4790 * ieee80211_get_assoc_led_name - get name of association LED 4791 * 4792 * mac80211 creates a association LED trigger for each wireless hardware 4793 * that can be used to drive LEDs if your driver registers a LED device. 4794 * This function returns the name (or %NULL if not configured for LEDs) 4795 * of the trigger so you can automatically link the LED device. 4796 * 4797 * @hw: the hardware to get the LED trigger name for 4798 * 4799 * Return: The name of the LED trigger. %NULL if not configured for LEDs. 4800 */ 4801 static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw) 4802 { 4803 #ifdef CONFIG_MAC80211_LEDS 4804 return __ieee80211_get_assoc_led_name(hw); 4805 #else 4806 return NULL; 4807 #endif 4808 } 4809 4810 /** 4811 * ieee80211_get_radio_led_name - get name of radio LED 4812 * 4813 * mac80211 creates a radio change LED trigger for each wireless hardware 4814 * that can be used to drive LEDs if your driver registers a LED device. 4815 * This function returns the name (or %NULL if not configured for LEDs) 4816 * of the trigger so you can automatically link the LED device. 4817 * 4818 * @hw: the hardware to get the LED trigger name for 4819 * 4820 * Return: The name of the LED trigger. %NULL if not configured for LEDs. 4821 */ 4822 static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw) 4823 { 4824 #ifdef CONFIG_MAC80211_LEDS 4825 return __ieee80211_get_radio_led_name(hw); 4826 #else 4827 return NULL; 4828 #endif 4829 } 4830 4831 /** 4832 * ieee80211_create_tpt_led_trigger - create throughput LED trigger 4833 * @hw: the hardware to create the trigger for 4834 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags 4835 * @blink_table: the blink table -- needs to be ordered by throughput 4836 * @blink_table_len: size of the blink table 4837 * 4838 * Return: %NULL (in case of error, or if no LED triggers are 4839 * configured) or the name of the new trigger. 4840 * 4841 * Note: This function must be called before ieee80211_register_hw(). 4842 */ 4843 static inline const char * 4844 ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags, 4845 const struct ieee80211_tpt_blink *blink_table, 4846 unsigned int blink_table_len) 4847 { 4848 #ifdef CONFIG_MAC80211_LEDS 4849 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table, 4850 blink_table_len); 4851 #else 4852 return NULL; 4853 #endif 4854 } 4855 4856 /** 4857 * ieee80211_unregister_hw - Unregister a hardware device 4858 * 4859 * This function instructs mac80211 to free allocated resources 4860 * and unregister netdevices from the networking subsystem. 4861 * 4862 * @hw: the hardware to unregister 4863 */ 4864 void ieee80211_unregister_hw(struct ieee80211_hw *hw); 4865 4866 /** 4867 * ieee80211_free_hw - free hardware descriptor 4868 * 4869 * This function frees everything that was allocated, including the 4870 * private data for the driver. You must call ieee80211_unregister_hw() 4871 * before calling this function. 4872 * 4873 * @hw: the hardware to free 4874 */ 4875 void ieee80211_free_hw(struct ieee80211_hw *hw); 4876 4877 /** 4878 * ieee80211_restart_hw - restart hardware completely 4879 * 4880 * Call this function when the hardware was restarted for some reason 4881 * (hardware error, ...) and the driver is unable to restore its state 4882 * by itself. mac80211 assumes that at this point the driver/hardware 4883 * is completely uninitialised and stopped, it starts the process by 4884 * calling the ->start() operation. The driver will need to reset all 4885 * internal state that it has prior to calling this function. 4886 * 4887 * @hw: the hardware to restart 4888 */ 4889 void ieee80211_restart_hw(struct ieee80211_hw *hw); 4890 4891 /** 4892 * ieee80211_rx_list - receive frame and store processed skbs in a list 4893 * 4894 * Use this function to hand received frames to mac80211. The receive 4895 * buffer in @skb must start with an IEEE 802.11 header. In case of a 4896 * paged @skb is used, the driver is recommended to put the ieee80211 4897 * header of the frame on the linear part of the @skb to avoid memory 4898 * allocation and/or memcpy by the stack. 4899 * 4900 * This function may not be called in IRQ context. Calls to this function 4901 * for a single hardware must be synchronized against each other. Calls to 4902 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be 4903 * mixed for a single hardware. Must not run concurrently with 4904 * ieee80211_tx_status() or ieee80211_tx_status_ni(). 4905 * 4906 * This function must be called with BHs disabled and RCU read lock 4907 * 4908 * @hw: the hardware this frame came in on 4909 * @sta: the station the frame was received from, or %NULL 4910 * @skb: the buffer to receive, owned by mac80211 after this call 4911 * @list: the destination list 4912 */ 4913 void ieee80211_rx_list(struct ieee80211_hw *hw, struct ieee80211_sta *sta, 4914 struct sk_buff *skb, struct list_head *list); 4915 4916 /** 4917 * ieee80211_rx_napi - receive frame from NAPI context 4918 * 4919 * Use this function to hand received frames to mac80211. The receive 4920 * buffer in @skb must start with an IEEE 802.11 header. In case of a 4921 * paged @skb is used, the driver is recommended to put the ieee80211 4922 * header of the frame on the linear part of the @skb to avoid memory 4923 * allocation and/or memcpy by the stack. 4924 * 4925 * This function may not be called in IRQ context. Calls to this function 4926 * for a single hardware must be synchronized against each other. Calls to 4927 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be 4928 * mixed for a single hardware. Must not run concurrently with 4929 * ieee80211_tx_status() or ieee80211_tx_status_ni(). 4930 * 4931 * This function must be called with BHs disabled. 4932 * 4933 * @hw: the hardware this frame came in on 4934 * @sta: the station the frame was received from, or %NULL 4935 * @skb: the buffer to receive, owned by mac80211 after this call 4936 * @napi: the NAPI context 4937 */ 4938 void ieee80211_rx_napi(struct ieee80211_hw *hw, struct ieee80211_sta *sta, 4939 struct sk_buff *skb, struct napi_struct *napi); 4940 4941 /** 4942 * ieee80211_rx - receive frame 4943 * 4944 * Use this function to hand received frames to mac80211. The receive 4945 * buffer in @skb must start with an IEEE 802.11 header. In case of a 4946 * paged @skb is used, the driver is recommended to put the ieee80211 4947 * header of the frame on the linear part of the @skb to avoid memory 4948 * allocation and/or memcpy by the stack. 4949 * 4950 * This function may not be called in IRQ context. Calls to this function 4951 * for a single hardware must be synchronized against each other. Calls to 4952 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be 4953 * mixed for a single hardware. Must not run concurrently with 4954 * ieee80211_tx_status() or ieee80211_tx_status_ni(). 4955 * 4956 * In process context use instead ieee80211_rx_ni(). 4957 * 4958 * @hw: the hardware this frame came in on 4959 * @skb: the buffer to receive, owned by mac80211 after this call 4960 */ 4961 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb) 4962 { 4963 ieee80211_rx_napi(hw, NULL, skb, NULL); 4964 } 4965 4966 /** 4967 * ieee80211_rx_irqsafe - receive frame 4968 * 4969 * Like ieee80211_rx() but can be called in IRQ context 4970 * (internally defers to a tasklet.) 4971 * 4972 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not 4973 * be mixed for a single hardware.Must not run concurrently with 4974 * ieee80211_tx_status() or ieee80211_tx_status_ni(). 4975 * 4976 * @hw: the hardware this frame came in on 4977 * @skb: the buffer to receive, owned by mac80211 after this call 4978 */ 4979 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb); 4980 4981 /** 4982 * ieee80211_rx_ni - receive frame (in process context) 4983 * 4984 * Like ieee80211_rx() but can be called in process context 4985 * (internally disables bottom halves). 4986 * 4987 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may 4988 * not be mixed for a single hardware. Must not run concurrently with 4989 * ieee80211_tx_status() or ieee80211_tx_status_ni(). 4990 * 4991 * @hw: the hardware this frame came in on 4992 * @skb: the buffer to receive, owned by mac80211 after this call 4993 */ 4994 static inline void ieee80211_rx_ni(struct ieee80211_hw *hw, 4995 struct sk_buff *skb) 4996 { 4997 local_bh_disable(); 4998 ieee80211_rx(hw, skb); 4999 local_bh_enable(); 5000 } 5001 5002 /** 5003 * ieee80211_sta_ps_transition - PS transition for connected sta 5004 * 5005 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS 5006 * flag set, use this function to inform mac80211 about a connected station 5007 * entering/leaving PS mode. 5008 * 5009 * This function may not be called in IRQ context or with softirqs enabled. 5010 * 5011 * Calls to this function for a single hardware must be synchronized against 5012 * each other. 5013 * 5014 * @sta: currently connected sta 5015 * @start: start or stop PS 5016 * 5017 * Return: 0 on success. -EINVAL when the requested PS mode is already set. 5018 */ 5019 int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start); 5020 5021 /** 5022 * ieee80211_sta_ps_transition_ni - PS transition for connected sta 5023 * (in process context) 5024 * 5025 * Like ieee80211_sta_ps_transition() but can be called in process context 5026 * (internally disables bottom halves). Concurrent call restriction still 5027 * applies. 5028 * 5029 * @sta: currently connected sta 5030 * @start: start or stop PS 5031 * 5032 * Return: Like ieee80211_sta_ps_transition(). 5033 */ 5034 static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta, 5035 bool start) 5036 { 5037 int ret; 5038 5039 local_bh_disable(); 5040 ret = ieee80211_sta_ps_transition(sta, start); 5041 local_bh_enable(); 5042 5043 return ret; 5044 } 5045 5046 /** 5047 * ieee80211_sta_pspoll - PS-Poll frame received 5048 * @sta: currently connected station 5049 * 5050 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set, 5051 * use this function to inform mac80211 that a PS-Poll frame from a 5052 * connected station was received. 5053 * This must be used in conjunction with ieee80211_sta_ps_transition() 5054 * and possibly ieee80211_sta_uapsd_trigger(); calls to all three must 5055 * be serialized. 5056 */ 5057 void ieee80211_sta_pspoll(struct ieee80211_sta *sta); 5058 5059 /** 5060 * ieee80211_sta_uapsd_trigger - (potential) U-APSD trigger frame received 5061 * @sta: currently connected station 5062 * @tid: TID of the received (potential) trigger frame 5063 * 5064 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set, 5065 * use this function to inform mac80211 that a (potential) trigger frame 5066 * from a connected station was received. 5067 * This must be used in conjunction with ieee80211_sta_ps_transition() 5068 * and possibly ieee80211_sta_pspoll(); calls to all three must be 5069 * serialized. 5070 * %IEEE80211_NUM_TIDS can be passed as the tid if the tid is unknown. 5071 * In this case, mac80211 will not check that this tid maps to an AC 5072 * that is trigger enabled and assume that the caller did the proper 5073 * checks. 5074 */ 5075 void ieee80211_sta_uapsd_trigger(struct ieee80211_sta *sta, u8 tid); 5076 5077 /* 5078 * The TX headroom reserved by mac80211 for its own tx_status functions. 5079 * This is enough for the radiotap header. 5080 */ 5081 #define IEEE80211_TX_STATUS_HEADROOM ALIGN(14, 4) 5082 5083 /** 5084 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames 5085 * @sta: &struct ieee80211_sta pointer for the sleeping station 5086 * @tid: the TID that has buffered frames 5087 * @buffered: indicates whether or not frames are buffered for this TID 5088 * 5089 * If a driver buffers frames for a powersave station instead of passing 5090 * them back to mac80211 for retransmission, the station may still need 5091 * to be told that there are buffered frames via the TIM bit. 5092 * 5093 * This function informs mac80211 whether or not there are frames that are 5094 * buffered in the driver for a given TID; mac80211 can then use this data 5095 * to set the TIM bit (NOTE: This may call back into the driver's set_tim 5096 * call! Beware of the locking!) 5097 * 5098 * If all frames are released to the station (due to PS-poll or uAPSD) 5099 * then the driver needs to inform mac80211 that there no longer are 5100 * frames buffered. However, when the station wakes up mac80211 assumes 5101 * that all buffered frames will be transmitted and clears this data, 5102 * drivers need to make sure they inform mac80211 about all buffered 5103 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP). 5104 * 5105 * Note that technically mac80211 only needs to know this per AC, not per 5106 * TID, but since driver buffering will inevitably happen per TID (since 5107 * it is related to aggregation) it is easier to make mac80211 map the 5108 * TID to the AC as required instead of keeping track in all drivers that 5109 * use this API. 5110 */ 5111 void ieee80211_sta_set_buffered(struct ieee80211_sta *sta, 5112 u8 tid, bool buffered); 5113 5114 /** 5115 * ieee80211_get_tx_rates - get the selected transmit rates for a packet 5116 * 5117 * Call this function in a driver with per-packet rate selection support 5118 * to combine the rate info in the packet tx info with the most recent 5119 * rate selection table for the station entry. 5120 * 5121 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 5122 * @sta: the receiver station to which this packet is sent. 5123 * @skb: the frame to be transmitted. 5124 * @dest: buffer for extracted rate/retry information 5125 * @max_rates: maximum number of rates to fetch 5126 */ 5127 void ieee80211_get_tx_rates(struct ieee80211_vif *vif, 5128 struct ieee80211_sta *sta, 5129 struct sk_buff *skb, 5130 struct ieee80211_tx_rate *dest, 5131 int max_rates); 5132 5133 /** 5134 * ieee80211_sta_set_expected_throughput - set the expected tpt for a station 5135 * 5136 * Call this function to notify mac80211 about a change in expected throughput 5137 * to a station. A driver for a device that does rate control in firmware can 5138 * call this function when the expected throughput estimate towards a station 5139 * changes. The information is used to tune the CoDel AQM applied to traffic 5140 * going towards that station (which can otherwise be too aggressive and cause 5141 * slow stations to starve). 5142 * 5143 * @pubsta: the station to set throughput for. 5144 * @thr: the current expected throughput in kbps. 5145 */ 5146 void ieee80211_sta_set_expected_throughput(struct ieee80211_sta *pubsta, 5147 u32 thr); 5148 5149 /** 5150 * ieee80211_tx_rate_update - transmit rate update callback 5151 * 5152 * Drivers should call this functions with a non-NULL pub sta 5153 * This function can be used in drivers that does not have provision 5154 * in updating the tx rate in data path. 5155 * 5156 * @hw: the hardware the frame was transmitted by 5157 * @pubsta: the station to update the tx rate for. 5158 * @info: tx status information 5159 */ 5160 void ieee80211_tx_rate_update(struct ieee80211_hw *hw, 5161 struct ieee80211_sta *pubsta, 5162 struct ieee80211_tx_info *info); 5163 5164 /** 5165 * ieee80211_tx_status - transmit status callback 5166 * 5167 * Call this function for all transmitted frames after they have been 5168 * transmitted. It is permissible to not call this function for 5169 * multicast frames but this can affect statistics. 5170 * 5171 * This function may not be called in IRQ context. Calls to this function 5172 * for a single hardware must be synchronized against each other. Calls 5173 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe() 5174 * may not be mixed for a single hardware. Must not run concurrently with 5175 * ieee80211_rx() or ieee80211_rx_ni(). 5176 * 5177 * @hw: the hardware the frame was transmitted by 5178 * @skb: the frame that was transmitted, owned by mac80211 after this call 5179 */ 5180 void ieee80211_tx_status(struct ieee80211_hw *hw, 5181 struct sk_buff *skb); 5182 5183 /** 5184 * ieee80211_tx_status_ext - extended transmit status callback 5185 * 5186 * This function can be used as a replacement for ieee80211_tx_status 5187 * in drivers that may want to provide extra information that does not 5188 * fit into &struct ieee80211_tx_info. 5189 * 5190 * Calls to this function for a single hardware must be synchronized 5191 * against each other. Calls to this function, ieee80211_tx_status_ni() 5192 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware. 5193 * 5194 * @hw: the hardware the frame was transmitted by 5195 * @status: tx status information 5196 */ 5197 void ieee80211_tx_status_ext(struct ieee80211_hw *hw, 5198 struct ieee80211_tx_status *status); 5199 5200 /** 5201 * ieee80211_tx_status_noskb - transmit status callback without skb 5202 * 5203 * This function can be used as a replacement for ieee80211_tx_status 5204 * in drivers that cannot reliably map tx status information back to 5205 * specific skbs. 5206 * 5207 * Calls to this function for a single hardware must be synchronized 5208 * against each other. Calls to this function, ieee80211_tx_status_ni() 5209 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware. 5210 * 5211 * @hw: the hardware the frame was transmitted by 5212 * @sta: the receiver station to which this packet is sent 5213 * (NULL for multicast packets) 5214 * @info: tx status information 5215 */ 5216 static inline void ieee80211_tx_status_noskb(struct ieee80211_hw *hw, 5217 struct ieee80211_sta *sta, 5218 struct ieee80211_tx_info *info) 5219 { 5220 struct ieee80211_tx_status status = { 5221 .sta = sta, 5222 .info = info, 5223 }; 5224 5225 ieee80211_tx_status_ext(hw, &status); 5226 } 5227 5228 /** 5229 * ieee80211_tx_status_ni - transmit status callback (in process context) 5230 * 5231 * Like ieee80211_tx_status() but can be called in process context. 5232 * 5233 * Calls to this function, ieee80211_tx_status() and 5234 * ieee80211_tx_status_irqsafe() may not be mixed 5235 * for a single hardware. 5236 * 5237 * @hw: the hardware the frame was transmitted by 5238 * @skb: the frame that was transmitted, owned by mac80211 after this call 5239 */ 5240 static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw, 5241 struct sk_buff *skb) 5242 { 5243 local_bh_disable(); 5244 ieee80211_tx_status(hw, skb); 5245 local_bh_enable(); 5246 } 5247 5248 /** 5249 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback 5250 * 5251 * Like ieee80211_tx_status() but can be called in IRQ context 5252 * (internally defers to a tasklet.) 5253 * 5254 * Calls to this function, ieee80211_tx_status() and 5255 * ieee80211_tx_status_ni() may not be mixed for a single hardware. 5256 * 5257 * @hw: the hardware the frame was transmitted by 5258 * @skb: the frame that was transmitted, owned by mac80211 after this call 5259 */ 5260 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw, 5261 struct sk_buff *skb); 5262 5263 /** 5264 * ieee80211_report_low_ack - report non-responding station 5265 * 5266 * When operating in AP-mode, call this function to report a non-responding 5267 * connected STA. 5268 * 5269 * @sta: the non-responding connected sta 5270 * @num_packets: number of packets sent to @sta without a response 5271 */ 5272 void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets); 5273 5274 #define IEEE80211_MAX_CNTDWN_COUNTERS_NUM 2 5275 5276 /** 5277 * struct ieee80211_mutable_offsets - mutable beacon offsets 5278 * @tim_offset: position of TIM element 5279 * @tim_length: size of TIM element 5280 * @cntdwn_counter_offs: array of IEEE80211_MAX_CNTDWN_COUNTERS_NUM offsets 5281 * to countdown counters. This array can contain zero values which 5282 * should be ignored. 5283 * @mbssid_off: position of the multiple bssid element 5284 */ 5285 struct ieee80211_mutable_offsets { 5286 u16 tim_offset; 5287 u16 tim_length; 5288 5289 u16 cntdwn_counter_offs[IEEE80211_MAX_CNTDWN_COUNTERS_NUM]; 5290 u16 mbssid_off; 5291 }; 5292 5293 /** 5294 * ieee80211_beacon_get_template - beacon template generation function 5295 * @hw: pointer obtained from ieee80211_alloc_hw(). 5296 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 5297 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will 5298 * receive the offsets that may be updated by the driver. 5299 * @link_id: the link id to which the beacon belongs (or 0 for an AP STA 5300 * that is not associated with AP MLD). 5301 * 5302 * If the driver implements beaconing modes, it must use this function to 5303 * obtain the beacon template. 5304 * 5305 * This function should be used if the beacon frames are generated by the 5306 * device, and then the driver must use the returned beacon as the template 5307 * The driver or the device are responsible to update the DTIM and, when 5308 * applicable, the CSA count. 5309 * 5310 * The driver is responsible for freeing the returned skb. 5311 * 5312 * Return: The beacon template. %NULL on error. 5313 */ 5314 struct sk_buff * 5315 ieee80211_beacon_get_template(struct ieee80211_hw *hw, 5316 struct ieee80211_vif *vif, 5317 struct ieee80211_mutable_offsets *offs, 5318 unsigned int link_id); 5319 5320 /** 5321 * ieee80211_beacon_get_template_ema_index - EMA beacon template generation 5322 * @hw: pointer obtained from ieee80211_alloc_hw(). 5323 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 5324 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will 5325 * receive the offsets that may be updated by the driver. 5326 * @link_id: the link id to which the beacon belongs (or 0 for a non-MLD AP). 5327 * @ema_index: index of the beacon in the EMA set. 5328 * 5329 * This function follows the same rules as ieee80211_beacon_get_template() 5330 * but returns a beacon template which includes multiple BSSID element at the 5331 * requested index. 5332 * 5333 * Return: The beacon template. %NULL indicates the end of EMA templates. 5334 */ 5335 struct sk_buff * 5336 ieee80211_beacon_get_template_ema_index(struct ieee80211_hw *hw, 5337 struct ieee80211_vif *vif, 5338 struct ieee80211_mutable_offsets *offs, 5339 unsigned int link_id, u8 ema_index); 5340 5341 /** 5342 * struct ieee80211_ema_beacons - List of EMA beacons 5343 * @cnt: count of EMA beacons. 5344 * 5345 * @bcn: array of EMA beacons. 5346 * @bcn.skb: the skb containing this specific beacon 5347 * @bcn.offs: &struct ieee80211_mutable_offsets pointer to struct that will 5348 * receive the offsets that may be updated by the driver. 5349 */ 5350 struct ieee80211_ema_beacons { 5351 u8 cnt; 5352 struct { 5353 struct sk_buff *skb; 5354 struct ieee80211_mutable_offsets offs; 5355 } bcn[]; 5356 }; 5357 5358 /** 5359 * ieee80211_beacon_get_template_ema_list - EMA beacon template generation 5360 * @hw: pointer obtained from ieee80211_alloc_hw(). 5361 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 5362 * @link_id: the link id to which the beacon belongs (or 0 for a non-MLD AP) 5363 * 5364 * This function follows the same rules as ieee80211_beacon_get_template() 5365 * but allocates and returns a pointer to list of all beacon templates required 5366 * to cover all profiles in the multiple BSSID set. Each template includes only 5367 * one multiple BSSID element. 5368 * 5369 * Driver must call ieee80211_beacon_free_ema_list() to free the memory. 5370 * 5371 * Return: EMA beacon templates of type struct ieee80211_ema_beacons *. 5372 * %NULL on error. 5373 */ 5374 struct ieee80211_ema_beacons * 5375 ieee80211_beacon_get_template_ema_list(struct ieee80211_hw *hw, 5376 struct ieee80211_vif *vif, 5377 unsigned int link_id); 5378 5379 /** 5380 * ieee80211_beacon_free_ema_list - free an EMA beacon template list 5381 * @ema_beacons: list of EMA beacons of type &struct ieee80211_ema_beacons pointers. 5382 * 5383 * This function will free a list previously acquired by calling 5384 * ieee80211_beacon_get_template_ema_list() 5385 */ 5386 void ieee80211_beacon_free_ema_list(struct ieee80211_ema_beacons *ema_beacons); 5387 5388 /** 5389 * ieee80211_beacon_get_tim - beacon generation function 5390 * @hw: pointer obtained from ieee80211_alloc_hw(). 5391 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 5392 * @tim_offset: pointer to variable that will receive the TIM IE offset. 5393 * Set to 0 if invalid (in non-AP modes). 5394 * @tim_length: pointer to variable that will receive the TIM IE length, 5395 * (including the ID and length bytes!). 5396 * Set to 0 if invalid (in non-AP modes). 5397 * @link_id: the link id to which the beacon belongs (or 0 for an AP STA 5398 * that is not associated with AP MLD). 5399 * 5400 * If the driver implements beaconing modes, it must use this function to 5401 * obtain the beacon frame. 5402 * 5403 * If the beacon frames are generated by the host system (i.e., not in 5404 * hardware/firmware), the driver uses this function to get each beacon 5405 * frame from mac80211 -- it is responsible for calling this function exactly 5406 * once before the beacon is needed (e.g. based on hardware interrupt). 5407 * 5408 * The driver is responsible for freeing the returned skb. 5409 * 5410 * Return: The beacon template. %NULL on error. 5411 */ 5412 struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw, 5413 struct ieee80211_vif *vif, 5414 u16 *tim_offset, u16 *tim_length, 5415 unsigned int link_id); 5416 5417 /** 5418 * ieee80211_beacon_get - beacon generation function 5419 * @hw: pointer obtained from ieee80211_alloc_hw(). 5420 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 5421 * @link_id: the link id to which the beacon belongs (or 0 for an AP STA 5422 * that is not associated with AP MLD). 5423 * 5424 * See ieee80211_beacon_get_tim(). 5425 * 5426 * Return: See ieee80211_beacon_get_tim(). 5427 */ 5428 static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw, 5429 struct ieee80211_vif *vif, 5430 unsigned int link_id) 5431 { 5432 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL, link_id); 5433 } 5434 5435 /** 5436 * ieee80211_beacon_update_cntdwn - request mac80211 to decrement the beacon countdown 5437 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 5438 * 5439 * The beacon counter should be updated after each beacon transmission. 5440 * This function is called implicitly when 5441 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the 5442 * beacon frames are generated by the device, the driver should call this 5443 * function after each beacon transmission to sync mac80211's beacon countdown. 5444 * 5445 * Return: new countdown value 5446 */ 5447 u8 ieee80211_beacon_update_cntdwn(struct ieee80211_vif *vif); 5448 5449 /** 5450 * ieee80211_beacon_set_cntdwn - request mac80211 to set beacon countdown 5451 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 5452 * @counter: the new value for the counter 5453 * 5454 * The beacon countdown can be changed by the device, this API should be 5455 * used by the device driver to update csa counter in mac80211. 5456 * 5457 * It should never be used together with ieee80211_beacon_update_cntdwn(), 5458 * as it will cause a race condition around the counter value. 5459 */ 5460 void ieee80211_beacon_set_cntdwn(struct ieee80211_vif *vif, u8 counter); 5461 5462 /** 5463 * ieee80211_csa_finish - notify mac80211 about channel switch 5464 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 5465 * 5466 * After a channel switch announcement was scheduled and the counter in this 5467 * announcement hits 1, this function must be called by the driver to 5468 * notify mac80211 that the channel can be changed. 5469 */ 5470 void ieee80211_csa_finish(struct ieee80211_vif *vif); 5471 5472 /** 5473 * ieee80211_beacon_cntdwn_is_complete - find out if countdown reached 1 5474 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 5475 * 5476 * This function returns whether the countdown reached zero. 5477 */ 5478 bool ieee80211_beacon_cntdwn_is_complete(struct ieee80211_vif *vif); 5479 5480 /** 5481 * ieee80211_color_change_finish - notify mac80211 about color change 5482 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 5483 * 5484 * After a color change announcement was scheduled and the counter in this 5485 * announcement hits 1, this function must be called by the driver to 5486 * notify mac80211 that the color can be changed 5487 */ 5488 void ieee80211_color_change_finish(struct ieee80211_vif *vif); 5489 5490 /** 5491 * ieee80211_proberesp_get - retrieve a Probe Response template 5492 * @hw: pointer obtained from ieee80211_alloc_hw(). 5493 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 5494 * 5495 * Creates a Probe Response template which can, for example, be uploaded to 5496 * hardware. The destination address should be set by the caller. 5497 * 5498 * Can only be called in AP mode. 5499 * 5500 * Return: The Probe Response template. %NULL on error. 5501 */ 5502 struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw, 5503 struct ieee80211_vif *vif); 5504 5505 /** 5506 * ieee80211_pspoll_get - retrieve a PS Poll template 5507 * @hw: pointer obtained from ieee80211_alloc_hw(). 5508 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 5509 * 5510 * Creates a PS Poll a template which can, for example, uploaded to 5511 * hardware. The template must be updated after association so that correct 5512 * AID, BSSID and MAC address is used. 5513 * 5514 * Note: Caller (or hardware) is responsible for setting the 5515 * &IEEE80211_FCTL_PM bit. 5516 * 5517 * Return: The PS Poll template. %NULL on error. 5518 */ 5519 struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw, 5520 struct ieee80211_vif *vif); 5521 5522 /** 5523 * ieee80211_nullfunc_get - retrieve a nullfunc template 5524 * @hw: pointer obtained from ieee80211_alloc_hw(). 5525 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 5526 * @link_id: If the vif is an MLD, get a frame with the link addresses 5527 * for the given link ID. For a link_id < 0 you get a frame with 5528 * MLD addresses, however useful that might be. 5529 * @qos_ok: QoS NDP is acceptable to the caller, this should be set 5530 * if at all possible 5531 * 5532 * Creates a Nullfunc template which can, for example, uploaded to 5533 * hardware. The template must be updated after association so that correct 5534 * BSSID and address is used. 5535 * 5536 * If @qos_ndp is set and the association is to an AP with QoS/WMM, the 5537 * returned packet will be QoS NDP. 5538 * 5539 * Note: Caller (or hardware) is responsible for setting the 5540 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields. 5541 * 5542 * Return: The nullfunc template. %NULL on error. 5543 */ 5544 struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw, 5545 struct ieee80211_vif *vif, 5546 int link_id, bool qos_ok); 5547 5548 /** 5549 * ieee80211_probereq_get - retrieve a Probe Request template 5550 * @hw: pointer obtained from ieee80211_alloc_hw(). 5551 * @src_addr: source MAC address 5552 * @ssid: SSID buffer 5553 * @ssid_len: length of SSID 5554 * @tailroom: tailroom to reserve at end of SKB for IEs 5555 * 5556 * Creates a Probe Request template which can, for example, be uploaded to 5557 * hardware. 5558 * 5559 * Return: The Probe Request template. %NULL on error. 5560 */ 5561 struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw, 5562 const u8 *src_addr, 5563 const u8 *ssid, size_t ssid_len, 5564 size_t tailroom); 5565 5566 /** 5567 * ieee80211_rts_get - RTS frame generation function 5568 * @hw: pointer obtained from ieee80211_alloc_hw(). 5569 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 5570 * @frame: pointer to the frame that is going to be protected by the RTS. 5571 * @frame_len: the frame length (in octets). 5572 * @frame_txctl: &struct ieee80211_tx_info of the frame. 5573 * @rts: The buffer where to store the RTS frame. 5574 * 5575 * If the RTS frames are generated by the host system (i.e., not in 5576 * hardware/firmware), the low-level driver uses this function to receive 5577 * the next RTS frame from the 802.11 code. The low-level is responsible 5578 * for calling this function before and RTS frame is needed. 5579 */ 5580 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif, 5581 const void *frame, size_t frame_len, 5582 const struct ieee80211_tx_info *frame_txctl, 5583 struct ieee80211_rts *rts); 5584 5585 /** 5586 * ieee80211_rts_duration - Get the duration field for an RTS frame 5587 * @hw: pointer obtained from ieee80211_alloc_hw(). 5588 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 5589 * @frame_len: the length of the frame that is going to be protected by the RTS. 5590 * @frame_txctl: &struct ieee80211_tx_info of the frame. 5591 * 5592 * If the RTS is generated in firmware, but the host system must provide 5593 * the duration field, the low-level driver uses this function to receive 5594 * the duration field value in little-endian byteorder. 5595 * 5596 * Return: The duration. 5597 */ 5598 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw, 5599 struct ieee80211_vif *vif, size_t frame_len, 5600 const struct ieee80211_tx_info *frame_txctl); 5601 5602 /** 5603 * ieee80211_ctstoself_get - CTS-to-self frame generation function 5604 * @hw: pointer obtained from ieee80211_alloc_hw(). 5605 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 5606 * @frame: pointer to the frame that is going to be protected by the CTS-to-self. 5607 * @frame_len: the frame length (in octets). 5608 * @frame_txctl: &struct ieee80211_tx_info of the frame. 5609 * @cts: The buffer where to store the CTS-to-self frame. 5610 * 5611 * If the CTS-to-self frames are generated by the host system (i.e., not in 5612 * hardware/firmware), the low-level driver uses this function to receive 5613 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible 5614 * for calling this function before and CTS-to-self frame is needed. 5615 */ 5616 void ieee80211_ctstoself_get(struct ieee80211_hw *hw, 5617 struct ieee80211_vif *vif, 5618 const void *frame, size_t frame_len, 5619 const struct ieee80211_tx_info *frame_txctl, 5620 struct ieee80211_cts *cts); 5621 5622 /** 5623 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame 5624 * @hw: pointer obtained from ieee80211_alloc_hw(). 5625 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 5626 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self. 5627 * @frame_txctl: &struct ieee80211_tx_info of the frame. 5628 * 5629 * If the CTS-to-self is generated in firmware, but the host system must provide 5630 * the duration field, the low-level driver uses this function to receive 5631 * the duration field value in little-endian byteorder. 5632 * 5633 * Return: The duration. 5634 */ 5635 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, 5636 struct ieee80211_vif *vif, 5637 size_t frame_len, 5638 const struct ieee80211_tx_info *frame_txctl); 5639 5640 /** 5641 * ieee80211_generic_frame_duration - Calculate the duration field for a frame 5642 * @hw: pointer obtained from ieee80211_alloc_hw(). 5643 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 5644 * @band: the band to calculate the frame duration on 5645 * @frame_len: the length of the frame. 5646 * @rate: the rate at which the frame is going to be transmitted. 5647 * 5648 * Calculate the duration field of some generic frame, given its 5649 * length and transmission rate (in 100kbps). 5650 * 5651 * Return: The duration. 5652 */ 5653 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, 5654 struct ieee80211_vif *vif, 5655 enum nl80211_band band, 5656 size_t frame_len, 5657 struct ieee80211_rate *rate); 5658 5659 /** 5660 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames 5661 * @hw: pointer as obtained from ieee80211_alloc_hw(). 5662 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 5663 * 5664 * Function for accessing buffered broadcast and multicast frames. If 5665 * hardware/firmware does not implement buffering of broadcast/multicast 5666 * frames when power saving is used, 802.11 code buffers them in the host 5667 * memory. The low-level driver uses this function to fetch next buffered 5668 * frame. In most cases, this is used when generating beacon frame. 5669 * 5670 * Return: A pointer to the next buffered skb or NULL if no more buffered 5671 * frames are available. 5672 * 5673 * Note: buffered frames are returned only after DTIM beacon frame was 5674 * generated with ieee80211_beacon_get() and the low-level driver must thus 5675 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns 5676 * NULL if the previous generated beacon was not DTIM, so the low-level driver 5677 * does not need to check for DTIM beacons separately and should be able to 5678 * use common code for all beacons. 5679 */ 5680 struct sk_buff * 5681 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif); 5682 5683 /** 5684 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32 5685 * 5686 * This function returns the TKIP phase 1 key for the given IV32. 5687 * 5688 * @keyconf: the parameter passed with the set key 5689 * @iv32: IV32 to get the P1K for 5690 * @p1k: a buffer to which the key will be written, as 5 u16 values 5691 */ 5692 void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf, 5693 u32 iv32, u16 *p1k); 5694 5695 /** 5696 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key 5697 * 5698 * This function returns the TKIP phase 1 key for the IV32 taken 5699 * from the given packet. 5700 * 5701 * @keyconf: the parameter passed with the set key 5702 * @skb: the packet to take the IV32 value from that will be encrypted 5703 * with this P1K 5704 * @p1k: a buffer to which the key will be written, as 5 u16 values 5705 */ 5706 static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf, 5707 struct sk_buff *skb, u16 *p1k) 5708 { 5709 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data; 5710 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control); 5711 u32 iv32 = get_unaligned_le32(&data[4]); 5712 5713 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k); 5714 } 5715 5716 /** 5717 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX 5718 * 5719 * This function returns the TKIP phase 1 key for the given IV32 5720 * and transmitter address. 5721 * 5722 * @keyconf: the parameter passed with the set key 5723 * @ta: TA that will be used with the key 5724 * @iv32: IV32 to get the P1K for 5725 * @p1k: a buffer to which the key will be written, as 5 u16 values 5726 */ 5727 void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf, 5728 const u8 *ta, u32 iv32, u16 *p1k); 5729 5730 /** 5731 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key 5732 * 5733 * This function computes the TKIP RC4 key for the IV values 5734 * in the packet. 5735 * 5736 * @keyconf: the parameter passed with the set key 5737 * @skb: the packet to take the IV32/IV16 values from that will be 5738 * encrypted with this key 5739 * @p2k: a buffer to which the key will be written, 16 bytes 5740 */ 5741 void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf, 5742 struct sk_buff *skb, u8 *p2k); 5743 5744 /** 5745 * ieee80211_tkip_add_iv - write TKIP IV and Ext. IV to pos 5746 * 5747 * @pos: start of crypto header 5748 * @keyconf: the parameter passed with the set key 5749 * @pn: PN to add 5750 * 5751 * Returns: pointer to the octet following IVs (i.e. beginning of 5752 * the packet payload) 5753 * 5754 * This function writes the tkip IV value to pos (which should 5755 * point to the crypto header) 5756 */ 5757 u8 *ieee80211_tkip_add_iv(u8 *pos, struct ieee80211_key_conf *keyconf, u64 pn); 5758 5759 /** 5760 * ieee80211_get_key_rx_seq - get key RX sequence counter 5761 * 5762 * @keyconf: the parameter passed with the set key 5763 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only); 5764 * the value on TID 0 is also used for non-QoS frames. For 5765 * CMAC, only TID 0 is valid. 5766 * @seq: buffer to receive the sequence data 5767 * 5768 * This function allows a driver to retrieve the current RX IV/PNs 5769 * for the given key. It must not be called if IV checking is done 5770 * by the device and not by mac80211. 5771 * 5772 * Note that this function may only be called when no RX processing 5773 * can be done concurrently. 5774 */ 5775 void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf, 5776 int tid, struct ieee80211_key_seq *seq); 5777 5778 /** 5779 * ieee80211_set_key_rx_seq - set key RX sequence counter 5780 * 5781 * @keyconf: the parameter passed with the set key 5782 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only); 5783 * the value on TID 0 is also used for non-QoS frames. For 5784 * CMAC, only TID 0 is valid. 5785 * @seq: new sequence data 5786 * 5787 * This function allows a driver to set the current RX IV/PNs for the 5788 * given key. This is useful when resuming from WoWLAN sleep and GTK 5789 * rekey may have been done while suspended. It should not be called 5790 * if IV checking is done by the device and not by mac80211. 5791 * 5792 * Note that this function may only be called when no RX processing 5793 * can be done concurrently. 5794 */ 5795 void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf, 5796 int tid, struct ieee80211_key_seq *seq); 5797 5798 /** 5799 * ieee80211_remove_key - remove the given key 5800 * @keyconf: the parameter passed with the set key 5801 * 5802 * Remove the given key. If the key was uploaded to the hardware at the 5803 * time this function is called, it is not deleted in the hardware but 5804 * instead assumed to have been removed already. 5805 * 5806 * Note that due to locking considerations this function can (currently) 5807 * only be called during key iteration (ieee80211_iter_keys().) 5808 */ 5809 void ieee80211_remove_key(struct ieee80211_key_conf *keyconf); 5810 5811 /** 5812 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN 5813 * @vif: the virtual interface to add the key on 5814 * @keyconf: new key data 5815 * 5816 * When GTK rekeying was done while the system was suspended, (a) new 5817 * key(s) will be available. These will be needed by mac80211 for proper 5818 * RX processing, so this function allows setting them. 5819 * 5820 * The function returns the newly allocated key structure, which will 5821 * have similar contents to the passed key configuration but point to 5822 * mac80211-owned memory. In case of errors, the function returns an 5823 * ERR_PTR(), use IS_ERR() etc. 5824 * 5825 * Note that this function assumes the key isn't added to hardware 5826 * acceleration, so no TX will be done with the key. Since it's a GTK 5827 * on managed (station) networks, this is true anyway. If the driver 5828 * calls this function from the resume callback and subsequently uses 5829 * the return code 1 to reconfigure the device, this key will be part 5830 * of the reconfiguration. 5831 * 5832 * Note that the driver should also call ieee80211_set_key_rx_seq() 5833 * for the new key for each TID to set up sequence counters properly. 5834 * 5835 * IMPORTANT: If this replaces a key that is present in the hardware, 5836 * then it will attempt to remove it during this call. In many cases 5837 * this isn't what you want, so call ieee80211_remove_key() first for 5838 * the key that's being replaced. 5839 */ 5840 struct ieee80211_key_conf * 5841 ieee80211_gtk_rekey_add(struct ieee80211_vif *vif, 5842 struct ieee80211_key_conf *keyconf); 5843 5844 /** 5845 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying 5846 * @vif: virtual interface the rekeying was done on 5847 * @bssid: The BSSID of the AP, for checking association 5848 * @replay_ctr: the new replay counter after GTK rekeying 5849 * @gfp: allocation flags 5850 */ 5851 void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid, 5852 const u8 *replay_ctr, gfp_t gfp); 5853 5854 /** 5855 * ieee80211_key_mic_failure - increment MIC failure counter for the key 5856 * 5857 * Note: this is really only safe if no other RX function is called 5858 * at the same time. 5859 * 5860 * @keyconf: the key in question 5861 */ 5862 void ieee80211_key_mic_failure(struct ieee80211_key_conf *keyconf); 5863 5864 /** 5865 * ieee80211_key_replay - increment replay counter for the key 5866 * 5867 * Note: this is really only safe if no other RX function is called 5868 * at the same time. 5869 * 5870 * @keyconf: the key in question 5871 */ 5872 void ieee80211_key_replay(struct ieee80211_key_conf *keyconf); 5873 5874 /** 5875 * ieee80211_wake_queue - wake specific queue 5876 * @hw: pointer as obtained from ieee80211_alloc_hw(). 5877 * @queue: queue number (counted from zero). 5878 * 5879 * Drivers must use this function instead of netif_wake_queue. 5880 */ 5881 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue); 5882 5883 /** 5884 * ieee80211_stop_queue - stop specific queue 5885 * @hw: pointer as obtained from ieee80211_alloc_hw(). 5886 * @queue: queue number (counted from zero). 5887 * 5888 * Drivers must use this function instead of netif_stop_queue. 5889 */ 5890 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue); 5891 5892 /** 5893 * ieee80211_queue_stopped - test status of the queue 5894 * @hw: pointer as obtained from ieee80211_alloc_hw(). 5895 * @queue: queue number (counted from zero). 5896 * 5897 * Drivers must use this function instead of netif_queue_stopped. 5898 * 5899 * Return: %true if the queue is stopped. %false otherwise. 5900 */ 5901 5902 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue); 5903 5904 /** 5905 * ieee80211_stop_queues - stop all queues 5906 * @hw: pointer as obtained from ieee80211_alloc_hw(). 5907 * 5908 * Drivers must use this function instead of netif_tx_stop_all_queues. 5909 */ 5910 void ieee80211_stop_queues(struct ieee80211_hw *hw); 5911 5912 /** 5913 * ieee80211_wake_queues - wake all queues 5914 * @hw: pointer as obtained from ieee80211_alloc_hw(). 5915 * 5916 * Drivers must use this function instead of netif_tx_wake_all_queues. 5917 */ 5918 void ieee80211_wake_queues(struct ieee80211_hw *hw); 5919 5920 /** 5921 * ieee80211_scan_completed - completed hardware scan 5922 * 5923 * When hardware scan offload is used (i.e. the hw_scan() callback is 5924 * assigned) this function needs to be called by the driver to notify 5925 * mac80211 that the scan finished. This function can be called from 5926 * any context, including hardirq context. 5927 * 5928 * @hw: the hardware that finished the scan 5929 * @info: information about the completed scan 5930 */ 5931 void ieee80211_scan_completed(struct ieee80211_hw *hw, 5932 struct cfg80211_scan_info *info); 5933 5934 /** 5935 * ieee80211_sched_scan_results - got results from scheduled scan 5936 * 5937 * When a scheduled scan is running, this function needs to be called by the 5938 * driver whenever there are new scan results available. 5939 * 5940 * @hw: the hardware that is performing scheduled scans 5941 */ 5942 void ieee80211_sched_scan_results(struct ieee80211_hw *hw); 5943 5944 /** 5945 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped 5946 * 5947 * When a scheduled scan is running, this function can be called by 5948 * the driver if it needs to stop the scan to perform another task. 5949 * Usual scenarios are drivers that cannot continue the scheduled scan 5950 * while associating, for instance. 5951 * 5952 * @hw: the hardware that is performing scheduled scans 5953 */ 5954 void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw); 5955 5956 /** 5957 * enum ieee80211_interface_iteration_flags - interface iteration flags 5958 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have 5959 * been added to the driver; However, note that during hardware 5960 * reconfiguration (after restart_hw) it will iterate over a new 5961 * interface and over all the existing interfaces even if they 5962 * haven't been re-added to the driver yet. 5963 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all 5964 * interfaces, even if they haven't been re-added to the driver yet. 5965 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up). 5966 * @IEEE80211_IFACE_SKIP_SDATA_NOT_IN_DRIVER: Skip any interfaces where SDATA 5967 * is not in the driver. This may fix crashes during firmware recovery 5968 * for instance. 5969 */ 5970 enum ieee80211_interface_iteration_flags { 5971 IEEE80211_IFACE_ITER_NORMAL = 0, 5972 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0), 5973 IEEE80211_IFACE_ITER_ACTIVE = BIT(1), 5974 IEEE80211_IFACE_SKIP_SDATA_NOT_IN_DRIVER = BIT(2), 5975 }; 5976 5977 /** 5978 * ieee80211_iterate_interfaces - iterate interfaces 5979 * 5980 * This function iterates over the interfaces associated with a given 5981 * hardware and calls the callback for them. This includes active as well as 5982 * inactive interfaces. This function allows the iterator function to sleep. 5983 * Will iterate over a new interface during add_interface(). 5984 * 5985 * @hw: the hardware struct of which the interfaces should be iterated over 5986 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags 5987 * @iterator: the iterator function to call 5988 * @data: first argument of the iterator function 5989 */ 5990 void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags, 5991 void (*iterator)(void *data, u8 *mac, 5992 struct ieee80211_vif *vif), 5993 void *data); 5994 5995 /** 5996 * ieee80211_iterate_active_interfaces - iterate active interfaces 5997 * 5998 * This function iterates over the interfaces associated with a given 5999 * hardware that are currently active and calls the callback for them. 6000 * This function allows the iterator function to sleep, when the iterator 6001 * function is atomic @ieee80211_iterate_active_interfaces_atomic can 6002 * be used. 6003 * Does not iterate over a new interface during add_interface(). 6004 * 6005 * @hw: the hardware struct of which the interfaces should be iterated over 6006 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags 6007 * @iterator: the iterator function to call 6008 * @data: first argument of the iterator function 6009 */ 6010 static inline void 6011 ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags, 6012 void (*iterator)(void *data, u8 *mac, 6013 struct ieee80211_vif *vif), 6014 void *data) 6015 { 6016 ieee80211_iterate_interfaces(hw, 6017 iter_flags | IEEE80211_IFACE_ITER_ACTIVE, 6018 iterator, data); 6019 } 6020 6021 /** 6022 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces 6023 * 6024 * This function iterates over the interfaces associated with a given 6025 * hardware that are currently active and calls the callback for them. 6026 * This function requires the iterator callback function to be atomic, 6027 * if that is not desired, use @ieee80211_iterate_active_interfaces instead. 6028 * Does not iterate over a new interface during add_interface(). 6029 * 6030 * @hw: the hardware struct of which the interfaces should be iterated over 6031 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags 6032 * @iterator: the iterator function to call, cannot sleep 6033 * @data: first argument of the iterator function 6034 */ 6035 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw, 6036 u32 iter_flags, 6037 void (*iterator)(void *data, 6038 u8 *mac, 6039 struct ieee80211_vif *vif), 6040 void *data); 6041 6042 /** 6043 * ieee80211_iterate_active_interfaces_mtx - iterate active interfaces 6044 * 6045 * This function iterates over the interfaces associated with a given 6046 * hardware that are currently active and calls the callback for them. 6047 * This version can only be used while holding the wiphy mutex. 6048 * 6049 * @hw: the hardware struct of which the interfaces should be iterated over 6050 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags 6051 * @iterator: the iterator function to call, cannot sleep 6052 * @data: first argument of the iterator function 6053 */ 6054 void ieee80211_iterate_active_interfaces_mtx(struct ieee80211_hw *hw, 6055 u32 iter_flags, 6056 void (*iterator)(void *data, 6057 u8 *mac, 6058 struct ieee80211_vif *vif), 6059 void *data); 6060 6061 /** 6062 * ieee80211_iterate_stations_atomic - iterate stations 6063 * 6064 * This function iterates over all stations associated with a given 6065 * hardware that are currently uploaded to the driver and calls the callback 6066 * function for them. 6067 * This function requires the iterator callback function to be atomic, 6068 * 6069 * @hw: the hardware struct of which the interfaces should be iterated over 6070 * @iterator: the iterator function to call, cannot sleep 6071 * @data: first argument of the iterator function 6072 */ 6073 void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw, 6074 void (*iterator)(void *data, 6075 struct ieee80211_sta *sta), 6076 void *data); 6077 /** 6078 * ieee80211_queue_work - add work onto the mac80211 workqueue 6079 * 6080 * Drivers and mac80211 use this to add work onto the mac80211 workqueue. 6081 * This helper ensures drivers are not queueing work when they should not be. 6082 * 6083 * @hw: the hardware struct for the interface we are adding work for 6084 * @work: the work we want to add onto the mac80211 workqueue 6085 */ 6086 void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work); 6087 6088 /** 6089 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue 6090 * 6091 * Drivers and mac80211 use this to queue delayed work onto the mac80211 6092 * workqueue. 6093 * 6094 * @hw: the hardware struct for the interface we are adding work for 6095 * @dwork: delayable work to queue onto the mac80211 workqueue 6096 * @delay: number of jiffies to wait before queueing 6097 */ 6098 void ieee80211_queue_delayed_work(struct ieee80211_hw *hw, 6099 struct delayed_work *dwork, 6100 unsigned long delay); 6101 6102 /** 6103 * ieee80211_refresh_tx_agg_session_timer - Refresh a tx agg session timer. 6104 * @sta: the station for which to start a BA session 6105 * @tid: the TID to BA on. 6106 * 6107 * This function allows low level driver to refresh tx agg session timer 6108 * to maintain BA session, the session level will still be managed by the 6109 * mac80211. 6110 * 6111 * Note: must be called in an RCU critical section. 6112 */ 6113 void ieee80211_refresh_tx_agg_session_timer(struct ieee80211_sta *sta, 6114 u16 tid); 6115 6116 /** 6117 * ieee80211_start_tx_ba_session - Start a tx Block Ack session. 6118 * @sta: the station for which to start a BA session 6119 * @tid: the TID to BA on. 6120 * @timeout: session timeout value (in TUs) 6121 * 6122 * Return: success if addBA request was sent, failure otherwise 6123 * 6124 * Although mac80211/low level driver/user space application can estimate 6125 * the need to start aggregation on a certain RA/TID, the session level 6126 * will be managed by the mac80211. 6127 */ 6128 int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid, 6129 u16 timeout); 6130 6131 /** 6132 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate. 6133 * @vif: &struct ieee80211_vif pointer from the add_interface callback 6134 * @ra: receiver address of the BA session recipient. 6135 * @tid: the TID to BA on. 6136 * 6137 * This function must be called by low level driver once it has 6138 * finished with preparations for the BA session. It can be called 6139 * from any context. 6140 */ 6141 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra, 6142 u16 tid); 6143 6144 /** 6145 * ieee80211_stop_tx_ba_session - Stop a Block Ack session. 6146 * @sta: the station whose BA session to stop 6147 * @tid: the TID to stop BA. 6148 * 6149 * Return: negative error if the TID is invalid, or no aggregation active 6150 * 6151 * Although mac80211/low level driver/user space application can estimate 6152 * the need to stop aggregation on a certain RA/TID, the session level 6153 * will be managed by the mac80211. 6154 */ 6155 int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid); 6156 6157 /** 6158 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate. 6159 * @vif: &struct ieee80211_vif pointer from the add_interface callback 6160 * @ra: receiver address of the BA session recipient. 6161 * @tid: the desired TID to BA on. 6162 * 6163 * This function must be called by low level driver once it has 6164 * finished with preparations for the BA session tear down. It 6165 * can be called from any context. 6166 */ 6167 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra, 6168 u16 tid); 6169 6170 /** 6171 * ieee80211_find_sta - find a station 6172 * 6173 * @vif: virtual interface to look for station on 6174 * @addr: station's address 6175 * 6176 * Return: The station, if found. %NULL otherwise. 6177 * 6178 * Note: This function must be called under RCU lock and the 6179 * resulting pointer is only valid under RCU lock as well. 6180 */ 6181 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif, 6182 const u8 *addr); 6183 6184 /** 6185 * ieee80211_find_sta_by_ifaddr - find a station on hardware 6186 * 6187 * @hw: pointer as obtained from ieee80211_alloc_hw() 6188 * @addr: remote station's address 6189 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'. 6190 * 6191 * Return: The station, if found. %NULL otherwise. 6192 * 6193 * Note: This function must be called under RCU lock and the 6194 * resulting pointer is only valid under RCU lock as well. 6195 * 6196 * NOTE: You may pass NULL for localaddr, but then you will just get 6197 * the first STA that matches the remote address 'addr'. 6198 * We can have multiple STA associated with multiple 6199 * logical stations (e.g. consider a station connecting to another 6200 * BSSID on the same AP hardware without disconnecting first). 6201 * In this case, the result of this method with localaddr NULL 6202 * is not reliable. 6203 * 6204 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible. 6205 */ 6206 struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw, 6207 const u8 *addr, 6208 const u8 *localaddr); 6209 6210 /** 6211 * ieee80211_find_sta_by_link_addrs - find STA by link addresses 6212 * @hw: pointer as obtained from ieee80211_alloc_hw() 6213 * @addr: remote station's link address 6214 * @localaddr: local link address, use %NULL for any (but avoid that) 6215 * @link_id: pointer to obtain the link ID if the STA is found, 6216 * may be %NULL if the link ID is not needed 6217 * 6218 * Obtain the STA by link address, must use RCU protection. 6219 */ 6220 struct ieee80211_sta * 6221 ieee80211_find_sta_by_link_addrs(struct ieee80211_hw *hw, 6222 const u8 *addr, 6223 const u8 *localaddr, 6224 unsigned int *link_id); 6225 6226 /** 6227 * ieee80211_sta_block_awake - block station from waking up 6228 * @hw: the hardware 6229 * @pubsta: the station 6230 * @block: whether to block or unblock 6231 * 6232 * Some devices require that all frames that are on the queues 6233 * for a specific station that went to sleep are flushed before 6234 * a poll response or frames after the station woke up can be 6235 * delivered to that it. Note that such frames must be rejected 6236 * by the driver as filtered, with the appropriate status flag. 6237 * 6238 * This function allows implementing this mode in a race-free 6239 * manner. 6240 * 6241 * To do this, a driver must keep track of the number of frames 6242 * still enqueued for a specific station. If this number is not 6243 * zero when the station goes to sleep, the driver must call 6244 * this function to force mac80211 to consider the station to 6245 * be asleep regardless of the station's actual state. Once the 6246 * number of outstanding frames reaches zero, the driver must 6247 * call this function again to unblock the station. That will 6248 * cause mac80211 to be able to send ps-poll responses, and if 6249 * the station queried in the meantime then frames will also 6250 * be sent out as a result of this. Additionally, the driver 6251 * will be notified that the station woke up some time after 6252 * it is unblocked, regardless of whether the station actually 6253 * woke up while blocked or not. 6254 */ 6255 void ieee80211_sta_block_awake(struct ieee80211_hw *hw, 6256 struct ieee80211_sta *pubsta, bool block); 6257 6258 /** 6259 * ieee80211_sta_eosp - notify mac80211 about end of SP 6260 * @pubsta: the station 6261 * 6262 * When a device transmits frames in a way that it can't tell 6263 * mac80211 in the TX status about the EOSP, it must clear the 6264 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead. 6265 * This applies for PS-Poll as well as uAPSD. 6266 * 6267 * Note that just like with _tx_status() and _rx() drivers must 6268 * not mix calls to irqsafe/non-irqsafe versions, this function 6269 * must not be mixed with those either. Use the all irqsafe, or 6270 * all non-irqsafe, don't mix! 6271 * 6272 * NB: the _irqsafe version of this function doesn't exist, no 6273 * driver needs it right now. Don't call this function if 6274 * you'd need the _irqsafe version, look at the git history 6275 * and restore the _irqsafe version! 6276 */ 6277 void ieee80211_sta_eosp(struct ieee80211_sta *pubsta); 6278 6279 /** 6280 * ieee80211_send_eosp_nullfunc - ask mac80211 to send NDP with EOSP 6281 * @pubsta: the station 6282 * @tid: the tid of the NDP 6283 * 6284 * Sometimes the device understands that it needs to close 6285 * the Service Period unexpectedly. This can happen when 6286 * sending frames that are filling holes in the BA window. 6287 * In this case, the device can ask mac80211 to send a 6288 * Nullfunc frame with EOSP set. When that happens, the 6289 * driver must have called ieee80211_sta_set_buffered() to 6290 * let mac80211 know that there are no buffered frames any 6291 * more, otherwise mac80211 will get the more_data bit wrong. 6292 * The low level driver must have made sure that the frame 6293 * will be sent despite the station being in power-save. 6294 * Mac80211 won't call allow_buffered_frames(). 6295 * Note that calling this function, doesn't exempt the driver 6296 * from closing the EOSP properly, it will still have to call 6297 * ieee80211_sta_eosp when the NDP is sent. 6298 */ 6299 void ieee80211_send_eosp_nullfunc(struct ieee80211_sta *pubsta, int tid); 6300 6301 /** 6302 * ieee80211_sta_recalc_aggregates - recalculate aggregate data after a change 6303 * @pubsta: the station 6304 * 6305 * Call this function after changing a per-link aggregate data as referenced in 6306 * &struct ieee80211_sta_aggregates by accessing the agg field of 6307 * &struct ieee80211_link_sta. 6308 * 6309 * With non MLO the data in deflink will be referenced directly. In that case 6310 * there is no need to call this function. 6311 */ 6312 void ieee80211_sta_recalc_aggregates(struct ieee80211_sta *pubsta); 6313 6314 /** 6315 * ieee80211_sta_register_airtime - register airtime usage for a sta/tid 6316 * 6317 * Register airtime usage for a given sta on a given tid. The driver must call 6318 * this function to notify mac80211 that a station used a certain amount of 6319 * airtime. This information will be used by the TXQ scheduler to schedule 6320 * stations in a way that ensures airtime fairness. 6321 * 6322 * The reported airtime should as a minimum include all time that is spent 6323 * transmitting to the remote station, including overhead and padding, but not 6324 * including time spent waiting for a TXOP. If the time is not reported by the 6325 * hardware it can in some cases be calculated from the rate and known frame 6326 * composition. When possible, the time should include any failed transmission 6327 * attempts. 6328 * 6329 * The driver can either call this function synchronously for every packet or 6330 * aggregate, or asynchronously as airtime usage information becomes available. 6331 * TX and RX airtime can be reported together, or separately by setting one of 6332 * them to 0. 6333 * 6334 * @pubsta: the station 6335 * @tid: the TID to register airtime for 6336 * @tx_airtime: airtime used during TX (in usec) 6337 * @rx_airtime: airtime used during RX (in usec) 6338 */ 6339 void ieee80211_sta_register_airtime(struct ieee80211_sta *pubsta, u8 tid, 6340 u32 tx_airtime, u32 rx_airtime); 6341 6342 /** 6343 * ieee80211_txq_airtime_check - check if a txq can send frame to device 6344 * 6345 * @hw: pointer obtained from ieee80211_alloc_hw() 6346 * @txq: pointer obtained from station or virtual interface 6347 * 6348 * Return true if the AQL's airtime limit has not been reached and the txq can 6349 * continue to send more packets to the device. Otherwise return false. 6350 */ 6351 bool 6352 ieee80211_txq_airtime_check(struct ieee80211_hw *hw, struct ieee80211_txq *txq); 6353 6354 /** 6355 * ieee80211_iter_keys - iterate keys programmed into the device 6356 * @hw: pointer obtained from ieee80211_alloc_hw() 6357 * @vif: virtual interface to iterate, may be %NULL for all 6358 * @iter: iterator function that will be called for each key 6359 * @iter_data: custom data to pass to the iterator function 6360 * 6361 * This function can be used to iterate all the keys known to 6362 * mac80211, even those that weren't previously programmed into 6363 * the device. This is intended for use in WoWLAN if the device 6364 * needs reprogramming of the keys during suspend. Note that due 6365 * to locking reasons, it is also only safe to call this at few 6366 * spots since it must hold the RTNL and be able to sleep. 6367 * 6368 * The order in which the keys are iterated matches the order 6369 * in which they were originally installed and handed to the 6370 * set_key callback. 6371 */ 6372 void ieee80211_iter_keys(struct ieee80211_hw *hw, 6373 struct ieee80211_vif *vif, 6374 void (*iter)(struct ieee80211_hw *hw, 6375 struct ieee80211_vif *vif, 6376 struct ieee80211_sta *sta, 6377 struct ieee80211_key_conf *key, 6378 void *data), 6379 void *iter_data); 6380 6381 /** 6382 * ieee80211_iter_keys_rcu - iterate keys programmed into the device 6383 * @hw: pointer obtained from ieee80211_alloc_hw() 6384 * @vif: virtual interface to iterate, may be %NULL for all 6385 * @iter: iterator function that will be called for each key 6386 * @iter_data: custom data to pass to the iterator function 6387 * 6388 * This function can be used to iterate all the keys known to 6389 * mac80211, even those that weren't previously programmed into 6390 * the device. Note that due to locking reasons, keys of station 6391 * in removal process will be skipped. 6392 * 6393 * This function requires being called in an RCU critical section, 6394 * and thus iter must be atomic. 6395 */ 6396 void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw, 6397 struct ieee80211_vif *vif, 6398 void (*iter)(struct ieee80211_hw *hw, 6399 struct ieee80211_vif *vif, 6400 struct ieee80211_sta *sta, 6401 struct ieee80211_key_conf *key, 6402 void *data), 6403 void *iter_data); 6404 6405 /** 6406 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts 6407 * @hw: pointer obtained from ieee80211_alloc_hw(). 6408 * @iter: iterator function 6409 * @iter_data: data passed to iterator function 6410 * 6411 * Iterate all active channel contexts. This function is atomic and 6412 * doesn't acquire any locks internally that might be held in other 6413 * places while calling into the driver. 6414 * 6415 * The iterator will not find a context that's being added (during 6416 * the driver callback to add it) but will find it while it's being 6417 * removed. 6418 * 6419 * Note that during hardware restart, all contexts that existed 6420 * before the restart are considered already present so will be 6421 * found while iterating, whether they've been re-added already 6422 * or not. 6423 */ 6424 void ieee80211_iter_chan_contexts_atomic( 6425 struct ieee80211_hw *hw, 6426 void (*iter)(struct ieee80211_hw *hw, 6427 struct ieee80211_chanctx_conf *chanctx_conf, 6428 void *data), 6429 void *iter_data); 6430 6431 /** 6432 * ieee80211_ap_probereq_get - retrieve a Probe Request template 6433 * @hw: pointer obtained from ieee80211_alloc_hw(). 6434 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 6435 * 6436 * Creates a Probe Request template which can, for example, be uploaded to 6437 * hardware. The template is filled with bssid, ssid and supported rate 6438 * information. This function must only be called from within the 6439 * .bss_info_changed callback function and only in managed mode. The function 6440 * is only useful when the interface is associated, otherwise it will return 6441 * %NULL. 6442 * 6443 * Return: The Probe Request template. %NULL on error. 6444 */ 6445 struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw, 6446 struct ieee80211_vif *vif); 6447 6448 /** 6449 * ieee80211_beacon_loss - inform hardware does not receive beacons 6450 * 6451 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 6452 * 6453 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and 6454 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the 6455 * hardware is not receiving beacons with this function. 6456 */ 6457 void ieee80211_beacon_loss(struct ieee80211_vif *vif); 6458 6459 /** 6460 * ieee80211_connection_loss - inform hardware has lost connection to the AP 6461 * 6462 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 6463 * 6464 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and 6465 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver 6466 * needs to inform if the connection to the AP has been lost. 6467 * The function may also be called if the connection needs to be terminated 6468 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set. 6469 * 6470 * This function will cause immediate change to disassociated state, 6471 * without connection recovery attempts. 6472 */ 6473 void ieee80211_connection_loss(struct ieee80211_vif *vif); 6474 6475 /** 6476 * ieee80211_disconnect - request disconnection 6477 * 6478 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 6479 * @reconnect: immediate reconnect is desired 6480 * 6481 * Request disconnection from the current network and, if enabled, send a 6482 * hint to the higher layers that immediate reconnect is desired. 6483 */ 6484 void ieee80211_disconnect(struct ieee80211_vif *vif, bool reconnect); 6485 6486 /** 6487 * ieee80211_resume_disconnect - disconnect from AP after resume 6488 * 6489 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 6490 * 6491 * Instructs mac80211 to disconnect from the AP after resume. 6492 * Drivers can use this after WoWLAN if they know that the 6493 * connection cannot be kept up, for example because keys were 6494 * used while the device was asleep but the replay counters or 6495 * similar cannot be retrieved from the device during resume. 6496 * 6497 * Note that due to implementation issues, if the driver uses 6498 * the reconfiguration functionality during resume the interface 6499 * will still be added as associated first during resume and then 6500 * disconnect normally later. 6501 * 6502 * This function can only be called from the resume callback and 6503 * the driver must not be holding any of its own locks while it 6504 * calls this function, or at least not any locks it needs in the 6505 * key configuration paths (if it supports HW crypto). 6506 */ 6507 void ieee80211_resume_disconnect(struct ieee80211_vif *vif); 6508 6509 /** 6510 * ieee80211_hw_restart_disconnect - disconnect from AP after 6511 * hardware restart 6512 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 6513 * 6514 * Instructs mac80211 to disconnect from the AP after 6515 * hardware restart. 6516 */ 6517 void ieee80211_hw_restart_disconnect(struct ieee80211_vif *vif); 6518 6519 /** 6520 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring 6521 * rssi threshold triggered 6522 * 6523 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 6524 * @rssi_event: the RSSI trigger event type 6525 * @rssi_level: new RSSI level value or 0 if not available 6526 * @gfp: context flags 6527 * 6528 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality 6529 * monitoring is configured with an rssi threshold, the driver will inform 6530 * whenever the rssi level reaches the threshold. 6531 */ 6532 void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif, 6533 enum nl80211_cqm_rssi_threshold_event rssi_event, 6534 s32 rssi_level, 6535 gfp_t gfp); 6536 6537 /** 6538 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss 6539 * 6540 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 6541 * @gfp: context flags 6542 */ 6543 void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp); 6544 6545 /** 6546 * ieee80211_radar_detected - inform that a radar was detected 6547 * 6548 * @hw: pointer as obtained from ieee80211_alloc_hw() 6549 */ 6550 void ieee80211_radar_detected(struct ieee80211_hw *hw); 6551 6552 /** 6553 * ieee80211_chswitch_done - Complete channel switch process 6554 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 6555 * @success: make the channel switch successful or not 6556 * @link_id: the link_id on which the switch was done. Ignored if success is 6557 * false. 6558 * 6559 * Complete the channel switch post-process: set the new operational channel 6560 * and wake up the suspended queues. 6561 */ 6562 void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success, 6563 unsigned int link_id); 6564 6565 /** 6566 * ieee80211_channel_switch_disconnect - disconnect due to channel switch error 6567 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 6568 * @block_tx: if %true, do not send deauth frame. 6569 * 6570 * Instruct mac80211 to disconnect due to a channel switch error. The channel 6571 * switch can request to block the tx and so, we need to make sure we do not send 6572 * a deauth frame in this case. 6573 */ 6574 void ieee80211_channel_switch_disconnect(struct ieee80211_vif *vif, 6575 bool block_tx); 6576 6577 /** 6578 * ieee80211_request_smps - request SM PS transition 6579 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 6580 * @link_id: link ID for MLO, or 0 6581 * @smps_mode: new SM PS mode 6582 * 6583 * This allows the driver to request an SM PS transition in managed 6584 * mode. This is useful when the driver has more information than 6585 * the stack about possible interference, for example by bluetooth. 6586 */ 6587 void ieee80211_request_smps(struct ieee80211_vif *vif, unsigned int link_id, 6588 enum ieee80211_smps_mode smps_mode); 6589 6590 /** 6591 * ieee80211_ready_on_channel - notification of remain-on-channel start 6592 * @hw: pointer as obtained from ieee80211_alloc_hw() 6593 */ 6594 void ieee80211_ready_on_channel(struct ieee80211_hw *hw); 6595 6596 /** 6597 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired 6598 * @hw: pointer as obtained from ieee80211_alloc_hw() 6599 */ 6600 void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw); 6601 6602 /** 6603 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions 6604 * 6605 * in order not to harm the system performance and user experience, the device 6606 * may request not to allow any rx ba session and tear down existing rx ba 6607 * sessions based on system constraints such as periodic BT activity that needs 6608 * to limit wlan activity (eg.sco or a2dp)." 6609 * in such cases, the intention is to limit the duration of the rx ppdu and 6610 * therefore prevent the peer device to use a-mpdu aggregation. 6611 * 6612 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 6613 * @ba_rx_bitmap: Bit map of open rx ba per tid 6614 * @addr: & to bssid mac address 6615 */ 6616 void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap, 6617 const u8 *addr); 6618 6619 /** 6620 * ieee80211_mark_rx_ba_filtered_frames - move RX BA window and mark filtered 6621 * @pubsta: station struct 6622 * @tid: the session's TID 6623 * @ssn: starting sequence number of the bitmap, all frames before this are 6624 * assumed to be out of the window after the call 6625 * @filtered: bitmap of filtered frames, BIT(0) is the @ssn entry etc. 6626 * @received_mpdus: number of received mpdus in firmware 6627 * 6628 * This function moves the BA window and releases all frames before @ssn, and 6629 * marks frames marked in the bitmap as having been filtered. Afterwards, it 6630 * checks if any frames in the window starting from @ssn can now be released 6631 * (in case they were only waiting for frames that were filtered.) 6632 * (Only work correctly if @max_rx_aggregation_subframes <= 64 frames) 6633 */ 6634 void ieee80211_mark_rx_ba_filtered_frames(struct ieee80211_sta *pubsta, u8 tid, 6635 u16 ssn, u64 filtered, 6636 u16 received_mpdus); 6637 6638 /** 6639 * ieee80211_send_bar - send a BlockAckReq frame 6640 * 6641 * can be used to flush pending frames from the peer's aggregation reorder 6642 * buffer. 6643 * 6644 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 6645 * @ra: the peer's destination address 6646 * @tid: the TID of the aggregation session 6647 * @ssn: the new starting sequence number for the receiver 6648 */ 6649 void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn); 6650 6651 /** 6652 * ieee80211_manage_rx_ba_offl - helper to queue an RX BA work 6653 * @vif: &struct ieee80211_vif pointer from the add_interface callback 6654 * @addr: station mac address 6655 * @tid: the rx tid 6656 */ 6657 void ieee80211_manage_rx_ba_offl(struct ieee80211_vif *vif, const u8 *addr, 6658 unsigned int tid); 6659 6660 /** 6661 * ieee80211_start_rx_ba_session_offl - start a Rx BA session 6662 * 6663 * Some device drivers may offload part of the Rx aggregation flow including 6664 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx 6665 * reordering. 6666 * 6667 * Create structures responsible for reordering so device drivers may call here 6668 * when they complete AddBa negotiation. 6669 * 6670 * @vif: &struct ieee80211_vif pointer from the add_interface callback 6671 * @addr: station mac address 6672 * @tid: the rx tid 6673 */ 6674 static inline void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif, 6675 const u8 *addr, u16 tid) 6676 { 6677 if (WARN_ON(tid >= IEEE80211_NUM_TIDS)) 6678 return; 6679 ieee80211_manage_rx_ba_offl(vif, addr, tid); 6680 } 6681 6682 /** 6683 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session 6684 * 6685 * Some device drivers may offload part of the Rx aggregation flow including 6686 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx 6687 * reordering. 6688 * 6689 * Destroy structures responsible for reordering so device drivers may call here 6690 * when they complete DelBa negotiation. 6691 * 6692 * @vif: &struct ieee80211_vif pointer from the add_interface callback 6693 * @addr: station mac address 6694 * @tid: the rx tid 6695 */ 6696 static inline void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif, 6697 const u8 *addr, u16 tid) 6698 { 6699 if (WARN_ON(tid >= IEEE80211_NUM_TIDS)) 6700 return; 6701 ieee80211_manage_rx_ba_offl(vif, addr, tid + IEEE80211_NUM_TIDS); 6702 } 6703 6704 /** 6705 * ieee80211_rx_ba_timer_expired - stop a Rx BA session due to timeout 6706 * 6707 * Some device drivers do not offload AddBa/DelBa negotiation, but handle rx 6708 * buffer reording internally, and therefore also handle the session timer. 6709 * 6710 * Trigger the timeout flow, which sends a DelBa. 6711 * 6712 * @vif: &struct ieee80211_vif pointer from the add_interface callback 6713 * @addr: station mac address 6714 * @tid: the rx tid 6715 */ 6716 void ieee80211_rx_ba_timer_expired(struct ieee80211_vif *vif, 6717 const u8 *addr, unsigned int tid); 6718 6719 /* Rate control API */ 6720 6721 /** 6722 * struct ieee80211_tx_rate_control - rate control information for/from RC algo 6723 * 6724 * @hw: The hardware the algorithm is invoked for. 6725 * @sband: The band this frame is being transmitted on. 6726 * @bss_conf: the current BSS configuration 6727 * @skb: the skb that will be transmitted, the control information in it needs 6728 * to be filled in 6729 * @reported_rate: The rate control algorithm can fill this in to indicate 6730 * which rate should be reported to userspace as the current rate and 6731 * used for rate calculations in the mesh network. 6732 * @rts: whether RTS will be used for this frame because it is longer than the 6733 * RTS threshold 6734 * @short_preamble: whether mac80211 will request short-preamble transmission 6735 * if the selected rate supports it 6736 * @rate_idx_mask: user-requested (legacy) rate mask 6737 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use) 6738 * @bss: whether this frame is sent out in AP or IBSS mode 6739 */ 6740 struct ieee80211_tx_rate_control { 6741 struct ieee80211_hw *hw; 6742 struct ieee80211_supported_band *sband; 6743 struct ieee80211_bss_conf *bss_conf; 6744 struct sk_buff *skb; 6745 struct ieee80211_tx_rate reported_rate; 6746 bool rts, short_preamble; 6747 u32 rate_idx_mask; 6748 u8 *rate_idx_mcs_mask; 6749 bool bss; 6750 }; 6751 6752 /** 6753 * enum rate_control_capabilities - rate control capabilities 6754 */ 6755 enum rate_control_capabilities { 6756 /** 6757 * @RATE_CTRL_CAPA_VHT_EXT_NSS_BW: 6758 * Support for extended NSS BW support (dot11VHTExtendedNSSCapable) 6759 * Note that this is only looked at if the minimum number of chains 6760 * that the AP uses is < the number of TX chains the hardware has, 6761 * otherwise the NSS difference doesn't bother us. 6762 */ 6763 RATE_CTRL_CAPA_VHT_EXT_NSS_BW = BIT(0), 6764 /** 6765 * @RATE_CTRL_CAPA_AMPDU_TRIGGER: 6766 * mac80211 should start A-MPDU sessions on tx 6767 */ 6768 RATE_CTRL_CAPA_AMPDU_TRIGGER = BIT(1), 6769 }; 6770 6771 struct rate_control_ops { 6772 unsigned long capa; 6773 const char *name; 6774 void *(*alloc)(struct ieee80211_hw *hw); 6775 void (*add_debugfs)(struct ieee80211_hw *hw, void *priv, 6776 struct dentry *debugfsdir); 6777 void (*free)(void *priv); 6778 6779 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp); 6780 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband, 6781 struct cfg80211_chan_def *chandef, 6782 struct ieee80211_sta *sta, void *priv_sta); 6783 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband, 6784 struct cfg80211_chan_def *chandef, 6785 struct ieee80211_sta *sta, void *priv_sta, 6786 u32 changed); 6787 void (*free_sta)(void *priv, struct ieee80211_sta *sta, 6788 void *priv_sta); 6789 6790 void (*tx_status_ext)(void *priv, 6791 struct ieee80211_supported_band *sband, 6792 void *priv_sta, struct ieee80211_tx_status *st); 6793 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband, 6794 struct ieee80211_sta *sta, void *priv_sta, 6795 struct sk_buff *skb); 6796 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta, 6797 struct ieee80211_tx_rate_control *txrc); 6798 6799 void (*add_sta_debugfs)(void *priv, void *priv_sta, 6800 struct dentry *dir); 6801 6802 u32 (*get_expected_throughput)(void *priv_sta); 6803 }; 6804 6805 static inline int rate_supported(struct ieee80211_sta *sta, 6806 enum nl80211_band band, 6807 int index) 6808 { 6809 return (sta == NULL || sta->deflink.supp_rates[band] & BIT(index)); 6810 } 6811 6812 static inline s8 6813 rate_lowest_index(struct ieee80211_supported_band *sband, 6814 struct ieee80211_sta *sta) 6815 { 6816 int i; 6817 6818 for (i = 0; i < sband->n_bitrates; i++) 6819 if (rate_supported(sta, sband->band, i)) 6820 return i; 6821 6822 /* warn when we cannot find a rate. */ 6823 WARN_ON_ONCE(1); 6824 6825 /* and return 0 (the lowest index) */ 6826 return 0; 6827 } 6828 6829 static inline 6830 bool rate_usable_index_exists(struct ieee80211_supported_band *sband, 6831 struct ieee80211_sta *sta) 6832 { 6833 unsigned int i; 6834 6835 for (i = 0; i < sband->n_bitrates; i++) 6836 if (rate_supported(sta, sband->band, i)) 6837 return true; 6838 return false; 6839 } 6840 6841 /** 6842 * rate_control_set_rates - pass the sta rate selection to mac80211/driver 6843 * 6844 * When not doing a rate control probe to test rates, rate control should pass 6845 * its rate selection to mac80211. If the driver supports receiving a station 6846 * rate table, it will use it to ensure that frames are always sent based on 6847 * the most recent rate control module decision. 6848 * 6849 * @hw: pointer as obtained from ieee80211_alloc_hw() 6850 * @pubsta: &struct ieee80211_sta pointer to the target destination. 6851 * @rates: new tx rate set to be used for this station. 6852 */ 6853 int rate_control_set_rates(struct ieee80211_hw *hw, 6854 struct ieee80211_sta *pubsta, 6855 struct ieee80211_sta_rates *rates); 6856 6857 int ieee80211_rate_control_register(const struct rate_control_ops *ops); 6858 void ieee80211_rate_control_unregister(const struct rate_control_ops *ops); 6859 6860 static inline bool 6861 conf_is_ht20(struct ieee80211_conf *conf) 6862 { 6863 return conf->chandef.width == NL80211_CHAN_WIDTH_20; 6864 } 6865 6866 static inline bool 6867 conf_is_ht40_minus(struct ieee80211_conf *conf) 6868 { 6869 return conf->chandef.width == NL80211_CHAN_WIDTH_40 && 6870 conf->chandef.center_freq1 < conf->chandef.chan->center_freq; 6871 } 6872 6873 static inline bool 6874 conf_is_ht40_plus(struct ieee80211_conf *conf) 6875 { 6876 return conf->chandef.width == NL80211_CHAN_WIDTH_40 && 6877 conf->chandef.center_freq1 > conf->chandef.chan->center_freq; 6878 } 6879 6880 static inline bool 6881 conf_is_ht40(struct ieee80211_conf *conf) 6882 { 6883 return conf->chandef.width == NL80211_CHAN_WIDTH_40; 6884 } 6885 6886 static inline bool 6887 conf_is_ht(struct ieee80211_conf *conf) 6888 { 6889 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) && 6890 (conf->chandef.width != NL80211_CHAN_WIDTH_10) && 6891 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT); 6892 } 6893 6894 static inline enum nl80211_iftype 6895 ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p) 6896 { 6897 if (p2p) { 6898 switch (type) { 6899 case NL80211_IFTYPE_STATION: 6900 return NL80211_IFTYPE_P2P_CLIENT; 6901 case NL80211_IFTYPE_AP: 6902 return NL80211_IFTYPE_P2P_GO; 6903 default: 6904 break; 6905 } 6906 } 6907 return type; 6908 } 6909 6910 static inline enum nl80211_iftype 6911 ieee80211_vif_type_p2p(struct ieee80211_vif *vif) 6912 { 6913 return ieee80211_iftype_p2p(vif->type, vif->p2p); 6914 } 6915 6916 /** 6917 * ieee80211_get_he_iftype_cap_vif - return HE capabilities for sband/vif 6918 * @sband: the sband to search for the iftype on 6919 * @vif: the vif to get the iftype from 6920 * 6921 * Return: pointer to the struct ieee80211_sta_he_cap, or %NULL is none found 6922 */ 6923 static inline const struct ieee80211_sta_he_cap * 6924 ieee80211_get_he_iftype_cap_vif(const struct ieee80211_supported_band *sband, 6925 struct ieee80211_vif *vif) 6926 { 6927 return ieee80211_get_he_iftype_cap(sband, ieee80211_vif_type_p2p(vif)); 6928 } 6929 6930 /** 6931 * ieee80211_get_he_6ghz_capa_vif - return HE 6 GHz capabilities 6932 * @sband: the sband to search for the STA on 6933 * @vif: the vif to get the iftype from 6934 * 6935 * Return: the 6GHz capabilities 6936 */ 6937 static inline __le16 6938 ieee80211_get_he_6ghz_capa_vif(const struct ieee80211_supported_band *sband, 6939 struct ieee80211_vif *vif) 6940 { 6941 return ieee80211_get_he_6ghz_capa(sband, ieee80211_vif_type_p2p(vif)); 6942 } 6943 6944 /** 6945 * ieee80211_get_eht_iftype_cap_vif - return ETH capabilities for sband/vif 6946 * @sband: the sband to search for the iftype on 6947 * @vif: the vif to get the iftype from 6948 * 6949 * Return: pointer to the struct ieee80211_sta_eht_cap, or %NULL is none found 6950 */ 6951 static inline const struct ieee80211_sta_eht_cap * 6952 ieee80211_get_eht_iftype_cap_vif(const struct ieee80211_supported_band *sband, 6953 struct ieee80211_vif *vif) 6954 { 6955 return ieee80211_get_eht_iftype_cap(sband, ieee80211_vif_type_p2p(vif)); 6956 } 6957 6958 /** 6959 * ieee80211_update_mu_groups - set the VHT MU-MIMO groud data 6960 * 6961 * @vif: the specified virtual interface 6962 * @link_id: the link ID for MLO, otherwise 0 6963 * @membership: 64 bits array - a bit is set if station is member of the group 6964 * @position: 2 bits per group id indicating the position in the group 6965 * 6966 * Note: This function assumes that the given vif is valid and the position and 6967 * membership data is of the correct size and are in the same byte order as the 6968 * matching GroupId management frame. 6969 * Calls to this function need to be serialized with RX path. 6970 */ 6971 void ieee80211_update_mu_groups(struct ieee80211_vif *vif, unsigned int link_id, 6972 const u8 *membership, const u8 *position); 6973 6974 void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif, 6975 int rssi_min_thold, 6976 int rssi_max_thold); 6977 6978 void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif); 6979 6980 /** 6981 * ieee80211_ave_rssi - report the average RSSI for the specified interface 6982 * 6983 * @vif: the specified virtual interface 6984 * 6985 * Note: This function assumes that the given vif is valid. 6986 * 6987 * Return: The average RSSI value for the requested interface, or 0 if not 6988 * applicable. 6989 */ 6990 int ieee80211_ave_rssi(struct ieee80211_vif *vif); 6991 6992 /** 6993 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup 6994 * @vif: virtual interface 6995 * @wakeup: wakeup reason(s) 6996 * @gfp: allocation flags 6997 * 6998 * See cfg80211_report_wowlan_wakeup(). 6999 */ 7000 void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif, 7001 struct cfg80211_wowlan_wakeup *wakeup, 7002 gfp_t gfp); 7003 7004 /** 7005 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission 7006 * @hw: pointer as obtained from ieee80211_alloc_hw() 7007 * @vif: virtual interface 7008 * @skb: frame to be sent from within the driver 7009 * @band: the band to transmit on 7010 * @sta: optional pointer to get the station to send the frame to 7011 * 7012 * Note: must be called under RCU lock 7013 */ 7014 bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw, 7015 struct ieee80211_vif *vif, struct sk_buff *skb, 7016 int band, struct ieee80211_sta **sta); 7017 7018 /** 7019 * ieee80211_parse_tx_radiotap - Sanity-check and parse the radiotap header 7020 * of injected frames. 7021 * 7022 * To accurately parse and take into account rate and retransmission fields, 7023 * you must initialize the chandef field in the ieee80211_tx_info structure 7024 * of the skb before calling this function. 7025 * 7026 * @skb: packet injected by userspace 7027 * @dev: the &struct device of this 802.11 device 7028 */ 7029 bool ieee80211_parse_tx_radiotap(struct sk_buff *skb, 7030 struct net_device *dev); 7031 7032 /** 7033 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state 7034 * 7035 * @next_tsf: TSF timestamp of the next absent state change 7036 * @has_next_tsf: next absent state change event pending 7037 * 7038 * @absent: descriptor bitmask, set if GO is currently absent 7039 * 7040 * private: 7041 * 7042 * @count: count fields from the NoA descriptors 7043 * @desc: adjusted data from the NoA 7044 */ 7045 struct ieee80211_noa_data { 7046 u32 next_tsf; 7047 bool has_next_tsf; 7048 7049 u8 absent; 7050 7051 u8 count[IEEE80211_P2P_NOA_DESC_MAX]; 7052 struct { 7053 u32 start; 7054 u32 duration; 7055 u32 interval; 7056 } desc[IEEE80211_P2P_NOA_DESC_MAX]; 7057 }; 7058 7059 /** 7060 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE 7061 * 7062 * @attr: P2P NoA IE 7063 * @data: NoA tracking data 7064 * @tsf: current TSF timestamp 7065 * 7066 * Return: number of successfully parsed descriptors 7067 */ 7068 int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr, 7069 struct ieee80211_noa_data *data, u32 tsf); 7070 7071 /** 7072 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change 7073 * 7074 * @data: NoA tracking data 7075 * @tsf: current TSF timestamp 7076 */ 7077 void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf); 7078 7079 /** 7080 * ieee80211_tdls_oper_request - request userspace to perform a TDLS operation 7081 * @vif: virtual interface 7082 * @peer: the peer's destination address 7083 * @oper: the requested TDLS operation 7084 * @reason_code: reason code for the operation, valid for TDLS teardown 7085 * @gfp: allocation flags 7086 * 7087 * See cfg80211_tdls_oper_request(). 7088 */ 7089 void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer, 7090 enum nl80211_tdls_operation oper, 7091 u16 reason_code, gfp_t gfp); 7092 7093 /** 7094 * ieee80211_reserve_tid - request to reserve a specific TID 7095 * 7096 * There is sometimes a need (such as in TDLS) for blocking the driver from 7097 * using a specific TID so that the FW can use it for certain operations such 7098 * as sending PTI requests. To make sure that the driver doesn't use that TID, 7099 * this function must be called as it flushes out packets on this TID and marks 7100 * it as blocked, so that any transmit for the station on this TID will be 7101 * redirected to the alternative TID in the same AC. 7102 * 7103 * Note that this function blocks and may call back into the driver, so it 7104 * should be called without driver locks held. Also note this function should 7105 * only be called from the driver's @sta_state callback. 7106 * 7107 * @sta: the station to reserve the TID for 7108 * @tid: the TID to reserve 7109 * 7110 * Returns: 0 on success, else on failure 7111 */ 7112 int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid); 7113 7114 /** 7115 * ieee80211_unreserve_tid - request to unreserve a specific TID 7116 * 7117 * Once there is no longer any need for reserving a certain TID, this function 7118 * should be called, and no longer will packets have their TID modified for 7119 * preventing use of this TID in the driver. 7120 * 7121 * Note that this function blocks and acquires a lock, so it should be called 7122 * without driver locks held. Also note this function should only be called 7123 * from the driver's @sta_state callback. 7124 * 7125 * @sta: the station 7126 * @tid: the TID to unreserve 7127 */ 7128 void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid); 7129 7130 /** 7131 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue 7132 * 7133 * @hw: pointer as obtained from ieee80211_alloc_hw() 7134 * @txq: pointer obtained from station or virtual interface, or from 7135 * ieee80211_next_txq() 7136 * 7137 * Returns the skb if successful, %NULL if no frame was available. 7138 * 7139 * Note that this must be called in an rcu_read_lock() critical section, 7140 * which can only be released after the SKB was handled. Some pointers in 7141 * skb->cb, e.g. the key pointer, are protected by RCU and thus the 7142 * critical section must persist not just for the duration of this call 7143 * but for the duration of the frame handling. 7144 * However, also note that while in the wake_tx_queue() method, 7145 * rcu_read_lock() is already held. 7146 * 7147 * softirqs must also be disabled when this function is called. 7148 * In process context, use ieee80211_tx_dequeue_ni() instead. 7149 */ 7150 struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw, 7151 struct ieee80211_txq *txq); 7152 7153 /** 7154 * ieee80211_tx_dequeue_ni - dequeue a packet from a software tx queue 7155 * (in process context) 7156 * 7157 * Like ieee80211_tx_dequeue() but can be called in process context 7158 * (internally disables bottom halves). 7159 * 7160 * @hw: pointer as obtained from ieee80211_alloc_hw() 7161 * @txq: pointer obtained from station or virtual interface, or from 7162 * ieee80211_next_txq() 7163 */ 7164 static inline struct sk_buff *ieee80211_tx_dequeue_ni(struct ieee80211_hw *hw, 7165 struct ieee80211_txq *txq) 7166 { 7167 struct sk_buff *skb; 7168 7169 local_bh_disable(); 7170 skb = ieee80211_tx_dequeue(hw, txq); 7171 local_bh_enable(); 7172 7173 return skb; 7174 } 7175 7176 /** 7177 * ieee80211_handle_wake_tx_queue - mac80211 handler for wake_tx_queue callback 7178 * 7179 * @hw: pointer as obtained from wake_tx_queue() callback(). 7180 * @txq: pointer as obtained from wake_tx_queue() callback(). 7181 * 7182 * Drivers can use this function for the mandatory mac80211 wake_tx_queue 7183 * callback in struct ieee80211_ops. They should not call this function. 7184 */ 7185 void ieee80211_handle_wake_tx_queue(struct ieee80211_hw *hw, 7186 struct ieee80211_txq *txq); 7187 7188 /** 7189 * ieee80211_next_txq - get next tx queue to pull packets from 7190 * 7191 * @hw: pointer as obtained from ieee80211_alloc_hw() 7192 * @ac: AC number to return packets from. 7193 * 7194 * Returns the next txq if successful, %NULL if no queue is eligible. If a txq 7195 * is returned, it should be returned with ieee80211_return_txq() after the 7196 * driver has finished scheduling it. 7197 */ 7198 struct ieee80211_txq *ieee80211_next_txq(struct ieee80211_hw *hw, u8 ac); 7199 7200 /** 7201 * ieee80211_txq_schedule_start - start new scheduling round for TXQs 7202 * 7203 * @hw: pointer as obtained from ieee80211_alloc_hw() 7204 * @ac: AC number to acquire locks for 7205 * 7206 * Should be called before ieee80211_next_txq() or ieee80211_return_txq(). 7207 * The driver must not call multiple TXQ scheduling rounds concurrently. 7208 */ 7209 void ieee80211_txq_schedule_start(struct ieee80211_hw *hw, u8 ac); 7210 7211 /* (deprecated) */ 7212 static inline void ieee80211_txq_schedule_end(struct ieee80211_hw *hw, u8 ac) 7213 { 7214 } 7215 7216 void __ieee80211_schedule_txq(struct ieee80211_hw *hw, 7217 struct ieee80211_txq *txq, bool force); 7218 7219 /** 7220 * ieee80211_schedule_txq - schedule a TXQ for transmission 7221 * 7222 * @hw: pointer as obtained from ieee80211_alloc_hw() 7223 * @txq: pointer obtained from station or virtual interface 7224 * 7225 * Schedules a TXQ for transmission if it is not already scheduled, 7226 * even if mac80211 does not have any packets buffered. 7227 * 7228 * The driver may call this function if it has buffered packets for 7229 * this TXQ internally. 7230 */ 7231 static inline void 7232 ieee80211_schedule_txq(struct ieee80211_hw *hw, struct ieee80211_txq *txq) 7233 { 7234 __ieee80211_schedule_txq(hw, txq, true); 7235 } 7236 7237 /** 7238 * ieee80211_return_txq - return a TXQ previously acquired by ieee80211_next_txq() 7239 * 7240 * @hw: pointer as obtained from ieee80211_alloc_hw() 7241 * @txq: pointer obtained from station or virtual interface 7242 * @force: schedule txq even if mac80211 does not have any buffered packets. 7243 * 7244 * The driver may set force=true if it has buffered packets for this TXQ 7245 * internally. 7246 */ 7247 static inline void 7248 ieee80211_return_txq(struct ieee80211_hw *hw, struct ieee80211_txq *txq, 7249 bool force) 7250 { 7251 __ieee80211_schedule_txq(hw, txq, force); 7252 } 7253 7254 /** 7255 * ieee80211_txq_may_transmit - check whether TXQ is allowed to transmit 7256 * 7257 * This function is used to check whether given txq is allowed to transmit by 7258 * the airtime scheduler, and can be used by drivers to access the airtime 7259 * fairness accounting without going using the scheduling order enfored by 7260 * next_txq(). 7261 * 7262 * Returns %true if the airtime scheduler thinks the TXQ should be allowed to 7263 * transmit, and %false if it should be throttled. This function can also have 7264 * the side effect of rotating the TXQ in the scheduler rotation, which will 7265 * eventually bring the deficit to positive and allow the station to transmit 7266 * again. 7267 * 7268 * The API ieee80211_txq_may_transmit() also ensures that TXQ list will be 7269 * aligned against driver's own round-robin scheduler list. i.e it rotates 7270 * the TXQ list till it makes the requested node becomes the first entry 7271 * in TXQ list. Thus both the TXQ list and driver's list are in sync. If this 7272 * function returns %true, the driver is expected to schedule packets 7273 * for transmission, and then return the TXQ through ieee80211_return_txq(). 7274 * 7275 * @hw: pointer as obtained from ieee80211_alloc_hw() 7276 * @txq: pointer obtained from station or virtual interface 7277 */ 7278 bool ieee80211_txq_may_transmit(struct ieee80211_hw *hw, 7279 struct ieee80211_txq *txq); 7280 7281 /** 7282 * ieee80211_txq_get_depth - get pending frame/byte count of given txq 7283 * 7284 * The values are not guaranteed to be coherent with regard to each other, i.e. 7285 * txq state can change half-way of this function and the caller may end up 7286 * with "new" frame_cnt and "old" byte_cnt or vice-versa. 7287 * 7288 * @txq: pointer obtained from station or virtual interface 7289 * @frame_cnt: pointer to store frame count 7290 * @byte_cnt: pointer to store byte count 7291 */ 7292 void ieee80211_txq_get_depth(struct ieee80211_txq *txq, 7293 unsigned long *frame_cnt, 7294 unsigned long *byte_cnt); 7295 7296 /** 7297 * ieee80211_nan_func_terminated - notify about NAN function termination. 7298 * 7299 * This function is used to notify mac80211 about NAN function termination. 7300 * Note that this function can't be called from hard irq. 7301 * 7302 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 7303 * @inst_id: the local instance id 7304 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*) 7305 * @gfp: allocation flags 7306 */ 7307 void ieee80211_nan_func_terminated(struct ieee80211_vif *vif, 7308 u8 inst_id, 7309 enum nl80211_nan_func_term_reason reason, 7310 gfp_t gfp); 7311 7312 /** 7313 * ieee80211_nan_func_match - notify about NAN function match event. 7314 * 7315 * This function is used to notify mac80211 about NAN function match. The 7316 * cookie inside the match struct will be assigned by mac80211. 7317 * Note that this function can't be called from hard irq. 7318 * 7319 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 7320 * @match: match event information 7321 * @gfp: allocation flags 7322 */ 7323 void ieee80211_nan_func_match(struct ieee80211_vif *vif, 7324 struct cfg80211_nan_match_params *match, 7325 gfp_t gfp); 7326 7327 /** 7328 * ieee80211_calc_rx_airtime - calculate estimated transmission airtime for RX. 7329 * 7330 * This function calculates the estimated airtime usage of a frame based on the 7331 * rate information in the RX status struct and the frame length. 7332 * 7333 * @hw: pointer as obtained from ieee80211_alloc_hw() 7334 * @status: &struct ieee80211_rx_status containing the transmission rate 7335 * information. 7336 * @len: frame length in bytes 7337 */ 7338 u32 ieee80211_calc_rx_airtime(struct ieee80211_hw *hw, 7339 struct ieee80211_rx_status *status, 7340 int len); 7341 7342 /** 7343 * ieee80211_calc_tx_airtime - calculate estimated transmission airtime for TX. 7344 * 7345 * This function calculates the estimated airtime usage of a frame based on the 7346 * rate information in the TX info struct and the frame length. 7347 * 7348 * @hw: pointer as obtained from ieee80211_alloc_hw() 7349 * @info: &struct ieee80211_tx_info of the frame. 7350 * @len: frame length in bytes 7351 */ 7352 u32 ieee80211_calc_tx_airtime(struct ieee80211_hw *hw, 7353 struct ieee80211_tx_info *info, 7354 int len); 7355 /** 7356 * ieee80211_set_hw_80211_encap - enable hardware encapsulation offloading. 7357 * 7358 * This function is used to notify mac80211 that a vif can be passed raw 802.3 7359 * frames. The driver needs to then handle the 802.11 encapsulation inside the 7360 * hardware or firmware. 7361 * 7362 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 7363 * @enable: indicate if the feature should be turned on or off 7364 */ 7365 bool ieee80211_set_hw_80211_encap(struct ieee80211_vif *vif, bool enable); 7366 7367 /** 7368 * ieee80211_get_fils_discovery_tmpl - Get FILS discovery template. 7369 * @hw: pointer obtained from ieee80211_alloc_hw(). 7370 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 7371 * 7372 * The driver is responsible for freeing the returned skb. 7373 * 7374 * Return: FILS discovery template. %NULL on error. 7375 */ 7376 struct sk_buff *ieee80211_get_fils_discovery_tmpl(struct ieee80211_hw *hw, 7377 struct ieee80211_vif *vif); 7378 7379 /** 7380 * ieee80211_get_unsol_bcast_probe_resp_tmpl - Get unsolicited broadcast 7381 * probe response template. 7382 * @hw: pointer obtained from ieee80211_alloc_hw(). 7383 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 7384 * 7385 * The driver is responsible for freeing the returned skb. 7386 * 7387 * Return: Unsolicited broadcast probe response template. %NULL on error. 7388 */ 7389 struct sk_buff * 7390 ieee80211_get_unsol_bcast_probe_resp_tmpl(struct ieee80211_hw *hw, 7391 struct ieee80211_vif *vif); 7392 7393 /** 7394 * ieee80211_obss_color_collision_notify - notify userland about a BSS color 7395 * collision. 7396 * 7397 * @vif: &struct ieee80211_vif pointer from the add_interface callback. 7398 * @color_bitmap: a 64 bit bitmap representing the colors that the local BSS is 7399 * aware of. 7400 * @gfp: allocation flags 7401 */ 7402 void 7403 ieee80211_obss_color_collision_notify(struct ieee80211_vif *vif, 7404 u64 color_bitmap, gfp_t gfp); 7405 7406 /** 7407 * ieee80211_is_tx_data - check if frame is a data frame 7408 * 7409 * The function is used to check if a frame is a data frame. Frames with 7410 * hardware encapsulation enabled are data frames. 7411 * 7412 * @skb: the frame to be transmitted. 7413 */ 7414 static inline bool ieee80211_is_tx_data(struct sk_buff *skb) 7415 { 7416 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb); 7417 struct ieee80211_hdr *hdr = (void *) skb->data; 7418 7419 return info->flags & IEEE80211_TX_CTL_HW_80211_ENCAP || 7420 ieee80211_is_data(hdr->frame_control); 7421 } 7422 7423 /** 7424 * ieee80211_set_active_links - set active links in client mode 7425 * @vif: interface to set active links on 7426 * @active_links: the new active links bitmap 7427 * 7428 * This changes the active links on an interface. The interface 7429 * must be in client mode (in AP mode, all links are always active), 7430 * and @active_links must be a subset of the vif's valid_links. 7431 * 7432 * If a link is switched off and another is switched on at the same 7433 * time (e.g. active_links going from 0x1 to 0x10) then you will get 7434 * a sequence of calls like 7435 * - change_vif_links(0x11) 7436 * - unassign_vif_chanctx(link_id=0) 7437 * - change_sta_links(0x11) for each affected STA (the AP) 7438 * (TDLS connections on now inactive links should be torn down) 7439 * - remove group keys on the old link (link_id 0) 7440 * - add new group keys (GTK/IGTK/BIGTK) on the new link (link_id 4) 7441 * - change_sta_links(0x10) for each affected STA (the AP) 7442 * - assign_vif_chanctx(link_id=4) 7443 * - change_vif_links(0x10) 7444 * 7445 * Note: This function acquires some mac80211 locks and must not 7446 * be called with any driver locks held that could cause a 7447 * lock dependency inversion. Best call it without locks. 7448 */ 7449 int ieee80211_set_active_links(struct ieee80211_vif *vif, u16 active_links); 7450 7451 /** 7452 * ieee80211_set_active_links_async - asynchronously set active links 7453 * @vif: interface to set active links on 7454 * @active_links: the new active links bitmap 7455 * 7456 * See ieee80211_set_active_links() for more information, the only 7457 * difference here is that the link change is triggered async and 7458 * can be called in any context, but the link switch will only be 7459 * completed after it returns. 7460 */ 7461 void ieee80211_set_active_links_async(struct ieee80211_vif *vif, 7462 u16 active_links); 7463 7464 #endif /* MAC80211_H */ 7465