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