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