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