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