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