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