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