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