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