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