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