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