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