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