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