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