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