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