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