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