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