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