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