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