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