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