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