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