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