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