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