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