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