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