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