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