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