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