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