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