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