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