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