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