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