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