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