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