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