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