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