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