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