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