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