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