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