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