Loading...
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 - 2024 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 <linux/lockdep.h>
22#include <net/cfg80211.h>
23#include <net/codel.h>
24#include <net/ieee80211_radiotap.h>
25#include <linux/unaligned.h>
26
27/**
28 * DOC: Introduction
29 *
30 * mac80211 is the Linux stack for 802.11 hardware that implements
31 * only partial functionality in hard- or firmware. This document
32 * defines the interface between mac80211 and low-level hardware
33 * drivers.
34 */
35
36/**
37 * DOC: Calling mac80211 from interrupts
38 *
39 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
40 * called in hardware interrupt context. The low-level driver must not call any
41 * other functions in hardware interrupt context. If there is a need for such
42 * call, the low-level driver should first ACK the interrupt and perform the
43 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
44 * tasklet function.
45 *
46 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
47 * use the non-IRQ-safe functions!
48 */
49
50/**
51 * DOC: Warning
52 *
53 * If you're reading this document and not the header file itself, it will
54 * be incomplete because not all documentation has been converted yet.
55 */
56
57/**
58 * DOC: Frame format
59 *
60 * As a general rule, when frames are passed between mac80211 and the driver,
61 * they start with the IEEE 802.11 header and include the same octets that are
62 * sent over the air except for the FCS which should be calculated by the
63 * hardware.
64 *
65 * There are, however, various exceptions to this rule for advanced features:
66 *
67 * The first exception is for hardware encryption and decryption offload
68 * where the IV/ICV may or may not be generated in hardware.
69 *
70 * Secondly, when the hardware handles fragmentation, the frame handed to
71 * the driver from mac80211 is the MSDU, not the MPDU.
72 */
73
74/**
75 * DOC: mac80211 workqueue
76 *
77 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
78 * The workqueue is a single threaded workqueue and can only be accessed by
79 * helpers for sanity checking. Drivers must ensure all work added onto the
80 * mac80211 workqueue should be cancelled on the driver stop() callback.
81 *
82 * mac80211 will flush the workqueue upon interface removal and during
83 * suspend.
84 *
85 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
86 *
87 */
88
89/**
90 * DOC: mac80211 software tx queueing
91 *
92 * mac80211 uses an intermediate queueing implementation, designed to allow the
93 * driver to keep hardware queues short and to provide some fairness between
94 * different stations/interfaces.
95 *
96 * Drivers must provide the .wake_tx_queue driver operation by either
97 * linking it to ieee80211_handle_wake_tx_queue() or implementing a custom
98 * handler.
99 *
100 * Intermediate queues (struct ieee80211_txq) are kept per-sta per-tid, with
101 * another per-sta for non-data/non-mgmt and bufferable management frames, and
102 * a single per-vif queue for multicast data frames.
103 *
104 * The driver is expected to initialize its private per-queue data for stations
105 * and interfaces in the .add_interface and .sta_add ops.
106 *
107 * The driver can't access the internal TX queues (iTXQs) directly.
108 * Whenever mac80211 adds a new frame to a queue, it calls the .wake_tx_queue
109 * driver op.
110 * Drivers implementing a custom .wake_tx_queue op can get them by calling
111 * ieee80211_tx_dequeue(). Drivers using ieee80211_handle_wake_tx_queue() will
112 * simply get the individual frames pushed via the .tx driver operation.
113 *
114 * Drivers can optionally delegate responsibility for scheduling queues to
115 * mac80211, to take advantage of airtime fairness accounting. In this case, to
116 * obtain the next queue to pull frames from, the driver calls
117 * ieee80211_next_txq(). The driver is then expected to return the txq using
118 * ieee80211_return_txq().
119 *
120 * For AP powersave TIM handling, the driver only needs to indicate if it has
121 * buffered packets in the driver specific data structures by calling
122 * ieee80211_sta_set_buffered(). For frames buffered in the ieee80211_txq
123 * struct, mac80211 sets the appropriate TIM PVB bits and calls
124 * .release_buffered_frames().
125 * In that callback the driver is therefore expected to release its own
126 * buffered frames and afterwards also frames from the ieee80211_txq (obtained
127 * via the usual ieee80211_tx_dequeue).
128 */
129
130/**
131 * DOC: HW timestamping
132 *
133 * Timing Measurement and Fine Timing Measurement require accurate timestamps
134 * of the action frames TX/RX and their respective acks.
135 *
136 * To report hardware timestamps for Timing Measurement or Fine Timing
137 * Measurement frame RX, the low level driver should set the SKB's hwtstamp
138 * field to the frame RX timestamp and report the ack TX timestamp in the
139 * ieee80211_rx_status struct.
140 *
141 * Similarly, to report hardware timestamps for Timing Measurement or Fine
142 * Timing Measurement frame TX, the driver should set the SKB's hwtstamp field
143 * to the frame TX timestamp and report the ack RX timestamp in the
144 * ieee80211_tx_status struct.
145 */
146struct device;
147
148/**
149 * enum ieee80211_max_queues - maximum number of queues
150 *
151 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
152 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
153 */
154enum ieee80211_max_queues {
155 IEEE80211_MAX_QUEUES = 16,
156 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
157};
158
159#define IEEE80211_INVAL_HW_QUEUE 0xff
160
161/**
162 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
163 * @IEEE80211_AC_VO: voice
164 * @IEEE80211_AC_VI: video
165 * @IEEE80211_AC_BE: best effort
166 * @IEEE80211_AC_BK: background
167 */
168enum ieee80211_ac_numbers {
169 IEEE80211_AC_VO = 0,
170 IEEE80211_AC_VI = 1,
171 IEEE80211_AC_BE = 2,
172 IEEE80211_AC_BK = 3,
173};
174
175/**
176 * struct ieee80211_tx_queue_params - transmit queue configuration
177 *
178 * The information provided in this structure is required for QoS
179 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
180 *
181 * @aifs: arbitration interframe space [0..255]
182 * @cw_min: minimum contention window [a value of the form
183 * 2^n-1 in the range 1..32767]
184 * @cw_max: maximum contention window [like @cw_min]
185 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
186 * @acm: is mandatory admission control required for the access category
187 * @uapsd: is U-APSD mode enabled for the queue
188 * @mu_edca: is the MU EDCA configured
189 * @mu_edca_param_rec: MU EDCA Parameter Record for HE
190 */
191struct ieee80211_tx_queue_params {
192 u16 txop;
193 u16 cw_min;
194 u16 cw_max;
195 u8 aifs;
196 bool acm;
197 bool uapsd;
198 bool mu_edca;
199 struct ieee80211_he_mu_edca_param_ac_rec mu_edca_param_rec;
200};
201
202struct ieee80211_low_level_stats {
203 unsigned int dot11ACKFailureCount;
204 unsigned int dot11RTSFailureCount;
205 unsigned int dot11FCSErrorCount;
206 unsigned int dot11RTSSuccessCount;
207};
208
209/**
210 * enum ieee80211_chanctx_change - change flag for channel context
211 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
212 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
213 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
214 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
215 * this is used only with channel switching with CSA
216 * @IEEE80211_CHANCTX_CHANGE_MIN_DEF: The min chandef changed
217 * @IEEE80211_CHANCTX_CHANGE_AP: The AP channel definition changed, so (wider
218 * bandwidth) OFDMA settings need to be changed
219 * @IEEE80211_CHANCTX_CHANGE_PUNCTURING: The punctured channel(s) bitmap
220 * was changed.
221 */
222enum ieee80211_chanctx_change {
223 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
224 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
225 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
226 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
227 IEEE80211_CHANCTX_CHANGE_MIN_DEF = BIT(4),
228 IEEE80211_CHANCTX_CHANGE_AP = BIT(5),
229 IEEE80211_CHANCTX_CHANGE_PUNCTURING = BIT(6),
230};
231
232/**
233 * struct ieee80211_chan_req - A channel "request"
234 * @oper: channel definition to use for operation
235 * @ap: the channel definition of the AP, if any
236 * (otherwise the chan member is %NULL)
237 */
238struct ieee80211_chan_req {
239 struct cfg80211_chan_def oper;
240 struct cfg80211_chan_def ap;
241};
242
243/**
244 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
245 *
246 * This is the driver-visible part. The ieee80211_chanctx
247 * that contains it is visible in mac80211 only.
248 *
249 * @def: the channel definition
250 * @min_def: the minimum channel definition currently required.
251 * @ap: the channel definition the AP actually is operating as,
252 * for use with (wider bandwidth) OFDMA
253 * @radio_idx: index of the wiphy radio used used for this channel
254 * @rx_chains_static: The number of RX chains that must always be
255 * active on the channel to receive MIMO transmissions
256 * @rx_chains_dynamic: The number of RX chains that must be enabled
257 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
258 * this will always be >= @rx_chains_static.
259 * @radar_enabled: whether radar detection is enabled on this channel.
260 * @drv_priv: data area for driver use, will always be aligned to
261 * sizeof(void *), size is determined in hw information.
262 */
263struct ieee80211_chanctx_conf {
264 struct cfg80211_chan_def def;
265 struct cfg80211_chan_def min_def;
266 struct cfg80211_chan_def ap;
267
268 int radio_idx;
269 u8 rx_chains_static, rx_chains_dynamic;
270
271 bool radar_enabled;
272
273 u8 drv_priv[] __aligned(sizeof(void *));
274};
275
276/**
277 * enum ieee80211_chanctx_switch_mode - channel context switch mode
278 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
279 * exist (and will continue to exist), but the virtual interface
280 * needs to be switched from one to the other.
281 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
282 * to exist with this call, the new context doesn't exist but
283 * will be active after this call, the virtual interface switches
284 * from the old to the new (note that the driver may of course
285 * implement this as an on-the-fly chandef switch of the existing
286 * hardware context, but the mac80211 pointer for the old context
287 * will cease to exist and only the new one will later be used
288 * for changes/removal.)
289 */
290enum ieee80211_chanctx_switch_mode {
291 CHANCTX_SWMODE_REASSIGN_VIF,
292 CHANCTX_SWMODE_SWAP_CONTEXTS,
293};
294
295/**
296 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
297 *
298 * This is structure is used to pass information about a vif that
299 * needs to switch from one chanctx to another. The
300 * &ieee80211_chanctx_switch_mode defines how the switch should be
301 * done.
302 *
303 * @vif: the vif that should be switched from old_ctx to new_ctx
304 * @link_conf: the link conf that's switching
305 * @old_ctx: the old context to which the vif was assigned
306 * @new_ctx: the new context to which the vif must be assigned
307 */
308struct ieee80211_vif_chanctx_switch {
309 struct ieee80211_vif *vif;
310 struct ieee80211_bss_conf *link_conf;
311 struct ieee80211_chanctx_conf *old_ctx;
312 struct ieee80211_chanctx_conf *new_ctx;
313};
314
315/**
316 * enum ieee80211_bss_change - BSS change notification flags
317 *
318 * These flags are used with the bss_info_changed(), link_info_changed()
319 * and vif_cfg_changed() callbacks to indicate which parameter(s) changed.
320 *
321 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
322 * also implies a change in the AID.
323 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
324 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
325 * @BSS_CHANGED_ERP_SLOT: slot timing changed
326 * @BSS_CHANGED_HT: 802.11n parameters changed
327 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
328 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
329 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
330 * reason (IBSS and managed mode)
331 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
332 * new beacon (beaconing modes)
333 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
334 * enabled/disabled (beaconing modes)
335 * @BSS_CHANGED_CQM: Connection quality monitor config changed
336 * @BSS_CHANGED_IBSS: IBSS join status changed
337 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
338 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
339 * that it is only ever disabled for station mode.
340 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
341 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
342 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
343 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
344 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
345 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
346 * changed
347 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
348 * currently dtim_period only is under consideration.
349 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
350 * note that this is only called when it changes after the channel
351 * context had been assigned.
352 * @BSS_CHANGED_OCB: OCB join status changed
353 * @BSS_CHANGED_MU_GROUPS: VHT MU-MIMO group id or user position changed
354 * @BSS_CHANGED_KEEP_ALIVE: keep alive options (idle period or protected
355 * keep alive) changed.
356 * @BSS_CHANGED_MCAST_RATE: Multicast Rate setting changed for this interface
357 * @BSS_CHANGED_FTM_RESPONDER: fine timing measurement request responder
358 * functionality changed for this BSS (AP mode).
359 * @BSS_CHANGED_TWT: TWT status changed
360 * @BSS_CHANGED_HE_OBSS_PD: OBSS Packet Detection status changed.
361 * @BSS_CHANGED_HE_BSS_COLOR: BSS Color has changed
362 * @BSS_CHANGED_FILS_DISCOVERY: FILS discovery status changed.
363 * @BSS_CHANGED_UNSOL_BCAST_PROBE_RESP: Unsolicited broadcast probe response
364 * status changed.
365 * @BSS_CHANGED_MLD_VALID_LINKS: MLD valid links status changed.
366 * @BSS_CHANGED_MLD_TTLM: negotiated TID to link mapping was changed
367 * @BSS_CHANGED_TPE: transmit power envelope changed
368 */
369enum ieee80211_bss_change {
370 BSS_CHANGED_ASSOC = 1<<0,
371 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
372 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
373 BSS_CHANGED_ERP_SLOT = 1<<3,
374 BSS_CHANGED_HT = 1<<4,
375 BSS_CHANGED_BASIC_RATES = 1<<5,
376 BSS_CHANGED_BEACON_INT = 1<<6,
377 BSS_CHANGED_BSSID = 1<<7,
378 BSS_CHANGED_BEACON = 1<<8,
379 BSS_CHANGED_BEACON_ENABLED = 1<<9,
380 BSS_CHANGED_CQM = 1<<10,
381 BSS_CHANGED_IBSS = 1<<11,
382 BSS_CHANGED_ARP_FILTER = 1<<12,
383 BSS_CHANGED_QOS = 1<<13,
384 BSS_CHANGED_IDLE = 1<<14,
385 BSS_CHANGED_SSID = 1<<15,
386 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
387 BSS_CHANGED_PS = 1<<17,
388 BSS_CHANGED_TXPOWER = 1<<18,
389 BSS_CHANGED_P2P_PS = 1<<19,
390 BSS_CHANGED_BEACON_INFO = 1<<20,
391 BSS_CHANGED_BANDWIDTH = 1<<21,
392 BSS_CHANGED_OCB = 1<<22,
393 BSS_CHANGED_MU_GROUPS = 1<<23,
394 BSS_CHANGED_KEEP_ALIVE = 1<<24,
395 BSS_CHANGED_MCAST_RATE = 1<<25,
396 BSS_CHANGED_FTM_RESPONDER = 1<<26,
397 BSS_CHANGED_TWT = 1<<27,
398 BSS_CHANGED_HE_OBSS_PD = 1<<28,
399 BSS_CHANGED_HE_BSS_COLOR = 1<<29,
400 BSS_CHANGED_FILS_DISCOVERY = 1<<30,
401 BSS_CHANGED_UNSOL_BCAST_PROBE_RESP = BIT_ULL(31),
402 BSS_CHANGED_MLD_VALID_LINKS = BIT_ULL(33),
403 BSS_CHANGED_MLD_TTLM = BIT_ULL(34),
404 BSS_CHANGED_TPE = BIT_ULL(35),
405
406 /* when adding here, make sure to change ieee80211_reconfig */
407};
408
409/*
410 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
411 * of addresses for an interface increase beyond this value, hardware ARP
412 * filtering will be disabled.
413 */
414#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
415
416/**
417 * enum ieee80211_event_type - event to be notified to the low level driver
418 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
419 * @MLME_EVENT: event related to MLME
420 * @BAR_RX_EVENT: a BAR was received
421 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because
422 * they timed out. This won't be called for each frame released, but only
423 * once each time the timeout triggers.
424 */
425enum ieee80211_event_type {
426 RSSI_EVENT,
427 MLME_EVENT,
428 BAR_RX_EVENT,
429 BA_FRAME_TIMEOUT,
430};
431
432/**
433 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
434 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
435 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
436 */
437enum ieee80211_rssi_event_data {
438 RSSI_EVENT_HIGH,
439 RSSI_EVENT_LOW,
440};
441
442/**
443 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
444 * @data: See &enum ieee80211_rssi_event_data
445 */
446struct ieee80211_rssi_event {
447 enum ieee80211_rssi_event_data data;
448};
449
450/**
451 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
452 * @AUTH_EVENT: the MLME operation is authentication
453 * @ASSOC_EVENT: the MLME operation is association
454 * @DEAUTH_RX_EVENT: deauth received..
455 * @DEAUTH_TX_EVENT: deauth sent.
456 */
457enum ieee80211_mlme_event_data {
458 AUTH_EVENT,
459 ASSOC_EVENT,
460 DEAUTH_RX_EVENT,
461 DEAUTH_TX_EVENT,
462};
463
464/**
465 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
466 * @MLME_SUCCESS: the MLME operation completed successfully.
467 * @MLME_DENIED: the MLME operation was denied by the peer.
468 * @MLME_TIMEOUT: the MLME operation timed out.
469 */
470enum ieee80211_mlme_event_status {
471 MLME_SUCCESS,
472 MLME_DENIED,
473 MLME_TIMEOUT,
474};
475
476/**
477 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
478 * @data: See &enum ieee80211_mlme_event_data
479 * @status: See &enum ieee80211_mlme_event_status
480 * @reason: the reason code if applicable
481 */
482struct ieee80211_mlme_event {
483 enum ieee80211_mlme_event_data data;
484 enum ieee80211_mlme_event_status status;
485 u16 reason;
486};
487
488/**
489 * struct ieee80211_ba_event - data attached for BlockAck related events
490 * @sta: pointer to the &ieee80211_sta to which this event relates
491 * @tid: the tid
492 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
493 */
494struct ieee80211_ba_event {
495 struct ieee80211_sta *sta;
496 u16 tid;
497 u16 ssn;
498};
499
500/**
501 * struct ieee80211_event - event to be sent to the driver
502 * @type: The event itself. See &enum ieee80211_event_type.
503 * @u.rssi: relevant if &type is %RSSI_EVENT
504 * @u.mlme: relevant if &type is %AUTH_EVENT
505 * @u.ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
506 * @u:union holding the fields above
507 */
508struct ieee80211_event {
509 enum ieee80211_event_type type;
510 union {
511 struct ieee80211_rssi_event rssi;
512 struct ieee80211_mlme_event mlme;
513 struct ieee80211_ba_event ba;
514 } u;
515};
516
517/**
518 * struct ieee80211_mu_group_data - STA's VHT MU-MIMO group data
519 *
520 * This structure describes the group id data of VHT MU-MIMO
521 *
522 * @membership: 64 bits array - a bit is set if station is member of the group
523 * @position: 2 bits per group id indicating the position in the group
524 */
525struct ieee80211_mu_group_data {
526 u8 membership[WLAN_MEMBERSHIP_LEN];
527 u8 position[WLAN_USER_POSITION_LEN];
528};
529
530/**
531 * struct ieee80211_ftm_responder_params - FTM responder parameters
532 *
533 * @lci: LCI subelement content
534 * @civicloc: CIVIC location subelement content
535 * @lci_len: LCI data length
536 * @civicloc_len: Civic data length
537 */
538struct ieee80211_ftm_responder_params {
539 const u8 *lci;
540 const u8 *civicloc;
541 size_t lci_len;
542 size_t civicloc_len;
543};
544
545/**
546 * struct ieee80211_fils_discovery - FILS discovery parameters from
547 * IEEE Std 802.11ai-2016, Annex C.3 MIB detail.
548 *
549 * @min_interval: Minimum packet interval in TUs (0 - 10000)
550 * @max_interval: Maximum packet interval in TUs (0 - 10000)
551 */
552struct ieee80211_fils_discovery {
553 u32 min_interval;
554 u32 max_interval;
555};
556
557#define IEEE80211_TPE_EIRP_ENTRIES_320MHZ 5
558struct ieee80211_parsed_tpe_eirp {
559 bool valid;
560 s8 power[IEEE80211_TPE_EIRP_ENTRIES_320MHZ];
561 u8 count;
562};
563
564#define IEEE80211_TPE_PSD_ENTRIES_320MHZ 16
565struct ieee80211_parsed_tpe_psd {
566 bool valid;
567 s8 power[IEEE80211_TPE_PSD_ENTRIES_320MHZ];
568 u8 count, n;
569};
570
571/**
572 * struct ieee80211_parsed_tpe - parsed transmit power envelope information
573 * @max_local: maximum local EIRP, one value for 20, 40, 80, 160, 320 MHz each
574 * (indexed by TX power category)
575 * @max_reg_client: maximum regulatory client EIRP, one value for 20, 40, 80,
576 * 160, 320 MHz each
577 * (indexed by TX power category)
578 * @psd_local: maximum local power spectral density, one value for each 20 MHz
579 * subchannel per bss_conf's chanreq.oper
580 * (indexed by TX power category)
581 * @psd_reg_client: maximum regulatory power spectral density, one value for
582 * each 20 MHz subchannel per bss_conf's chanreq.oper
583 * (indexed by TX power category)
584 */
585struct ieee80211_parsed_tpe {
586 struct ieee80211_parsed_tpe_eirp max_local[2], max_reg_client[2];
587 struct ieee80211_parsed_tpe_psd psd_local[2], psd_reg_client[2];
588};
589
590/**
591 * struct ieee80211_bss_conf - holds the BSS's changing parameters
592 *
593 * This structure keeps information about a BSS (and an association
594 * to that BSS) that can change during the lifetime of the BSS.
595 *
596 * @vif: reference to owning VIF
597 * @bss: the cfg80211 bss descriptor. Valid only for a station, and only
598 * when associated. Note: This contains information which is not
599 * necessarily authenticated. For example, information coming from probe
600 * responses.
601 * @addr: (link) address used locally
602 * @link_id: link ID, or 0 for non-MLO
603 * @htc_trig_based_pkt_ext: default PE in 4us units, if BSS supports HE
604 * @uora_exists: is the UORA element advertised by AP
605 * @uora_ocw_range: UORA element's OCW Range field
606 * @frame_time_rts_th: HE duration RTS threshold, in units of 32us
607 * @he_support: does this BSS support HE
608 * @twt_requester: does this BSS support TWT requester (relevant for managed
609 * mode only, set if the AP advertises TWT responder role)
610 * @twt_responder: does this BSS support TWT requester (relevant for managed
611 * mode only, set if the AP advertises TWT responder role)
612 * @twt_protected: does this BSS support protected TWT frames
613 * @twt_broadcast: does this BSS support broadcast TWT
614 * @use_cts_prot: use CTS protection
615 * @use_short_preamble: use 802.11b short preamble
616 * @use_short_slot: use short slot time (only relevant for ERP)
617 * @dtim_period: num of beacons before the next DTIM, for beaconing,
618 * valid in station mode only if after the driver was notified
619 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
620 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
621 * as it may have been received during scanning long ago). If the
622 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
623 * only come from a beacon, but might not become valid until after
624 * association when a beacon is received (which is notified with the
625 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
626 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
627 * the driver/device can use this to calculate synchronisation
628 * (see @sync_tsf). See also sync_dtim_count important notice.
629 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
630 * is requested, see @sync_tsf/@sync_device_ts.
631 * IMPORTANT: These three sync_* parameters would possibly be out of sync
632 * by the time the driver will use them. The synchronized view is currently
633 * guaranteed only in certain callbacks.
634 * Note also that this is not used with MLD associations, mac80211 doesn't
635 * know how to track beacons for all of the links for this.
636 * @beacon_int: beacon interval
637 * @assoc_capability: capabilities taken from assoc resp
638 * @basic_rates: bitmap of basic rates, each bit stands for an
639 * index into the rate table configured by the driver in
640 * the current band.
641 * @beacon_rate: associated AP's beacon TX rate
642 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
643 * @bssid: The BSSID for this BSS
644 * @enable_beacon: whether beaconing should be enabled or not
645 * @chanreq: Channel request for this BSS -- the hardware might be
646 * configured a higher bandwidth than this BSS uses, for example.
647 * @mu_group: VHT MU-MIMO group membership data
648 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
649 * This field is only valid when the channel is a wide HT/VHT channel.
650 * Note that with TDLS this can be the case (channel is HT, protection must
651 * be used from this field) even when the BSS association isn't using HT.
652 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
653 * implies disabled. As with the cfg80211 callback, a change here should
654 * cause an event to be sent indicating where the current value is in
655 * relation to the newly configured threshold.
656 * @cqm_rssi_low: Connection quality monitor RSSI lower threshold, a zero value
657 * implies disabled. This is an alternative mechanism to the single
658 * threshold event and can't be enabled simultaneously with it.
659 * @cqm_rssi_high: Connection quality monitor RSSI upper threshold.
660 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
661 * @qos: This is a QoS-enabled BSS.
662 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
663 * @txpower: TX power in dBm. INT_MIN means not configured.
664 * @txpower_type: TX power adjustment used to control per packet Transmit
665 * Power Control (TPC) in lower driver for the current vif. In particular
666 * TPC is enabled if value passed in %txpower_type is
667 * NL80211_TX_POWER_LIMITED (allow using less than specified from
668 * userspace), whereas TPC is disabled if %txpower_type is set to
669 * NL80211_TX_POWER_FIXED (use value configured from userspace)
670 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
671 * @allow_p2p_go_ps: indication for AP or P2P GO interface, whether it's allowed
672 * to use P2P PS mechanism or not. AP/P2P GO is not allowed to use P2P PS
673 * if it has associated clients without P2P PS support.
674 * @max_idle_period: the time period during which the station can refrain from
675 * transmitting frames to its associated AP without being disassociated.
676 * In units of 1000 TUs. Zero value indicates that the AP did not include
677 * a (valid) BSS Max Idle Period Element.
678 * @protected_keep_alive: if set, indicates that the station should send an RSN
679 * protected frame to the AP to reset the idle timer at the AP for the
680 * station.
681 * @ftm_responder: whether to enable or disable fine timing measurement FTM
682 * responder functionality.
683 * @ftmr_params: configurable lci/civic parameter when enabling FTM responder.
684 * @nontransmitted: this BSS is a nontransmitted BSS profile
685 * @transmitter_bssid: the address of transmitter AP
686 * @bssid_index: index inside the multiple BSSID set
687 * @bssid_indicator: 2^bssid_indicator is the maximum number of APs in set
688 * @ema_ap: AP supports enhancements of discovery and advertisement of
689 * nontransmitted BSSIDs
690 * @profile_periodicity: the least number of beacon frames need to be received
691 * in order to discover all the nontransmitted BSSIDs in the set.
692 * @he_oper: HE operation information of the BSS (AP/Mesh) or of the AP we are
693 * connected to (STA)
694 * @he_obss_pd: OBSS Packet Detection parameters.
695 * @he_bss_color: BSS coloring settings, if BSS supports HE
696 * @fils_discovery: FILS discovery configuration
697 * @unsol_bcast_probe_resp_interval: Unsolicited broadcast probe response
698 * interval.
699 * @beacon_tx_rate: The configured beacon transmit rate that needs to be passed
700 * to driver when rate control is offloaded to firmware.
701 * @power_type: power type of BSS for 6 GHz
702 * @tpe: transmit power envelope information
703 * @pwr_reduction: power constraint of BSS.
704 * @eht_support: does this BSS support EHT
705 * @csa_active: marks whether a channel switch is going on.
706 * @mu_mimo_owner: indicates interface owns MU-MIMO capability
707 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
708 * when it is not assigned. This pointer is RCU-protected due to the TX
709 * path needing to access it; even though the netdev carrier will always
710 * be off when it is %NULL there can still be races and packets could be
711 * processed after it switches back to %NULL.
712 * @color_change_active: marks whether a color change is ongoing.
713 * @color_change_color: the bss color that will be used after the change.
714 * @ht_ldpc: in AP mode, indicates interface has HT LDPC capability.
715 * @vht_ldpc: in AP mode, indicates interface has VHT LDPC capability.
716 * @he_ldpc: in AP mode, indicates interface has HE LDPC capability.
717 * @vht_su_beamformer: in AP mode, does this BSS support operation as an VHT SU
718 * beamformer
719 * @vht_su_beamformee: in AP mode, does this BSS support operation as an VHT SU
720 * beamformee
721 * @vht_mu_beamformer: in AP mode, does this BSS support operation as an VHT MU
722 * beamformer
723 * @vht_mu_beamformee: in AP mode, does this BSS support operation as an VHT MU
724 * beamformee
725 * @he_su_beamformer: in AP-mode, does this BSS support operation as an HE SU
726 * beamformer
727 * @he_su_beamformee: in AP-mode, does this BSS support operation as an HE SU
728 * beamformee
729 * @he_mu_beamformer: in AP-mode, does this BSS support operation as an HE MU
730 * beamformer
731 * @he_full_ul_mumimo: does this BSS support the reception (AP) or transmission
732 * (non-AP STA) of an HE TB PPDU on an RU that spans the entire PPDU
733 * bandwidth
734 * @eht_su_beamformer: in AP-mode, does this BSS enable operation as an EHT SU
735 * beamformer
736 * @eht_su_beamformee: in AP-mode, does this BSS enable operation as an EHT SU
737 * beamformee
738 * @eht_mu_beamformer: in AP-mode, does this BSS enable operation as an EHT MU
739 * beamformer
740 * @eht_80mhz_full_bw_ul_mumimo: in AP-mode, does this BSS support the
741 * reception of an EHT TB PPDU on an RU that spans the entire PPDU
742 * bandwidth
743 * @bss_param_ch_cnt: in BSS-mode, the BSS params change count. This
744 * information is the latest known value. It can come from this link's
745 * beacon or from a beacon sent by another link.
746 * @bss_param_ch_cnt_link_id: in BSS-mode, the link_id to which the beacon
747 * that updated &bss_param_ch_cnt belongs. E.g. if link 1 doesn't hear
748 * its beacons, and link 2 sent a beacon with an RNR element that updated
749 * link 1's BSS params change count, then, link 1's
750 * bss_param_ch_cnt_link_id will be 2. That means that link 1 knows that
751 * link 2 was the link that updated its bss_param_ch_cnt value.
752 * In case link 1 hears its beacon again, bss_param_ch_cnt_link_id will
753 * be updated to 1, even if bss_param_ch_cnt didn't change. This allows
754 * the link to know that it heard the latest value from its own beacon
755 * (as opposed to hearing its value from another link's beacon).
756 */
757struct ieee80211_bss_conf {
758 struct ieee80211_vif *vif;
759 struct cfg80211_bss *bss;
760
761 const u8 *bssid;
762 unsigned int link_id;
763 u8 addr[ETH_ALEN] __aligned(2);
764 u8 htc_trig_based_pkt_ext;
765 bool uora_exists;
766 u8 uora_ocw_range;
767 u16 frame_time_rts_th;
768 bool he_support;
769 bool twt_requester;
770 bool twt_responder;
771 bool twt_protected;
772 bool twt_broadcast;
773 /* erp related data */
774 bool use_cts_prot;
775 bool use_short_preamble;
776 bool use_short_slot;
777 bool enable_beacon;
778 u8 dtim_period;
779 u16 beacon_int;
780 u16 assoc_capability;
781 u64 sync_tsf;
782 u32 sync_device_ts;
783 u8 sync_dtim_count;
784 u32 basic_rates;
785 struct ieee80211_rate *beacon_rate;
786 int mcast_rate[NUM_NL80211_BANDS];
787 u16 ht_operation_mode;
788 s32 cqm_rssi_thold;
789 u32 cqm_rssi_hyst;
790 s32 cqm_rssi_low;
791 s32 cqm_rssi_high;
792 struct ieee80211_chan_req chanreq;
793 struct ieee80211_mu_group_data mu_group;
794 bool qos;
795 bool hidden_ssid;
796 int txpower;
797 enum nl80211_tx_power_setting txpower_type;
798 struct ieee80211_p2p_noa_attr p2p_noa_attr;
799 bool allow_p2p_go_ps;
800 u16 max_idle_period;
801 bool protected_keep_alive;
802 bool ftm_responder;
803 struct ieee80211_ftm_responder_params *ftmr_params;
804 /* Multiple BSSID data */
805 bool nontransmitted;
806 u8 transmitter_bssid[ETH_ALEN];
807 u8 bssid_index;
808 u8 bssid_indicator;
809 bool ema_ap;
810 u8 profile_periodicity;
811 struct {
812 u32 params;
813 u16 nss_set;
814 } he_oper;
815 struct ieee80211_he_obss_pd he_obss_pd;
816 struct cfg80211_he_bss_color he_bss_color;
817 struct ieee80211_fils_discovery fils_discovery;
818 u32 unsol_bcast_probe_resp_interval;
819 struct cfg80211_bitrate_mask beacon_tx_rate;
820 enum ieee80211_ap_reg_power power_type;
821
822 struct ieee80211_parsed_tpe tpe;
823
824 u8 pwr_reduction;
825 bool eht_support;
826
827 bool csa_active;
828
829 bool mu_mimo_owner;
830 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
831
832 bool color_change_active;
833 u8 color_change_color;
834
835 bool ht_ldpc;
836 bool vht_ldpc;
837 bool he_ldpc;
838 bool vht_su_beamformer;
839 bool vht_su_beamformee;
840 bool vht_mu_beamformer;
841 bool vht_mu_beamformee;
842 bool he_su_beamformer;
843 bool he_su_beamformee;
844 bool he_mu_beamformer;
845 bool he_full_ul_mumimo;
846 bool eht_su_beamformer;
847 bool eht_su_beamformee;
848 bool eht_mu_beamformer;
849 bool eht_80mhz_full_bw_ul_mumimo;
850 u8 bss_param_ch_cnt;
851 u8 bss_param_ch_cnt_link_id;
852};
853
854/**
855 * enum mac80211_tx_info_flags - flags to describe transmission information/status
856 *
857 * These flags are used with the @flags member of &ieee80211_tx_info.
858 *
859 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
860 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
861 * number to this frame, taking care of not overwriting the fragment
862 * number and increasing the sequence number only when the
863 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
864 * assign sequence numbers to QoS-data frames but cannot do so correctly
865 * for non-QoS-data and management frames because beacons need them from
866 * that counter as well and mac80211 cannot guarantee proper sequencing.
867 * If this flag is set, the driver should instruct the hardware to
868 * assign a sequence number to the frame or assign one itself. Cf. IEEE
869 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
870 * beacons and always be clear for frames without a sequence number field.
871 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
872 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
873 * station
874 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
875 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
876 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
877 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
878 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
879 * because the destination STA was in powersave mode. Note that to
880 * avoid race conditions, the filter must be set by the hardware or
881 * firmware upon receiving a frame that indicates that the station
882 * went to sleep (must be done on device to filter frames already on
883 * the queue) and may only be unset after mac80211 gives the OK for
884 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
885 * since only then is it guaranteed that no more frames are in the
886 * hardware queue.
887 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
888 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
889 * is for the whole aggregation.
890 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
891 * so consider using block ack request (BAR).
892 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
893 * set by rate control algorithms to indicate probe rate, will
894 * be cleared for fragmented frames (except on the last fragment)
895 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
896 * that a frame can be transmitted while the queues are stopped for
897 * off-channel operation.
898 * @IEEE80211_TX_CTL_HW_80211_ENCAP: This frame uses hardware encapsulation
899 * (header conversion)
900 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
901 * used to indicate that a frame was already retried due to PS
902 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
903 * used to indicate frame should not be encrypted
904 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
905 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
906 * be sent although the station is in powersave mode.
907 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
908 * transmit function after the current frame, this can be used
909 * by drivers to kick the DMA queue only if unset or when the
910 * queue gets full.
911 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
912 * after TX status because the destination was asleep, it must not
913 * be modified again (no seqno assignment, crypto, etc.)
914 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
915 * code for connection establishment, this indicates that its status
916 * should kick the MLME state machine.
917 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
918 * MLME command (internal to mac80211 to figure out whether to send TX
919 * status to user space)
920 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
921 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
922 * frame and selects the maximum number of streams that it can use.
923 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
924 * the off-channel channel when a remain-on-channel offload is done
925 * in hardware -- normal packets still flow and are expected to be
926 * handled properly by the device.
927 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
928 * testing. It will be sent out with incorrect Michael MIC key to allow
929 * TKIP countermeasures to be tested.
930 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
931 * This flag is actually used for management frame especially for P2P
932 * frames not being sent at CCK rate in 2GHz band.
933 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
934 * when its status is reported the service period ends. For frames in
935 * an SP that mac80211 transmits, it is already set; for driver frames
936 * the driver may set this flag. It is also used to do the same for
937 * PS-Poll responses.
938 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
939 * This flag is used to send nullfunc frame at minimum rate when
940 * the nullfunc is used for connection monitoring purpose.
941 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
942 * would be fragmented by size (this is optional, only used for
943 * monitor injection).
944 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
945 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
946 * any errors (like issues specific to the driver/HW).
947 * This flag must not be set for frames that don't request no-ack
948 * behaviour with IEEE80211_TX_CTL_NO_ACK.
949 *
950 * Note: If you have to add new flags to the enumeration, then don't
951 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
952 */
953enum mac80211_tx_info_flags {
954 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
955 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
956 IEEE80211_TX_CTL_NO_ACK = BIT(2),
957 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
958 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
959 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
960 IEEE80211_TX_CTL_AMPDU = BIT(6),
961 IEEE80211_TX_CTL_INJECTED = BIT(7),
962 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
963 IEEE80211_TX_STAT_ACK = BIT(9),
964 IEEE80211_TX_STAT_AMPDU = BIT(10),
965 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
966 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
967 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
968 IEEE80211_TX_CTL_HW_80211_ENCAP = BIT(14),
969 IEEE80211_TX_INTFL_RETRIED = BIT(15),
970 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
971 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
972 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
973 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
974 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
975 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
976 IEEE80211_TX_CTL_LDPC = BIT(22),
977 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
978 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
979 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
980 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
981 IEEE80211_TX_STATUS_EOSP = BIT(28),
982 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
983 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
984 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31),
985};
986
987#define IEEE80211_TX_CTL_STBC_SHIFT 23
988
989#define IEEE80211_TX_RC_S1G_MCS IEEE80211_TX_RC_VHT_MCS
990
991/**
992 * enum mac80211_tx_control_flags - flags to describe transmit control
993 *
994 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
995 * protocol frame (e.g. EAP)
996 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
997 * frame (PS-Poll or uAPSD).
998 * @IEEE80211_TX_CTRL_RATE_INJECT: This frame is injected with rate information
999 * @IEEE80211_TX_CTRL_AMSDU: This frame is an A-MSDU frame
1000 * @IEEE80211_TX_CTRL_FAST_XMIT: This frame is going through the fast_xmit path
1001 * @IEEE80211_TX_CTRL_SKIP_MPATH_LOOKUP: This frame skips mesh path lookup
1002 * @IEEE80211_TX_INTCFL_NEED_TXPROCESSING: completely internal to mac80211,
1003 * used to indicate that a pending frame requires TX processing before
1004 * it can be sent out.
1005 * @IEEE80211_TX_CTRL_NO_SEQNO: Do not overwrite the sequence number that
1006 * has already been assigned to this frame.
1007 * @IEEE80211_TX_CTRL_DONT_REORDER: This frame should not be reordered
1008 * relative to other frames that have this flag set, independent
1009 * of their QoS TID or other priority field values.
1010 * @IEEE80211_TX_CTRL_MCAST_MLO_FIRST_TX: first MLO TX, used mostly internally
1011 * for sequence number assignment
1012 * @IEEE80211_TX_CTRL_DONT_USE_RATE_MASK: Don't use rate mask for this frame
1013 * which is transmitted due to scanning or offchannel TX, not in normal
1014 * operation on the interface.
1015 * @IEEE80211_TX_CTRL_MLO_LINK: If not @IEEE80211_LINK_UNSPECIFIED, this
1016 * frame should be transmitted on the specific link. This really is
1017 * only relevant for frames that do not have data present, and is
1018 * also not used for 802.3 format frames. Note that even if the frame
1019 * is on a specific link, address translation might still apply if
1020 * it's intended for an MLD.
1021 *
1022 * These flags are used in tx_info->control.flags.
1023 */
1024enum mac80211_tx_control_flags {
1025 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
1026 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
1027 IEEE80211_TX_CTRL_RATE_INJECT = BIT(2),
1028 IEEE80211_TX_CTRL_AMSDU = BIT(3),
1029 IEEE80211_TX_CTRL_FAST_XMIT = BIT(4),
1030 IEEE80211_TX_CTRL_SKIP_MPATH_LOOKUP = BIT(5),
1031 IEEE80211_TX_INTCFL_NEED_TXPROCESSING = BIT(6),
1032 IEEE80211_TX_CTRL_NO_SEQNO = BIT(7),
1033 IEEE80211_TX_CTRL_DONT_REORDER = BIT(8),
1034 IEEE80211_TX_CTRL_MCAST_MLO_FIRST_TX = BIT(9),
1035 IEEE80211_TX_CTRL_DONT_USE_RATE_MASK = BIT(10),
1036 IEEE80211_TX_CTRL_MLO_LINK = 0xf0000000,
1037};
1038
1039#define IEEE80211_LINK_UNSPECIFIED 0xf
1040#define IEEE80211_TX_CTRL_MLO_LINK_UNSPEC \
1041 u32_encode_bits(IEEE80211_LINK_UNSPECIFIED, \
1042 IEEE80211_TX_CTRL_MLO_LINK)
1043
1044/**
1045 * enum mac80211_tx_status_flags - flags to describe transmit status
1046 *
1047 * @IEEE80211_TX_STATUS_ACK_SIGNAL_VALID: ACK signal is valid
1048 *
1049 * These flags are used in tx_info->status.flags.
1050 */
1051enum mac80211_tx_status_flags {
1052 IEEE80211_TX_STATUS_ACK_SIGNAL_VALID = BIT(0),
1053};
1054
1055/*
1056 * This definition is used as a mask to clear all temporary flags, which are
1057 * set by the tx handlers for each transmission attempt by the mac80211 stack.
1058 */
1059#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
1060 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
1061 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
1062 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
1063 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
1064 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
1065 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
1066 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
1067
1068/**
1069 * enum mac80211_rate_control_flags - per-rate flags set by the
1070 * Rate Control algorithm.
1071 *
1072 * These flags are set by the Rate control algorithm for each rate during tx,
1073 * in the @flags member of struct ieee80211_tx_rate.
1074 *
1075 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
1076 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
1077 * This is set if the current BSS requires ERP protection.
1078 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
1079 * @IEEE80211_TX_RC_MCS: HT rate.
1080 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
1081 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
1082 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
1083 * Greenfield mode.
1084 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
1085 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
1086 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
1087 * (80+80 isn't supported yet)
1088 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
1089 * adjacent 20 MHz channels, if the current channel type is
1090 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
1091 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
1092 */
1093enum mac80211_rate_control_flags {
1094 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
1095 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
1096 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
1097
1098 /* rate index is an HT/VHT MCS instead of an index */
1099 IEEE80211_TX_RC_MCS = BIT(3),
1100 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
1101 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
1102 IEEE80211_TX_RC_DUP_DATA = BIT(6),
1103 IEEE80211_TX_RC_SHORT_GI = BIT(7),
1104 IEEE80211_TX_RC_VHT_MCS = BIT(8),
1105 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
1106 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
1107};
1108
1109
1110/* there are 40 bytes if you don't need the rateset to be kept */
1111#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
1112
1113/* if you do need the rateset, then you have less space */
1114#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
1115
1116/* maximum number of rate stages */
1117#define IEEE80211_TX_MAX_RATES 4
1118
1119/* maximum number of rate table entries */
1120#define IEEE80211_TX_RATE_TABLE_SIZE 4
1121
1122/**
1123 * struct ieee80211_tx_rate - rate selection/status
1124 *
1125 * @idx: rate index to attempt to send with
1126 * @flags: rate control flags (&enum mac80211_rate_control_flags)
1127 * @count: number of tries in this rate before going to the next rate
1128 *
1129 * A value of -1 for @idx indicates an invalid rate and, if used
1130 * in an array of retry rates, that no more rates should be tried.
1131 *
1132 * When used for transmit status reporting, the driver should
1133 * always report the rate along with the flags it used.
1134 *
1135 * &struct ieee80211_tx_info contains an array of these structs
1136 * in the control information, and it will be filled by the rate
1137 * control algorithm according to what should be sent. For example,
1138 * if this array contains, in the format { <idx>, <count> } the
1139 * information::
1140 *
1141 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
1142 *
1143 * then this means that the frame should be transmitted
1144 * up to twice at rate 3, up to twice at rate 2, and up to four
1145 * times at rate 1 if it doesn't get acknowledged. Say it gets
1146 * acknowledged by the peer after the fifth attempt, the status
1147 * information should then contain::
1148 *
1149 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
1150 *
1151 * since it was transmitted twice at rate 3, twice at rate 2
1152 * and once at rate 1 after which we received an acknowledgement.
1153 */
1154struct ieee80211_tx_rate {
1155 s8 idx;
1156 u16 count:5,
1157 flags:11;
1158} __packed;
1159
1160#define IEEE80211_MAX_TX_RETRY 31
1161
1162static inline bool ieee80211_rate_valid(struct ieee80211_tx_rate *rate)
1163{
1164 return rate->idx >= 0 && rate->count > 0;
1165}
1166
1167static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
1168 u8 mcs, u8 nss)
1169{
1170 WARN_ON(mcs & ~0xF);
1171 WARN_ON((nss - 1) & ~0x7);
1172 rate->idx = ((nss - 1) << 4) | mcs;
1173}
1174
1175static inline u8
1176ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
1177{
1178 return rate->idx & 0xF;
1179}
1180
1181static inline u8
1182ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
1183{
1184 return (rate->idx >> 4) + 1;
1185}
1186
1187/**
1188 * struct ieee80211_tx_info - skb transmit information
1189 *
1190 * This structure is placed in skb->cb for three uses:
1191 * (1) mac80211 TX control - mac80211 tells the driver what to do
1192 * (2) driver internal use (if applicable)
1193 * (3) TX status information - driver tells mac80211 what happened
1194 *
1195 * @flags: transmit info flags, defined above
1196 * @band: the band to transmit on (use e.g. for checking for races),
1197 * not valid if the interface is an MLD since we won't know which
1198 * link the frame will be transmitted on
1199 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
1200 * @status_data: internal data for TX status handling, assigned privately,
1201 * see also &enum ieee80211_status_data for the internal documentation
1202 * @status_data_idr: indicates status data is IDR allocated ID for ack frame
1203 * @tx_time_est: TX time estimate in units of 4us, used internally
1204 * @control: union part for control data
1205 * @control.rates: TX rates array to try
1206 * @control.rts_cts_rate_idx: rate for RTS or CTS
1207 * @control.use_rts: use RTS
1208 * @control.use_cts_prot: use RTS/CTS
1209 * @control.short_preamble: use short preamble (CCK only)
1210 * @control.skip_table: skip externally configured rate table
1211 * @control.jiffies: timestamp for expiry on powersave clients
1212 * @control.vif: virtual interface (may be NULL)
1213 * @control.hw_key: key to encrypt with (may be NULL)
1214 * @control.flags: control flags, see &enum mac80211_tx_control_flags
1215 * @control.enqueue_time: enqueue time (for iTXQs)
1216 * @driver_rates: alias to @control.rates to reserve space
1217 * @pad: padding
1218 * @rate_driver_data: driver use area if driver needs @control.rates
1219 * @status: union part for status data
1220 * @status.rates: attempted rates
1221 * @status.ack_signal: ACK signal
1222 * @status.ampdu_ack_len: AMPDU ack length
1223 * @status.ampdu_len: AMPDU length
1224 * @status.antenna: (legacy, kept only for iwlegacy)
1225 * @status.tx_time: airtime consumed for transmission; note this is only
1226 * used for WMM AC, not for airtime fairness
1227 * @status.flags: status flags, see &enum mac80211_tx_status_flags
1228 * @status.status_driver_data: driver use area
1229 * @ack: union part for pure ACK data
1230 * @ack.cookie: cookie for the ACK
1231 * @driver_data: array of driver_data pointers
1232 */
1233struct ieee80211_tx_info {
1234 /* common information */
1235 u32 flags;
1236 u32 band:3,
1237 status_data_idr:1,
1238 status_data:13,
1239 hw_queue:4,
1240 tx_time_est:10;
1241 /* 1 free bit */
1242
1243 union {
1244 struct {
1245 union {
1246 /* rate control */
1247 struct {
1248 struct ieee80211_tx_rate rates[
1249 IEEE80211_TX_MAX_RATES];
1250 s8 rts_cts_rate_idx;
1251 u8 use_rts:1;
1252 u8 use_cts_prot:1;
1253 u8 short_preamble:1;
1254 u8 skip_table:1;
1255
1256 /* for injection only (bitmap) */
1257 u8 antennas:2;
1258
1259 /* 14 bits free */
1260 };
1261 /* only needed before rate control */
1262 unsigned long jiffies;
1263 };
1264 /* NB: vif can be NULL for injected frames */
1265 struct ieee80211_vif *vif;
1266 struct ieee80211_key_conf *hw_key;
1267 u32 flags;
1268 codel_time_t enqueue_time;
1269 } control;
1270 struct {
1271 u64 cookie;
1272 } ack;
1273 struct {
1274 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
1275 s32 ack_signal;
1276 u8 ampdu_ack_len;
1277 u8 ampdu_len;
1278 u8 antenna;
1279 u8 pad;
1280 u16 tx_time;
1281 u8 flags;
1282 u8 pad2;
1283 void *status_driver_data[16 / sizeof(void *)];
1284 } status;
1285 struct {
1286 struct ieee80211_tx_rate driver_rates[
1287 IEEE80211_TX_MAX_RATES];
1288 u8 pad[4];
1289
1290 void *rate_driver_data[
1291 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
1292 };
1293 void *driver_data[
1294 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
1295 };
1296};
1297
1298static inline u16
1299ieee80211_info_set_tx_time_est(struct ieee80211_tx_info *info, u16 tx_time_est)
1300{
1301 /* We only have 10 bits in tx_time_est, so store airtime
1302 * in increments of 4us and clamp the maximum to 2**12-1
1303 */
1304 info->tx_time_est = min_t(u16, tx_time_est, 4095) >> 2;
1305 return info->tx_time_est << 2;
1306}
1307
1308static inline u16
1309ieee80211_info_get_tx_time_est(struct ieee80211_tx_info *info)
1310{
1311 return info->tx_time_est << 2;
1312}
1313
1314/***
1315 * struct ieee80211_rate_status - mrr stage for status path
1316 *
1317 * This struct is used in struct ieee80211_tx_status to provide drivers a
1318 * dynamic way to report about used rates and power levels per packet.
1319 *
1320 * @rate_idx The actual used rate.
1321 * @try_count How often the rate was tried.
1322 * @tx_power_idx An idx into the ieee80211_hw->tx_power_levels list of the
1323 * corresponding wifi hardware. The idx shall point to the power level
1324 * that was used when sending the packet.
1325 */
1326struct ieee80211_rate_status {
1327 struct rate_info rate_idx;
1328 u8 try_count;
1329 u8 tx_power_idx;
1330};
1331
1332/**
1333 * struct ieee80211_tx_status - extended tx status info for rate control
1334 *
1335 * @sta: Station that the packet was transmitted for
1336 * @info: Basic tx status information
1337 * @skb: Packet skb (can be NULL if not provided by the driver)
1338 * @rates: Mrr stages that were used when sending the packet
1339 * @n_rates: Number of mrr stages (count of instances for @rates)
1340 * @free_list: list where processed skbs are stored to be free'd by the driver
1341 * @ack_hwtstamp: Hardware timestamp of the received ack in nanoseconds
1342 * Only needed for Timing measurement and Fine timing measurement action
1343 * frames. Only reported by devices that have timestamping enabled.
1344 */
1345struct ieee80211_tx_status {
1346 struct ieee80211_sta *sta;
1347 struct ieee80211_tx_info *info;
1348 struct sk_buff *skb;
1349 struct ieee80211_rate_status *rates;
1350 ktime_t ack_hwtstamp;
1351 u8 n_rates;
1352
1353 struct list_head *free_list;
1354};
1355
1356/**
1357 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
1358 *
1359 * This structure is used to point to different blocks of IEs in HW scan
1360 * and scheduled scan. These blocks contain the IEs passed by userspace
1361 * and the ones generated by mac80211.
1362 *
1363 * @ies: pointers to band specific IEs.
1364 * @len: lengths of band_specific IEs.
1365 * @common_ies: IEs for all bands (especially vendor specific ones)
1366 * @common_ie_len: length of the common_ies
1367 */
1368struct ieee80211_scan_ies {
1369 const u8 *ies[NUM_NL80211_BANDS];
1370 size_t len[NUM_NL80211_BANDS];
1371 const u8 *common_ies;
1372 size_t common_ie_len;
1373};
1374
1375
1376static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
1377{
1378 return (struct ieee80211_tx_info *)skb->cb;
1379}
1380
1381static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
1382{
1383 return (struct ieee80211_rx_status *)skb->cb;
1384}
1385
1386/**
1387 * ieee80211_tx_info_clear_status - clear TX status
1388 *
1389 * @info: The &struct ieee80211_tx_info to be cleared.
1390 *
1391 * When the driver passes an skb back to mac80211, it must report
1392 * a number of things in TX status. This function clears everything
1393 * in the TX status but the rate control information (it does clear
1394 * the count since you need to fill that in anyway).
1395 *
1396 * NOTE: While the rates array is kept intact, this will wipe all of the
1397 * driver_data fields in info, so it's up to the driver to restore
1398 * any fields it needs after calling this helper.
1399 */
1400static inline void
1401ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
1402{
1403 int i;
1404
1405 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1406 offsetof(struct ieee80211_tx_info, control.rates));
1407 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1408 offsetof(struct ieee80211_tx_info, driver_rates));
1409 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
1410 /* clear the rate counts */
1411 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
1412 info->status.rates[i].count = 0;
1413 memset_after(&info->status, 0, rates);
1414}
1415
1416
1417/**
1418 * enum mac80211_rx_flags - receive flags
1419 *
1420 * These flags are used with the @flag member of &struct ieee80211_rx_status.
1421 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
1422 * Use together with %RX_FLAG_MMIC_STRIPPED.
1423 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
1424 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
1425 * verification has been done by the hardware.
1426 * @RX_FLAG_IV_STRIPPED: The IV and ICV are stripped from this frame.
1427 * If this flag is set, the stack cannot do any replay detection
1428 * hence the driver or hardware will have to do that.
1429 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
1430 * flag indicates that the PN was verified for replay protection.
1431 * Note that this flag is also currently only supported when a frame
1432 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
1433 * @RX_FLAG_DUP_VALIDATED: The driver should set this flag if it did
1434 * de-duplication by itself.
1435 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
1436 * the frame.
1437 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
1438 * the frame.
1439 * @RX_FLAG_MACTIME: The timestamp passed in the RX status (@mactime
1440 * field) is valid if this field is non-zero, and the position
1441 * where the timestamp was sampled depends on the value.
1442 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
1443 * field) is valid and contains the time the first symbol of the MPDU
1444 * was received. This is useful in monitor mode and for proper IBSS
1445 * merging.
1446 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
1447 * field) is valid and contains the time the last symbol of the MPDU
1448 * (including FCS) was received.
1449 * @RX_FLAG_MACTIME_PLCP_START: The timestamp passed in the RX status (@mactime
1450 * field) is valid and contains the time the SYNC preamble was received.
1451 * @RX_FLAG_MACTIME_IS_RTAP_TS64: The timestamp passed in the RX status @mactime
1452 * is only for use in the radiotap timestamp header, not otherwise a valid
1453 * @mactime value. Note this is a separate flag so that we continue to see
1454 * %RX_FLAG_MACTIME as unset. Also note that in this case the timestamp is
1455 * reported to be 64 bits wide, not just 32.
1456 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
1457 * Valid only for data frames (mainly A-MPDU)
1458 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1459 * number (@ampdu_reference) must be populated and be a distinct number for
1460 * each A-MPDU
1461 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1462 * subframes of a single A-MPDU
1463 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1464 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1465 * on this subframe
1466 * @RX_FLAG_MIC_STRIPPED: The mic was stripped of this packet. Decryption was
1467 * done by the hardware
1468 * @RX_FLAG_ONLY_MONITOR: Report frame only to monitor interfaces without
1469 * processing it in any regular way.
1470 * This is useful if drivers offload some frames but still want to report
1471 * them for sniffing purposes.
1472 * @RX_FLAG_SKIP_MONITOR: Process and report frame to all interfaces except
1473 * monitor interfaces.
1474 * This is useful if drivers offload some frames but still want to report
1475 * them for sniffing purposes.
1476 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1477 * subframes instead of a one huge frame for performance reasons.
1478 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1479 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1480 * the 3rd (last) one must not have this flag set. The flag is used to
1481 * deal with retransmission/duplication recovery properly since A-MSDU
1482 * subframes share the same sequence number. Reported subframes can be
1483 * either regular MSDU or singly A-MSDUs. Subframes must not be
1484 * interleaved with other frames.
1485 * @RX_FLAG_RADIOTAP_TLV_AT_END: This frame contains radiotap TLVs in the
1486 * skb->data (before the 802.11 header).
1487 * If used, the SKB's mac_header pointer must be set to point
1488 * to the 802.11 header after the TLVs, and any padding added after TLV
1489 * data to align to 4 must be cleared by the driver putting the TLVs
1490 * in the skb.
1491 * @RX_FLAG_ALLOW_SAME_PN: Allow the same PN as same packet before.
1492 * This is used for AMSDU subframes which can have the same PN as
1493 * the first subframe.
1494 * @RX_FLAG_ICV_STRIPPED: The ICV is stripped from this frame. CRC checking must
1495 * be done in the hardware.
1496 * @RX_FLAG_AMPDU_EOF_BIT: Value of the EOF bit in the A-MPDU delimiter for this
1497 * frame
1498 * @RX_FLAG_AMPDU_EOF_BIT_KNOWN: The EOF value is known
1499 * @RX_FLAG_RADIOTAP_HE: HE radiotap data is present
1500 * (&struct ieee80211_radiotap_he, mac80211 will fill in
1501 *
1502 * - DATA3_DATA_MCS
1503 * - DATA3_DATA_DCM
1504 * - DATA3_CODING
1505 * - DATA5_GI
1506 * - DATA5_DATA_BW_RU_ALLOC
1507 * - DATA6_NSTS
1508 * - DATA3_STBC
1509 *
1510 * from the RX info data, so leave those zeroed when building this data)
1511 * @RX_FLAG_RADIOTAP_HE_MU: HE MU radiotap data is present
1512 * (&struct ieee80211_radiotap_he_mu)
1513 * @RX_FLAG_RADIOTAP_LSIG: L-SIG radiotap data is present
1514 * @RX_FLAG_NO_PSDU: use the frame only for radiotap reporting, with
1515 * the "0-length PSDU" field included there. The value for it is
1516 * in &struct ieee80211_rx_status. Note that if this value isn't
1517 * known the frame shouldn't be reported.
1518 * @RX_FLAG_8023: the frame has an 802.3 header (decap offload performed by
1519 * hardware or driver)
1520 */
1521enum mac80211_rx_flags {
1522 RX_FLAG_MMIC_ERROR = BIT(0),
1523 RX_FLAG_DECRYPTED = BIT(1),
1524 RX_FLAG_ONLY_MONITOR = BIT(2),
1525 RX_FLAG_MMIC_STRIPPED = BIT(3),
1526 RX_FLAG_IV_STRIPPED = BIT(4),
1527 RX_FLAG_FAILED_FCS_CRC = BIT(5),
1528 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
1529 RX_FLAG_MACTIME_IS_RTAP_TS64 = BIT(7),
1530 RX_FLAG_NO_SIGNAL_VAL = BIT(8),
1531 RX_FLAG_AMPDU_DETAILS = BIT(9),
1532 RX_FLAG_PN_VALIDATED = BIT(10),
1533 RX_FLAG_DUP_VALIDATED = BIT(11),
1534 RX_FLAG_AMPDU_LAST_KNOWN = BIT(12),
1535 RX_FLAG_AMPDU_IS_LAST = BIT(13),
1536 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(14),
1537 /* one free bit at 15 */
1538 RX_FLAG_MACTIME = BIT(16) | BIT(17),
1539 RX_FLAG_MACTIME_PLCP_START = 1 << 16,
1540 RX_FLAG_MACTIME_START = 2 << 16,
1541 RX_FLAG_MACTIME_END = 3 << 16,
1542 RX_FLAG_SKIP_MONITOR = BIT(18),
1543 RX_FLAG_AMSDU_MORE = BIT(19),
1544 RX_FLAG_RADIOTAP_TLV_AT_END = BIT(20),
1545 RX_FLAG_MIC_STRIPPED = BIT(21),
1546 RX_FLAG_ALLOW_SAME_PN = BIT(22),
1547 RX_FLAG_ICV_STRIPPED = BIT(23),
1548 RX_FLAG_AMPDU_EOF_BIT = BIT(24),
1549 RX_FLAG_AMPDU_EOF_BIT_KNOWN = BIT(25),
1550 RX_FLAG_RADIOTAP_HE = BIT(26),
1551 RX_FLAG_RADIOTAP_HE_MU = BIT(27),
1552 RX_FLAG_RADIOTAP_LSIG = BIT(28),
1553 RX_FLAG_NO_PSDU = BIT(29),
1554 RX_FLAG_8023 = BIT(30),
1555};
1556
1557/**
1558 * enum mac80211_rx_encoding_flags - MCS & bandwidth flags
1559 *
1560 * @RX_ENC_FLAG_SHORTPRE: Short preamble was used for this frame
1561 * @RX_ENC_FLAG_SHORT_GI: Short guard interval was used
1562 * @RX_ENC_FLAG_HT_GF: This frame was received in a HT-greenfield transmission,
1563 * if the driver fills this value it should add
1564 * %IEEE80211_RADIOTAP_MCS_HAVE_FMT
1565 * to @hw.radiotap_mcs_details to advertise that fact.
1566 * @RX_ENC_FLAG_LDPC: LDPC was used
1567 * @RX_ENC_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1568 * @RX_ENC_FLAG_BF: packet was beamformed
1569 */
1570enum mac80211_rx_encoding_flags {
1571 RX_ENC_FLAG_SHORTPRE = BIT(0),
1572 RX_ENC_FLAG_SHORT_GI = BIT(2),
1573 RX_ENC_FLAG_HT_GF = BIT(3),
1574 RX_ENC_FLAG_STBC_MASK = BIT(4) | BIT(5),
1575 RX_ENC_FLAG_LDPC = BIT(6),
1576 RX_ENC_FLAG_BF = BIT(7),
1577};
1578
1579#define RX_ENC_FLAG_STBC_SHIFT 4
1580
1581enum mac80211_rx_encoding {
1582 RX_ENC_LEGACY = 0,
1583 RX_ENC_HT,
1584 RX_ENC_VHT,
1585 RX_ENC_HE,
1586 RX_ENC_EHT,
1587};
1588
1589/**
1590 * struct ieee80211_rx_status - receive status
1591 *
1592 * The low-level driver should provide this information (the subset
1593 * supported by hardware) to the 802.11 code with each received
1594 * frame, in the skb's control buffer (cb).
1595 *
1596 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1597 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1598 * @boottime_ns: CLOCK_BOOTTIME timestamp the frame was received at, this is
1599 * needed only for beacons and probe responses that update the scan cache.
1600 * @ack_tx_hwtstamp: Hardware timestamp for the ack TX in nanoseconds. Only
1601 * needed for Timing measurement and Fine timing measurement action frames.
1602 * Only reported by devices that have timestamping enabled.
1603 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1604 * it but can store it and pass it back to the driver for synchronisation
1605 * @band: the active band when this frame was received
1606 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1607 * This field must be set for management frames, but isn't strictly needed
1608 * for data (other) frames - for those it only affects radiotap reporting.
1609 * @freq_offset: @freq has a positive offset of 500Khz.
1610 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1611 * unspecified depending on the hardware capabilities flags
1612 * @IEEE80211_HW_SIGNAL_*
1613 * @chains: bitmask of receive chains for which separate signal strength
1614 * values were filled.
1615 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1616 * support dB or unspecified units)
1617 * @antenna: antenna used
1618 * @rate_idx: index of data rate into band's supported rates or MCS index if
1619 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1620 * @nss: number of streams (VHT, HE and EHT only)
1621 * @flag: %RX_FLAG_\*
1622 * @encoding: &enum mac80211_rx_encoding
1623 * @bw: &enum rate_info_bw
1624 * @enc_flags: uses bits from &enum mac80211_rx_encoding_flags
1625 * @he_ru: HE RU, from &enum nl80211_he_ru_alloc
1626 * @he_gi: HE GI, from &enum nl80211_he_gi
1627 * @he_dcm: HE DCM value
1628 * @eht: EHT specific rate information
1629 * @eht.ru: EHT RU, from &enum nl80211_eht_ru_alloc
1630 * @eht.gi: EHT GI, from &enum nl80211_eht_gi
1631 * @rx_flags: internal RX flags for mac80211
1632 * @ampdu_reference: A-MPDU reference number, must be a different value for
1633 * each A-MPDU but the same for each subframe within one A-MPDU
1634 * @zero_length_psdu_type: radiotap type of the 0-length PSDU
1635 * @link_valid: if the link which is identified by @link_id is valid. This flag
1636 * is set only when connection is MLO.
1637 * @link_id: id of the link used to receive the packet. This is used along with
1638 * @link_valid.
1639 */
1640struct ieee80211_rx_status {
1641 u64 mactime;
1642 union {
1643 u64 boottime_ns;
1644 ktime_t ack_tx_hwtstamp;
1645 };
1646 u32 device_timestamp;
1647 u32 ampdu_reference;
1648 u32 flag;
1649 u16 freq: 13, freq_offset: 1;
1650 u8 enc_flags;
1651 u8 encoding:3, bw:4;
1652 union {
1653 struct {
1654 u8 he_ru:3;
1655 u8 he_gi:2;
1656 u8 he_dcm:1;
1657 };
1658 struct {
1659 u8 ru:4;
1660 u8 gi:2;
1661 } eht;
1662 };
1663 u8 rate_idx;
1664 u8 nss;
1665 u8 rx_flags;
1666 u8 band;
1667 u8 antenna;
1668 s8 signal;
1669 u8 chains;
1670 s8 chain_signal[IEEE80211_MAX_CHAINS];
1671 u8 zero_length_psdu_type;
1672 u8 link_valid:1, link_id:4;
1673};
1674
1675static inline u32
1676ieee80211_rx_status_to_khz(struct ieee80211_rx_status *rx_status)
1677{
1678 return MHZ_TO_KHZ(rx_status->freq) +
1679 (rx_status->freq_offset ? 500 : 0);
1680}
1681
1682/**
1683 * enum ieee80211_conf_flags - configuration flags
1684 *
1685 * Flags to define PHY configuration options
1686 *
1687 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1688 * to determine for example whether to calculate timestamps for packets
1689 * or not, do not use instead of filter flags!
1690 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1691 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1692 * meaning that the hardware still wakes up for beacons, is able to
1693 * transmit frames and receive the possible acknowledgment frames.
1694 * Not to be confused with hardware specific wakeup/sleep states,
1695 * driver is responsible for that. See the section "Powersave support"
1696 * for more.
1697 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1698 * the driver should be prepared to handle configuration requests but
1699 * may turn the device off as much as possible. Typically, this flag will
1700 * be set when an interface is set UP but not associated or scanning, but
1701 * it can also be unset in that case when monitor interfaces are active.
1702 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1703 * operating channel.
1704 */
1705enum ieee80211_conf_flags {
1706 IEEE80211_CONF_MONITOR = (1<<0),
1707 IEEE80211_CONF_PS = (1<<1),
1708 IEEE80211_CONF_IDLE = (1<<2),
1709 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1710};
1711
1712
1713/**
1714 * enum ieee80211_conf_changed - denotes which configuration changed
1715 *
1716 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1717 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1718 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1719 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1720 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1721 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1722 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1723 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1724 * Note that this is only valid if channel contexts are not used,
1725 * otherwise each channel context has the number of chains listed.
1726 */
1727enum ieee80211_conf_changed {
1728 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1729 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1730 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1731 IEEE80211_CONF_CHANGE_PS = BIT(4),
1732 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1733 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1734 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1735 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1736};
1737
1738/**
1739 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1740 *
1741 * @IEEE80211_SMPS_AUTOMATIC: automatic
1742 * @IEEE80211_SMPS_OFF: off
1743 * @IEEE80211_SMPS_STATIC: static
1744 * @IEEE80211_SMPS_DYNAMIC: dynamic
1745 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1746 */
1747enum ieee80211_smps_mode {
1748 IEEE80211_SMPS_AUTOMATIC,
1749 IEEE80211_SMPS_OFF,
1750 IEEE80211_SMPS_STATIC,
1751 IEEE80211_SMPS_DYNAMIC,
1752
1753 /* keep last */
1754 IEEE80211_SMPS_NUM_MODES,
1755};
1756
1757/**
1758 * struct ieee80211_conf - configuration of the device
1759 *
1760 * This struct indicates how the driver shall configure the hardware.
1761 *
1762 * @flags: configuration flags defined above
1763 *
1764 * @listen_interval: listen interval in units of beacon interval
1765 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1766 * in power saving. Power saving will not be enabled until a beacon
1767 * has been received and the DTIM period is known.
1768 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1769 * powersave documentation below. This variable is valid only when
1770 * the CONF_PS flag is set.
1771 *
1772 * @power_level: requested transmit power (in dBm), backward compatibility
1773 * value only that is set to the minimum of all interfaces
1774 *
1775 * @chandef: the channel definition to tune to
1776 * @radar_enabled: whether radar detection is enabled
1777 *
1778 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1779 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1780 * but actually means the number of transmissions not the number of retries
1781 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1782 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1783 * number of transmissions not the number of retries
1784 *
1785 * @smps_mode: spatial multiplexing powersave mode; note that
1786 * %IEEE80211_SMPS_STATIC is used when the device is not
1787 * configured for an HT channel.
1788 * Note that this is only valid if channel contexts are not used,
1789 * otherwise each channel context has the number of chains listed.
1790 */
1791struct ieee80211_conf {
1792 u32 flags;
1793 int power_level, dynamic_ps_timeout;
1794
1795 u16 listen_interval;
1796 u8 ps_dtim_period;
1797
1798 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1799
1800 struct cfg80211_chan_def chandef;
1801 bool radar_enabled;
1802 enum ieee80211_smps_mode smps_mode;
1803};
1804
1805/**
1806 * struct ieee80211_channel_switch - holds the channel switch data
1807 *
1808 * The information provided in this structure is required for channel switch
1809 * operation.
1810 *
1811 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1812 * Function (TSF) timer when the frame containing the channel switch
1813 * announcement was received. This is simply the rx.mactime parameter
1814 * the driver passed into mac80211.
1815 * @device_timestamp: arbitrary timestamp for the device, this is the
1816 * rx.device_timestamp parameter the driver passed to mac80211.
1817 * @block_tx: Indicates whether transmission must be blocked before the
1818 * scheduled channel switch, as indicated by the AP.
1819 * @chandef: the new channel to switch to
1820 * @count: the number of TBTT's until the channel switch event
1821 * @delay: maximum delay between the time the AP transmitted the last beacon in
1822 * current channel and the expected time of the first beacon in the new
1823 * channel, expressed in TU.
1824 * @link_id: the link ID of the link doing the channel switch, 0 for non-MLO
1825 */
1826struct ieee80211_channel_switch {
1827 u64 timestamp;
1828 u32 device_timestamp;
1829 bool block_tx;
1830 struct cfg80211_chan_def chandef;
1831 u8 count;
1832 u8 link_id;
1833 u32 delay;
1834};
1835
1836/**
1837 * enum ieee80211_vif_flags - virtual interface flags
1838 *
1839 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1840 * on this virtual interface to avoid unnecessary CPU wakeups
1841 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1842 * monitoring on this virtual interface -- i.e. it can monitor
1843 * connection quality related parameters, such as the RSSI level and
1844 * provide notifications if configured trigger levels are reached.
1845 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1846 * interface. This flag should be set during interface addition,
1847 * but may be set/cleared as late as authentication to an AP. It is
1848 * only valid for managed/station mode interfaces.
1849 * @IEEE80211_VIF_GET_NOA_UPDATE: request to handle NOA attributes
1850 * and send P2P_PS notification to the driver if NOA changed, even
1851 * this is not pure P2P vif.
1852 * @IEEE80211_VIF_EML_ACTIVE: The driver indicates that EML operation is
1853 * enabled for the interface.
1854 * @IEEE80211_VIF_IGNORE_OFDMA_WIDER_BW: Ignore wider bandwidth OFDMA
1855 * operation on this interface and request a channel context without
1856 * the AP definition. Use this e.g. because the device is able to
1857 * handle OFDMA (downlink and trigger for uplink) on a per-AP basis.
1858 */
1859enum ieee80211_vif_flags {
1860 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1861 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1862 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2),
1863 IEEE80211_VIF_GET_NOA_UPDATE = BIT(3),
1864 IEEE80211_VIF_EML_ACTIVE = BIT(4),
1865 IEEE80211_VIF_IGNORE_OFDMA_WIDER_BW = BIT(5),
1866};
1867
1868
1869/**
1870 * enum ieee80211_offload_flags - virtual interface offload flags
1871 *
1872 * @IEEE80211_OFFLOAD_ENCAP_ENABLED: tx encapsulation offload is enabled
1873 * The driver supports sending frames passed as 802.3 frames by mac80211.
1874 * It must also support sending 802.11 packets for the same interface.
1875 * @IEEE80211_OFFLOAD_ENCAP_4ADDR: support 4-address mode encapsulation offload
1876 * @IEEE80211_OFFLOAD_DECAP_ENABLED: rx encapsulation offload is enabled
1877 * The driver supports passing received 802.11 frames as 802.3 frames to
1878 * mac80211.
1879 */
1880
1881enum ieee80211_offload_flags {
1882 IEEE80211_OFFLOAD_ENCAP_ENABLED = BIT(0),
1883 IEEE80211_OFFLOAD_ENCAP_4ADDR = BIT(1),
1884 IEEE80211_OFFLOAD_DECAP_ENABLED = BIT(2),
1885};
1886
1887/**
1888 * struct ieee80211_vif_cfg - interface configuration
1889 * @assoc: association status
1890 * @ibss_joined: indicates whether this station is part of an IBSS or not
1891 * @ibss_creator: indicates if a new IBSS network is being created
1892 * @ps: power-save mode (STA only). This flag is NOT affected by
1893 * offchannel/dynamic_ps operations.
1894 * @aid: association ID number, valid only when @assoc is true
1895 * @eml_cap: EML capabilities as described in P802.11be_D4.1 Figure 9-1001j.
1896 * @eml_med_sync_delay: Medium Synchronization delay as described in
1897 * P802.11be_D4.1 Figure 9-1001i.
1898 * @mld_capa_op: MLD Capabilities and Operations per P802.11be_D4.1
1899 * Figure 9-1001k
1900 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
1901 * may filter ARP queries targeted for other addresses than listed here.
1902 * The driver must allow ARP queries targeted for all address listed here
1903 * to pass through. An empty list implies no ARP queries need to pass.
1904 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
1905 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
1906 * array size), it's up to the driver what to do in that case.
1907 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
1908 * @ssid_len: Length of SSID given in @ssid.
1909 * @s1g: BSS is S1G BSS (affects Association Request format).
1910 * @idle: This interface is idle. There's also a global idle flag in the
1911 * hardware config which may be more appropriate depending on what
1912 * your driver/device needs to do.
1913 * @ap_addr: AP MLD address, or BSSID for non-MLO connections
1914 * (station mode only)
1915 */
1916struct ieee80211_vif_cfg {
1917 /* association related data */
1918 bool assoc, ibss_joined;
1919 bool ibss_creator;
1920 bool ps;
1921 u16 aid;
1922 u16 eml_cap;
1923 u16 eml_med_sync_delay;
1924 u16 mld_capa_op;
1925
1926 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
1927 int arp_addr_cnt;
1928 u8 ssid[IEEE80211_MAX_SSID_LEN];
1929 size_t ssid_len;
1930 bool s1g;
1931 bool idle;
1932 u8 ap_addr[ETH_ALEN] __aligned(2);
1933};
1934
1935#define IEEE80211_TTLM_NUM_TIDS 8
1936
1937/**
1938 * struct ieee80211_neg_ttlm - negotiated TID to link map info
1939 *
1940 * @downlink: bitmap of active links per TID for downlink, or 0 if mapping for
1941 * this TID is not included.
1942 * @uplink: bitmap of active links per TID for uplink, or 0 if mapping for this
1943 * TID is not included.
1944 * @valid: info is valid or not.
1945 */
1946struct ieee80211_neg_ttlm {
1947 u16 downlink[IEEE80211_TTLM_NUM_TIDS];
1948 u16 uplink[IEEE80211_TTLM_NUM_TIDS];
1949 bool valid;
1950};
1951
1952/**
1953 * enum ieee80211_neg_ttlm_res - return value for negotiated TTLM handling
1954 * @NEG_TTLM_RES_ACCEPT: accept the request
1955 * @NEG_TTLM_RES_REJECT: reject the request
1956 * @NEG_TTLM_RES_SUGGEST_PREFERRED: reject and suggest a new mapping
1957 */
1958enum ieee80211_neg_ttlm_res {
1959 NEG_TTLM_RES_ACCEPT,
1960 NEG_TTLM_RES_REJECT,
1961 NEG_TTLM_RES_SUGGEST_PREFERRED
1962};
1963
1964/**
1965 * struct ieee80211_vif - per-interface data
1966 *
1967 * Data in this structure is continually present for driver
1968 * use during the life of a virtual interface.
1969 *
1970 * @type: type of this virtual interface
1971 * @cfg: vif configuration, see &struct ieee80211_vif_cfg
1972 * @bss_conf: BSS configuration for this interface, either our own
1973 * or the BSS we're associated to
1974 * @link_conf: in case of MLD, the per-link BSS configuration,
1975 * indexed by link ID
1976 * @valid_links: bitmap of valid links, or 0 for non-MLO.
1977 * @active_links: The bitmap of active links, or 0 for non-MLO.
1978 * The driver shouldn't change this directly, but use the
1979 * API calls meant for that purpose.
1980 * @dormant_links: subset of the valid links that are disabled/suspended
1981 * due to advertised or negotiated TTLM respectively.
1982 * 0 for non-MLO.
1983 * @suspended_links: subset of dormant_links representing links that are
1984 * suspended due to negotiated TTLM, and could be activated in the
1985 * future by tearing down the TTLM negotiation.
1986 * 0 for non-MLO.
1987 * @neg_ttlm: negotiated TID to link mapping info.
1988 * see &struct ieee80211_neg_ttlm.
1989 * @addr: address of this interface
1990 * @addr_valid: indicates if the address is actively used. Set to false for
1991 * passive monitor interfaces, true in all other cases.
1992 * @p2p: indicates whether this AP or STA interface is a p2p
1993 * interface, i.e. a GO or p2p-sta respectively
1994 * @netdev_features: tx netdev features supported by the hardware for this
1995 * vif. mac80211 initializes this to hw->netdev_features, and the driver
1996 * can mask out specific tx features. mac80211 will handle software fixup
1997 * for masked offloads (GSO, CSUM)
1998 * @driver_flags: flags/capabilities the driver has for this interface,
1999 * these need to be set (or cleared) when the interface is added
2000 * or, if supported by the driver, the interface type is changed
2001 * at runtime, mac80211 will never touch this field
2002 * @offload_flags: hardware offload capabilities/flags for this interface.
2003 * These are initialized by mac80211 before calling .add_interface,
2004 * .change_interface or .update_vif_offload and updated by the driver
2005 * within these ops, based on supported features or runtime change
2006 * restrictions.
2007 * @hw_queue: hardware queue for each AC
2008 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
2009 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
2010 * interface debug files. Note that it will be NULL for the virtual
2011 * monitor interface (if that is requested.)
2012 * @probe_req_reg: probe requests should be reported to mac80211 for this
2013 * interface.
2014 * @rx_mcast_action_reg: multicast Action frames should be reported to mac80211
2015 * for this interface.
2016 * @drv_priv: data area for driver use, will always be aligned to
2017 * sizeof(void \*).
2018 * @txq: the multicast data TX queue
2019 * @offload_flags: 802.3 -> 802.11 enapsulation offload flags, see
2020 * &enum ieee80211_offload_flags.
2021 * @mbssid_tx_vif: Pointer to the transmitting interface if MBSSID is enabled.
2022 */
2023struct ieee80211_vif {
2024 enum nl80211_iftype type;
2025 struct ieee80211_vif_cfg cfg;
2026 struct ieee80211_bss_conf bss_conf;
2027 struct ieee80211_bss_conf __rcu *link_conf[IEEE80211_MLD_MAX_NUM_LINKS];
2028 u16 valid_links, active_links, dormant_links, suspended_links;
2029 struct ieee80211_neg_ttlm neg_ttlm;
2030 u8 addr[ETH_ALEN] __aligned(2);
2031 bool addr_valid;
2032 bool p2p;
2033
2034 u8 cab_queue;
2035 u8 hw_queue[IEEE80211_NUM_ACS];
2036
2037 struct ieee80211_txq *txq;
2038
2039 netdev_features_t netdev_features;
2040 u32 driver_flags;
2041 u32 offload_flags;
2042
2043#ifdef CONFIG_MAC80211_DEBUGFS
2044 struct dentry *debugfs_dir;
2045#endif
2046
2047 bool probe_req_reg;
2048 bool rx_mcast_action_reg;
2049
2050 struct ieee80211_vif *mbssid_tx_vif;
2051
2052 /* must be last */
2053 u8 drv_priv[] __aligned(sizeof(void *));
2054};
2055
2056/**
2057 * ieee80211_vif_usable_links - Return the usable links for the vif
2058 * @vif: the vif for which the usable links are requested
2059 * Return: the usable link bitmap
2060 */
2061static inline u16 ieee80211_vif_usable_links(const struct ieee80211_vif *vif)
2062{
2063 return vif->valid_links & ~vif->dormant_links;
2064}
2065
2066/**
2067 * ieee80211_vif_is_mld - Returns true iff the vif is an MLD one
2068 * @vif: the vif
2069 * Return: %true if the vif is an MLD, %false otherwise.
2070 */
2071static inline bool ieee80211_vif_is_mld(const struct ieee80211_vif *vif)
2072{
2073 /* valid_links != 0 indicates this vif is an MLD */
2074 return vif->valid_links != 0;
2075}
2076
2077/**
2078 * ieee80211_vif_link_active - check if a given link is active
2079 * @vif: the vif
2080 * @link_id: the link ID to check
2081 * Return: %true if the vif is an MLD and the link is active, or if
2082 * the vif is not an MLD and the link ID is 0; %false otherwise.
2083 */
2084static inline bool ieee80211_vif_link_active(const struct ieee80211_vif *vif,
2085 unsigned int link_id)
2086{
2087 if (!ieee80211_vif_is_mld(vif))
2088 return link_id == 0;
2089 return vif->active_links & BIT(link_id);
2090}
2091
2092#define for_each_vif_active_link(vif, link, link_id) \
2093 for (link_id = 0; link_id < ARRAY_SIZE((vif)->link_conf); link_id++) \
2094 if ((!(vif)->active_links || \
2095 (vif)->active_links & BIT(link_id)) && \
2096 (link = link_conf_dereference_check(vif, link_id)))
2097
2098static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
2099{
2100#ifdef CONFIG_MAC80211_MESH
2101 return vif->type == NL80211_IFTYPE_MESH_POINT;
2102#endif
2103 return false;
2104}
2105
2106/**
2107 * wdev_to_ieee80211_vif - return a vif struct from a wdev
2108 * @wdev: the wdev to get the vif for
2109 *
2110 * This can be used by mac80211 drivers with direct cfg80211 APIs
2111 * (like the vendor commands) that get a wdev.
2112 *
2113 * Return: pointer to the wdev, or %NULL if the given wdev isn't
2114 * associated with a vif that the driver knows about (e.g. monitor
2115 * or AP_VLAN interfaces.)
2116 */
2117struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
2118
2119/**
2120 * ieee80211_vif_to_wdev - return a wdev struct from a vif
2121 * @vif: the vif to get the wdev for
2122 *
2123 * This can be used by mac80211 drivers with direct cfg80211 APIs
2124 * (like the vendor commands) that needs to get the wdev for a vif.
2125 * This can also be useful to get the netdev associated to a vif.
2126 *
2127 * Return: pointer to the wdev
2128 */
2129struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif);
2130
2131static inline bool lockdep_vif_wiphy_mutex_held(struct ieee80211_vif *vif)
2132{
2133 return lockdep_is_held(&ieee80211_vif_to_wdev(vif)->wiphy->mtx);
2134}
2135
2136#define link_conf_dereference_protected(vif, link_id) \
2137 rcu_dereference_protected((vif)->link_conf[link_id], \
2138 lockdep_vif_wiphy_mutex_held(vif))
2139
2140#define link_conf_dereference_check(vif, link_id) \
2141 rcu_dereference_check((vif)->link_conf[link_id], \
2142 lockdep_vif_wiphy_mutex_held(vif))
2143
2144/**
2145 * enum ieee80211_key_flags - key flags
2146 *
2147 * These flags are used for communication about keys between the driver
2148 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
2149 *
2150 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
2151 * driver to indicate that it requires IV generation for this
2152 * particular key. Setting this flag does not necessarily mean that SKBs
2153 * will have sufficient tailroom for ICV or MIC.
2154 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
2155 * the driver for a TKIP key if it requires Michael MIC
2156 * generation in software.
2157 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
2158 * that the key is pairwise rather then a shared key.
2159 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
2160 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
2161 * (MFP) to be done in software.
2162 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
2163 * if space should be prepared for the IV, but the IV
2164 * itself should not be generated. Do not set together with
2165 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
2166 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
2167 * MIC.
2168 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
2169 * management frames. The flag can help drivers that have a hardware
2170 * crypto implementation that doesn't deal with management frames
2171 * properly by allowing them to not upload the keys to hardware and
2172 * fall back to software crypto. Note that this flag deals only with
2173 * RX, if your crypto engine can't deal with TX you can also set the
2174 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
2175 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
2176 * driver for a CCMP/GCMP key to indicate that is requires IV generation
2177 * only for management frames (MFP).
2178 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
2179 * driver for a key to indicate that sufficient tailroom must always
2180 * be reserved for ICV or MIC, even when HW encryption is enabled.
2181 * @IEEE80211_KEY_FLAG_PUT_MIC_SPACE: This flag should be set by the driver for
2182 * a TKIP key if it only requires MIC space. Do not set together with
2183 * @IEEE80211_KEY_FLAG_GENERATE_MMIC on the same key.
2184 * @IEEE80211_KEY_FLAG_NO_AUTO_TX: Key needs explicit Tx activation.
2185 * @IEEE80211_KEY_FLAG_GENERATE_MMIE: This flag should be set by the driver
2186 * for a AES_CMAC or a AES_GMAC key to indicate that it requires sequence
2187 * number generation only
2188 * @IEEE80211_KEY_FLAG_SPP_AMSDU: SPP A-MSDUs can be used with this key
2189 * (set by mac80211 from the sta->spp_amsdu flag)
2190 */
2191enum ieee80211_key_flags {
2192 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
2193 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
2194 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
2195 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
2196 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
2197 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
2198 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
2199 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7),
2200 IEEE80211_KEY_FLAG_PUT_MIC_SPACE = BIT(8),
2201 IEEE80211_KEY_FLAG_NO_AUTO_TX = BIT(9),
2202 IEEE80211_KEY_FLAG_GENERATE_MMIE = BIT(10),
2203 IEEE80211_KEY_FLAG_SPP_AMSDU = BIT(11),
2204};
2205
2206/**
2207 * struct ieee80211_key_conf - key information
2208 *
2209 * This key information is given by mac80211 to the driver by
2210 * the set_key() callback in &struct ieee80211_ops.
2211 *
2212 * @hw_key_idx: To be set by the driver, this is the key index the driver
2213 * wants to be given when a frame is transmitted and needs to be
2214 * encrypted in hardware.
2215 * @cipher: The key's cipher suite selector.
2216 * @tx_pn: PN used for TX keys, may be used by the driver as well if it
2217 * needs to do software PN assignment by itself (e.g. due to TSO)
2218 * @flags: key flags, see &enum ieee80211_key_flags.
2219 * @keyidx: the key index (0-3)
2220 * @keylen: key material length
2221 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
2222 * data block:
2223 * - Temporal Encryption Key (128 bits)
2224 * - Temporal Authenticator Tx MIC Key (64 bits)
2225 * - Temporal Authenticator Rx MIC Key (64 bits)
2226 * @icv_len: The ICV length for this key type
2227 * @iv_len: The IV length for this key type
2228 * @link_id: the link ID for MLO, or -1 for non-MLO or pairwise keys
2229 */
2230struct ieee80211_key_conf {
2231 atomic64_t tx_pn;
2232 u32 cipher;
2233 u8 icv_len;
2234 u8 iv_len;
2235 u8 hw_key_idx;
2236 s8 keyidx;
2237 u16 flags;
2238 s8 link_id;
2239 u8 keylen;
2240 u8 key[];
2241};
2242
2243#define IEEE80211_MAX_PN_LEN 16
2244
2245#define TKIP_PN_TO_IV16(pn) ((u16)(pn & 0xffff))
2246#define TKIP_PN_TO_IV32(pn) ((u32)((pn >> 16) & 0xffffffff))
2247
2248/**
2249 * struct ieee80211_key_seq - key sequence counter
2250 *
2251 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
2252 * @ccmp: PN data, most significant byte first (big endian,
2253 * reverse order than in packet)
2254 * @aes_cmac: PN data, most significant byte first (big endian,
2255 * reverse order than in packet)
2256 * @aes_gmac: PN data, most significant byte first (big endian,
2257 * reverse order than in packet)
2258 * @gcmp: PN data, most significant byte first (big endian,
2259 * reverse order than in packet)
2260 * @hw: data for HW-only (e.g. cipher scheme) keys
2261 */
2262struct ieee80211_key_seq {
2263 union {
2264 struct {
2265 u32 iv32;
2266 u16 iv16;
2267 } tkip;
2268 struct {
2269 u8 pn[6];
2270 } ccmp;
2271 struct {
2272 u8 pn[6];
2273 } aes_cmac;
2274 struct {
2275 u8 pn[6];
2276 } aes_gmac;
2277 struct {
2278 u8 pn[6];
2279 } gcmp;
2280 struct {
2281 u8 seq[IEEE80211_MAX_PN_LEN];
2282 u8 seq_len;
2283 } hw;
2284 };
2285};
2286
2287/**
2288 * enum set_key_cmd - key command
2289 *
2290 * Used with the set_key() callback in &struct ieee80211_ops, this
2291 * indicates whether a key is being removed or added.
2292 *
2293 * @SET_KEY: a key is set
2294 * @DISABLE_KEY: a key must be disabled
2295 */
2296enum set_key_cmd {
2297 SET_KEY, DISABLE_KEY,
2298};
2299
2300/**
2301 * enum ieee80211_sta_state - station state
2302 *
2303 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
2304 * this is a special state for add/remove transitions
2305 * @IEEE80211_STA_NONE: station exists without special state
2306 * @IEEE80211_STA_AUTH: station is authenticated
2307 * @IEEE80211_STA_ASSOC: station is associated
2308 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
2309 */
2310enum ieee80211_sta_state {
2311 /* NOTE: These need to be ordered correctly! */
2312 IEEE80211_STA_NOTEXIST,
2313 IEEE80211_STA_NONE,
2314 IEEE80211_STA_AUTH,
2315 IEEE80211_STA_ASSOC,
2316 IEEE80211_STA_AUTHORIZED,
2317};
2318
2319/**
2320 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
2321 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
2322 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
2323 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
2324 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
2325 * (including 80+80 MHz)
2326 * @IEEE80211_STA_RX_BW_320: station can receive up to 320 MHz
2327 *
2328 * Implementation note: 20 must be zero to be initialized
2329 * correctly, the values must be sorted.
2330 */
2331enum ieee80211_sta_rx_bandwidth {
2332 IEEE80211_STA_RX_BW_20 = 0,
2333 IEEE80211_STA_RX_BW_40,
2334 IEEE80211_STA_RX_BW_80,
2335 IEEE80211_STA_RX_BW_160,
2336 IEEE80211_STA_RX_BW_320,
2337};
2338
2339/**
2340 * struct ieee80211_sta_rates - station rate selection table
2341 *
2342 * @rcu_head: RCU head used for freeing the table on update
2343 * @rate: transmit rates/flags to be used by default.
2344 * Overriding entries per-packet is possible by using cb tx control.
2345 */
2346struct ieee80211_sta_rates {
2347 struct rcu_head rcu_head;
2348 struct {
2349 s8 idx;
2350 u8 count;
2351 u8 count_cts;
2352 u8 count_rts;
2353 u16 flags;
2354 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
2355};
2356
2357/**
2358 * struct ieee80211_sta_txpwr - station txpower configuration
2359 *
2360 * Used to configure txpower for station.
2361 *
2362 * @power: indicates the tx power, in dBm, to be used when sending data frames
2363 * to the STA.
2364 * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
2365 * will be less than or equal to specified from userspace, whereas if TPC
2366 * %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
2367 * NL80211_TX_POWER_FIXED is not a valid configuration option for
2368 * per peer TPC.
2369 */
2370struct ieee80211_sta_txpwr {
2371 s16 power;
2372 enum nl80211_tx_power_setting type;
2373};
2374
2375/**
2376 * struct ieee80211_sta_aggregates - info that is aggregated from active links
2377 *
2378 * Used for any per-link data that needs to be aggregated and updated in the
2379 * main &struct ieee80211_sta when updated or the active links change.
2380 *
2381 * @max_amsdu_len: indicates the maximal length of an A-MSDU in bytes.
2382 * This field is always valid for packets with a VHT preamble.
2383 * For packets with a HT preamble, additional limits apply:
2384 *
2385 * * If the skb is transmitted as part of a BA agreement, the
2386 * A-MSDU maximal size is min(max_amsdu_len, 4065) bytes.
2387 * * If the skb is not part of a BA agreement, the A-MSDU maximal
2388 * size is min(max_amsdu_len, 7935) bytes.
2389 *
2390 * Both additional HT limits must be enforced by the low level
2391 * driver. This is defined by the spec (IEEE 802.11-2012 section
2392 * 8.3.2.2 NOTE 2).
2393 * @max_rc_amsdu_len: Maximum A-MSDU size in bytes recommended by rate control.
2394 * @max_tid_amsdu_len: Maximum A-MSDU size in bytes for this TID
2395 */
2396struct ieee80211_sta_aggregates {
2397 u16 max_amsdu_len;
2398
2399 u16 max_rc_amsdu_len;
2400 u16 max_tid_amsdu_len[IEEE80211_NUM_TIDS];
2401};
2402
2403/**
2404 * struct ieee80211_link_sta - station Link specific info
2405 * All link specific info for a STA link for a non MLD STA(single)
2406 * or a MLD STA(multiple entries) are stored here.
2407 *
2408 * @sta: reference to owning STA
2409 * @addr: MAC address of the Link STA. For non-MLO STA this is same as the addr
2410 * in ieee80211_sta. For MLO Link STA this addr can be same or different
2411 * from addr in ieee80211_sta (representing MLD STA addr)
2412 * @link_id: the link ID for this link STA (0 for deflink)
2413 * @smps_mode: current SMPS mode (off, static or dynamic)
2414 * @supp_rates: Bitmap of supported rates
2415 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
2416 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
2417 * @he_cap: HE capabilities of this STA
2418 * @he_6ghz_capa: on 6 GHz, holds the HE 6 GHz band capabilities
2419 * @eht_cap: EHT capabilities of this STA
2420 * @agg: per-link data for multi-link aggregation
2421 * @bandwidth: current bandwidth the station can receive with
2422 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
2423 * station can receive at the moment, changed by operating mode
2424 * notifications and capabilities. The value is only valid after
2425 * the station moves to associated state.
2426 * @txpwr: the station tx power configuration
2427 *
2428 */
2429struct ieee80211_link_sta {
2430 struct ieee80211_sta *sta;
2431
2432 u8 addr[ETH_ALEN];
2433 u8 link_id;
2434 enum ieee80211_smps_mode smps_mode;
2435
2436 u32 supp_rates[NUM_NL80211_BANDS];
2437 struct ieee80211_sta_ht_cap ht_cap;
2438 struct ieee80211_sta_vht_cap vht_cap;
2439 struct ieee80211_sta_he_cap he_cap;
2440 struct ieee80211_he_6ghz_capa he_6ghz_capa;
2441 struct ieee80211_sta_eht_cap eht_cap;
2442
2443 struct ieee80211_sta_aggregates agg;
2444
2445 u8 rx_nss;
2446 enum ieee80211_sta_rx_bandwidth bandwidth;
2447 struct ieee80211_sta_txpwr txpwr;
2448};
2449
2450/**
2451 * struct ieee80211_sta - station table entry
2452 *
2453 * A station table entry represents a station we are possibly
2454 * communicating with. Since stations are RCU-managed in
2455 * mac80211, any ieee80211_sta pointer you get access to must
2456 * either be protected by rcu_read_lock() explicitly or implicitly,
2457 * or you must take good care to not use such a pointer after a
2458 * call to your sta_remove callback that removed it.
2459 * This also represents the MLD STA in case of MLO association
2460 * and holds pointers to various link STA's
2461 *
2462 * @addr: MAC address
2463 * @aid: AID we assigned to the station if we're an AP
2464 * @max_rx_aggregation_subframes: maximal amount of frames in a single AMPDU
2465 * that this station is allowed to transmit to us.
2466 * Can be modified by driver.
2467 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
2468 * otherwise always false)
2469 * @drv_priv: data area for driver use, will always be aligned to
2470 * sizeof(void \*), size is determined in hw information.
2471 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
2472 * if wme is supported. The bits order is like in
2473 * IEEE80211_WMM_IE_STA_QOSINFO_AC_*.
2474 * @max_sp: max Service Period. Only valid if wme is supported.
2475 * @rates: rate control selection table
2476 * @tdls: indicates whether the STA is a TDLS peer
2477 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
2478 * valid if the STA is a TDLS peer in the first place.
2479 * @mfp: indicates whether the STA uses management frame protection or not.
2480 * @mlo: indicates whether the STA is MLO station.
2481 * @max_amsdu_subframes: indicates the maximal number of MSDUs in a single
2482 * A-MSDU. Taken from the Extended Capabilities element. 0 means
2483 * unlimited.
2484 * @cur: currently valid data as aggregated from the active links
2485 * For non MLO STA it will point to the deflink data. For MLO STA
2486 * ieee80211_sta_recalc_aggregates() must be called to update it.
2487 * @support_p2p_ps: indicates whether the STA supports P2P PS mechanism or not.
2488 * @txq: per-TID data TX queues; note that the last entry (%IEEE80211_NUM_TIDS)
2489 * is used for non-data frames
2490 * @deflink: This holds the default link STA information, for non MLO STA all link
2491 * specific STA information is accessed through @deflink or through
2492 * link[0] which points to address of @deflink. For MLO Link STA
2493 * the first added link STA will point to deflink.
2494 * @link: reference to Link Sta entries. For Non MLO STA, except 1st link,
2495 * i.e link[0] all links would be assigned to NULL by default and
2496 * would access link information via @deflink or link[0]. For MLO
2497 * STA, first link STA being added will point its link pointer to
2498 * @deflink address and remaining would be allocated and the address
2499 * would be assigned to link[link_id] where link_id is the id assigned
2500 * by the AP.
2501 * @valid_links: bitmap of valid links, or 0 for non-MLO
2502 * @spp_amsdu: indicates whether the STA uses SPP A-MSDU or not.
2503 */
2504struct ieee80211_sta {
2505 u8 addr[ETH_ALEN] __aligned(2);
2506 u16 aid;
2507 u16 max_rx_aggregation_subframes;
2508 bool wme;
2509 u8 uapsd_queues;
2510 u8 max_sp;
2511 struct ieee80211_sta_rates __rcu *rates;
2512 bool tdls;
2513 bool tdls_initiator;
2514 bool mfp;
2515 bool mlo;
2516 bool spp_amsdu;
2517 u8 max_amsdu_subframes;
2518
2519 struct ieee80211_sta_aggregates *cur;
2520
2521 bool support_p2p_ps;
2522
2523 struct ieee80211_txq *txq[IEEE80211_NUM_TIDS + 1];
2524
2525 u16 valid_links;
2526 struct ieee80211_link_sta deflink;
2527 struct ieee80211_link_sta __rcu *link[IEEE80211_MLD_MAX_NUM_LINKS];
2528
2529 /* must be last */
2530 u8 drv_priv[] __aligned(sizeof(void *));
2531};
2532
2533#ifdef CONFIG_LOCKDEP
2534bool lockdep_sta_mutex_held(struct ieee80211_sta *pubsta);
2535#else
2536static inline bool lockdep_sta_mutex_held(struct ieee80211_sta *pubsta)
2537{
2538 return true;
2539}
2540#endif
2541
2542#define link_sta_dereference_protected(sta, link_id) \
2543 rcu_dereference_protected((sta)->link[link_id], \
2544 lockdep_sta_mutex_held(sta))
2545
2546#define link_sta_dereference_check(sta, link_id) \
2547 rcu_dereference_check((sta)->link[link_id], \
2548 lockdep_sta_mutex_held(sta))
2549
2550#define for_each_sta_active_link(vif, sta, link_sta, link_id) \
2551 for (link_id = 0; link_id < ARRAY_SIZE((sta)->link); link_id++) \
2552 if ((!(vif)->active_links || \
2553 (vif)->active_links & BIT(link_id)) && \
2554 ((link_sta) = link_sta_dereference_check(sta, link_id)))
2555
2556/**
2557 * enum sta_notify_cmd - sta notify command
2558 *
2559 * Used with the sta_notify() callback in &struct ieee80211_ops, this
2560 * indicates if an associated station made a power state transition.
2561 *
2562 * @STA_NOTIFY_SLEEP: a station is now sleeping
2563 * @STA_NOTIFY_AWAKE: a sleeping station woke up
2564 */
2565enum sta_notify_cmd {
2566 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
2567};
2568
2569/**
2570 * struct ieee80211_tx_control - TX control data
2571 *
2572 * @sta: station table entry, this sta pointer may be NULL and
2573 * it is not allowed to copy the pointer, due to RCU.
2574 */
2575struct ieee80211_tx_control {
2576 struct ieee80211_sta *sta;
2577};
2578
2579/**
2580 * struct ieee80211_txq - Software intermediate tx queue
2581 *
2582 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
2583 * @sta: station table entry, %NULL for per-vif queue
2584 * @tid: the TID for this queue (unused for per-vif queue),
2585 * %IEEE80211_NUM_TIDS for non-data (if enabled)
2586 * @ac: the AC for this queue
2587 * @drv_priv: driver private area, sized by hw->txq_data_size
2588 *
2589 * The driver can obtain packets from this queue by calling
2590 * ieee80211_tx_dequeue().
2591 */
2592struct ieee80211_txq {
2593 struct ieee80211_vif *vif;
2594 struct ieee80211_sta *sta;
2595 u8 tid;
2596 u8 ac;
2597
2598 /* must be last */
2599 u8 drv_priv[] __aligned(sizeof(void *));
2600};
2601
2602/**
2603 * enum ieee80211_hw_flags - hardware flags
2604 *
2605 * These flags are used to indicate hardware capabilities to
2606 * the stack. Generally, flags here should have their meaning
2607 * done in a way that the simplest hardware doesn't need setting
2608 * any particular flags. There are some exceptions to this rule,
2609 * however, so you are advised to review these flags carefully.
2610 *
2611 * @IEEE80211_HW_HAS_RATE_CONTROL:
2612 * The hardware or firmware includes rate control, and cannot be
2613 * controlled by the stack. As such, no rate control algorithm
2614 * should be instantiated, and the TX rate reported to userspace
2615 * will be taken from the TX status instead of the rate control
2616 * algorithm.
2617 * Note that this requires that the driver implement a number of
2618 * callbacks so it has the correct information, it needs to have
2619 * the @set_rts_threshold callback and must look at the BSS config
2620 * @use_cts_prot for G/N protection, @use_short_slot for slot
2621 * timing in 2.4 GHz and @use_short_preamble for preambles for
2622 * CCK frames.
2623 *
2624 * @IEEE80211_HW_RX_INCLUDES_FCS:
2625 * Indicates that received frames passed to the stack include
2626 * the FCS at the end.
2627 *
2628 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
2629 * Some wireless LAN chipsets buffer broadcast/multicast frames
2630 * for power saving stations in the hardware/firmware and others
2631 * rely on the host system for such buffering. This option is used
2632 * to configure the IEEE 802.11 upper layer to buffer broadcast and
2633 * multicast frames when there are power saving stations so that
2634 * the driver can fetch them with ieee80211_get_buffered_bc().
2635 *
2636 * @IEEE80211_HW_SIGNAL_UNSPEC:
2637 * Hardware can provide signal values but we don't know its units. We
2638 * expect values between 0 and @max_signal.
2639 * If possible please provide dB or dBm instead.
2640 *
2641 * @IEEE80211_HW_SIGNAL_DBM:
2642 * Hardware gives signal values in dBm, decibel difference from
2643 * one milliwatt. This is the preferred method since it is standardized
2644 * between different devices. @max_signal does not need to be set.
2645 *
2646 * @IEEE80211_HW_SPECTRUM_MGMT:
2647 * Hardware supports spectrum management defined in 802.11h
2648 * Measurement, Channel Switch, Quieting, TPC
2649 *
2650 * @IEEE80211_HW_AMPDU_AGGREGATION:
2651 * Hardware supports 11n A-MPDU aggregation.
2652 *
2653 * @IEEE80211_HW_SUPPORTS_PS:
2654 * Hardware has power save support (i.e. can go to sleep).
2655 *
2656 * @IEEE80211_HW_PS_NULLFUNC_STACK:
2657 * Hardware requires nullfunc frame handling in stack, implies
2658 * stack support for dynamic PS.
2659 *
2660 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
2661 * Hardware has support for dynamic PS.
2662 *
2663 * @IEEE80211_HW_MFP_CAPABLE:
2664 * Hardware supports management frame protection (MFP, IEEE 802.11w).
2665 *
2666 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
2667 * Hardware can provide ack status reports of Tx frames to
2668 * the stack.
2669 *
2670 * @IEEE80211_HW_CONNECTION_MONITOR:
2671 * The hardware performs its own connection monitoring, including
2672 * periodic keep-alives to the AP and probing the AP on beacon loss.
2673 *
2674 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
2675 * This device needs to get data from beacon before association (i.e.
2676 * dtim_period).
2677 *
2678 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
2679 * per-station GTKs as used by IBSS RSN or during fast transition. If
2680 * the device doesn't support per-station GTKs, but can be asked not
2681 * to decrypt group addressed frames, then IBSS RSN support is still
2682 * possible but software crypto will be used. Advertise the wiphy flag
2683 * only in that case.
2684 *
2685 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
2686 * autonomously manages the PS status of connected stations. When
2687 * this flag is set mac80211 will not trigger PS mode for connected
2688 * stations based on the PM bit of incoming frames.
2689 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
2690 * the PS mode of connected stations.
2691 *
2692 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
2693 * setup strictly in HW. mac80211 should not attempt to do this in
2694 * software.
2695 *
2696 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
2697 * a virtual monitor interface when monitor interfaces are the only
2698 * active interfaces.
2699 *
2700 * @IEEE80211_HW_NO_VIRTUAL_MONITOR: The driver would like to be informed
2701 * of any monitor interface, as well as their configured channel.
2702 * This is useful for supporting multiple monitor interfaces on different
2703 * channels.
2704 *
2705 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
2706 * be created. It is expected user-space will create vifs as
2707 * desired (and thus have them named as desired).
2708 *
2709 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
2710 * crypto algorithms can be done in software - so don't automatically
2711 * try to fall back to it if hardware crypto fails, but do so only if
2712 * the driver returns 1. This also forces the driver to advertise its
2713 * supported cipher suites.
2714 *
2715 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
2716 * this currently requires only the ability to calculate the duration
2717 * for frames.
2718 *
2719 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
2720 * queue mapping in order to use different queues (not just one per AC)
2721 * for different virtual interfaces. See the doc section on HW queue
2722 * control for more details.
2723 *
2724 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
2725 * selection table provided by the rate control algorithm.
2726 *
2727 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
2728 * P2P Interface. This will be honoured even if more than one interface
2729 * is supported.
2730 *
2731 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
2732 * only, to allow getting TBTT of a DTIM beacon.
2733 *
2734 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
2735 * and can cope with CCK rates in an aggregation session (e.g. by not
2736 * using aggregation for such frames.)
2737 *
2738 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
2739 * for a single active channel while using channel contexts. When support
2740 * is not enabled the default action is to disconnect when getting the
2741 * CSA frame.
2742 *
2743 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
2744 * or tailroom of TX skbs without copying them first.
2745 *
2746 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
2747 * in one command, mac80211 doesn't have to run separate scans per band.
2748 *
2749 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
2750 * than then BSS bandwidth for a TDLS link on the base channel.
2751 *
2752 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs
2753 * within A-MPDU.
2754 *
2755 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status
2756 * for sent beacons.
2757 *
2758 * @IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR: Hardware (or driver) requires that each
2759 * station has a unique address, i.e. each station entry can be identified
2760 * by just its MAC address; this prevents, for example, the same station
2761 * from connecting to two virtual AP interfaces at the same time.
2762 *
2763 * @IEEE80211_HW_SUPPORTS_REORDERING_BUFFER: Hardware (or driver) manages the
2764 * reordering buffer internally, guaranteeing mac80211 receives frames in
2765 * order and does not need to manage its own reorder buffer or BA session
2766 * timeout.
2767 *
2768 * @IEEE80211_HW_USES_RSS: The device uses RSS and thus requires parallel RX,
2769 * which implies using per-CPU station statistics.
2770 *
2771 * @IEEE80211_HW_TX_AMSDU: Hardware (or driver) supports software aggregated
2772 * A-MSDU frames. Requires software tx queueing and fast-xmit support.
2773 * When not using minstrel/minstrel_ht rate control, the driver must
2774 * limit the maximum A-MSDU size based on the current tx rate by setting
2775 * max_rc_amsdu_len in struct ieee80211_sta.
2776 *
2777 * @IEEE80211_HW_TX_FRAG_LIST: Hardware (or driver) supports sending frag_list
2778 * skbs, needed for zero-copy software A-MSDU.
2779 *
2780 * @IEEE80211_HW_REPORTS_LOW_ACK: The driver (or firmware) reports low ack event
2781 * by ieee80211_report_low_ack() based on its own algorithm. For such
2782 * drivers, mac80211 packet loss mechanism will not be triggered and driver
2783 * is completely depending on firmware event for station kickout.
2784 *
2785 * @IEEE80211_HW_SUPPORTS_TX_FRAG: Hardware does fragmentation by itself.
2786 * The stack will not do fragmentation.
2787 * The callback for @set_frag_threshold should be set as well.
2788 *
2789 * @IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA: Hardware supports buffer STA on
2790 * TDLS links.
2791 *
2792 * @IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP: The driver (or firmware) doesn't
2793 * support QoS NDP for AP probing - that's most likely a driver bug.
2794 *
2795 * @IEEE80211_HW_BUFF_MMPDU_TXQ: use the TXQ for bufferable MMPDUs, this of
2796 * course requires the driver to use TXQs to start with.
2797 *
2798 * @IEEE80211_HW_SUPPORTS_VHT_EXT_NSS_BW: (Hardware) rate control supports VHT
2799 * extended NSS BW (dot11VHTExtendedNSSBWCapable). This flag will be set if
2800 * the selected rate control algorithm sets %RATE_CTRL_CAPA_VHT_EXT_NSS_BW
2801 * but if the rate control is built-in then it must be set by the driver.
2802 * See also the documentation for that flag.
2803 *
2804 * @IEEE80211_HW_STA_MMPDU_TXQ: use the extra non-TID per-station TXQ for all
2805 * MMPDUs on station interfaces. This of course requires the driver to use
2806 * TXQs to start with.
2807 *
2808 * @IEEE80211_HW_TX_STATUS_NO_AMPDU_LEN: Driver does not report accurate A-MPDU
2809 * length in tx status information
2810 *
2811 * @IEEE80211_HW_SUPPORTS_MULTI_BSSID: Hardware supports multi BSSID
2812 *
2813 * @IEEE80211_HW_SUPPORTS_ONLY_HE_MULTI_BSSID: Hardware supports multi BSSID
2814 * only for HE APs. Applies if @IEEE80211_HW_SUPPORTS_MULTI_BSSID is set.
2815 *
2816 * @IEEE80211_HW_AMPDU_KEYBORDER_SUPPORT: The card and driver is only
2817 * aggregating MPDUs with the same keyid, allowing mac80211 to keep Tx
2818 * A-MPDU sessions active while rekeying with Extended Key ID.
2819 *
2820 * @IEEE80211_HW_SUPPORTS_TX_ENCAP_OFFLOAD: Hardware supports tx encapsulation
2821 * offload
2822 *
2823 * @IEEE80211_HW_SUPPORTS_RX_DECAP_OFFLOAD: Hardware supports rx decapsulation
2824 * offload
2825 *
2826 * @IEEE80211_HW_SUPPORTS_CONC_MON_RX_DECAP: Hardware supports concurrent rx
2827 * decapsulation offload and passing raw 802.11 frames for monitor iface.
2828 * If this is supported, the driver must pass both 802.3 frames for real
2829 * usage and 802.11 frames with %RX_FLAG_ONLY_MONITOR set for monitor to
2830 * the stack.
2831 *
2832 * @IEEE80211_HW_DETECTS_COLOR_COLLISION: HW/driver has support for BSS color
2833 * collision detection and doesn't need it in software.
2834 *
2835 * @IEEE80211_HW_MLO_MCAST_MULTI_LINK_TX: Hardware/driver handles transmitting
2836 * multicast frames on all links, mac80211 should not do that.
2837 *
2838 * @IEEE80211_HW_DISALLOW_PUNCTURING: HW requires disabling puncturing in EHT
2839 * and connecting with a lower bandwidth instead
2840 * @IEEE80211_HW_DISALLOW_PUNCTURING_5GHZ: HW requires disabling puncturing in
2841 * EHT in 5 GHz and connecting with a lower bandwidth instead
2842 *
2843 * @IEEE80211_HW_HANDLES_QUIET_CSA: HW/driver handles quieting for CSA, so
2844 * no need to stop queues. This really should be set by a driver that
2845 * implements MLO, so operation can continue on other links when one
2846 * link is switching.
2847 *
2848 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
2849 */
2850enum ieee80211_hw_flags {
2851 IEEE80211_HW_HAS_RATE_CONTROL,
2852 IEEE80211_HW_RX_INCLUDES_FCS,
2853 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING,
2854 IEEE80211_HW_SIGNAL_UNSPEC,
2855 IEEE80211_HW_SIGNAL_DBM,
2856 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC,
2857 IEEE80211_HW_SPECTRUM_MGMT,
2858 IEEE80211_HW_AMPDU_AGGREGATION,
2859 IEEE80211_HW_SUPPORTS_PS,
2860 IEEE80211_HW_PS_NULLFUNC_STACK,
2861 IEEE80211_HW_SUPPORTS_DYNAMIC_PS,
2862 IEEE80211_HW_MFP_CAPABLE,
2863 IEEE80211_HW_WANT_MONITOR_VIF,
2864 IEEE80211_HW_NO_VIRTUAL_MONITOR,
2865 IEEE80211_HW_NO_AUTO_VIF,
2866 IEEE80211_HW_SW_CRYPTO_CONTROL,
2867 IEEE80211_HW_SUPPORT_FAST_XMIT,
2868 IEEE80211_HW_REPORTS_TX_ACK_STATUS,
2869 IEEE80211_HW_CONNECTION_MONITOR,
2870 IEEE80211_HW_QUEUE_CONTROL,
2871 IEEE80211_HW_SUPPORTS_PER_STA_GTK,
2872 IEEE80211_HW_AP_LINK_PS,
2873 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW,
2874 IEEE80211_HW_SUPPORTS_RC_TABLE,
2875 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF,
2876 IEEE80211_HW_TIMING_BEACON_ONLY,
2877 IEEE80211_HW_SUPPORTS_HT_CCK_RATES,
2878 IEEE80211_HW_CHANCTX_STA_CSA,
2879 IEEE80211_HW_SUPPORTS_CLONED_SKBS,
2880 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS,
2881 IEEE80211_HW_TDLS_WIDER_BW,
2882 IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU,
2883 IEEE80211_HW_BEACON_TX_STATUS,
2884 IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR,
2885 IEEE80211_HW_SUPPORTS_REORDERING_BUFFER,
2886 IEEE80211_HW_USES_RSS,
2887 IEEE80211_HW_TX_AMSDU,
2888 IEEE80211_HW_TX_FRAG_LIST,
2889 IEEE80211_HW_REPORTS_LOW_ACK,
2890 IEEE80211_HW_SUPPORTS_TX_FRAG,
2891 IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA,
2892 IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP,
2893 IEEE80211_HW_BUFF_MMPDU_TXQ,
2894 IEEE80211_HW_SUPPORTS_VHT_EXT_NSS_BW,
2895 IEEE80211_HW_STA_MMPDU_TXQ,
2896 IEEE80211_HW_TX_STATUS_NO_AMPDU_LEN,
2897 IEEE80211_HW_SUPPORTS_MULTI_BSSID,
2898 IEEE80211_HW_SUPPORTS_ONLY_HE_MULTI_BSSID,
2899 IEEE80211_HW_AMPDU_KEYBORDER_SUPPORT,
2900 IEEE80211_HW_SUPPORTS_TX_ENCAP_OFFLOAD,
2901 IEEE80211_HW_SUPPORTS_RX_DECAP_OFFLOAD,
2902 IEEE80211_HW_SUPPORTS_CONC_MON_RX_DECAP,
2903 IEEE80211_HW_DETECTS_COLOR_COLLISION,
2904 IEEE80211_HW_MLO_MCAST_MULTI_LINK_TX,
2905 IEEE80211_HW_DISALLOW_PUNCTURING,
2906 IEEE80211_HW_DISALLOW_PUNCTURING_5GHZ,
2907 IEEE80211_HW_HANDLES_QUIET_CSA,
2908
2909 /* keep last, obviously */
2910 NUM_IEEE80211_HW_FLAGS
2911};
2912
2913/**
2914 * struct ieee80211_hw - hardware information and state
2915 *
2916 * This structure contains the configuration and hardware
2917 * information for an 802.11 PHY.
2918 *
2919 * @wiphy: This points to the &struct wiphy allocated for this
2920 * 802.11 PHY. You must fill in the @perm_addr and @dev
2921 * members of this structure using SET_IEEE80211_DEV()
2922 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
2923 * bands (with channels, bitrates) are registered here.
2924 *
2925 * @conf: &struct ieee80211_conf, device configuration, don't use.
2926 *
2927 * @priv: pointer to private area that was allocated for driver use
2928 * along with this structure.
2929 *
2930 * @flags: hardware flags, see &enum ieee80211_hw_flags.
2931 *
2932 * @extra_tx_headroom: headroom to reserve in each transmit skb
2933 * for use by the driver (e.g. for transmit headers.)
2934 *
2935 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
2936 * Can be used by drivers to add extra IEs.
2937 *
2938 * @max_signal: Maximum value for signal (rssi) in RX information, used
2939 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
2940 *
2941 * @max_listen_interval: max listen interval in units of beacon interval
2942 * that HW supports
2943 *
2944 * @queues: number of available hardware transmit queues for
2945 * data packets. WMM/QoS requires at least four, these
2946 * queues need to have configurable access parameters.
2947 *
2948 * @rate_control_algorithm: rate control algorithm for this hardware.
2949 * If unset (NULL), the default algorithm will be used. Must be
2950 * set before calling ieee80211_register_hw().
2951 *
2952 * @vif_data_size: size (in bytes) of the drv_priv data area
2953 * within &struct ieee80211_vif.
2954 * @sta_data_size: size (in bytes) of the drv_priv data area
2955 * within &struct ieee80211_sta.
2956 * @chanctx_data_size: size (in bytes) of the drv_priv data area
2957 * within &struct ieee80211_chanctx_conf.
2958 * @txq_data_size: size (in bytes) of the drv_priv data area
2959 * within @struct ieee80211_txq.
2960 *
2961 * @max_rates: maximum number of alternate rate retry stages the hw
2962 * can handle.
2963 * @max_report_rates: maximum number of alternate rate retry stages
2964 * the hw can report back.
2965 * @max_rate_tries: maximum number of tries for each stage
2966 *
2967 * @max_rx_aggregation_subframes: maximum buffer size (number of
2968 * sub-frames) to be used for A-MPDU block ack receiver
2969 * aggregation.
2970 * This is only relevant if the device has restrictions on the
2971 * number of subframes, if it relies on mac80211 to do reordering
2972 * it shouldn't be set.
2973 *
2974 * @max_tx_aggregation_subframes: maximum number of subframes in an
2975 * aggregate an HT/HE device will transmit. In HT AddBA we'll
2976 * advertise a constant value of 64 as some older APs crash if
2977 * the window size is smaller (an example is LinkSys WRT120N
2978 * with FW v1.0.07 build 002 Jun 18 2012).
2979 * For AddBA to HE capable peers this value will be used.
2980 *
2981 * @max_tx_fragments: maximum number of tx buffers per (A)-MSDU, sum
2982 * of 1 + skb_shinfo(skb)->nr_frags for each skb in the frag_list.
2983 *
2984 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2985 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
2986 *
2987 * @radiotap_mcs_details: lists which MCS information can the HW
2988 * reports, by default it is set to _MCS, _GI and _BW but doesn't
2989 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_\* values, only
2990 * adding _BW is supported today.
2991 *
2992 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2993 * the default is _GI | _BANDWIDTH.
2994 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_\* values.
2995 *
2996 * @radiotap_timestamp: Information for the radiotap timestamp field; if the
2997 * @units_pos member is set to a non-negative value then the timestamp
2998 * field will be added and populated from the &struct ieee80211_rx_status
2999 * device_timestamp.
3000 * @radiotap_timestamp.units_pos: Must be set to a combination of a
3001 * IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a
3002 * IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value.
3003 * @radiotap_timestamp.accuracy: If non-negative, fills the accuracy in the
3004 * radiotap field and the accuracy known flag will be set.
3005 *
3006 * @netdev_features: netdev features to be set in each netdev created
3007 * from this HW. Note that not all features are usable with mac80211,
3008 * other features will be rejected during HW registration.
3009 *
3010 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
3011 * for each access category if it is uAPSD trigger-enabled and delivery-
3012 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
3013 * Each bit corresponds to different AC. Value '1' in specific bit means
3014 * that corresponding AC is both trigger- and delivery-enabled. '0' means
3015 * neither enabled.
3016 *
3017 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
3018 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
3019 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
3020 *
3021 * @max_nan_de_entries: maximum number of NAN DE functions supported by the
3022 * device.
3023 *
3024 * @tx_sk_pacing_shift: Pacing shift to set on TCP sockets when frames from
3025 * them are encountered. The default should typically not be changed,
3026 * unless the driver has good reasons for needing more buffers.
3027 *
3028 * @weight_multiplier: Driver specific airtime weight multiplier used while
3029 * refilling deficit of each TXQ.
3030 *
3031 * @max_mtu: the max mtu could be set.
3032 *
3033 * @tx_power_levels: a list of power levels supported by the wifi hardware.
3034 * The power levels can be specified either as integer or fractions.
3035 * The power level at idx 0 shall be the maximum positive power level.
3036 *
3037 * @max_txpwr_levels_idx: the maximum valid idx of 'tx_power_levels' list.
3038 */
3039struct ieee80211_hw {
3040 struct ieee80211_conf conf;
3041 struct wiphy *wiphy;
3042 const char *rate_control_algorithm;
3043 void *priv;
3044 unsigned long flags[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS)];
3045 unsigned int extra_tx_headroom;
3046 unsigned int extra_beacon_tailroom;
3047 int vif_data_size;
3048 int sta_data_size;
3049 int chanctx_data_size;
3050 int txq_data_size;
3051 u16 queues;
3052 u16 max_listen_interval;
3053 s8 max_signal;
3054 u8 max_rates;
3055 u8 max_report_rates;
3056 u8 max_rate_tries;
3057 u16 max_rx_aggregation_subframes;
3058 u16 max_tx_aggregation_subframes;
3059 u8 max_tx_fragments;
3060 u8 offchannel_tx_hw_queue;
3061 u8 radiotap_mcs_details;
3062 u16 radiotap_vht_details;
3063 struct {
3064 int units_pos;
3065 s16 accuracy;
3066 } radiotap_timestamp;
3067 netdev_features_t netdev_features;
3068 u8 uapsd_queues;
3069 u8 uapsd_max_sp_len;
3070 u8 max_nan_de_entries;
3071 u8 tx_sk_pacing_shift;
3072 u8 weight_multiplier;
3073 u32 max_mtu;
3074 const s8 *tx_power_levels;
3075 u8 max_txpwr_levels_idx;
3076};
3077
3078static inline bool _ieee80211_hw_check(struct ieee80211_hw *hw,
3079 enum ieee80211_hw_flags flg)
3080{
3081 return test_bit(flg, hw->flags);
3082}
3083#define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
3084
3085static inline void _ieee80211_hw_set(struct ieee80211_hw *hw,
3086 enum ieee80211_hw_flags flg)
3087{
3088 return __set_bit(flg, hw->flags);
3089}
3090#define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
3091
3092/**
3093 * struct ieee80211_scan_request - hw scan request
3094 *
3095 * @ies: pointers different parts of IEs (in req.ie)
3096 * @req: cfg80211 request.
3097 */
3098struct ieee80211_scan_request {
3099 struct ieee80211_scan_ies ies;
3100
3101 /* Keep last */
3102 struct cfg80211_scan_request req;
3103};
3104
3105/**
3106 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
3107 *
3108 * @sta: peer this TDLS channel-switch request/response came from
3109 * @chandef: channel referenced in a TDLS channel-switch request
3110 * @action_code: see &enum ieee80211_tdls_actioncode
3111 * @status: channel-switch response status
3112 * @timestamp: time at which the frame was received
3113 * @switch_time: switch-timing parameter received in the frame
3114 * @switch_timeout: switch-timing parameter received in the frame
3115 * @tmpl_skb: TDLS switch-channel response template
3116 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
3117 */
3118struct ieee80211_tdls_ch_sw_params {
3119 struct ieee80211_sta *sta;
3120 struct cfg80211_chan_def *chandef;
3121 u8 action_code;
3122 u32 status;
3123 u32 timestamp;
3124 u16 switch_time;
3125 u16 switch_timeout;
3126 struct sk_buff *tmpl_skb;
3127 u32 ch_sw_tm_ie;
3128};
3129
3130/**
3131 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
3132 *
3133 * @wiphy: the &struct wiphy which we want to query
3134 *
3135 * mac80211 drivers can use this to get to their respective
3136 * &struct ieee80211_hw. Drivers wishing to get to their own private
3137 * structure can then access it via hw->priv. Note that mac802111 drivers should
3138 * not use wiphy_priv() to try to get their private driver structure as this
3139 * is already used internally by mac80211.
3140 *
3141 * Return: The mac80211 driver hw struct of @wiphy.
3142 */
3143struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
3144
3145/**
3146 * SET_IEEE80211_DEV - set device for 802.11 hardware
3147 *
3148 * @hw: the &struct ieee80211_hw to set the device for
3149 * @dev: the &struct device of this 802.11 device
3150 */
3151static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
3152{
3153 set_wiphy_dev(hw->wiphy, dev);
3154}
3155
3156/**
3157 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
3158 *
3159 * @hw: the &struct ieee80211_hw to set the MAC address for
3160 * @addr: the address to set
3161 */
3162static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, const u8 *addr)
3163{
3164 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
3165}
3166
3167static inline struct ieee80211_rate *
3168ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
3169 const struct ieee80211_tx_info *c)
3170{
3171 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
3172 return NULL;
3173 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
3174}
3175
3176static inline struct ieee80211_rate *
3177ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
3178 const struct ieee80211_tx_info *c)
3179{
3180 if (c->control.rts_cts_rate_idx < 0)
3181 return NULL;
3182 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
3183}
3184
3185static inline struct ieee80211_rate *
3186ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
3187 const struct ieee80211_tx_info *c, int idx)
3188{
3189 if (c->control.rates[idx + 1].idx < 0)
3190 return NULL;
3191 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
3192}
3193
3194/**
3195 * ieee80211_free_txskb - free TX skb
3196 * @hw: the hardware
3197 * @skb: the skb
3198 *
3199 * Free a transmit skb. Use this function when some failure
3200 * to transmit happened and thus status cannot be reported.
3201 */
3202void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
3203
3204/**
3205 * ieee80211_purge_tx_queue - purge TX skb queue
3206 * @hw: the hardware
3207 * @skbs: the skbs
3208 *
3209 * Free a set of transmit skbs. Use this function when device is going to stop
3210 * but some transmit skbs without TX status are still queued.
3211 * This function does not take the list lock and the caller must hold the
3212 * relevant locks to use it.
3213 */
3214void ieee80211_purge_tx_queue(struct ieee80211_hw *hw,
3215 struct sk_buff_head *skbs);
3216
3217/**
3218 * DOC: Hardware crypto acceleration
3219 *
3220 * mac80211 is capable of taking advantage of many hardware
3221 * acceleration designs for encryption and decryption operations.
3222 *
3223 * The set_key() callback in the &struct ieee80211_ops for a given
3224 * device is called to enable hardware acceleration of encryption and
3225 * decryption. The callback takes a @sta parameter that will be NULL
3226 * for default keys or keys used for transmission only, or point to
3227 * the station information for the peer for individual keys.
3228 * Multiple transmission keys with the same key index may be used when
3229 * VLANs are configured for an access point.
3230 *
3231 * When transmitting, the TX control data will use the @hw_key_idx
3232 * selected by the driver by modifying the &struct ieee80211_key_conf
3233 * pointed to by the @key parameter to the set_key() function.
3234 *
3235 * The set_key() call for the %SET_KEY command should return 0 if
3236 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
3237 * added; if you return 0 then hw_key_idx must be assigned to the
3238 * hardware key index. You are free to use the full u8 range.
3239 *
3240 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
3241 * set, mac80211 will not automatically fall back to software crypto if
3242 * enabling hardware crypto failed. The set_key() call may also return the
3243 * value 1 to permit this specific key/algorithm to be done in software.
3244 *
3245 * When the cmd is %DISABLE_KEY then it must succeed.
3246 *
3247 * Note that it is permissible to not decrypt a frame even if a key
3248 * for it has been uploaded to hardware. The stack will not make any
3249 * decision based on whether a key has been uploaded or not but rather
3250 * based on the receive flags.
3251 *
3252 * The &struct ieee80211_key_conf structure pointed to by the @key
3253 * parameter is guaranteed to be valid until another call to set_key()
3254 * removes it, but it can only be used as a cookie to differentiate
3255 * keys.
3256 *
3257 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
3258 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
3259 * handler.
3260 * The update_tkip_key() call updates the driver with the new phase 1 key.
3261 * This happens every time the iv16 wraps around (every 65536 packets). The
3262 * set_key() call will happen only once for each key (unless the AP did
3263 * rekeying); it will not include a valid phase 1 key. The valid phase 1 key is
3264 * provided by update_tkip_key only. The trigger that makes mac80211 call this
3265 * handler is software decryption with wrap around of iv16.
3266 *
3267 * The set_default_unicast_key() call updates the default WEP key index
3268 * configured to the hardware for WEP encryption type. This is required
3269 * for devices that support offload of data packets (e.g. ARP responses).
3270 *
3271 * Mac80211 drivers should set the @NL80211_EXT_FEATURE_CAN_REPLACE_PTK0 flag
3272 * when they are able to replace in-use PTK keys according to the following
3273 * requirements:
3274 * 1) They do not hand over frames decrypted with the old key to mac80211
3275 once the call to set_key() with command %DISABLE_KEY has been completed,
3276 2) either drop or continue to use the old key for any outgoing frames queued
3277 at the time of the key deletion (including re-transmits),
3278 3) never send out a frame queued prior to the set_key() %SET_KEY command
3279 encrypted with the new key when also needing
3280 @IEEE80211_KEY_FLAG_GENERATE_IV and
3281 4) never send out a frame unencrypted when it should be encrypted.
3282 Mac80211 will not queue any new frames for a deleted key to the driver.
3283 */
3284
3285/**
3286 * DOC: Powersave support
3287 *
3288 * mac80211 has support for various powersave implementations.
3289 *
3290 * First, it can support hardware that handles all powersaving by itself;
3291 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
3292 * flag. In that case, it will be told about the desired powersave mode
3293 * with the %IEEE80211_CONF_PS flag depending on the association status.
3294 * The hardware must take care of sending nullfunc frames when necessary,
3295 * i.e. when entering and leaving powersave mode. The hardware is required
3296 * to look at the AID in beacons and signal to the AP that it woke up when
3297 * it finds traffic directed to it.
3298 *
3299 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
3300 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
3301 * with hardware wakeup and sleep states. Driver is responsible for waking
3302 * up the hardware before issuing commands to the hardware and putting it
3303 * back to sleep at appropriate times.
3304 *
3305 * When PS is enabled, hardware needs to wakeup for beacons and receive the
3306 * buffered multicast/broadcast frames after the beacon. Also it must be
3307 * possible to send frames and receive the acknowledment frame.
3308 *
3309 * Other hardware designs cannot send nullfunc frames by themselves and also
3310 * need software support for parsing the TIM bitmap. This is also supported
3311 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
3312 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
3313 * required to pass up beacons. The hardware is still required to handle
3314 * waking up for multicast traffic; if it cannot the driver must handle that
3315 * as best as it can; mac80211 is too slow to do that.
3316 *
3317 * Dynamic powersave is an extension to normal powersave in which the
3318 * hardware stays awake for a user-specified period of time after sending a
3319 * frame so that reply frames need not be buffered and therefore delayed to
3320 * the next wakeup. It's a compromise of getting good enough latency when
3321 * there's data traffic and still saving significantly power in idle
3322 * periods.
3323 *
3324 * Dynamic powersave is simply supported by mac80211 enabling and disabling
3325 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
3326 * flag and mac80211 will handle everything automatically. Additionally,
3327 * hardware having support for the dynamic PS feature may set the
3328 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
3329 * dynamic PS mode itself. The driver needs to look at the
3330 * @dynamic_ps_timeout hardware configuration value and use it that value
3331 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
3332 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
3333 * enabled whenever user has enabled powersave.
3334 *
3335 * Driver informs U-APSD client support by enabling
3336 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
3337 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
3338 * Nullfunc frames and stay awake until the service period has ended. To
3339 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
3340 * from that AC are transmitted with powersave enabled.
3341 *
3342 * Note: U-APSD client mode is not yet supported with
3343 * %IEEE80211_HW_PS_NULLFUNC_STACK.
3344 */
3345
3346/**
3347 * DOC: Beacon filter support
3348 *
3349 * Some hardware have beacon filter support to reduce host cpu wakeups
3350 * which will reduce system power consumption. It usually works so that
3351 * the firmware creates a checksum of the beacon but omits all constantly
3352 * changing elements (TSF, TIM etc). Whenever the checksum changes the
3353 * beacon is forwarded to the host, otherwise it will be just dropped. That
3354 * way the host will only receive beacons where some relevant information
3355 * (for example ERP protection or WMM settings) have changed.
3356 *
3357 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
3358 * interface capability. The driver needs to enable beacon filter support
3359 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
3360 * power save is enabled, the stack will not check for beacon loss and the
3361 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
3362 *
3363 * The time (or number of beacons missed) until the firmware notifies the
3364 * driver of a beacon loss event (which in turn causes the driver to call
3365 * ieee80211_beacon_loss()) should be configurable and will be controlled
3366 * by mac80211 and the roaming algorithm in the future.
3367 *
3368 * Since there may be constantly changing information elements that nothing
3369 * in the software stack cares about, we will, in the future, have mac80211
3370 * tell the driver which information elements are interesting in the sense
3371 * that we want to see changes in them. This will include
3372 *
3373 * - a list of information element IDs
3374 * - a list of OUIs for the vendor information element
3375 *
3376 * Ideally, the hardware would filter out any beacons without changes in the
3377 * requested elements, but if it cannot support that it may, at the expense
3378 * of some efficiency, filter out only a subset. For example, if the device
3379 * doesn't support checking for OUIs it should pass up all changes in all
3380 * vendor information elements.
3381 *
3382 * Note that change, for the sake of simplification, also includes information
3383 * elements appearing or disappearing from the beacon.
3384 *
3385 * Some hardware supports an "ignore list" instead. Just make sure nothing
3386 * that was requested is on the ignore list, and include commonly changing
3387 * information element IDs in the ignore list, for example 11 (BSS load) and
3388 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
3389 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
3390 * it could also include some currently unused IDs.
3391 *
3392 *
3393 * In addition to these capabilities, hardware should support notifying the
3394 * host of changes in the beacon RSSI. This is relevant to implement roaming
3395 * when no traffic is flowing (when traffic is flowing we see the RSSI of
3396 * the received data packets). This can consist of notifying the host when
3397 * the RSSI changes significantly or when it drops below or rises above
3398 * configurable thresholds. In the future these thresholds will also be
3399 * configured by mac80211 (which gets them from userspace) to implement
3400 * them as the roaming algorithm requires.
3401 *
3402 * If the hardware cannot implement this, the driver should ask it to
3403 * periodically pass beacon frames to the host so that software can do the
3404 * signal strength threshold checking.
3405 */
3406
3407/**
3408 * DOC: Spatial multiplexing power save
3409 *
3410 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
3411 * power in an 802.11n implementation. For details on the mechanism
3412 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
3413 * "11.2.3 SM power save".
3414 *
3415 * The mac80211 implementation is capable of sending action frames
3416 * to update the AP about the station's SMPS mode, and will instruct
3417 * the driver to enter the specific mode. It will also announce the
3418 * requested SMPS mode during the association handshake. Hardware
3419 * support for this feature is required, and can be indicated by
3420 * hardware flags.
3421 *
3422 * The default mode will be "automatic", which nl80211/cfg80211
3423 * defines to be dynamic SMPS in (regular) powersave, and SMPS
3424 * turned off otherwise.
3425 *
3426 * To support this feature, the driver must set the appropriate
3427 * hardware support flags, and handle the SMPS flag to the config()
3428 * operation. It will then with this mechanism be instructed to
3429 * enter the requested SMPS mode while associated to an HT AP.
3430 */
3431
3432/**
3433 * DOC: Frame filtering
3434 *
3435 * mac80211 requires to see many management frames for proper
3436 * operation, and users may want to see many more frames when
3437 * in monitor mode. However, for best CPU usage and power consumption,
3438 * having as few frames as possible percolate through the stack is
3439 * desirable. Hence, the hardware should filter as much as possible.
3440 *
3441 * To achieve this, mac80211 uses filter flags (see below) to tell
3442 * the driver's configure_filter() function which frames should be
3443 * passed to mac80211 and which should be filtered out.
3444 *
3445 * Before configure_filter() is invoked, the prepare_multicast()
3446 * callback is invoked with the parameters @mc_count and @mc_list
3447 * for the combined multicast address list of all virtual interfaces.
3448 * It's use is optional, and it returns a u64 that is passed to
3449 * configure_filter(). Additionally, configure_filter() has the
3450 * arguments @changed_flags telling which flags were changed and
3451 * @total_flags with the new flag states.
3452 *
3453 * If your device has no multicast address filters your driver will
3454 * need to check both the %FIF_ALLMULTI flag and the @mc_count
3455 * parameter to see whether multicast frames should be accepted
3456 * or dropped.
3457 *
3458 * All unsupported flags in @total_flags must be cleared.
3459 * Hardware does not support a flag if it is incapable of _passing_
3460 * the frame to the stack. Otherwise the driver must ignore
3461 * the flag, but not clear it.
3462 * You must _only_ clear the flag (announce no support for the
3463 * flag to mac80211) if you are not able to pass the packet type
3464 * to the stack (so the hardware always filters it).
3465 * So for example, you should clear @FIF_CONTROL, if your hardware
3466 * always filters control frames. If your hardware always passes
3467 * control frames to the kernel and is incapable of filtering them,
3468 * you do _not_ clear the @FIF_CONTROL flag.
3469 * This rule applies to all other FIF flags as well.
3470 */
3471
3472/**
3473 * DOC: AP support for powersaving clients
3474 *
3475 * In order to implement AP and P2P GO modes, mac80211 has support for
3476 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
3477 * There currently is no support for sAPSD.
3478 *
3479 * There is one assumption that mac80211 makes, namely that a client
3480 * will not poll with PS-Poll and trigger with uAPSD at the same time.
3481 * Both are supported, and both can be used by the same client, but
3482 * they can't be used concurrently by the same client. This simplifies
3483 * the driver code.
3484 *
3485 * The first thing to keep in mind is that there is a flag for complete
3486 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
3487 * mac80211 expects the driver to handle most of the state machine for
3488 * powersaving clients and will ignore the PM bit in incoming frames.
3489 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
3490 * stations' powersave transitions. In this mode, mac80211 also doesn't
3491 * handle PS-Poll/uAPSD.
3492 *
3493 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
3494 * PM bit in incoming frames for client powersave transitions. When a
3495 * station goes to sleep, we will stop transmitting to it. There is,
3496 * however, a race condition: a station might go to sleep while there is
3497 * data buffered on hardware queues. If the device has support for this
3498 * it will reject frames, and the driver should give the frames back to
3499 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
3500 * cause mac80211 to retry the frame when the station wakes up. The
3501 * driver is also notified of powersave transitions by calling its
3502 * @sta_notify callback.
3503 *
3504 * When the station is asleep, it has three choices: it can wake up,
3505 * it can PS-Poll, or it can possibly start a uAPSD service period.
3506 * Waking up is implemented by simply transmitting all buffered (and
3507 * filtered) frames to the station. This is the easiest case. When
3508 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
3509 * will inform the driver of this with the @allow_buffered_frames
3510 * callback; this callback is optional. mac80211 will then transmit
3511 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
3512 * on each frame. The last frame in the service period (or the only
3513 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
3514 * indicate that it ends the service period; as this frame must have
3515 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
3516 * When TX status is reported for this frame, the service period is
3517 * marked has having ended and a new one can be started by the peer.
3518 *
3519 * Additionally, non-bufferable MMPDUs can also be transmitted by
3520 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
3521 *
3522 * Another race condition can happen on some devices like iwlwifi
3523 * when there are frames queued for the station and it wakes up
3524 * or polls; the frames that are already queued could end up being
3525 * transmitted first instead, causing reordering and/or wrong
3526 * processing of the EOSP. The cause is that allowing frames to be
3527 * transmitted to a certain station is out-of-band communication to
3528 * the device. To allow this problem to be solved, the driver can
3529 * call ieee80211_sta_block_awake() if frames are buffered when it
3530 * is notified that the station went to sleep. When all these frames
3531 * have been filtered (see above), it must call the function again
3532 * to indicate that the station is no longer blocked.
3533 *
3534 * If the driver buffers frames in the driver for aggregation in any
3535 * way, it must use the ieee80211_sta_set_buffered() call when it is
3536 * notified of the station going to sleep to inform mac80211 of any
3537 * TIDs that have frames buffered. Note that when a station wakes up
3538 * this information is reset (hence the requirement to call it when
3539 * informed of the station going to sleep). Then, when a service
3540 * period starts for any reason, @release_buffered_frames is called
3541 * with the number of frames to be released and which TIDs they are
3542 * to come from. In this case, the driver is responsible for setting
3543 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames.
3544 * To help the @more_data parameter is passed to tell the driver if
3545 * there is more data on other TIDs -- the TIDs to release frames
3546 * from are ignored since mac80211 doesn't know how many frames the
3547 * buffers for those TIDs contain.
3548 *
3549 * If the driver also implement GO mode, where absence periods may
3550 * shorten service periods (or abort PS-Poll responses), it must
3551 * filter those response frames except in the case of frames that
3552 * are buffered in the driver -- those must remain buffered to avoid
3553 * reordering. Because it is possible that no frames are released
3554 * in this case, the driver must call ieee80211_sta_eosp()
3555 * to indicate to mac80211 that the service period ended anyway.
3556 *
3557 * Finally, if frames from multiple TIDs are released from mac80211
3558 * but the driver might reorder them, it must clear & set the flags
3559 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
3560 * and also take care of the EOSP and MORE_DATA bits in the frame.
3561 * The driver may also use ieee80211_sta_eosp() in this case.
3562 *
3563 * Note that if the driver ever buffers frames other than QoS-data
3564 * frames, it must take care to never send a non-QoS-data frame as
3565 * the last frame in a service period, adding a QoS-nulldata frame
3566 * after a non-QoS-data frame if needed.
3567 */
3568
3569/**
3570 * DOC: HW queue control
3571 *
3572 * Before HW queue control was introduced, mac80211 only had a single static
3573 * assignment of per-interface AC software queues to hardware queues. This
3574 * was problematic for a few reasons:
3575 * 1) off-channel transmissions might get stuck behind other frames
3576 * 2) multiple virtual interfaces couldn't be handled correctly
3577 * 3) after-DTIM frames could get stuck behind other frames
3578 *
3579 * To solve this, hardware typically uses multiple different queues for all
3580 * the different usages, and this needs to be propagated into mac80211 so it
3581 * won't have the same problem with the software queues.
3582 *
3583 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
3584 * flag that tells it that the driver implements its own queue control. To do
3585 * so, the driver will set up the various queues in each &struct ieee80211_vif
3586 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
3587 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
3588 * if necessary will queue the frame on the right software queue that mirrors
3589 * the hardware queue.
3590 * Additionally, the driver has to then use these HW queue IDs for the queue
3591 * management functions (ieee80211_stop_queue() et al.)
3592 *
3593 * The driver is free to set up the queue mappings as needed; multiple virtual
3594 * interfaces may map to the same hardware queues if needed. The setup has to
3595 * happen during add_interface or change_interface callbacks. For example, a
3596 * driver supporting station+station and station+AP modes might decide to have
3597 * 10 hardware queues to handle different scenarios:
3598 *
3599 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
3600 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
3601 * after-DTIM queue for AP: 8
3602 * off-channel queue: 9
3603 *
3604 * It would then set up the hardware like this:
3605 * hw.offchannel_tx_hw_queue = 9
3606 *
3607 * and the first virtual interface that is added as follows:
3608 * vif.hw_queue[IEEE80211_AC_VO] = 0
3609 * vif.hw_queue[IEEE80211_AC_VI] = 1
3610 * vif.hw_queue[IEEE80211_AC_BE] = 2
3611 * vif.hw_queue[IEEE80211_AC_BK] = 3
3612 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
3613 * and the second virtual interface with 4-7.
3614 *
3615 * If queue 6 gets full, for example, mac80211 would only stop the second
3616 * virtual interface's BE queue since virtual interface queues are per AC.
3617 *
3618 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
3619 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
3620 * queue could potentially be shared since mac80211 will look at cab_queue when
3621 * a queue is stopped/woken even if the interface is not in AP mode.
3622 */
3623
3624/**
3625 * enum ieee80211_filter_flags - hardware filter flags
3626 *
3627 * These flags determine what the filter in hardware should be
3628 * programmed to let through and what should not be passed to the
3629 * stack. It is always safe to pass more frames than requested,
3630 * but this has negative impact on power consumption.
3631 *
3632 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
3633 * by the user or if the hardware is not capable of filtering by
3634 * multicast address.
3635 *
3636 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
3637 * %RX_FLAG_FAILED_FCS_CRC for them)
3638 *
3639 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
3640 * the %RX_FLAG_FAILED_PLCP_CRC for them
3641 *
3642 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
3643 * to the hardware that it should not filter beacons or probe responses
3644 * by BSSID. Filtering them can greatly reduce the amount of processing
3645 * mac80211 needs to do and the amount of CPU wakeups, so you should
3646 * honour this flag if possible.
3647 *
3648 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
3649 * station
3650 *
3651 * @FIF_OTHER_BSS: pass frames destined to other BSSes
3652 *
3653 * @FIF_PSPOLL: pass PS Poll frames
3654 *
3655 * @FIF_PROBE_REQ: pass probe request frames
3656 *
3657 * @FIF_MCAST_ACTION: pass multicast Action frames
3658 */
3659enum ieee80211_filter_flags {
3660 FIF_ALLMULTI = 1<<1,
3661 FIF_FCSFAIL = 1<<2,
3662 FIF_PLCPFAIL = 1<<3,
3663 FIF_BCN_PRBRESP_PROMISC = 1<<4,
3664 FIF_CONTROL = 1<<5,
3665 FIF_OTHER_BSS = 1<<6,
3666 FIF_PSPOLL = 1<<7,
3667 FIF_PROBE_REQ = 1<<8,
3668 FIF_MCAST_ACTION = 1<<9,
3669};
3670
3671/**
3672 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
3673 *
3674 * These flags are used with the ampdu_action() callback in
3675 * &struct ieee80211_ops to indicate which action is needed.
3676 *
3677 * Note that drivers MUST be able to deal with a TX aggregation
3678 * session being stopped even before they OK'ed starting it by
3679 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
3680 * might receive the addBA frame and send a delBA right away!
3681 *
3682 * @IEEE80211_AMPDU_RX_START: start RX aggregation
3683 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
3684 * @IEEE80211_AMPDU_TX_START: start TX aggregation, the driver must either
3685 * call ieee80211_start_tx_ba_cb_irqsafe() or
3686 * call ieee80211_start_tx_ba_cb_irqsafe() with status
3687 * %IEEE80211_AMPDU_TX_START_DELAY_ADDBA to delay addba after
3688 * ieee80211_start_tx_ba_cb_irqsafe is called, or just return the special
3689 * status %IEEE80211_AMPDU_TX_START_IMMEDIATE.
3690 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
3691 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
3692 * queued packets, now unaggregated. After all packets are transmitted the
3693 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
3694 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
3695 * called when the station is removed. There's no need or reason to call
3696 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
3697 * session is gone and removes the station.
3698 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
3699 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
3700 * now the connection is dropped and the station will be removed. Drivers
3701 * should clean up and drop remaining packets when this is called.
3702 */
3703enum ieee80211_ampdu_mlme_action {
3704 IEEE80211_AMPDU_RX_START,
3705 IEEE80211_AMPDU_RX_STOP,
3706 IEEE80211_AMPDU_TX_START,
3707 IEEE80211_AMPDU_TX_STOP_CONT,
3708 IEEE80211_AMPDU_TX_STOP_FLUSH,
3709 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
3710 IEEE80211_AMPDU_TX_OPERATIONAL,
3711};
3712
3713#define IEEE80211_AMPDU_TX_START_IMMEDIATE 1
3714#define IEEE80211_AMPDU_TX_START_DELAY_ADDBA 2
3715
3716/**
3717 * struct ieee80211_ampdu_params - AMPDU action parameters
3718 *
3719 * @action: the ampdu action, value from %ieee80211_ampdu_mlme_action.
3720 * @sta: peer of this AMPDU session
3721 * @tid: tid of the BA session
3722 * @ssn: start sequence number of the session. TX/RX_STOP can pass 0. When
3723 * action is set to %IEEE80211_AMPDU_RX_START the driver passes back the
3724 * actual ssn value used to start the session and writes the value here.
3725 * @buf_size: reorder buffer size (number of subframes). Valid only when the
3726 * action is set to %IEEE80211_AMPDU_RX_START or
3727 * %IEEE80211_AMPDU_TX_OPERATIONAL
3728 * @amsdu: indicates the peer's ability to receive A-MSDU within A-MPDU.
3729 * valid when the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL
3730 * @timeout: BA session timeout. Valid only when the action is set to
3731 * %IEEE80211_AMPDU_RX_START
3732 */
3733struct ieee80211_ampdu_params {
3734 enum ieee80211_ampdu_mlme_action action;
3735 struct ieee80211_sta *sta;
3736 u16 tid;
3737 u16 ssn;
3738 u16 buf_size;
3739 bool amsdu;
3740 u16 timeout;
3741};
3742
3743/**
3744 * enum ieee80211_frame_release_type - frame release reason
3745 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
3746 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
3747 * frame received on trigger-enabled AC
3748 */
3749enum ieee80211_frame_release_type {
3750 IEEE80211_FRAME_RELEASE_PSPOLL,
3751 IEEE80211_FRAME_RELEASE_UAPSD,
3752};
3753
3754/**
3755 * enum ieee80211_rate_control_changed - flags to indicate what changed
3756 *
3757 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
3758 * to this station changed. The actual bandwidth is in the station
3759 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
3760 * flag changes, for HT and VHT the bandwidth field changes.
3761 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
3762 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
3763 * changed (in IBSS mode) due to discovering more information about
3764 * the peer.
3765 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
3766 * by the peer
3767 */
3768enum ieee80211_rate_control_changed {
3769 IEEE80211_RC_BW_CHANGED = BIT(0),
3770 IEEE80211_RC_SMPS_CHANGED = BIT(1),
3771 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
3772 IEEE80211_RC_NSS_CHANGED = BIT(3),
3773};
3774
3775/**
3776 * enum ieee80211_roc_type - remain on channel type
3777 *
3778 * With the support for multi channel contexts and multi channel operations,
3779 * remain on channel operations might be limited/deferred/aborted by other
3780 * flows/operations which have higher priority (and vice versa).
3781 * Specifying the ROC type can be used by devices to prioritize the ROC
3782 * operations compared to other operations/flows.
3783 *
3784 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
3785 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
3786 * for sending management frames offchannel.
3787 */
3788enum ieee80211_roc_type {
3789 IEEE80211_ROC_TYPE_NORMAL = 0,
3790 IEEE80211_ROC_TYPE_MGMT_TX,
3791};
3792
3793/**
3794 * enum ieee80211_reconfig_type - reconfig type
3795 *
3796 * This enum is used by the reconfig_complete() callback to indicate what
3797 * reconfiguration type was completed.
3798 *
3799 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
3800 * (also due to resume() callback returning 1)
3801 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
3802 * of wowlan configuration)
3803 */
3804enum ieee80211_reconfig_type {
3805 IEEE80211_RECONFIG_TYPE_RESTART,
3806 IEEE80211_RECONFIG_TYPE_SUSPEND,
3807};
3808
3809/**
3810 * struct ieee80211_prep_tx_info - prepare TX information
3811 * @duration: if non-zero, hint about the required duration,
3812 * only used with the mgd_prepare_tx() method.
3813 * @subtype: frame subtype (auth, (re)assoc, deauth, disassoc)
3814 * @success: whether the frame exchange was successful, only
3815 * used with the mgd_complete_tx() method, and then only
3816 * valid for auth and (re)assoc.
3817 * @was_assoc: set if this call is due to deauth/disassoc
3818 * while just having been associated
3819 * @link_id: the link id on which the frame will be TX'ed.
3820 * Only used with the mgd_prepare_tx() method.
3821 */
3822struct ieee80211_prep_tx_info {
3823 u16 duration;
3824 u16 subtype;
3825 u8 success:1, was_assoc:1;
3826 int link_id;
3827};
3828
3829/**
3830 * struct ieee80211_ops - callbacks from mac80211 to the driver
3831 *
3832 * This structure contains various callbacks that the driver may
3833 * handle or, in some cases, must handle, for example to configure
3834 * the hardware to a new channel or to transmit a frame.
3835 *
3836 * @tx: Handler that 802.11 module calls for each transmitted frame.
3837 * skb contains the buffer starting from the IEEE 802.11 header.
3838 * The low-level driver should send the frame out based on
3839 * configuration in the TX control data. This handler should,
3840 * preferably, never fail and stop queues appropriately.
3841 * Must be atomic.
3842 *
3843 * @start: Called before the first netdevice attached to the hardware
3844 * is enabled. This should turn on the hardware and must turn on
3845 * frame reception (for possibly enabled monitor interfaces.)
3846 * Returns negative error codes, these may be seen in userspace,
3847 * or zero.
3848 * When the device is started it should not have a MAC address
3849 * to avoid acknowledging frames before a non-monitor device
3850 * is added.
3851 * Must be implemented and can sleep.
3852 *
3853 * @stop: Called after last netdevice attached to the hardware
3854 * is disabled. This should turn off the hardware (at least
3855 * it must turn off frame reception.)
3856 * May be called right after add_interface if that rejects
3857 * an interface. If you added any work onto the mac80211 workqueue
3858 * you should ensure to cancel it on this callback.
3859 * Must be implemented and can sleep.
3860 *
3861 * @suspend: Suspend the device; mac80211 itself will quiesce before and
3862 * stop transmitting and doing any other configuration, and then
3863 * ask the device to suspend. This is only invoked when WoWLAN is
3864 * configured, otherwise the device is deconfigured completely and
3865 * reconfigured at resume time.
3866 * The driver may also impose special conditions under which it
3867 * wants to use the "normal" suspend (deconfigure), say if it only
3868 * supports WoWLAN when the device is associated. In this case, it
3869 * must return 1 from this function.
3870 *
3871 * @resume: If WoWLAN was configured, this indicates that mac80211 is
3872 * now resuming its operation, after this the device must be fully
3873 * functional again. If this returns an error, the only way out is
3874 * to also unregister the device. If it returns 1, then mac80211
3875 * will also go through the regular complete restart on resume.
3876 *
3877 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
3878 * modified. The reason is that device_set_wakeup_enable() is
3879 * supposed to be called when the configuration changes, not only
3880 * in suspend().
3881 *
3882 * @add_interface: Called when a netdevice attached to the hardware is
3883 * enabled. Because it is not called for monitor mode devices, @start
3884 * and @stop must be implemented.
3885 * The driver should perform any initialization it needs before
3886 * the device can be enabled. The initial configuration for the
3887 * interface is given in the conf parameter.
3888 * The callback may refuse to add an interface by returning a
3889 * negative error code (which will be seen in userspace.)
3890 * Must be implemented and can sleep.
3891 *
3892 * @change_interface: Called when a netdevice changes type. This callback
3893 * is optional, but only if it is supported can interface types be
3894 * switched while the interface is UP. The callback may sleep.
3895 * Note that while an interface is being switched, it will not be
3896 * found by the interface iteration callbacks.
3897 *
3898 * @remove_interface: Notifies a driver that an interface is going down.
3899 * The @stop callback is called after this if it is the last interface
3900 * and no monitor interfaces are present.
3901 * When all interfaces are removed, the MAC address in the hardware
3902 * must be cleared so the device no longer acknowledges packets,
3903 * the mac_addr member of the conf structure is, however, set to the
3904 * MAC address of the device going away.
3905 * Hence, this callback must be implemented. It can sleep.
3906 *
3907 * @config: Handler for configuration requests. IEEE 802.11 code calls this
3908 * function to change hardware configuration, e.g., channel.
3909 * This function should never fail but returns a negative error code
3910 * if it does. The callback can sleep.
3911 *
3912 * @bss_info_changed: Handler for configuration requests related to BSS
3913 * parameters that may vary during BSS's lifespan, and may affect low
3914 * level driver (e.g. assoc/disassoc status, erp parameters).
3915 * This function should not be used if no BSS has been set, unless
3916 * for association indication. The @changed parameter indicates which
3917 * of the bss parameters has changed when a call is made. The callback
3918 * can sleep.
3919 * Note: this callback is called if @vif_cfg_changed or @link_info_changed
3920 * are not implemented.
3921 *
3922 * @vif_cfg_changed: Handler for configuration requests related to interface
3923 * (MLD) parameters from &struct ieee80211_vif_cfg that vary during the
3924 * lifetime of the interface (e.g. assoc status, IP addresses, etc.)
3925 * The @changed parameter indicates which value changed.
3926 * The callback can sleep.
3927 *
3928 * @link_info_changed: Handler for configuration requests related to link
3929 * parameters from &struct ieee80211_bss_conf that are related to an
3930 * individual link. e.g. legacy/HT/VHT/... rate information.
3931 * The @changed parameter indicates which value changed, and the @link_id
3932 * parameter indicates the link ID. Note that the @link_id will be 0 for
3933 * non-MLO connections.
3934 * The callback can sleep.
3935 *
3936 * @prepare_multicast: Prepare for multicast filter configuration.
3937 * This callback is optional, and its return value is passed
3938 * to configure_filter(). This callback must be atomic.
3939 *
3940 * @configure_filter: Configure the device's RX filter.
3941 * See the section "Frame filtering" for more information.
3942 * This callback must be implemented and can sleep.
3943 *
3944 * @config_iface_filter: Configure the interface's RX filter.
3945 * This callback is optional and is used to configure which frames
3946 * should be passed to mac80211. The filter_flags is the combination
3947 * of FIF_* flags. The changed_flags is a bit mask that indicates
3948 * which flags are changed.
3949 * This callback can sleep.
3950 *
3951 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
3952 * must be set or cleared for a given STA. Must be atomic.
3953 *
3954 * @set_key: See the section "Hardware crypto acceleration"
3955 * This callback is only called between add_interface and
3956 * remove_interface calls, i.e. while the given virtual interface
3957 * is enabled.
3958 * Returns a negative error code if the key can't be added.
3959 * The callback can sleep.
3960 *
3961 * @update_tkip_key: See the section "Hardware crypto acceleration"
3962 * This callback will be called in the context of Rx. Called for drivers
3963 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
3964 * The callback must be atomic.
3965 *
3966 * @set_rekey_data: If the device supports GTK rekeying, for example while the
3967 * host is suspended, it can assign this callback to retrieve the data
3968 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
3969 * After rekeying was done it should (for example during resume) notify
3970 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
3971 *
3972 * @set_default_unicast_key: Set the default (unicast) key index, useful for
3973 * WEP when the device sends data packets autonomously, e.g. for ARP
3974 * offloading. The index can be 0-3, or -1 for unsetting it.
3975 *
3976 * @hw_scan: Ask the hardware to service the scan request, no need to start
3977 * the scan state machine in stack. The scan must honour the channel
3978 * configuration done by the regulatory agent in the wiphy's
3979 * registered bands. The hardware (or the driver) needs to make sure
3980 * that power save is disabled.
3981 * The @req ie/ie_len members are rewritten by mac80211 to contain the
3982 * entire IEs after the SSID, so that drivers need not look at these
3983 * at all but just send them after the SSID -- mac80211 includes the
3984 * (extended) supported rates and HT information (where applicable).
3985 * When the scan finishes, ieee80211_scan_completed() must be called;
3986 * note that it also must be called when the scan cannot finish due to
3987 * any error unless this callback returned a negative error code.
3988 * This callback is also allowed to return the special return value 1,
3989 * this indicates that hardware scan isn't desirable right now and a
3990 * software scan should be done instead. A driver wishing to use this
3991 * capability must ensure its (hardware) scan capabilities aren't
3992 * advertised as more capable than mac80211's software scan is.
3993 * The callback can sleep.
3994 *
3995 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
3996 * The driver should ask the hardware to cancel the scan (if possible),
3997 * but the scan will be completed only after the driver will call
3998 * ieee80211_scan_completed().
3999 * This callback is needed for wowlan, to prevent enqueueing a new
4000 * scan_work after the low-level driver was already suspended.
4001 * The callback can sleep.
4002 *
4003 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
4004 * specific intervals. The driver must call the
4005 * ieee80211_sched_scan_results() function whenever it finds results.
4006 * This process will continue until sched_scan_stop is called.
4007 *
4008 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
4009 * In this case, ieee80211_sched_scan_stopped() must not be called.
4010 *
4011 * @sw_scan_start: Notifier function that is called just before a software scan
4012 * is started. Can be NULL, if the driver doesn't need this notification.
4013 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
4014 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
4015 * can use this parameter. The callback can sleep.
4016 *
4017 * @sw_scan_complete: Notifier function that is called just after a
4018 * software scan finished. Can be NULL, if the driver doesn't need
4019 * this notification.
4020 * The callback can sleep.
4021 *
4022 * @get_stats: Return low-level statistics.
4023 * Returns zero if statistics are available.
4024 * The callback can sleep.
4025 *
4026 * @get_key_seq: If your device implements encryption in hardware and does
4027 * IV/PN assignment then this callback should be provided to read the
4028 * IV/PN for the given key from hardware.
4029 * The callback must be atomic.
4030 *
4031 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
4032 * if the device does fragmentation by itself. Note that to prevent the
4033 * stack from doing fragmentation IEEE80211_HW_SUPPORTS_TX_FRAG
4034 * should be set as well.
4035 * The callback can sleep.
4036 *
4037 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
4038 * The callback can sleep.
4039 *
4040 * @sta_add: Notifies low level driver about addition of an associated station,
4041 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
4042 *
4043 * @sta_remove: Notifies low level driver about removal of an associated
4044 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
4045 * returns it isn't safe to use the pointer, not even RCU protected;
4046 * no RCU grace period is guaranteed between returning here and freeing
4047 * the station. See @sta_pre_rcu_remove if needed.
4048 * This callback can sleep.
4049 *
4050 * @vif_add_debugfs: Drivers can use this callback to add a debugfs vif
4051 * directory with its files. This callback should be within a
4052 * CONFIG_MAC80211_DEBUGFS conditional. This callback can sleep.
4053 *
4054 * @link_add_debugfs: Drivers can use this callback to add debugfs files
4055 * when a link is added to a mac80211 vif. This callback should be within
4056 * a CONFIG_MAC80211_DEBUGFS conditional. This callback can sleep.
4057 * For non-MLO the callback will be called once for the default bss_conf
4058 * with the vif's directory rather than a separate subdirectory.
4059 *
4060 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
4061 * when a station is added to mac80211's station list. This callback
4062 * should be within a CONFIG_MAC80211_DEBUGFS conditional. This
4063 * callback can sleep.
4064 *
4065 * @link_sta_add_debugfs: Drivers can use this callback to add debugfs files
4066 * when a link is added to a mac80211 station. This callback
4067 * should be within a CONFIG_MAC80211_DEBUGFS conditional. This
4068 * callback can sleep.
4069 * For non-MLO the callback will be called once for the deflink with the
4070 * station's directory rather than a separate subdirectory.
4071 *
4072 * @sta_notify: Notifies low level driver about power state transition of an
4073 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
4074 * in AP mode, this callback will not be called when the flag
4075 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
4076 *
4077 * @sta_set_txpwr: Configure the station tx power. This callback set the tx
4078 * power for the station.
4079 * This callback can sleep.
4080 *
4081 * @sta_state: Notifies low level driver about state transition of a
4082 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
4083 * This callback is mutually exclusive with @sta_add/@sta_remove.
4084 * It must not fail for down transitions but may fail for transitions
4085 * up the list of states. Also note that after the callback returns it
4086 * isn't safe to use the pointer, not even RCU protected - no RCU grace
4087 * period is guaranteed between returning here and freeing the station.
4088 * See @sta_pre_rcu_remove if needed.
4089 * The callback can sleep.
4090 *
4091 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
4092 * synchronisation. This is useful if a driver needs to have station
4093 * pointers protected using RCU, it can then use this call to clear
4094 * the pointers instead of waiting for an RCU grace period to elapse
4095 * in @sta_state.
4096 * The callback can sleep.
4097 *
4098 * @link_sta_rc_update: Notifies the driver of changes to the bitrates that can
4099 * be used to transmit to the station. The changes are advertised with bits
4100 * from &enum ieee80211_rate_control_changed and the values are reflected
4101 * in the station data. This callback should only be used when the driver
4102 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
4103 * otherwise the rate control algorithm is notified directly.
4104 * Must be atomic.
4105 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
4106 * is only used if the configured rate control algorithm actually uses
4107 * the new rate table API, and is therefore optional. Must be atomic.
4108 *
4109 * @sta_statistics: Get statistics for this station. For example with beacon
4110 * filtering, the statistics kept by mac80211 might not be accurate, so
4111 * let the driver pre-fill the statistics. The driver can fill most of
4112 * the values (indicating which by setting the filled bitmap), but not
4113 * all of them make sense - see the source for which ones are possible.
4114 * Statistics that the driver doesn't fill will be filled by mac80211.
4115 * The callback can sleep.
4116 *
4117 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
4118 * bursting) for a hardware TX queue.
4119 * Returns a negative error code on failure.
4120 * The callback can sleep.
4121 *
4122 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
4123 * this is only used for IBSS mode BSSID merging and debugging. Is not a
4124 * required function.
4125 * The callback can sleep.
4126 *
4127 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
4128 * Currently, this is only used for IBSS mode debugging. Is not a
4129 * required function.
4130 * The callback can sleep.
4131 *
4132 * @offset_tsf: Offset the TSF timer by the specified value in the
4133 * firmware/hardware. Preferred to set_tsf as it avoids delay between
4134 * calling set_tsf() and hardware getting programmed, which will show up
4135 * as TSF delay. Is not a required function.
4136 * The callback can sleep.
4137 *
4138 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
4139 * with other STAs in the IBSS. This is only used in IBSS mode. This
4140 * function is optional if the firmware/hardware takes full care of
4141 * TSF synchronization.
4142 * The callback can sleep.
4143 *
4144 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
4145 * This is needed only for IBSS mode and the result of this function is
4146 * used to determine whether to reply to Probe Requests.
4147 * Returns non-zero if this device sent the last beacon.
4148 * The callback can sleep.
4149 *
4150 * @get_survey: Return per-channel survey information
4151 *
4152 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
4153 * need to set wiphy->rfkill_poll to %true before registration,
4154 * and need to call wiphy_rfkill_set_hw_state() in the callback.
4155 * The callback can sleep.
4156 *
4157 * @set_coverage_class: Set slot time for given coverage class as specified
4158 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
4159 * accordingly; coverage class equals to -1 to enable ACK timeout
4160 * estimation algorithm (dynack). To disable dynack set valid value for
4161 * coverage class. This callback is not required and may sleep.
4162 *
4163 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
4164 * be %NULL. The callback can sleep.
4165 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
4166 *
4167 * @flush: Flush all pending frames from the hardware queue, making sure
4168 * that the hardware queues are empty. The @queues parameter is a bitmap
4169 * of queues to flush, which is useful if different virtual interfaces
4170 * use different hardware queues; it may also indicate all queues.
4171 * If the parameter @drop is set to %true, pending frames may be dropped.
4172 * Note that vif can be NULL.
4173 * The callback can sleep.
4174 *
4175 * @flush_sta: Flush or drop all pending frames from the hardware queue(s) for
4176 * the given station, as it's about to be removed.
4177 * The callback can sleep.
4178 *
4179 * @channel_switch: Drivers that need (or want) to offload the channel
4180 * switch operation for CSAs received from the AP may implement this
4181 * callback. They must then call ieee80211_chswitch_done() to indicate
4182 * completion of the channel switch.
4183 *
4184 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
4185 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
4186 * reject TX/RX mask combinations they cannot support by returning -EINVAL
4187 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
4188 *
4189 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
4190 *
4191 * @remain_on_channel: Starts an off-channel period on the given channel, must
4192 * call back to ieee80211_ready_on_channel() when on that channel. Note
4193 * that normal channel traffic is not stopped as this is intended for hw
4194 * offload. Frames to transmit on the off-channel channel are transmitted
4195 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
4196 * duration (which will always be non-zero) expires, the driver must call
4197 * ieee80211_remain_on_channel_expired().
4198 * Note that this callback may be called while the device is in IDLE and
4199 * must be accepted in this case.
4200 * This callback may sleep.
4201 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
4202 * aborted before it expires. This callback may sleep.
4203 *
4204 * @set_ringparam: Set tx and rx ring sizes.
4205 *
4206 * @get_ringparam: Get tx and rx ring current and maximum sizes.
4207 *
4208 * @tx_frames_pending: Check if there is any pending frame in the hardware
4209 * queues before entering power save.
4210 *
4211 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
4212 * when transmitting a frame. Currently only legacy rates are handled.
4213 * The callback can sleep.
4214 * @event_callback: Notify driver about any event in mac80211. See
4215 * &enum ieee80211_event_type for the different types.
4216 * The callback must be atomic.
4217 *
4218 * @release_buffered_frames: Release buffered frames according to the given
4219 * parameters. In the case where the driver buffers some frames for
4220 * sleeping stations mac80211 will use this callback to tell the driver
4221 * to release some frames, either for PS-poll or uAPSD.
4222 * Note that if the @more_data parameter is %false the driver must check
4223 * if there are more frames on the given TIDs, and if there are more than
4224 * the frames being released then it must still set the more-data bit in
4225 * the frame. If the @more_data parameter is %true, then of course the
4226 * more-data bit must always be set.
4227 * The @tids parameter tells the driver which TIDs to release frames
4228 * from, for PS-poll it will always have only a single bit set.
4229 * In the case this is used for a PS-poll initiated release, the
4230 * @num_frames parameter will always be 1 so code can be shared. In
4231 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
4232 * on the TX status (and must report TX status) so that the PS-poll
4233 * period is properly ended. This is used to avoid sending multiple
4234 * responses for a retried PS-poll frame.
4235 * In the case this is used for uAPSD, the @num_frames parameter may be
4236 * bigger than one, but the driver may send fewer frames (it must send
4237 * at least one, however). In this case it is also responsible for
4238 * setting the EOSP flag in the QoS header of the frames. Also, when the
4239 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
4240 * on the last frame in the SP. Alternatively, it may call the function
4241 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
4242 * This callback must be atomic.
4243 * @allow_buffered_frames: Prepare device to allow the given number of frames
4244 * to go out to the given station. The frames will be sent by mac80211
4245 * via the usual TX path after this call. The TX information for frames
4246 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
4247 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
4248 * frames from multiple TIDs are released and the driver might reorder
4249 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
4250 * on the last frame and clear it on all others and also handle the EOSP
4251 * bit in the QoS header correctly. Alternatively, it can also call the
4252 * ieee80211_sta_eosp() function.
4253 * The @tids parameter is a bitmap and tells the driver which TIDs the
4254 * frames will be on; it will at most have two bits set.
4255 * This callback must be atomic.
4256 *
4257 * @get_et_sset_count: Ethtool API to get string-set count.
4258 * Note that the wiphy mutex is not held for this callback since it's
4259 * expected to return a static value.
4260 *
4261 * @get_et_stats: Ethtool API to get a set of u64 stats.
4262 *
4263 * @get_et_strings: Ethtool API to get a set of strings to describe stats
4264 * and perhaps other supported types of ethtool data-sets.
4265 * Note that the wiphy mutex is not held for this callback since it's
4266 * expected to return a static value.
4267 *
4268 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
4269 * before associated. In multi-channel scenarios, a virtual interface is
4270 * bound to a channel before it is associated, but as it isn't associated
4271 * yet it need not necessarily be given airtime, in particular since any
4272 * transmission to a P2P GO needs to be synchronized against the GO's
4273 * powersave state. mac80211 will call this function before transmitting a
4274 * management frame prior to transmitting that frame to allow the driver
4275 * to give it channel time for the transmission, to get a response and be
4276 * able to synchronize with the GO.
4277 * The callback will be called before each transmission and upon return
4278 * mac80211 will transmit the frame right away.
4279 * Additional information is passed in the &struct ieee80211_prep_tx_info
4280 * data. If duration there is greater than zero, mac80211 hints to the
4281 * driver the duration for which the operation is requested.
4282 * The callback is optional and can (should!) sleep.
4283 * @mgd_complete_tx: Notify the driver that the response frame for a previously
4284 * transmitted frame announced with @mgd_prepare_tx was received, the data
4285 * is filled similarly to @mgd_prepare_tx though the duration is not used.
4286 *
4287 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
4288 * a TDLS discovery-request, we expect a reply to arrive on the AP's
4289 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
4290 * setup-response is a direct packet not buffered by the AP.
4291 * mac80211 will call this function just before the transmission of a TDLS
4292 * discovery-request. The recommended period of protection is at least
4293 * 2 * (DTIM period).
4294 * The callback is optional and can sleep.
4295 *
4296 * @add_chanctx: Notifies device driver about new channel context creation.
4297 * This callback may sleep.
4298 * @remove_chanctx: Notifies device driver about channel context destruction.
4299 * This callback may sleep.
4300 * @change_chanctx: Notifies device driver about channel context changes that
4301 * may happen when combining different virtual interfaces on the same
4302 * channel context with different settings
4303 * This callback may sleep.
4304 * @assign_vif_chanctx: Notifies device driver about channel context being bound
4305 * to vif. Possible use is for hw queue remapping.
4306 * This callback may sleep.
4307 * @unassign_vif_chanctx: Notifies device driver about channel context being
4308 * unbound from vif.
4309 * This callback may sleep.
4310 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
4311 * another, as specified in the list of
4312 * @ieee80211_vif_chanctx_switch passed to the driver, according
4313 * to the mode defined in &ieee80211_chanctx_switch_mode.
4314 * This callback may sleep.
4315 *
4316 * @start_ap: Start operation on the AP interface, this is called after all the
4317 * information in bss_conf is set and beacon can be retrieved. A channel
4318 * context is bound before this is called. Note that if the driver uses
4319 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
4320 * just "paused" for scanning/ROC, which is indicated by the beacon being
4321 * disabled/enabled via @bss_info_changed.
4322 * @stop_ap: Stop operation on the AP interface.
4323 *
4324 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
4325 * during resume, when the reconfiguration has completed.
4326 * This can help the driver implement the reconfiguration step (and
4327 * indicate mac80211 is ready to receive frames).
4328 * This callback may sleep.
4329 *
4330 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
4331 * Currently, this is only called for managed or P2P client interfaces.
4332 * This callback is optional; it must not sleep.
4333 *
4334 * @channel_switch_beacon: Starts a channel switch to a new channel.
4335 * Beacons are modified to include CSA or ECSA IEs before calling this
4336 * function. The corresponding count fields in these IEs must be
4337 * decremented, and when they reach 1 the driver must call
4338 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
4339 * get the csa counter decremented by mac80211, but must check if it is
4340 * 1 using ieee80211_beacon_counter_is_complete() after the beacon has been
4341 * transmitted and then call ieee80211_csa_finish().
4342 * If the CSA count starts as zero or 1, this function will not be called,
4343 * since there won't be any time to beacon before the switch anyway.
4344 * @pre_channel_switch: This is an optional callback that is called
4345 * before a channel switch procedure is started (ie. when a STA
4346 * gets a CSA or a userspace initiated channel-switch), allowing
4347 * the driver to prepare for the channel switch.
4348 * @post_channel_switch: This is an optional callback that is called
4349 * after a channel switch procedure is completed, allowing the
4350 * driver to go back to a normal configuration.
4351 * @abort_channel_switch: This is an optional callback that is called
4352 * when channel switch procedure was aborted, allowing the
4353 * driver to go back to a normal configuration.
4354 * @channel_switch_rx_beacon: This is an optional callback that is called
4355 * when channel switch procedure is in progress and additional beacon with
4356 * CSA IE was received, allowing driver to track changes in count.
4357 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
4358 * information in bss_conf is set up and the beacon can be retrieved. A
4359 * channel context is bound before this is called.
4360 * @leave_ibss: Leave the IBSS again.
4361 *
4362 * @get_expected_throughput: extract the expected throughput towards the
4363 * specified station. The returned value is expressed in Kbps. It returns 0
4364 * if the RC algorithm does not have proper data to provide.
4365 *
4366 * @get_txpower: get current maximum tx power (in dBm) based on configuration
4367 * and hardware limits.
4368 *
4369 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
4370 * is responsible for continually initiating channel-switching operations
4371 * and returning to the base channel for communication with the AP. The
4372 * driver receives a channel-switch request template and the location of
4373 * the switch-timing IE within the template as part of the invocation.
4374 * The template is valid only within the call, and the driver can
4375 * optionally copy the skb for further re-use.
4376 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
4377 * peers must be on the base channel when the call completes.
4378 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
4379 * response) has been received from a remote peer. The driver gets
4380 * parameters parsed from the incoming frame and may use them to continue
4381 * an ongoing channel-switch operation. In addition, a channel-switch
4382 * response template is provided, together with the location of the
4383 * switch-timing IE within the template. The skb can only be used within
4384 * the function call.
4385 *
4386 * @wake_tx_queue: Called when new packets have been added to the queue.
4387 * @sync_rx_queues: Process all pending frames in RSS queues. This is a
4388 * synchronization which is needed in case driver has in its RSS queues
4389 * pending frames that were received prior to the control path action
4390 * currently taken (e.g. disassociation) but are not processed yet.
4391 *
4392 * @start_nan: join an existing NAN cluster, or create a new one.
4393 * @stop_nan: leave the NAN cluster.
4394 * @nan_change_conf: change NAN configuration. The data in cfg80211_nan_conf
4395 * contains full new configuration and changes specify which parameters
4396 * are changed with respect to the last NAN config.
4397 * The driver gets both full configuration and the changed parameters since
4398 * some devices may need the full configuration while others need only the
4399 * changed parameters.
4400 * @add_nan_func: Add a NAN function. Returns 0 on success. The data in
4401 * cfg80211_nan_func must not be referenced outside the scope of
4402 * this call.
4403 * @del_nan_func: Remove a NAN function. The driver must call
4404 * ieee80211_nan_func_terminated() with
4405 * NL80211_NAN_FUNC_TERM_REASON_USER_REQUEST reason code upon removal.
4406 * @can_aggregate_in_amsdu: Called in order to determine if HW supports
4407 * aggregating two specific frames in the same A-MSDU. The relation
4408 * between the skbs should be symmetric and transitive. Note that while
4409 * skb is always a real frame, head may or may not be an A-MSDU.
4410 * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
4411 * Statistics should be cumulative, currently no way to reset is provided.
4412 *
4413 * @start_pmsr: start peer measurement (e.g. FTM) (this call can sleep)
4414 * @abort_pmsr: abort peer measurement (this call can sleep)
4415 * @set_tid_config: Apply TID specific configurations. This callback may sleep.
4416 * @reset_tid_config: Reset TID specific configuration for the peer.
4417 * This callback may sleep.
4418 * @update_vif_offload: Update virtual interface offload flags
4419 * This callback may sleep.
4420 * @sta_set_4addr: Called to notify the driver when a station starts/stops using
4421 * 4-address mode
4422 * @set_sar_specs: Update the SAR (TX power) settings.
4423 * @sta_set_decap_offload: Called to notify the driver when a station is allowed
4424 * to use rx decapsulation offload
4425 * @add_twt_setup: Update hw with TWT agreement parameters received from the peer.
4426 * This callback allows the hw to check if requested parameters
4427 * are supported and if there is enough room for a new agreement.
4428 * The hw is expected to set agreement result in the req_type field of
4429 * twt structure.
4430 * @twt_teardown_request: Update the hw with TWT teardown request received
4431 * from the peer.
4432 * @set_radar_background: Configure dedicated offchannel chain available for
4433 * radar/CAC detection on some hw. This chain can't be used to transmit
4434 * or receive frames and it is bounded to a running wdev.
4435 * Background radar/CAC detection allows to avoid the CAC downtime
4436 * switching to a different channel during CAC detection on the selected
4437 * radar channel.
4438 * The caller is expected to set chandef pointer to NULL in order to
4439 * disable background CAC/radar detection.
4440 * @net_fill_forward_path: Called from .ndo_fill_forward_path in order to
4441 * resolve a path for hardware flow offloading
4442 * @can_activate_links: Checks if a specific active_links bitmap is
4443 * supported by the driver.
4444 * @change_vif_links: Change the valid links on an interface, note that while
4445 * removing the old link information is still valid (link_conf pointer),
4446 * but may immediately disappear after the function returns. The old or
4447 * new links bitmaps may be 0 if going from/to a non-MLO situation.
4448 * The @old array contains pointers to the old bss_conf structures
4449 * that were already removed, in case they're needed.
4450 * This callback can sleep.
4451 * @change_sta_links: Change the valid links of a station, similar to
4452 * @change_vif_links. This callback can sleep.
4453 * Note that a sta can also be inserted or removed with valid links,
4454 * i.e. passed to @sta_add/@sta_state with sta->valid_links not zero.
4455 * In fact, cannot change from having valid_links and not having them.
4456 * @set_hw_timestamp: Enable/disable HW timestamping of TM/FTM frames. This is
4457 * not restored at HW reset by mac80211 so drivers need to take care of
4458 * that.
4459 * @net_setup_tc: Called from .ndo_setup_tc in order to prepare hardware
4460 * flow offloading for flows originating from the vif.
4461 * Note that the driver must not assume that the vif driver_data is valid
4462 * at this point, since the callback can be called during netdev teardown.
4463 * @can_neg_ttlm: for managed interface, requests the driver to determine
4464 * if the requested TID-To-Link mapping can be accepted or not.
4465 * If it's not accepted the driver may suggest a preferred mapping and
4466 * modify @ttlm parameter with the suggested TID-to-Link mapping.
4467 * @prep_add_interface: prepare for interface addition. This can be used by
4468 * drivers to prepare for the addition of a new interface, e.g., allocate
4469 * the needed resources etc. This callback doesn't guarantee that an
4470 * interface with the specified type would be added, and thus drivers that
4471 * implement this callback need to handle such cases. The type is the full
4472 * &enum nl80211_iftype.
4473 */
4474struct ieee80211_ops {
4475 void (*tx)(struct ieee80211_hw *hw,
4476 struct ieee80211_tx_control *control,
4477 struct sk_buff *skb);
4478 int (*start)(struct ieee80211_hw *hw);
4479 void (*stop)(struct ieee80211_hw *hw, bool suspend);
4480#ifdef CONFIG_PM
4481 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
4482 int (*resume)(struct ieee80211_hw *hw);
4483 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
4484#endif
4485 int (*add_interface)(struct ieee80211_hw *hw,
4486 struct ieee80211_vif *vif);
4487 int (*change_interface)(struct ieee80211_hw *hw,
4488 struct ieee80211_vif *vif,
4489 enum nl80211_iftype new_type, bool p2p);
4490 void (*remove_interface)(struct ieee80211_hw *hw,
4491 struct ieee80211_vif *vif);
4492 int (*config)(struct ieee80211_hw *hw, u32 changed);
4493 void (*bss_info_changed)(struct ieee80211_hw *hw,
4494 struct ieee80211_vif *vif,
4495 struct ieee80211_bss_conf *info,
4496 u64 changed);
4497 void (*vif_cfg_changed)(struct ieee80211_hw *hw,
4498 struct ieee80211_vif *vif,
4499 u64 changed);
4500 void (*link_info_changed)(struct ieee80211_hw *hw,
4501 struct ieee80211_vif *vif,
4502 struct ieee80211_bss_conf *info,
4503 u64 changed);
4504
4505 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4506 struct ieee80211_bss_conf *link_conf);
4507 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4508 struct ieee80211_bss_conf *link_conf);
4509
4510 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
4511 struct netdev_hw_addr_list *mc_list);
4512 void (*configure_filter)(struct ieee80211_hw *hw,
4513 unsigned int changed_flags,
4514 unsigned int *total_flags,
4515 u64 multicast);
4516 void (*config_iface_filter)(struct ieee80211_hw *hw,
4517 struct ieee80211_vif *vif,
4518 unsigned int filter_flags,
4519 unsigned int changed_flags);
4520 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
4521 bool set);
4522 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
4523 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
4524 struct ieee80211_key_conf *key);
4525 void (*update_tkip_key)(struct ieee80211_hw *hw,
4526 struct ieee80211_vif *vif,
4527 struct ieee80211_key_conf *conf,
4528 struct ieee80211_sta *sta,
4529 u32 iv32, u16 *phase1key);
4530 void (*set_rekey_data)(struct ieee80211_hw *hw,
4531 struct ieee80211_vif *vif,
4532 struct cfg80211_gtk_rekey_data *data);
4533 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
4534 struct ieee80211_vif *vif, int idx);
4535 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4536 struct ieee80211_scan_request *req);
4537 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
4538 struct ieee80211_vif *vif);
4539 int (*sched_scan_start)(struct ieee80211_hw *hw,
4540 struct ieee80211_vif *vif,
4541 struct cfg80211_sched_scan_request *req,
4542 struct ieee80211_scan_ies *ies);
4543 int (*sched_scan_stop)(struct ieee80211_hw *hw,
4544 struct ieee80211_vif *vif);
4545 void (*sw_scan_start)(struct ieee80211_hw *hw,
4546 struct ieee80211_vif *vif,
4547 const u8 *mac_addr);
4548 void (*sw_scan_complete)(struct ieee80211_hw *hw,
4549 struct ieee80211_vif *vif);
4550 int (*get_stats)(struct ieee80211_hw *hw,
4551 struct ieee80211_low_level_stats *stats);
4552 void (*get_key_seq)(struct ieee80211_hw *hw,
4553 struct ieee80211_key_conf *key,
4554 struct ieee80211_key_seq *seq);
4555 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
4556 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
4557 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4558 struct ieee80211_sta *sta);
4559 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4560 struct ieee80211_sta *sta);
4561#ifdef CONFIG_MAC80211_DEBUGFS
4562 void (*vif_add_debugfs)(struct ieee80211_hw *hw,
4563 struct ieee80211_vif *vif);
4564 void (*link_add_debugfs)(struct ieee80211_hw *hw,
4565 struct ieee80211_vif *vif,
4566 struct ieee80211_bss_conf *link_conf,
4567 struct dentry *dir);
4568 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
4569 struct ieee80211_vif *vif,
4570 struct ieee80211_sta *sta,
4571 struct dentry *dir);
4572 void (*link_sta_add_debugfs)(struct ieee80211_hw *hw,
4573 struct ieee80211_vif *vif,
4574 struct ieee80211_link_sta *link_sta,
4575 struct dentry *dir);
4576#endif
4577 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4578 enum sta_notify_cmd, struct ieee80211_sta *sta);
4579 int (*sta_set_txpwr)(struct ieee80211_hw *hw,
4580 struct ieee80211_vif *vif,
4581 struct ieee80211_sta *sta);
4582 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4583 struct ieee80211_sta *sta,
4584 enum ieee80211_sta_state old_state,
4585 enum ieee80211_sta_state new_state);
4586 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
4587 struct ieee80211_vif *vif,
4588 struct ieee80211_sta *sta);
4589 void (*link_sta_rc_update)(struct ieee80211_hw *hw,
4590 struct ieee80211_vif *vif,
4591 struct ieee80211_link_sta *link_sta,
4592 u32 changed);
4593 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
4594 struct ieee80211_vif *vif,
4595 struct ieee80211_sta *sta);
4596 void (*sta_statistics)(struct ieee80211_hw *hw,
4597 struct ieee80211_vif *vif,
4598 struct ieee80211_sta *sta,
4599 struct station_info *sinfo);
4600 int (*conf_tx)(struct ieee80211_hw *hw,
4601 struct ieee80211_vif *vif,
4602 unsigned int link_id, u16 ac,
4603 const struct ieee80211_tx_queue_params *params);
4604 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4605 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4606 u64 tsf);
4607 void (*offset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4608 s64 offset);
4609 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4610 int (*tx_last_beacon)(struct ieee80211_hw *hw);
4611
4612 /**
4613 * @ampdu_action:
4614 * Perform a certain A-MPDU action.
4615 * The RA/TID combination determines the destination and TID we want
4616 * the ampdu action to be performed for. The action is defined through
4617 * ieee80211_ampdu_mlme_action.
4618 * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver
4619 * may neither send aggregates containing more subframes than @buf_size
4620 * nor send aggregates in a way that lost frames would exceed the
4621 * buffer size. If just limiting the aggregate size, this would be
4622 * possible with a buf_size of 8:
4623 *
4624 * - ``TX: 1.....7``
4625 * - ``RX: 2....7`` (lost frame #1)
4626 * - ``TX: 8..1...``
4627 *
4628 * which is invalid since #1 was now re-transmitted well past the
4629 * buffer size of 8. Correct ways to retransmit #1 would be:
4630 *
4631 * - ``TX: 1 or``
4632 * - ``TX: 18 or``
4633 * - ``TX: 81``
4634 *
4635 * Even ``189`` would be wrong since 1 could be lost again.
4636 *
4637 * Returns a negative error code on failure. The driver may return
4638 * %IEEE80211_AMPDU_TX_START_IMMEDIATE for %IEEE80211_AMPDU_TX_START
4639 * if the session can start immediately.
4640 *
4641 * The callback can sleep.
4642 */
4643 int (*ampdu_action)(struct ieee80211_hw *hw,
4644 struct ieee80211_vif *vif,
4645 struct ieee80211_ampdu_params *params);
4646 int (*get_survey)(struct ieee80211_hw *hw, int idx,
4647 struct survey_info *survey);
4648 void (*rfkill_poll)(struct ieee80211_hw *hw);
4649 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
4650#ifdef CONFIG_NL80211_TESTMODE
4651 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4652 void *data, int len);
4653 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
4654 struct netlink_callback *cb,
4655 void *data, int len);
4656#endif
4657 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4658 u32 queues, bool drop);
4659 void (*flush_sta)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4660 struct ieee80211_sta *sta);
4661 void (*channel_switch)(struct ieee80211_hw *hw,
4662 struct ieee80211_vif *vif,
4663 struct ieee80211_channel_switch *ch_switch);
4664 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
4665 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
4666
4667 int (*remain_on_channel)(struct ieee80211_hw *hw,
4668 struct ieee80211_vif *vif,
4669 struct ieee80211_channel *chan,
4670 int duration,
4671 enum ieee80211_roc_type type);
4672 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw,
4673 struct ieee80211_vif *vif);
4674 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
4675 void (*get_ringparam)(struct ieee80211_hw *hw,
4676 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
4677 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
4678 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4679 const struct cfg80211_bitrate_mask *mask);
4680 void (*event_callback)(struct ieee80211_hw *hw,
4681 struct ieee80211_vif *vif,
4682 const struct ieee80211_event *event);
4683
4684 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
4685 struct ieee80211_sta *sta,
4686 u16 tids, int num_frames,
4687 enum ieee80211_frame_release_type reason,
4688 bool more_data);
4689 void (*release_buffered_frames)(struct ieee80211_hw *hw,
4690 struct ieee80211_sta *sta,
4691 u16 tids, int num_frames,
4692 enum ieee80211_frame_release_type reason,
4693 bool more_data);
4694
4695 int (*get_et_sset_count)(struct ieee80211_hw *hw,
4696 struct ieee80211_vif *vif, int sset);
4697 void (*get_et_stats)(struct ieee80211_hw *hw,
4698 struct ieee80211_vif *vif,
4699 struct ethtool_stats *stats, u64 *data);
4700 void (*get_et_strings)(struct ieee80211_hw *hw,
4701 struct ieee80211_vif *vif,
4702 u32 sset, u8 *data);
4703
4704 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
4705 struct ieee80211_vif *vif,
4706 struct ieee80211_prep_tx_info *info);
4707 void (*mgd_complete_tx)(struct ieee80211_hw *hw,
4708 struct ieee80211_vif *vif,
4709 struct ieee80211_prep_tx_info *info);
4710
4711 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
4712 struct ieee80211_vif *vif,
4713 unsigned int link_id);
4714
4715 int (*add_chanctx)(struct ieee80211_hw *hw,
4716 struct ieee80211_chanctx_conf *ctx);
4717 void (*remove_chanctx)(struct ieee80211_hw *hw,
4718 struct ieee80211_chanctx_conf *ctx);
4719 void (*change_chanctx)(struct ieee80211_hw *hw,
4720 struct ieee80211_chanctx_conf *ctx,
4721 u32 changed);
4722 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
4723 struct ieee80211_vif *vif,
4724 struct ieee80211_bss_conf *link_conf,
4725 struct ieee80211_chanctx_conf *ctx);
4726 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
4727 struct ieee80211_vif *vif,
4728 struct ieee80211_bss_conf *link_conf,
4729 struct ieee80211_chanctx_conf *ctx);
4730 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
4731 struct ieee80211_vif_chanctx_switch *vifs,
4732 int n_vifs,
4733 enum ieee80211_chanctx_switch_mode mode);
4734
4735 void (*reconfig_complete)(struct ieee80211_hw *hw,
4736 enum ieee80211_reconfig_type reconfig_type);
4737
4738#if IS_ENABLED(CONFIG_IPV6)
4739 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
4740 struct ieee80211_vif *vif,
4741 struct inet6_dev *idev);
4742#endif
4743 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
4744 struct ieee80211_vif *vif,
4745 struct cfg80211_chan_def *chandef);
4746 int (*pre_channel_switch)(struct ieee80211_hw *hw,
4747 struct ieee80211_vif *vif,
4748 struct ieee80211_channel_switch *ch_switch);
4749
4750 int (*post_channel_switch)(struct ieee80211_hw *hw,
4751 struct ieee80211_vif *vif,
4752 struct ieee80211_bss_conf *link_conf);
4753 void (*abort_channel_switch)(struct ieee80211_hw *hw,
4754 struct ieee80211_vif *vif,
4755 struct ieee80211_bss_conf *link_conf);
4756 void (*channel_switch_rx_beacon)(struct ieee80211_hw *hw,
4757 struct ieee80211_vif *vif,
4758 struct ieee80211_channel_switch *ch_switch);
4759
4760 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4761 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4762 u32 (*get_expected_throughput)(struct ieee80211_hw *hw,
4763 struct ieee80211_sta *sta);
4764 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4765 int *dbm);
4766
4767 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
4768 struct ieee80211_vif *vif,
4769 struct ieee80211_sta *sta, u8 oper_class,
4770 struct cfg80211_chan_def *chandef,
4771 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
4772 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
4773 struct ieee80211_vif *vif,
4774 struct ieee80211_sta *sta);
4775 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
4776 struct ieee80211_vif *vif,
4777 struct ieee80211_tdls_ch_sw_params *params);
4778
4779 void (*wake_tx_queue)(struct ieee80211_hw *hw,
4780 struct ieee80211_txq *txq);
4781 void (*sync_rx_queues)(struct ieee80211_hw *hw);
4782
4783 int (*start_nan)(struct ieee80211_hw *hw,
4784 struct ieee80211_vif *vif,
4785 struct cfg80211_nan_conf *conf);
4786 int (*stop_nan)(struct ieee80211_hw *hw,
4787 struct ieee80211_vif *vif);
4788 int (*nan_change_conf)(struct ieee80211_hw *hw,
4789 struct ieee80211_vif *vif,
4790 struct cfg80211_nan_conf *conf, u32 changes);
4791 int (*add_nan_func)(struct ieee80211_hw *hw,
4792 struct ieee80211_vif *vif,
4793 const struct cfg80211_nan_func *nan_func);
4794 void (*del_nan_func)(struct ieee80211_hw *hw,
4795 struct ieee80211_vif *vif,
4796 u8 instance_id);
4797 bool (*can_aggregate_in_amsdu)(struct ieee80211_hw *hw,
4798 struct sk_buff *head,
4799 struct sk_buff *skb);
4800 int (*get_ftm_responder_stats)(struct ieee80211_hw *hw,
4801 struct ieee80211_vif *vif,
4802 struct cfg80211_ftm_responder_stats *ftm_stats);
4803 int (*start_pmsr)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4804 struct cfg80211_pmsr_request *request);
4805 void (*abort_pmsr)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4806 struct cfg80211_pmsr_request *request);
4807 int (*set_tid_config)(struct ieee80211_hw *hw,
4808 struct ieee80211_vif *vif,
4809 struct ieee80211_sta *sta,
4810 struct cfg80211_tid_config *tid_conf);
4811 int (*reset_tid_config)(struct ieee80211_hw *hw,
4812 struct ieee80211_vif *vif,
4813 struct ieee80211_sta *sta, u8 tids);
4814 void (*update_vif_offload)(struct ieee80211_hw *hw,
4815 struct ieee80211_vif *vif);
4816 void (*sta_set_4addr)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4817 struct ieee80211_sta *sta, bool enabled);
4818 int (*set_sar_specs)(struct ieee80211_hw *hw,
4819 const struct cfg80211_sar_specs *sar);
4820 void (*sta_set_decap_offload)(struct ieee80211_hw *hw,
4821 struct ieee80211_vif *vif,
4822 struct ieee80211_sta *sta, bool enabled);
4823 void (*add_twt_setup)(struct ieee80211_hw *hw,
4824 struct ieee80211_sta *sta,
4825 struct ieee80211_twt_setup *twt);
4826 void (*twt_teardown_request)(struct ieee80211_hw *hw,
4827 struct ieee80211_sta *sta, u8 flowid);
4828 int (*set_radar_background)(struct ieee80211_hw *hw,
4829 struct cfg80211_chan_def *chandef);
4830 int (*net_fill_forward_path)(struct ieee80211_hw *hw,
4831 struct ieee80211_vif *vif,
4832 struct ieee80211_sta *sta,
4833 struct net_device_path_ctx *ctx,
4834 struct net_device_path *path);
4835 bool (*can_activate_links)(struct ieee80211_hw *hw,
4836 struct ieee80211_vif *vif,
4837 u16 active_links);
4838 int (*change_vif_links)(struct ieee80211_hw *hw,
4839 struct ieee80211_vif *vif,
4840 u16 old_links, u16 new_links,
4841 struct ieee80211_bss_conf *old[IEEE80211_MLD_MAX_NUM_LINKS]);
4842 int (*change_sta_links)(struct ieee80211_hw *hw,
4843 struct ieee80211_vif *vif,
4844 struct ieee80211_sta *sta,
4845 u16 old_links, u16 new_links);
4846 int (*set_hw_timestamp)(struct ieee80211_hw *hw,
4847 struct ieee80211_vif *vif,
4848 struct cfg80211_set_hw_timestamp *hwts);
4849 int (*net_setup_tc)(struct ieee80211_hw *hw,
4850 struct ieee80211_vif *vif,
4851 struct net_device *dev,
4852 enum tc_setup_type type,
4853 void *type_data);
4854 enum ieee80211_neg_ttlm_res
4855 (*can_neg_ttlm)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4856 struct ieee80211_neg_ttlm *ttlm);
4857 void (*prep_add_interface)(struct ieee80211_hw *hw,
4858 enum nl80211_iftype type);
4859};
4860
4861/**
4862 * ieee80211_alloc_hw_nm - Allocate a new hardware device
4863 *
4864 * This must be called once for each hardware device. The returned pointer
4865 * must be used to refer to this device when calling other functions.
4866 * mac80211 allocates a private data area for the driver pointed to by
4867 * @priv in &struct ieee80211_hw, the size of this area is given as
4868 * @priv_data_len.
4869 *
4870 * @priv_data_len: length of private data
4871 * @ops: callbacks for this device
4872 * @requested_name: Requested name for this device.
4873 * NULL is valid value, and means use the default naming (phy%d)
4874 *
4875 * Return: A pointer to the new hardware device, or %NULL on error.
4876 */
4877struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
4878 const struct ieee80211_ops *ops,
4879 const char *requested_name);
4880
4881/**
4882 * ieee80211_alloc_hw - Allocate a new hardware device
4883 *
4884 * This must be called once for each hardware device. The returned pointer
4885 * must be used to refer to this device when calling other functions.
4886 * mac80211 allocates a private data area for the driver pointed to by
4887 * @priv in &struct ieee80211_hw, the size of this area is given as
4888 * @priv_data_len.
4889 *
4890 * @priv_data_len: length of private data
4891 * @ops: callbacks for this device
4892 *
4893 * Return: A pointer to the new hardware device, or %NULL on error.
4894 */
4895static inline
4896struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
4897 const struct ieee80211_ops *ops)
4898{
4899 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
4900}
4901
4902/**
4903 * ieee80211_register_hw - Register hardware device
4904 *
4905 * You must call this function before any other functions in
4906 * mac80211. Note that before a hardware can be registered, you
4907 * need to fill the contained wiphy's information.
4908 *
4909 * @hw: the device to register as returned by ieee80211_alloc_hw()
4910 *
4911 * Return: 0 on success. An error code otherwise.
4912 */
4913int ieee80211_register_hw(struct ieee80211_hw *hw);
4914
4915/**
4916 * struct ieee80211_tpt_blink - throughput blink description
4917 * @throughput: throughput in Kbit/sec
4918 * @blink_time: blink time in milliseconds
4919 * (full cycle, ie. one off + one on period)
4920 */
4921struct ieee80211_tpt_blink {
4922 int throughput;
4923 int blink_time;
4924};
4925
4926/**
4927 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
4928 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
4929 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
4930 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
4931 * interface is connected in some way, including being an AP
4932 */
4933enum ieee80211_tpt_led_trigger_flags {
4934 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
4935 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
4936 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
4937};
4938
4939#ifdef CONFIG_MAC80211_LEDS
4940const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
4941const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
4942const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
4943const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
4944const char *
4945__ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
4946 unsigned int flags,
4947 const struct ieee80211_tpt_blink *blink_table,
4948 unsigned int blink_table_len);
4949#endif
4950/**
4951 * ieee80211_get_tx_led_name - get name of TX LED
4952 *
4953 * mac80211 creates a transmit LED trigger for each wireless hardware
4954 * that can be used to drive LEDs if your driver registers a LED device.
4955 * This function returns the name (or %NULL if not configured for LEDs)
4956 * of the trigger so you can automatically link the LED device.
4957 *
4958 * @hw: the hardware to get the LED trigger name for
4959 *
4960 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4961 */
4962static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
4963{
4964#ifdef CONFIG_MAC80211_LEDS
4965 return __ieee80211_get_tx_led_name(hw);
4966#else
4967 return NULL;
4968#endif
4969}
4970
4971/**
4972 * ieee80211_get_rx_led_name - get name of RX LED
4973 *
4974 * mac80211 creates a receive LED trigger for each wireless hardware
4975 * that can be used to drive LEDs if your driver registers a LED device.
4976 * This function returns the name (or %NULL if not configured for LEDs)
4977 * of the trigger so you can automatically link the LED device.
4978 *
4979 * @hw: the hardware to get the LED trigger name for
4980 *
4981 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
4982 */
4983static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
4984{
4985#ifdef CONFIG_MAC80211_LEDS
4986 return __ieee80211_get_rx_led_name(hw);
4987#else
4988 return NULL;
4989#endif
4990}
4991
4992/**
4993 * ieee80211_get_assoc_led_name - get name of association LED
4994 *
4995 * mac80211 creates a association LED trigger for each wireless hardware
4996 * that can be used to drive LEDs if your driver registers a LED device.
4997 * This function returns the name (or %NULL if not configured for LEDs)
4998 * of the trigger so you can automatically link the LED device.
4999 *
5000 * @hw: the hardware to get the LED trigger name for
5001 *
5002 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
5003 */
5004static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
5005{
5006#ifdef CONFIG_MAC80211_LEDS
5007 return __ieee80211_get_assoc_led_name(hw);
5008#else
5009 return NULL;
5010#endif
5011}
5012
5013/**
5014 * ieee80211_get_radio_led_name - get name of radio LED
5015 *
5016 * mac80211 creates a radio change LED trigger for each wireless hardware
5017 * that can be used to drive LEDs if your driver registers a LED device.
5018 * This function returns the name (or %NULL if not configured for LEDs)
5019 * of the trigger so you can automatically link the LED device.
5020 *
5021 * @hw: the hardware to get the LED trigger name for
5022 *
5023 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
5024 */
5025static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
5026{
5027#ifdef CONFIG_MAC80211_LEDS
5028 return __ieee80211_get_radio_led_name(hw);
5029#else
5030 return NULL;
5031#endif
5032}
5033
5034/**
5035 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
5036 * @hw: the hardware to create the trigger for
5037 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
5038 * @blink_table: the blink table -- needs to be ordered by throughput
5039 * @blink_table_len: size of the blink table
5040 *
5041 * Return: %NULL (in case of error, or if no LED triggers are
5042 * configured) or the name of the new trigger.
5043 *
5044 * Note: This function must be called before ieee80211_register_hw().
5045 */
5046static inline const char *
5047ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
5048 const struct ieee80211_tpt_blink *blink_table,
5049 unsigned int blink_table_len)
5050{
5051#ifdef CONFIG_MAC80211_LEDS
5052 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
5053 blink_table_len);
5054#else
5055 return NULL;
5056#endif
5057}
5058
5059/**
5060 * ieee80211_unregister_hw - Unregister a hardware device
5061 *
5062 * This function instructs mac80211 to free allocated resources
5063 * and unregister netdevices from the networking subsystem.
5064 *
5065 * @hw: the hardware to unregister
5066 */
5067void ieee80211_unregister_hw(struct ieee80211_hw *hw);
5068
5069/**
5070 * ieee80211_free_hw - free hardware descriptor
5071 *
5072 * This function frees everything that was allocated, including the
5073 * private data for the driver. You must call ieee80211_unregister_hw()
5074 * before calling this function.
5075 *
5076 * @hw: the hardware to free
5077 */
5078void ieee80211_free_hw(struct ieee80211_hw *hw);
5079
5080/**
5081 * ieee80211_restart_hw - restart hardware completely
5082 *
5083 * Call this function when the hardware was restarted for some reason
5084 * (hardware error, ...) and the driver is unable to restore its state
5085 * by itself. mac80211 assumes that at this point the driver/hardware
5086 * is completely uninitialised and stopped, it starts the process by
5087 * calling the ->start() operation. The driver will need to reset all
5088 * internal state that it has prior to calling this function.
5089 *
5090 * @hw: the hardware to restart
5091 */
5092void ieee80211_restart_hw(struct ieee80211_hw *hw);
5093
5094/**
5095 * ieee80211_rx_list - receive frame and store processed skbs in a list
5096 *
5097 * Use this function to hand received frames to mac80211. The receive
5098 * buffer in @skb must start with an IEEE 802.11 header. In case of a
5099 * paged @skb is used, the driver is recommended to put the ieee80211
5100 * header of the frame on the linear part of the @skb to avoid memory
5101 * allocation and/or memcpy by the stack.
5102 *
5103 * This function may not be called in IRQ context. Calls to this function
5104 * for a single hardware must be synchronized against each other. Calls to
5105 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
5106 * mixed for a single hardware. Must not run concurrently with
5107 * ieee80211_tx_status_skb() or ieee80211_tx_status_ni().
5108 *
5109 * This function must be called with BHs disabled and RCU read lock
5110 *
5111 * @hw: the hardware this frame came in on
5112 * @sta: the station the frame was received from, or %NULL
5113 * @skb: the buffer to receive, owned by mac80211 after this call
5114 * @list: the destination list
5115 */
5116void ieee80211_rx_list(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
5117 struct sk_buff *skb, struct list_head *list);
5118
5119/**
5120 * ieee80211_rx_napi - receive frame from NAPI context
5121 *
5122 * Use this function to hand received frames to mac80211. The receive
5123 * buffer in @skb must start with an IEEE 802.11 header. In case of a
5124 * paged @skb is used, the driver is recommended to put the ieee80211
5125 * header of the frame on the linear part of the @skb to avoid memory
5126 * allocation and/or memcpy by the stack.
5127 *
5128 * This function may not be called in IRQ context. Calls to this function
5129 * for a single hardware must be synchronized against each other. Calls to
5130 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
5131 * mixed for a single hardware. Must not run concurrently with
5132 * ieee80211_tx_status_skb() or ieee80211_tx_status_ni().
5133 *
5134 * This function must be called with BHs disabled.
5135 *
5136 * @hw: the hardware this frame came in on
5137 * @sta: the station the frame was received from, or %NULL
5138 * @skb: the buffer to receive, owned by mac80211 after this call
5139 * @napi: the NAPI context
5140 */
5141void ieee80211_rx_napi(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
5142 struct sk_buff *skb, struct napi_struct *napi);
5143
5144/**
5145 * ieee80211_rx - receive frame
5146 *
5147 * Use this function to hand received frames to mac80211. The receive
5148 * buffer in @skb must start with an IEEE 802.11 header. In case of a
5149 * paged @skb is used, the driver is recommended to put the ieee80211
5150 * header of the frame on the linear part of the @skb to avoid memory
5151 * allocation and/or memcpy by the stack.
5152 *
5153 * This function may not be called in IRQ context. Calls to this function
5154 * for a single hardware must be synchronized against each other. Calls to
5155 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
5156 * mixed for a single hardware. Must not run concurrently with
5157 * ieee80211_tx_status_skb() or ieee80211_tx_status_ni().
5158 *
5159 * In process context use instead ieee80211_rx_ni().
5160 *
5161 * @hw: the hardware this frame came in on
5162 * @skb: the buffer to receive, owned by mac80211 after this call
5163 */
5164static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb)
5165{
5166 ieee80211_rx_napi(hw, NULL, skb, NULL);
5167}
5168
5169/**
5170 * ieee80211_rx_irqsafe - receive frame
5171 *
5172 * Like ieee80211_rx() but can be called in IRQ context
5173 * (internally defers to a tasklet.)
5174 *
5175 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
5176 * be mixed for a single hardware.Must not run concurrently with
5177 * ieee80211_tx_status_skb() or ieee80211_tx_status_ni().
5178 *
5179 * @hw: the hardware this frame came in on
5180 * @skb: the buffer to receive, owned by mac80211 after this call
5181 */
5182void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
5183
5184/**
5185 * ieee80211_rx_ni - receive frame (in process context)
5186 *
5187 * Like ieee80211_rx() but can be called in process context
5188 * (internally disables bottom halves).
5189 *
5190 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
5191 * not be mixed for a single hardware. Must not run concurrently with
5192 * ieee80211_tx_status_skb() or ieee80211_tx_status_ni().
5193 *
5194 * @hw: the hardware this frame came in on
5195 * @skb: the buffer to receive, owned by mac80211 after this call
5196 */
5197static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
5198 struct sk_buff *skb)
5199{
5200 local_bh_disable();
5201 ieee80211_rx(hw, skb);
5202 local_bh_enable();
5203}
5204
5205/**
5206 * ieee80211_sta_ps_transition - PS transition for connected sta
5207 *
5208 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
5209 * flag set, use this function to inform mac80211 about a connected station
5210 * entering/leaving PS mode.
5211 *
5212 * This function may not be called in IRQ context or with softirqs enabled.
5213 *
5214 * Calls to this function for a single hardware must be synchronized against
5215 * each other.
5216 *
5217 * @sta: currently connected sta
5218 * @start: start or stop PS
5219 *
5220 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
5221 */
5222int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
5223
5224/**
5225 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
5226 * (in process context)
5227 *
5228 * Like ieee80211_sta_ps_transition() but can be called in process context
5229 * (internally disables bottom halves). Concurrent call restriction still
5230 * applies.
5231 *
5232 * @sta: currently connected sta
5233 * @start: start or stop PS
5234 *
5235 * Return: Like ieee80211_sta_ps_transition().
5236 */
5237static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
5238 bool start)
5239{
5240 int ret;
5241
5242 local_bh_disable();
5243 ret = ieee80211_sta_ps_transition(sta, start);
5244 local_bh_enable();
5245
5246 return ret;
5247}
5248
5249/**
5250 * ieee80211_sta_pspoll - PS-Poll frame received
5251 * @sta: currently connected station
5252 *
5253 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
5254 * use this function to inform mac80211 that a PS-Poll frame from a
5255 * connected station was received.
5256 * This must be used in conjunction with ieee80211_sta_ps_transition()
5257 * and possibly ieee80211_sta_uapsd_trigger(); calls to all three must
5258 * be serialized.
5259 */
5260void ieee80211_sta_pspoll(struct ieee80211_sta *sta);
5261
5262/**
5263 * ieee80211_sta_uapsd_trigger - (potential) U-APSD trigger frame received
5264 * @sta: currently connected station
5265 * @tid: TID of the received (potential) trigger frame
5266 *
5267 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
5268 * use this function to inform mac80211 that a (potential) trigger frame
5269 * from a connected station was received.
5270 * This must be used in conjunction with ieee80211_sta_ps_transition()
5271 * and possibly ieee80211_sta_pspoll(); calls to all three must be
5272 * serialized.
5273 * %IEEE80211_NUM_TIDS can be passed as the tid if the tid is unknown.
5274 * In this case, mac80211 will not check that this tid maps to an AC
5275 * that is trigger enabled and assume that the caller did the proper
5276 * checks.
5277 */
5278void ieee80211_sta_uapsd_trigger(struct ieee80211_sta *sta, u8 tid);
5279
5280/*
5281 * The TX headroom reserved by mac80211 for its own tx_status functions.
5282 * This is enough for the radiotap header.
5283 */
5284#define IEEE80211_TX_STATUS_HEADROOM ALIGN(14, 4)
5285
5286/**
5287 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
5288 * @sta: &struct ieee80211_sta pointer for the sleeping station
5289 * @tid: the TID that has buffered frames
5290 * @buffered: indicates whether or not frames are buffered for this TID
5291 *
5292 * If a driver buffers frames for a powersave station instead of passing
5293 * them back to mac80211 for retransmission, the station may still need
5294 * to be told that there are buffered frames via the TIM bit.
5295 *
5296 * This function informs mac80211 whether or not there are frames that are
5297 * buffered in the driver for a given TID; mac80211 can then use this data
5298 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
5299 * call! Beware of the locking!)
5300 *
5301 * If all frames are released to the station (due to PS-poll or uAPSD)
5302 * then the driver needs to inform mac80211 that there no longer are
5303 * frames buffered. However, when the station wakes up mac80211 assumes
5304 * that all buffered frames will be transmitted and clears this data,
5305 * drivers need to make sure they inform mac80211 about all buffered
5306 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
5307 *
5308 * Note that technically mac80211 only needs to know this per AC, not per
5309 * TID, but since driver buffering will inevitably happen per TID (since
5310 * it is related to aggregation) it is easier to make mac80211 map the
5311 * TID to the AC as required instead of keeping track in all drivers that
5312 * use this API.
5313 */
5314void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
5315 u8 tid, bool buffered);
5316
5317/**
5318 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
5319 *
5320 * Call this function in a driver with per-packet rate selection support
5321 * to combine the rate info in the packet tx info with the most recent
5322 * rate selection table for the station entry.
5323 *
5324 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5325 * @sta: the receiver station to which this packet is sent.
5326 * @skb: the frame to be transmitted.
5327 * @dest: buffer for extracted rate/retry information
5328 * @max_rates: maximum number of rates to fetch
5329 */
5330void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
5331 struct ieee80211_sta *sta,
5332 struct sk_buff *skb,
5333 struct ieee80211_tx_rate *dest,
5334 int max_rates);
5335
5336/**
5337 * ieee80211_sta_set_expected_throughput - set the expected tpt for a station
5338 *
5339 * Call this function to notify mac80211 about a change in expected throughput
5340 * to a station. A driver for a device that does rate control in firmware can
5341 * call this function when the expected throughput estimate towards a station
5342 * changes. The information is used to tune the CoDel AQM applied to traffic
5343 * going towards that station (which can otherwise be too aggressive and cause
5344 * slow stations to starve).
5345 *
5346 * @pubsta: the station to set throughput for.
5347 * @thr: the current expected throughput in kbps.
5348 */
5349void ieee80211_sta_set_expected_throughput(struct ieee80211_sta *pubsta,
5350 u32 thr);
5351
5352/**
5353 * ieee80211_tx_rate_update - transmit rate update callback
5354 *
5355 * Drivers should call this functions with a non-NULL pub sta
5356 * This function can be used in drivers that does not have provision
5357 * in updating the tx rate in data path.
5358 *
5359 * @hw: the hardware the frame was transmitted by
5360 * @pubsta: the station to update the tx rate for.
5361 * @info: tx status information
5362 */
5363void ieee80211_tx_rate_update(struct ieee80211_hw *hw,
5364 struct ieee80211_sta *pubsta,
5365 struct ieee80211_tx_info *info);
5366
5367/**
5368 * ieee80211_tx_status_skb - transmit status callback
5369 *
5370 * Call this function for all transmitted frames after they have been
5371 * transmitted. It is permissible to not call this function for
5372 * multicast frames but this can affect statistics.
5373 *
5374 * This function may not be called in IRQ context. Calls to this function
5375 * for a single hardware must be synchronized against each other. Calls
5376 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
5377 * may not be mixed for a single hardware. Must not run concurrently with
5378 * ieee80211_rx() or ieee80211_rx_ni().
5379 *
5380 * @hw: the hardware the frame was transmitted by
5381 * @skb: the frame that was transmitted, owned by mac80211 after this call
5382 */
5383void ieee80211_tx_status_skb(struct ieee80211_hw *hw,
5384 struct sk_buff *skb);
5385
5386/**
5387 * ieee80211_tx_status_ext - extended transmit status callback
5388 *
5389 * This function can be used as a replacement for ieee80211_tx_status_skb()
5390 * in drivers that may want to provide extra information that does not
5391 * fit into &struct ieee80211_tx_info.
5392 *
5393 * Calls to this function for a single hardware must be synchronized
5394 * against each other. Calls to this function, ieee80211_tx_status_ni()
5395 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
5396 *
5397 * @hw: the hardware the frame was transmitted by
5398 * @status: tx status information
5399 */
5400void ieee80211_tx_status_ext(struct ieee80211_hw *hw,
5401 struct ieee80211_tx_status *status);
5402
5403/**
5404 * ieee80211_tx_status_noskb - transmit status callback without skb
5405 *
5406 * This function can be used as a replacement for ieee80211_tx_status_skb()
5407 * in drivers that cannot reliably map tx status information back to
5408 * specific skbs.
5409 *
5410 * Calls to this function for a single hardware must be synchronized
5411 * against each other. Calls to this function, ieee80211_tx_status_ni()
5412 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
5413 *
5414 * @hw: the hardware the frame was transmitted by
5415 * @sta: the receiver station to which this packet is sent
5416 * (NULL for multicast packets)
5417 * @info: tx status information
5418 */
5419static inline void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
5420 struct ieee80211_sta *sta,
5421 struct ieee80211_tx_info *info)
5422{
5423 struct ieee80211_tx_status status = {
5424 .sta = sta,
5425 .info = info,
5426 };
5427
5428 ieee80211_tx_status_ext(hw, &status);
5429}
5430
5431/**
5432 * ieee80211_tx_status_ni - transmit status callback (in process context)
5433 *
5434 * Like ieee80211_tx_status_skb() but can be called in process context.
5435 *
5436 * Calls to this function, ieee80211_tx_status_skb() and
5437 * ieee80211_tx_status_irqsafe() may not be mixed
5438 * for a single hardware.
5439 *
5440 * @hw: the hardware the frame was transmitted by
5441 * @skb: the frame that was transmitted, owned by mac80211 after this call
5442 */
5443static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
5444 struct sk_buff *skb)
5445{
5446 local_bh_disable();
5447 ieee80211_tx_status_skb(hw, skb);
5448 local_bh_enable();
5449}
5450
5451/**
5452 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
5453 *
5454 * Like ieee80211_tx_status_skb() but can be called in IRQ context
5455 * (internally defers to a tasklet.)
5456 *
5457 * Calls to this function, ieee80211_tx_status_skb() and
5458 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
5459 *
5460 * @hw: the hardware the frame was transmitted by
5461 * @skb: the frame that was transmitted, owned by mac80211 after this call
5462 */
5463void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
5464 struct sk_buff *skb);
5465
5466/**
5467 * ieee80211_report_low_ack - report non-responding station
5468 *
5469 * When operating in AP-mode, call this function to report a non-responding
5470 * connected STA.
5471 *
5472 * @sta: the non-responding connected sta
5473 * @num_packets: number of packets sent to @sta without a response
5474 */
5475void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
5476
5477#define IEEE80211_MAX_CNTDWN_COUNTERS_NUM 2
5478
5479/**
5480 * struct ieee80211_mutable_offsets - mutable beacon offsets
5481 * @tim_offset: position of TIM element
5482 * @tim_length: size of TIM element
5483 * @cntdwn_counter_offs: array of IEEE80211_MAX_CNTDWN_COUNTERS_NUM offsets
5484 * to countdown counters. This array can contain zero values which
5485 * should be ignored.
5486 * @mbssid_off: position of the multiple bssid element
5487 */
5488struct ieee80211_mutable_offsets {
5489 u16 tim_offset;
5490 u16 tim_length;
5491
5492 u16 cntdwn_counter_offs[IEEE80211_MAX_CNTDWN_COUNTERS_NUM];
5493 u16 mbssid_off;
5494};
5495
5496/**
5497 * ieee80211_beacon_get_template - beacon template generation function
5498 * @hw: pointer obtained from ieee80211_alloc_hw().
5499 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5500 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
5501 * receive the offsets that may be updated by the driver.
5502 * @link_id: the link id to which the beacon belongs (or 0 for an AP STA
5503 * that is not associated with AP MLD).
5504 *
5505 * If the driver implements beaconing modes, it must use this function to
5506 * obtain the beacon template.
5507 *
5508 * This function should be used if the beacon frames are generated by the
5509 * device, and then the driver must use the returned beacon as the template
5510 * The driver or the device are responsible to update the DTIM and, when
5511 * applicable, the CSA count.
5512 *
5513 * The driver is responsible for freeing the returned skb.
5514 *
5515 * Return: The beacon template. %NULL on error.
5516 */
5517struct sk_buff *
5518ieee80211_beacon_get_template(struct ieee80211_hw *hw,
5519 struct ieee80211_vif *vif,
5520 struct ieee80211_mutable_offsets *offs,
5521 unsigned int link_id);
5522
5523/**
5524 * ieee80211_beacon_get_template_ema_index - EMA beacon template generation
5525 * @hw: pointer obtained from ieee80211_alloc_hw().
5526 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5527 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
5528 * receive the offsets that may be updated by the driver.
5529 * @link_id: the link id to which the beacon belongs (or 0 for a non-MLD AP).
5530 * @ema_index: index of the beacon in the EMA set.
5531 *
5532 * This function follows the same rules as ieee80211_beacon_get_template()
5533 * but returns a beacon template which includes multiple BSSID element at the
5534 * requested index.
5535 *
5536 * Return: The beacon template. %NULL indicates the end of EMA templates.
5537 */
5538struct sk_buff *
5539ieee80211_beacon_get_template_ema_index(struct ieee80211_hw *hw,
5540 struct ieee80211_vif *vif,
5541 struct ieee80211_mutable_offsets *offs,
5542 unsigned int link_id, u8 ema_index);
5543
5544/**
5545 * struct ieee80211_ema_beacons - List of EMA beacons
5546 * @cnt: count of EMA beacons.
5547 *
5548 * @bcn: array of EMA beacons.
5549 * @bcn.skb: the skb containing this specific beacon
5550 * @bcn.offs: &struct ieee80211_mutable_offsets pointer to struct that will
5551 * receive the offsets that may be updated by the driver.
5552 */
5553struct ieee80211_ema_beacons {
5554 u8 cnt;
5555 struct {
5556 struct sk_buff *skb;
5557 struct ieee80211_mutable_offsets offs;
5558 } bcn[];
5559};
5560
5561/**
5562 * ieee80211_beacon_get_template_ema_list - EMA beacon template generation
5563 * @hw: pointer obtained from ieee80211_alloc_hw().
5564 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5565 * @link_id: the link id to which the beacon belongs (or 0 for a non-MLD AP)
5566 *
5567 * This function follows the same rules as ieee80211_beacon_get_template()
5568 * but allocates and returns a pointer to list of all beacon templates required
5569 * to cover all profiles in the multiple BSSID set. Each template includes only
5570 * one multiple BSSID element.
5571 *
5572 * Driver must call ieee80211_beacon_free_ema_list() to free the memory.
5573 *
5574 * Return: EMA beacon templates of type struct ieee80211_ema_beacons *.
5575 * %NULL on error.
5576 */
5577struct ieee80211_ema_beacons *
5578ieee80211_beacon_get_template_ema_list(struct ieee80211_hw *hw,
5579 struct ieee80211_vif *vif,
5580 unsigned int link_id);
5581
5582/**
5583 * ieee80211_beacon_free_ema_list - free an EMA beacon template list
5584 * @ema_beacons: list of EMA beacons of type &struct ieee80211_ema_beacons pointers.
5585 *
5586 * This function will free a list previously acquired by calling
5587 * ieee80211_beacon_get_template_ema_list()
5588 */
5589void ieee80211_beacon_free_ema_list(struct ieee80211_ema_beacons *ema_beacons);
5590
5591/**
5592 * ieee80211_beacon_get_tim - beacon generation function
5593 * @hw: pointer obtained from ieee80211_alloc_hw().
5594 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5595 * @tim_offset: pointer to variable that will receive the TIM IE offset.
5596 * Set to 0 if invalid (in non-AP modes).
5597 * @tim_length: pointer to variable that will receive the TIM IE length,
5598 * (including the ID and length bytes!).
5599 * Set to 0 if invalid (in non-AP modes).
5600 * @link_id: the link id to which the beacon belongs (or 0 for an AP STA
5601 * that is not associated with AP MLD).
5602 *
5603 * If the driver implements beaconing modes, it must use this function to
5604 * obtain the beacon frame.
5605 *
5606 * If the beacon frames are generated by the host system (i.e., not in
5607 * hardware/firmware), the driver uses this function to get each beacon
5608 * frame from mac80211 -- it is responsible for calling this function exactly
5609 * once before the beacon is needed (e.g. based on hardware interrupt).
5610 *
5611 * The driver is responsible for freeing the returned skb.
5612 *
5613 * Return: The beacon template. %NULL on error.
5614 */
5615struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
5616 struct ieee80211_vif *vif,
5617 u16 *tim_offset, u16 *tim_length,
5618 unsigned int link_id);
5619
5620/**
5621 * ieee80211_beacon_get - beacon generation function
5622 * @hw: pointer obtained from ieee80211_alloc_hw().
5623 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5624 * @link_id: the link id to which the beacon belongs (or 0 for an AP STA
5625 * that is not associated with AP MLD).
5626 *
5627 * See ieee80211_beacon_get_tim().
5628 *
5629 * Return: See ieee80211_beacon_get_tim().
5630 */
5631static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
5632 struct ieee80211_vif *vif,
5633 unsigned int link_id)
5634{
5635 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL, link_id);
5636}
5637
5638/**
5639 * ieee80211_beacon_update_cntdwn - request mac80211 to decrement the beacon countdown
5640 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5641 * @link_id: valid link_id during MLO or 0 for non-MLO
5642 *
5643 * The beacon counter should be updated after each beacon transmission.
5644 * This function is called implicitly when
5645 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
5646 * beacon frames are generated by the device, the driver should call this
5647 * function after each beacon transmission to sync mac80211's beacon countdown.
5648 *
5649 * Return: new countdown value
5650 */
5651u8 ieee80211_beacon_update_cntdwn(struct ieee80211_vif *vif,
5652 unsigned int link_id);
5653
5654/**
5655 * ieee80211_beacon_set_cntdwn - request mac80211 to set beacon countdown
5656 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5657 * @counter: the new value for the counter
5658 *
5659 * The beacon countdown can be changed by the device, this API should be
5660 * used by the device driver to update csa counter in mac80211.
5661 *
5662 * It should never be used together with ieee80211_beacon_update_cntdwn(),
5663 * as it will cause a race condition around the counter value.
5664 */
5665void ieee80211_beacon_set_cntdwn(struct ieee80211_vif *vif, u8 counter);
5666
5667/**
5668 * ieee80211_csa_finish - notify mac80211 about channel switch
5669 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5670 * @link_id: valid link_id during MLO or 0 for non-MLO
5671 *
5672 * After a channel switch announcement was scheduled and the counter in this
5673 * announcement hits 1, this function must be called by the driver to
5674 * notify mac80211 that the channel can be changed.
5675 */
5676void ieee80211_csa_finish(struct ieee80211_vif *vif, unsigned int link_id);
5677
5678/**
5679 * ieee80211_beacon_cntdwn_is_complete - find out if countdown reached 1
5680 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5681 * @link_id: valid link_id during MLO or 0 for non-MLO
5682 *
5683 * Return: %true if the countdown reached 1, %false otherwise
5684 */
5685bool ieee80211_beacon_cntdwn_is_complete(struct ieee80211_vif *vif,
5686 unsigned int link_id);
5687
5688/**
5689 * ieee80211_color_change_finish - notify mac80211 about color change
5690 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5691 * @link_id: valid link_id during MLO or 0 for non-MLO
5692 *
5693 * After a color change announcement was scheduled and the counter in this
5694 * announcement hits 1, this function must be called by the driver to
5695 * notify mac80211 that the color can be changed
5696 */
5697void ieee80211_color_change_finish(struct ieee80211_vif *vif, u8 link_id);
5698
5699/**
5700 * ieee80211_proberesp_get - retrieve a Probe Response template
5701 * @hw: pointer obtained from ieee80211_alloc_hw().
5702 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5703 *
5704 * Creates a Probe Response template which can, for example, be uploaded to
5705 * hardware. The destination address should be set by the caller.
5706 *
5707 * Can only be called in AP mode.
5708 *
5709 * Return: The Probe Response template. %NULL on error.
5710 */
5711struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
5712 struct ieee80211_vif *vif);
5713
5714/**
5715 * ieee80211_pspoll_get - retrieve a PS Poll template
5716 * @hw: pointer obtained from ieee80211_alloc_hw().
5717 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5718 *
5719 * Creates a PS Poll a template which can, for example, uploaded to
5720 * hardware. The template must be updated after association so that correct
5721 * AID, BSSID and MAC address is used.
5722 *
5723 * Note: Caller (or hardware) is responsible for setting the
5724 * &IEEE80211_FCTL_PM bit.
5725 *
5726 * Return: The PS Poll template. %NULL on error.
5727 */
5728struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
5729 struct ieee80211_vif *vif);
5730
5731/**
5732 * ieee80211_nullfunc_get - retrieve a nullfunc template
5733 * @hw: pointer obtained from ieee80211_alloc_hw().
5734 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5735 * @link_id: If the vif is an MLD, get a frame with the link addresses
5736 * for the given link ID. For a link_id < 0 you get a frame with
5737 * MLD addresses, however useful that might be.
5738 * @qos_ok: QoS NDP is acceptable to the caller, this should be set
5739 * if at all possible
5740 *
5741 * Creates a Nullfunc template which can, for example, uploaded to
5742 * hardware. The template must be updated after association so that correct
5743 * BSSID and address is used.
5744 *
5745 * If @qos_ndp is set and the association is to an AP with QoS/WMM, the
5746 * returned packet will be QoS NDP.
5747 *
5748 * Note: Caller (or hardware) is responsible for setting the
5749 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
5750 *
5751 * Return: The nullfunc template. %NULL on error.
5752 */
5753struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
5754 struct ieee80211_vif *vif,
5755 int link_id, bool qos_ok);
5756
5757/**
5758 * ieee80211_probereq_get - retrieve a Probe Request template
5759 * @hw: pointer obtained from ieee80211_alloc_hw().
5760 * @src_addr: source MAC address
5761 * @ssid: SSID buffer
5762 * @ssid_len: length of SSID
5763 * @tailroom: tailroom to reserve at end of SKB for IEs
5764 *
5765 * Creates a Probe Request template which can, for example, be uploaded to
5766 * hardware.
5767 *
5768 * Return: The Probe Request template. %NULL on error.
5769 */
5770struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
5771 const u8 *src_addr,
5772 const u8 *ssid, size_t ssid_len,
5773 size_t tailroom);
5774
5775/**
5776 * ieee80211_rts_get - RTS frame generation function
5777 * @hw: pointer obtained from ieee80211_alloc_hw().
5778 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5779 * @frame: pointer to the frame that is going to be protected by the RTS.
5780 * @frame_len: the frame length (in octets).
5781 * @frame_txctl: &struct ieee80211_tx_info of the frame.
5782 * @rts: The buffer where to store the RTS frame.
5783 *
5784 * If the RTS frames are generated by the host system (i.e., not in
5785 * hardware/firmware), the low-level driver uses this function to receive
5786 * the next RTS frame from the 802.11 code. The low-level is responsible
5787 * for calling this function before and RTS frame is needed.
5788 */
5789void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
5790 const void *frame, size_t frame_len,
5791 const struct ieee80211_tx_info *frame_txctl,
5792 struct ieee80211_rts *rts);
5793
5794/**
5795 * ieee80211_rts_duration - Get the duration field for an RTS frame
5796 * @hw: pointer obtained from ieee80211_alloc_hw().
5797 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5798 * @frame_len: the length of the frame that is going to be protected by the RTS.
5799 * @frame_txctl: &struct ieee80211_tx_info of the frame.
5800 *
5801 * If the RTS is generated in firmware, but the host system must provide
5802 * the duration field, the low-level driver uses this function to receive
5803 * the duration field value in little-endian byteorder.
5804 *
5805 * Return: The duration.
5806 */
5807__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
5808 struct ieee80211_vif *vif, size_t frame_len,
5809 const struct ieee80211_tx_info *frame_txctl);
5810
5811/**
5812 * ieee80211_ctstoself_get - CTS-to-self frame generation function
5813 * @hw: pointer obtained from ieee80211_alloc_hw().
5814 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5815 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
5816 * @frame_len: the frame length (in octets).
5817 * @frame_txctl: &struct ieee80211_tx_info of the frame.
5818 * @cts: The buffer where to store the CTS-to-self frame.
5819 *
5820 * If the CTS-to-self frames are generated by the host system (i.e., not in
5821 * hardware/firmware), the low-level driver uses this function to receive
5822 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
5823 * for calling this function before and CTS-to-self frame is needed.
5824 */
5825void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
5826 struct ieee80211_vif *vif,
5827 const void *frame, size_t frame_len,
5828 const struct ieee80211_tx_info *frame_txctl,
5829 struct ieee80211_cts *cts);
5830
5831/**
5832 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
5833 * @hw: pointer obtained from ieee80211_alloc_hw().
5834 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5835 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
5836 * @frame_txctl: &struct ieee80211_tx_info of the frame.
5837 *
5838 * If the CTS-to-self is generated in firmware, but the host system must provide
5839 * the duration field, the low-level driver uses this function to receive
5840 * the duration field value in little-endian byteorder.
5841 *
5842 * Return: The duration.
5843 */
5844__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
5845 struct ieee80211_vif *vif,
5846 size_t frame_len,
5847 const struct ieee80211_tx_info *frame_txctl);
5848
5849/**
5850 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
5851 * @hw: pointer obtained from ieee80211_alloc_hw().
5852 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5853 * @band: the band to calculate the frame duration on
5854 * @frame_len: the length of the frame.
5855 * @rate: the rate at which the frame is going to be transmitted.
5856 *
5857 * Calculate the duration field of some generic frame, given its
5858 * length and transmission rate (in 100kbps).
5859 *
5860 * Return: The duration.
5861 */
5862__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
5863 struct ieee80211_vif *vif,
5864 enum nl80211_band band,
5865 size_t frame_len,
5866 struct ieee80211_rate *rate);
5867
5868/**
5869 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
5870 * @hw: pointer as obtained from ieee80211_alloc_hw().
5871 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5872 *
5873 * Function for accessing buffered broadcast and multicast frames. If
5874 * hardware/firmware does not implement buffering of broadcast/multicast
5875 * frames when power saving is used, 802.11 code buffers them in the host
5876 * memory. The low-level driver uses this function to fetch next buffered
5877 * frame. In most cases, this is used when generating beacon frame.
5878 *
5879 * Return: A pointer to the next buffered skb or NULL if no more buffered
5880 * frames are available.
5881 *
5882 * Note: buffered frames are returned only after DTIM beacon frame was
5883 * generated with ieee80211_beacon_get() and the low-level driver must thus
5884 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
5885 * NULL if the previous generated beacon was not DTIM, so the low-level driver
5886 * does not need to check for DTIM beacons separately and should be able to
5887 * use common code for all beacons.
5888 */
5889struct sk_buff *
5890ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
5891
5892/**
5893 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
5894 *
5895 * This function returns the TKIP phase 1 key for the given IV32.
5896 *
5897 * @keyconf: the parameter passed with the set key
5898 * @iv32: IV32 to get the P1K for
5899 * @p1k: a buffer to which the key will be written, as 5 u16 values
5900 */
5901void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
5902 u32 iv32, u16 *p1k);
5903
5904/**
5905 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
5906 *
5907 * This function returns the TKIP phase 1 key for the IV32 taken
5908 * from the given packet.
5909 *
5910 * @keyconf: the parameter passed with the set key
5911 * @skb: the packet to take the IV32 value from that will be encrypted
5912 * with this P1K
5913 * @p1k: a buffer to which the key will be written, as 5 u16 values
5914 */
5915static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
5916 struct sk_buff *skb, u16 *p1k)
5917{
5918 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
5919 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
5920 u32 iv32 = get_unaligned_le32(&data[4]);
5921
5922 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
5923}
5924
5925/**
5926 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
5927 *
5928 * This function returns the TKIP phase 1 key for the given IV32
5929 * and transmitter address.
5930 *
5931 * @keyconf: the parameter passed with the set key
5932 * @ta: TA that will be used with the key
5933 * @iv32: IV32 to get the P1K for
5934 * @p1k: a buffer to which the key will be written, as 5 u16 values
5935 */
5936void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
5937 const u8 *ta, u32 iv32, u16 *p1k);
5938
5939/**
5940 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
5941 *
5942 * This function computes the TKIP RC4 key for the IV values
5943 * in the packet.
5944 *
5945 * @keyconf: the parameter passed with the set key
5946 * @skb: the packet to take the IV32/IV16 values from that will be
5947 * encrypted with this key
5948 * @p2k: a buffer to which the key will be written, 16 bytes
5949 */
5950void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
5951 struct sk_buff *skb, u8 *p2k);
5952
5953/**
5954 * ieee80211_tkip_add_iv - write TKIP IV and Ext. IV to pos
5955 *
5956 * @pos: start of crypto header
5957 * @keyconf: the parameter passed with the set key
5958 * @pn: PN to add
5959 *
5960 * Returns: pointer to the octet following IVs (i.e. beginning of
5961 * the packet payload)
5962 *
5963 * This function writes the tkip IV value to pos (which should
5964 * point to the crypto header)
5965 */
5966u8 *ieee80211_tkip_add_iv(u8 *pos, struct ieee80211_key_conf *keyconf, u64 pn);
5967
5968/**
5969 * ieee80211_get_key_rx_seq - get key RX sequence counter
5970 *
5971 * @keyconf: the parameter passed with the set key
5972 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
5973 * the value on TID 0 is also used for non-QoS frames. For
5974 * CMAC, only TID 0 is valid.
5975 * @seq: buffer to receive the sequence data
5976 *
5977 * This function allows a driver to retrieve the current RX IV/PNs
5978 * for the given key. It must not be called if IV checking is done
5979 * by the device and not by mac80211.
5980 *
5981 * Note that this function may only be called when no RX processing
5982 * can be done concurrently.
5983 */
5984void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
5985 int tid, struct ieee80211_key_seq *seq);
5986
5987/**
5988 * ieee80211_set_key_rx_seq - set key RX sequence counter
5989 *
5990 * @keyconf: the parameter passed with the set key
5991 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
5992 * the value on TID 0 is also used for non-QoS frames. For
5993 * CMAC, only TID 0 is valid.
5994 * @seq: new sequence data
5995 *
5996 * This function allows a driver to set the current RX IV/PNs for the
5997 * given key. This is useful when resuming from WoWLAN sleep and GTK
5998 * rekey may have been done while suspended. It should not be called
5999 * if IV checking is done by the device and not by mac80211.
6000 *
6001 * Note that this function may only be called when no RX processing
6002 * can be done concurrently.
6003 */
6004void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
6005 int tid, struct ieee80211_key_seq *seq);
6006
6007/**
6008 * ieee80211_remove_key - remove the given key
6009 * @keyconf: the parameter passed with the set key
6010 *
6011 * Context: Must be called with the wiphy mutex held.
6012 *
6013 * Remove the given key. If the key was uploaded to the hardware at the
6014 * time this function is called, it is not deleted in the hardware but
6015 * instead assumed to have been removed already.
6016 */
6017void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
6018
6019/**
6020 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
6021 * @vif: the virtual interface to add the key on
6022 * @keyconf: new key data
6023 * @link_id: the link id of the key or -1 for non-MLO
6024 *
6025 * When GTK rekeying was done while the system was suspended, (a) new
6026 * key(s) will be available. These will be needed by mac80211 for proper
6027 * RX processing, so this function allows setting them.
6028 *
6029 * Return: the newly allocated key structure, which will have
6030 * similar contents to the passed key configuration but point to
6031 * mac80211-owned memory. In case of errors, the function returns an
6032 * ERR_PTR(), use IS_ERR() etc.
6033 *
6034 * Note that this function assumes the key isn't added to hardware
6035 * acceleration, so no TX will be done with the key. Since it's a GTK
6036 * on managed (station) networks, this is true anyway. If the driver
6037 * calls this function from the resume callback and subsequently uses
6038 * the return code 1 to reconfigure the device, this key will be part
6039 * of the reconfiguration.
6040 *
6041 * Note that the driver should also call ieee80211_set_key_rx_seq()
6042 * for the new key for each TID to set up sequence counters properly.
6043 *
6044 * IMPORTANT: If this replaces a key that is present in the hardware,
6045 * then it will attempt to remove it during this call. In many cases
6046 * this isn't what you want, so call ieee80211_remove_key() first for
6047 * the key that's being replaced.
6048 */
6049struct ieee80211_key_conf *
6050ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
6051 struct ieee80211_key_conf *keyconf,
6052 int link_id);
6053
6054/**
6055 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
6056 * @vif: virtual interface the rekeying was done on
6057 * @bssid: The BSSID of the AP, for checking association
6058 * @replay_ctr: the new replay counter after GTK rekeying
6059 * @gfp: allocation flags
6060 */
6061void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
6062 const u8 *replay_ctr, gfp_t gfp);
6063
6064/**
6065 * ieee80211_key_mic_failure - increment MIC failure counter for the key
6066 *
6067 * Note: this is really only safe if no other RX function is called
6068 * at the same time.
6069 *
6070 * @keyconf: the key in question
6071 */
6072void ieee80211_key_mic_failure(struct ieee80211_key_conf *keyconf);
6073
6074/**
6075 * ieee80211_key_replay - increment replay counter for the key
6076 *
6077 * Note: this is really only safe if no other RX function is called
6078 * at the same time.
6079 *
6080 * @keyconf: the key in question
6081 */
6082void ieee80211_key_replay(struct ieee80211_key_conf *keyconf);
6083
6084/**
6085 * ieee80211_wake_queue - wake specific queue
6086 * @hw: pointer as obtained from ieee80211_alloc_hw().
6087 * @queue: queue number (counted from zero).
6088 *
6089 * Drivers must use this function instead of netif_wake_queue.
6090 */
6091void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
6092
6093/**
6094 * ieee80211_stop_queue - stop specific queue
6095 * @hw: pointer as obtained from ieee80211_alloc_hw().
6096 * @queue: queue number (counted from zero).
6097 *
6098 * Drivers must use this function instead of netif_stop_queue.
6099 */
6100void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
6101
6102/**
6103 * ieee80211_queue_stopped - test status of the queue
6104 * @hw: pointer as obtained from ieee80211_alloc_hw().
6105 * @queue: queue number (counted from zero).
6106 *
6107 * Drivers must use this function instead of netif_queue_stopped.
6108 *
6109 * Return: %true if the queue is stopped. %false otherwise.
6110 */
6111
6112int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
6113
6114/**
6115 * ieee80211_stop_queues - stop all queues
6116 * @hw: pointer as obtained from ieee80211_alloc_hw().
6117 *
6118 * Drivers must use this function instead of netif_tx_stop_all_queues.
6119 */
6120void ieee80211_stop_queues(struct ieee80211_hw *hw);
6121
6122/**
6123 * ieee80211_wake_queues - wake all queues
6124 * @hw: pointer as obtained from ieee80211_alloc_hw().
6125 *
6126 * Drivers must use this function instead of netif_tx_wake_all_queues.
6127 */
6128void ieee80211_wake_queues(struct ieee80211_hw *hw);
6129
6130/**
6131 * ieee80211_scan_completed - completed hardware scan
6132 *
6133 * When hardware scan offload is used (i.e. the hw_scan() callback is
6134 * assigned) this function needs to be called by the driver to notify
6135 * mac80211 that the scan finished. This function can be called from
6136 * any context, including hardirq context.
6137 *
6138 * @hw: the hardware that finished the scan
6139 * @info: information about the completed scan
6140 */
6141void ieee80211_scan_completed(struct ieee80211_hw *hw,
6142 struct cfg80211_scan_info *info);
6143
6144/**
6145 * ieee80211_sched_scan_results - got results from scheduled scan
6146 *
6147 * When a scheduled scan is running, this function needs to be called by the
6148 * driver whenever there are new scan results available.
6149 *
6150 * @hw: the hardware that is performing scheduled scans
6151 */
6152void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
6153
6154/**
6155 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
6156 *
6157 * When a scheduled scan is running, this function can be called by
6158 * the driver if it needs to stop the scan to perform another task.
6159 * Usual scenarios are drivers that cannot continue the scheduled scan
6160 * while associating, for instance.
6161 *
6162 * @hw: the hardware that is performing scheduled scans
6163 */
6164void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
6165
6166/**
6167 * enum ieee80211_interface_iteration_flags - interface iteration flags
6168 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
6169 * been added to the driver; However, note that during hardware
6170 * reconfiguration (after restart_hw) it will iterate over a new
6171 * interface and over all the existing interfaces even if they
6172 * haven't been re-added to the driver yet.
6173 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
6174 * interfaces, even if they haven't been re-added to the driver yet.
6175 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
6176 * @IEEE80211_IFACE_SKIP_SDATA_NOT_IN_DRIVER: Skip any interfaces where SDATA
6177 * is not in the driver. This may fix crashes during firmware recovery
6178 * for instance.
6179 */
6180enum ieee80211_interface_iteration_flags {
6181 IEEE80211_IFACE_ITER_NORMAL = 0,
6182 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
6183 IEEE80211_IFACE_ITER_ACTIVE = BIT(1),
6184 IEEE80211_IFACE_SKIP_SDATA_NOT_IN_DRIVER = BIT(2),
6185};
6186
6187/**
6188 * ieee80211_iterate_interfaces - iterate interfaces
6189 *
6190 * This function iterates over the interfaces associated with a given
6191 * hardware and calls the callback for them. This includes active as well as
6192 * inactive interfaces. This function allows the iterator function to sleep.
6193 * Will iterate over a new interface during add_interface().
6194 *
6195 * @hw: the hardware struct of which the interfaces should be iterated over
6196 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
6197 * @iterator: the iterator function to call
6198 * @data: first argument of the iterator function
6199 */
6200void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
6201 void (*iterator)(void *data, u8 *mac,
6202 struct ieee80211_vif *vif),
6203 void *data);
6204
6205/**
6206 * ieee80211_iterate_active_interfaces - iterate active interfaces
6207 *
6208 * This function iterates over the interfaces associated with a given
6209 * hardware that are currently active and calls the callback for them.
6210 * This function allows the iterator function to sleep, when the iterator
6211 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
6212 * be used.
6213 * Does not iterate over a new interface during add_interface().
6214 *
6215 * @hw: the hardware struct of which the interfaces should be iterated over
6216 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
6217 * @iterator: the iterator function to call
6218 * @data: first argument of the iterator function
6219 */
6220static inline void
6221ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
6222 void (*iterator)(void *data, u8 *mac,
6223 struct ieee80211_vif *vif),
6224 void *data)
6225{
6226 ieee80211_iterate_interfaces(hw,
6227 iter_flags | IEEE80211_IFACE_ITER_ACTIVE,
6228 iterator, data);
6229}
6230
6231/**
6232 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
6233 *
6234 * This function iterates over the interfaces associated with a given
6235 * hardware that are currently active and calls the callback for them.
6236 * This function requires the iterator callback function to be atomic,
6237 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
6238 * Does not iterate over a new interface during add_interface().
6239 *
6240 * @hw: the hardware struct of which the interfaces should be iterated over
6241 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
6242 * @iterator: the iterator function to call, cannot sleep
6243 * @data: first argument of the iterator function
6244 */
6245void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
6246 u32 iter_flags,
6247 void (*iterator)(void *data,
6248 u8 *mac,
6249 struct ieee80211_vif *vif),
6250 void *data);
6251
6252/**
6253 * ieee80211_iterate_active_interfaces_mtx - iterate active interfaces
6254 *
6255 * This function iterates over the interfaces associated with a given
6256 * hardware that are currently active and calls the callback for them.
6257 * This version can only be used while holding the wiphy mutex.
6258 *
6259 * @hw: the hardware struct of which the interfaces should be iterated over
6260 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
6261 * @iterator: the iterator function to call, cannot sleep
6262 * @data: first argument of the iterator function
6263 */
6264void ieee80211_iterate_active_interfaces_mtx(struct ieee80211_hw *hw,
6265 u32 iter_flags,
6266 void (*iterator)(void *data,
6267 u8 *mac,
6268 struct ieee80211_vif *vif),
6269 void *data);
6270
6271/**
6272 * ieee80211_iterate_stations_atomic - iterate stations
6273 *
6274 * This function iterates over all stations associated with a given
6275 * hardware that are currently uploaded to the driver and calls the callback
6276 * function for them.
6277 * This function requires the iterator callback function to be atomic,
6278 *
6279 * @hw: the hardware struct of which the interfaces should be iterated over
6280 * @iterator: the iterator function to call, cannot sleep
6281 * @data: first argument of the iterator function
6282 */
6283void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
6284 void (*iterator)(void *data,
6285 struct ieee80211_sta *sta),
6286 void *data);
6287
6288/**
6289 * ieee80211_iterate_stations_mtx - iterate stations
6290 *
6291 * This function iterates over all stations associated with a given
6292 * hardware that are currently uploaded to the driver and calls the callback
6293 * function for them. This version can only be used while holding the wiphy
6294 * mutex.
6295 *
6296 * @hw: the hardware struct of which the interfaces should be iterated over
6297 * @iterator: the iterator function to call
6298 * @data: first argument of the iterator function
6299 */
6300void ieee80211_iterate_stations_mtx(struct ieee80211_hw *hw,
6301 void (*iterator)(void *data,
6302 struct ieee80211_sta *sta),
6303 void *data);
6304
6305/**
6306 * ieee80211_queue_work - add work onto the mac80211 workqueue
6307 *
6308 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
6309 * This helper ensures drivers are not queueing work when they should not be.
6310 *
6311 * @hw: the hardware struct for the interface we are adding work for
6312 * @work: the work we want to add onto the mac80211 workqueue
6313 */
6314void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
6315
6316/**
6317 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
6318 *
6319 * Drivers and mac80211 use this to queue delayed work onto the mac80211
6320 * workqueue.
6321 *
6322 * @hw: the hardware struct for the interface we are adding work for
6323 * @dwork: delayable work to queue onto the mac80211 workqueue
6324 * @delay: number of jiffies to wait before queueing
6325 */
6326void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
6327 struct delayed_work *dwork,
6328 unsigned long delay);
6329
6330/**
6331 * ieee80211_refresh_tx_agg_session_timer - Refresh a tx agg session timer.
6332 * @sta: the station for which to start a BA session
6333 * @tid: the TID to BA on.
6334 *
6335 * This function allows low level driver to refresh tx agg session timer
6336 * to maintain BA session, the session level will still be managed by the
6337 * mac80211.
6338 *
6339 * Note: must be called in an RCU critical section.
6340 */
6341void ieee80211_refresh_tx_agg_session_timer(struct ieee80211_sta *sta,
6342 u16 tid);
6343
6344/**
6345 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
6346 * @sta: the station for which to start a BA session
6347 * @tid: the TID to BA on.
6348 * @timeout: session timeout value (in TUs)
6349 *
6350 * Return: success if addBA request was sent, failure otherwise
6351 *
6352 * Although mac80211/low level driver/user space application can estimate
6353 * the need to start aggregation on a certain RA/TID, the session level
6354 * will be managed by the mac80211.
6355 */
6356int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
6357 u16 timeout);
6358
6359/**
6360 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
6361 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6362 * @ra: receiver address of the BA session recipient.
6363 * @tid: the TID to BA on.
6364 *
6365 * This function must be called by low level driver once it has
6366 * finished with preparations for the BA session. It can be called
6367 * from any context.
6368 */
6369void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
6370 u16 tid);
6371
6372/**
6373 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
6374 * @sta: the station whose BA session to stop
6375 * @tid: the TID to stop BA.
6376 *
6377 * Return: negative error if the TID is invalid, or no aggregation active
6378 *
6379 * Although mac80211/low level driver/user space application can estimate
6380 * the need to stop aggregation on a certain RA/TID, the session level
6381 * will be managed by the mac80211.
6382 */
6383int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
6384
6385/**
6386 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
6387 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6388 * @ra: receiver address of the BA session recipient.
6389 * @tid: the desired TID to BA on.
6390 *
6391 * This function must be called by low level driver once it has
6392 * finished with preparations for the BA session tear down. It
6393 * can be called from any context.
6394 */
6395void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
6396 u16 tid);
6397
6398/**
6399 * ieee80211_find_sta - find a station
6400 *
6401 * @vif: virtual interface to look for station on
6402 * @addr: station's address
6403 *
6404 * Return: The station, if found. %NULL otherwise.
6405 *
6406 * Note: This function must be called under RCU lock and the
6407 * resulting pointer is only valid under RCU lock as well.
6408 */
6409struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
6410 const u8 *addr);
6411
6412/**
6413 * ieee80211_find_sta_by_ifaddr - find a station on hardware
6414 *
6415 * @hw: pointer as obtained from ieee80211_alloc_hw()
6416 * @addr: remote station's address
6417 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
6418 *
6419 * Return: The station, if found. %NULL otherwise.
6420 *
6421 * Note: This function must be called under RCU lock and the
6422 * resulting pointer is only valid under RCU lock as well.
6423 *
6424 * NOTE: You may pass NULL for localaddr, but then you will just get
6425 * the first STA that matches the remote address 'addr'.
6426 * We can have multiple STA associated with multiple
6427 * logical stations (e.g. consider a station connecting to another
6428 * BSSID on the same AP hardware without disconnecting first).
6429 * In this case, the result of this method with localaddr NULL
6430 * is not reliable.
6431 *
6432 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
6433 */
6434struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
6435 const u8 *addr,
6436 const u8 *localaddr);
6437
6438/**
6439 * ieee80211_find_sta_by_link_addrs - find STA by link addresses
6440 * @hw: pointer as obtained from ieee80211_alloc_hw()
6441 * @addr: remote station's link address
6442 * @localaddr: local link address, use %NULL for any (but avoid that)
6443 * @link_id: pointer to obtain the link ID if the STA is found,
6444 * may be %NULL if the link ID is not needed
6445 *
6446 * Obtain the STA by link address, must use RCU protection.
6447 *
6448 * Return: pointer to STA if found, otherwise %NULL.
6449 */
6450struct ieee80211_sta *
6451ieee80211_find_sta_by_link_addrs(struct ieee80211_hw *hw,
6452 const u8 *addr,
6453 const u8 *localaddr,
6454 unsigned int *link_id);
6455
6456/**
6457 * ieee80211_sta_block_awake - block station from waking up
6458 * @hw: the hardware
6459 * @pubsta: the station
6460 * @block: whether to block or unblock
6461 *
6462 * Some devices require that all frames that are on the queues
6463 * for a specific station that went to sleep are flushed before
6464 * a poll response or frames after the station woke up can be
6465 * delivered to that it. Note that such frames must be rejected
6466 * by the driver as filtered, with the appropriate status flag.
6467 *
6468 * This function allows implementing this mode in a race-free
6469 * manner.
6470 *
6471 * To do this, a driver must keep track of the number of frames
6472 * still enqueued for a specific station. If this number is not
6473 * zero when the station goes to sleep, the driver must call
6474 * this function to force mac80211 to consider the station to
6475 * be asleep regardless of the station's actual state. Once the
6476 * number of outstanding frames reaches zero, the driver must
6477 * call this function again to unblock the station. That will
6478 * cause mac80211 to be able to send ps-poll responses, and if
6479 * the station queried in the meantime then frames will also
6480 * be sent out as a result of this. Additionally, the driver
6481 * will be notified that the station woke up some time after
6482 * it is unblocked, regardless of whether the station actually
6483 * woke up while blocked or not.
6484 */
6485void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
6486 struct ieee80211_sta *pubsta, bool block);
6487
6488/**
6489 * ieee80211_sta_eosp - notify mac80211 about end of SP
6490 * @pubsta: the station
6491 *
6492 * When a device transmits frames in a way that it can't tell
6493 * mac80211 in the TX status about the EOSP, it must clear the
6494 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
6495 * This applies for PS-Poll as well as uAPSD.
6496 *
6497 * Note that just like with _tx_status() and _rx() drivers must
6498 * not mix calls to irqsafe/non-irqsafe versions, this function
6499 * must not be mixed with those either. Use the all irqsafe, or
6500 * all non-irqsafe, don't mix!
6501 *
6502 * NB: the _irqsafe version of this function doesn't exist, no
6503 * driver needs it right now. Don't call this function if
6504 * you'd need the _irqsafe version, look at the git history
6505 * and restore the _irqsafe version!
6506 */
6507void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
6508
6509/**
6510 * ieee80211_send_eosp_nullfunc - ask mac80211 to send NDP with EOSP
6511 * @pubsta: the station
6512 * @tid: the tid of the NDP
6513 *
6514 * Sometimes the device understands that it needs to close
6515 * the Service Period unexpectedly. This can happen when
6516 * sending frames that are filling holes in the BA window.
6517 * In this case, the device can ask mac80211 to send a
6518 * Nullfunc frame with EOSP set. When that happens, the
6519 * driver must have called ieee80211_sta_set_buffered() to
6520 * let mac80211 know that there are no buffered frames any
6521 * more, otherwise mac80211 will get the more_data bit wrong.
6522 * The low level driver must have made sure that the frame
6523 * will be sent despite the station being in power-save.
6524 * Mac80211 won't call allow_buffered_frames().
6525 * Note that calling this function, doesn't exempt the driver
6526 * from closing the EOSP properly, it will still have to call
6527 * ieee80211_sta_eosp when the NDP is sent.
6528 */
6529void ieee80211_send_eosp_nullfunc(struct ieee80211_sta *pubsta, int tid);
6530
6531/**
6532 * ieee80211_sta_recalc_aggregates - recalculate aggregate data after a change
6533 * @pubsta: the station
6534 *
6535 * Call this function after changing a per-link aggregate data as referenced in
6536 * &struct ieee80211_sta_aggregates by accessing the agg field of
6537 * &struct ieee80211_link_sta.
6538 *
6539 * With non MLO the data in deflink will be referenced directly. In that case
6540 * there is no need to call this function.
6541 */
6542void ieee80211_sta_recalc_aggregates(struct ieee80211_sta *pubsta);
6543
6544/**
6545 * ieee80211_sta_register_airtime - register airtime usage for a sta/tid
6546 *
6547 * Register airtime usage for a given sta on a given tid. The driver must call
6548 * this function to notify mac80211 that a station used a certain amount of
6549 * airtime. This information will be used by the TXQ scheduler to schedule
6550 * stations in a way that ensures airtime fairness.
6551 *
6552 * The reported airtime should as a minimum include all time that is spent
6553 * transmitting to the remote station, including overhead and padding, but not
6554 * including time spent waiting for a TXOP. If the time is not reported by the
6555 * hardware it can in some cases be calculated from the rate and known frame
6556 * composition. When possible, the time should include any failed transmission
6557 * attempts.
6558 *
6559 * The driver can either call this function synchronously for every packet or
6560 * aggregate, or asynchronously as airtime usage information becomes available.
6561 * TX and RX airtime can be reported together, or separately by setting one of
6562 * them to 0.
6563 *
6564 * @pubsta: the station
6565 * @tid: the TID to register airtime for
6566 * @tx_airtime: airtime used during TX (in usec)
6567 * @rx_airtime: airtime used during RX (in usec)
6568 */
6569void ieee80211_sta_register_airtime(struct ieee80211_sta *pubsta, u8 tid,
6570 u32 tx_airtime, u32 rx_airtime);
6571
6572/**
6573 * ieee80211_txq_airtime_check - check if a txq can send frame to device
6574 *
6575 * @hw: pointer obtained from ieee80211_alloc_hw()
6576 * @txq: pointer obtained from station or virtual interface
6577 *
6578 * Return: %true if the AQL's airtime limit has not been reached and the txq can
6579 * continue to send more packets to the device. Otherwise return %false.
6580 */
6581bool
6582ieee80211_txq_airtime_check(struct ieee80211_hw *hw, struct ieee80211_txq *txq);
6583
6584/**
6585 * ieee80211_iter_keys - iterate keys programmed into the device
6586 * @hw: pointer obtained from ieee80211_alloc_hw()
6587 * @vif: virtual interface to iterate, may be %NULL for all
6588 * @iter: iterator function that will be called for each key
6589 * @iter_data: custom data to pass to the iterator function
6590 *
6591 * Context: Must be called with wiphy mutex held; can sleep.
6592 *
6593 * This function can be used to iterate all the keys known to
6594 * mac80211, even those that weren't previously programmed into
6595 * the device. This is intended for use in WoWLAN if the device
6596 * needs reprogramming of the keys during suspend.
6597 *
6598 * The order in which the keys are iterated matches the order
6599 * in which they were originally installed and handed to the
6600 * set_key callback.
6601 */
6602void ieee80211_iter_keys(struct ieee80211_hw *hw,
6603 struct ieee80211_vif *vif,
6604 void (*iter)(struct ieee80211_hw *hw,
6605 struct ieee80211_vif *vif,
6606 struct ieee80211_sta *sta,
6607 struct ieee80211_key_conf *key,
6608 void *data),
6609 void *iter_data);
6610
6611/**
6612 * ieee80211_iter_keys_rcu - iterate keys programmed into the device
6613 * @hw: pointer obtained from ieee80211_alloc_hw()
6614 * @vif: virtual interface to iterate, may be %NULL for all
6615 * @iter: iterator function that will be called for each key
6616 * @iter_data: custom data to pass to the iterator function
6617 *
6618 * This function can be used to iterate all the keys known to
6619 * mac80211, even those that weren't previously programmed into
6620 * the device. Note that due to locking reasons, keys of station
6621 * in removal process will be skipped.
6622 *
6623 * This function requires being called in an RCU critical section,
6624 * and thus iter must be atomic.
6625 */
6626void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
6627 struct ieee80211_vif *vif,
6628 void (*iter)(struct ieee80211_hw *hw,
6629 struct ieee80211_vif *vif,
6630 struct ieee80211_sta *sta,
6631 struct ieee80211_key_conf *key,
6632 void *data),
6633 void *iter_data);
6634
6635/**
6636 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
6637 * @hw: pointer obtained from ieee80211_alloc_hw().
6638 * @iter: iterator function
6639 * @iter_data: data passed to iterator function
6640 *
6641 * Iterate all active channel contexts. This function is atomic and
6642 * doesn't acquire any locks internally that might be held in other
6643 * places while calling into the driver.
6644 *
6645 * The iterator will not find a context that's being added (during
6646 * the driver callback to add it) but will find it while it's being
6647 * removed.
6648 *
6649 * Note that during hardware restart, all contexts that existed
6650 * before the restart are considered already present so will be
6651 * found while iterating, whether they've been re-added already
6652 * or not.
6653 */
6654void ieee80211_iter_chan_contexts_atomic(
6655 struct ieee80211_hw *hw,
6656 void (*iter)(struct ieee80211_hw *hw,
6657 struct ieee80211_chanctx_conf *chanctx_conf,
6658 void *data),
6659 void *iter_data);
6660
6661/**
6662 * ieee80211_ap_probereq_get - retrieve a Probe Request template
6663 * @hw: pointer obtained from ieee80211_alloc_hw().
6664 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6665 *
6666 * Creates a Probe Request template which can, for example, be uploaded to
6667 * hardware. The template is filled with bssid, ssid and supported rate
6668 * information. This function must only be called from within the
6669 * .bss_info_changed callback function and only in managed mode. The function
6670 * is only useful when the interface is associated, otherwise it will return
6671 * %NULL.
6672 *
6673 * Return: The Probe Request template. %NULL on error.
6674 */
6675struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
6676 struct ieee80211_vif *vif);
6677
6678/**
6679 * ieee80211_beacon_loss - inform hardware does not receive beacons
6680 *
6681 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6682 *
6683 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
6684 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
6685 * hardware is not receiving beacons with this function.
6686 */
6687void ieee80211_beacon_loss(struct ieee80211_vif *vif);
6688
6689/**
6690 * ieee80211_connection_loss - inform hardware has lost connection to the AP
6691 *
6692 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6693 *
6694 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
6695 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
6696 * needs to inform if the connection to the AP has been lost.
6697 * The function may also be called if the connection needs to be terminated
6698 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
6699 *
6700 * This function will cause immediate change to disassociated state,
6701 * without connection recovery attempts.
6702 */
6703void ieee80211_connection_loss(struct ieee80211_vif *vif);
6704
6705/**
6706 * ieee80211_disconnect - request disconnection
6707 *
6708 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6709 * @reconnect: immediate reconnect is desired
6710 *
6711 * Request disconnection from the current network and, if enabled, send a
6712 * hint to the higher layers that immediate reconnect is desired.
6713 */
6714void ieee80211_disconnect(struct ieee80211_vif *vif, bool reconnect);
6715
6716/**
6717 * ieee80211_resume_disconnect - disconnect from AP after resume
6718 *
6719 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6720 *
6721 * Instructs mac80211 to disconnect from the AP after resume.
6722 * Drivers can use this after WoWLAN if they know that the
6723 * connection cannot be kept up, for example because keys were
6724 * used while the device was asleep but the replay counters or
6725 * similar cannot be retrieved from the device during resume.
6726 *
6727 * Note that due to implementation issues, if the driver uses
6728 * the reconfiguration functionality during resume the interface
6729 * will still be added as associated first during resume and then
6730 * disconnect normally later.
6731 *
6732 * This function can only be called from the resume callback and
6733 * the driver must not be holding any of its own locks while it
6734 * calls this function, or at least not any locks it needs in the
6735 * key configuration paths (if it supports HW crypto).
6736 */
6737void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
6738
6739/**
6740 * ieee80211_hw_restart_disconnect - disconnect from AP after
6741 * hardware restart
6742 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6743 *
6744 * Instructs mac80211 to disconnect from the AP after
6745 * hardware restart.
6746 */
6747void ieee80211_hw_restart_disconnect(struct ieee80211_vif *vif);
6748
6749/**
6750 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
6751 * rssi threshold triggered
6752 *
6753 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6754 * @rssi_event: the RSSI trigger event type
6755 * @rssi_level: new RSSI level value or 0 if not available
6756 * @gfp: context flags
6757 *
6758 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
6759 * monitoring is configured with an rssi threshold, the driver will inform
6760 * whenever the rssi level reaches the threshold.
6761 */
6762void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
6763 enum nl80211_cqm_rssi_threshold_event rssi_event,
6764 s32 rssi_level,
6765 gfp_t gfp);
6766
6767/**
6768 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
6769 *
6770 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6771 * @gfp: context flags
6772 */
6773void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
6774
6775/**
6776 * ieee80211_radar_detected - inform that a radar was detected
6777 *
6778 * @hw: pointer as obtained from ieee80211_alloc_hw()
6779 * @chanctx_conf: Channel context on which radar is detected. Mandatory to
6780 * pass a valid pointer during MLO. For non-MLO %NULL can be passed
6781 */
6782void ieee80211_radar_detected(struct ieee80211_hw *hw,
6783 struct ieee80211_chanctx_conf *chanctx_conf);
6784
6785/**
6786 * ieee80211_chswitch_done - Complete channel switch process
6787 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6788 * @success: make the channel switch successful or not
6789 * @link_id: the link_id on which the switch was done. Ignored if success is
6790 * false.
6791 *
6792 * Complete the channel switch post-process: set the new operational channel
6793 * and wake up the suspended queues.
6794 */
6795void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success,
6796 unsigned int link_id);
6797
6798/**
6799 * ieee80211_channel_switch_disconnect - disconnect due to channel switch error
6800 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6801 *
6802 * Instruct mac80211 to disconnect due to a channel switch error. The channel
6803 * switch can request to block the tx and so, we need to make sure we do not send
6804 * a deauth frame in this case.
6805 */
6806void ieee80211_channel_switch_disconnect(struct ieee80211_vif *vif);
6807
6808/**
6809 * ieee80211_request_smps - request SM PS transition
6810 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6811 * @link_id: link ID for MLO, or 0
6812 * @smps_mode: new SM PS mode
6813 *
6814 * This allows the driver to request an SM PS transition in managed
6815 * mode. This is useful when the driver has more information than
6816 * the stack about possible interference, for example by bluetooth.
6817 */
6818void ieee80211_request_smps(struct ieee80211_vif *vif, unsigned int link_id,
6819 enum ieee80211_smps_mode smps_mode);
6820
6821/**
6822 * ieee80211_ready_on_channel - notification of remain-on-channel start
6823 * @hw: pointer as obtained from ieee80211_alloc_hw()
6824 */
6825void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
6826
6827/**
6828 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
6829 * @hw: pointer as obtained from ieee80211_alloc_hw()
6830 */
6831void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
6832
6833/**
6834 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
6835 *
6836 * in order not to harm the system performance and user experience, the device
6837 * may request not to allow any rx ba session and tear down existing rx ba
6838 * sessions based on system constraints such as periodic BT activity that needs
6839 * to limit wlan activity (eg.sco or a2dp)."
6840 * in such cases, the intention is to limit the duration of the rx ppdu and
6841 * therefore prevent the peer device to use a-mpdu aggregation.
6842 *
6843 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6844 * @ba_rx_bitmap: Bit map of open rx ba per tid
6845 * @addr: & to bssid mac address
6846 */
6847void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
6848 const u8 *addr);
6849
6850/**
6851 * ieee80211_mark_rx_ba_filtered_frames - move RX BA window and mark filtered
6852 * @pubsta: station struct
6853 * @tid: the session's TID
6854 * @ssn: starting sequence number of the bitmap, all frames before this are
6855 * assumed to be out of the window after the call
6856 * @filtered: bitmap of filtered frames, BIT(0) is the @ssn entry etc.
6857 * @received_mpdus: number of received mpdus in firmware
6858 *
6859 * This function moves the BA window and releases all frames before @ssn, and
6860 * marks frames marked in the bitmap as having been filtered. Afterwards, it
6861 * checks if any frames in the window starting from @ssn can now be released
6862 * (in case they were only waiting for frames that were filtered.)
6863 * (Only work correctly if @max_rx_aggregation_subframes <= 64 frames)
6864 */
6865void ieee80211_mark_rx_ba_filtered_frames(struct ieee80211_sta *pubsta, u8 tid,
6866 u16 ssn, u64 filtered,
6867 u16 received_mpdus);
6868
6869/**
6870 * ieee80211_send_bar - send a BlockAckReq frame
6871 *
6872 * can be used to flush pending frames from the peer's aggregation reorder
6873 * buffer.
6874 *
6875 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
6876 * @ra: the peer's destination address
6877 * @tid: the TID of the aggregation session
6878 * @ssn: the new starting sequence number for the receiver
6879 */
6880void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
6881
6882/**
6883 * ieee80211_manage_rx_ba_offl - helper to queue an RX BA work
6884 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6885 * @addr: station mac address
6886 * @tid: the rx tid
6887 */
6888void ieee80211_manage_rx_ba_offl(struct ieee80211_vif *vif, const u8 *addr,
6889 unsigned int tid);
6890
6891/**
6892 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
6893 *
6894 * Some device drivers may offload part of the Rx aggregation flow including
6895 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
6896 * reordering.
6897 *
6898 * Create structures responsible for reordering so device drivers may call here
6899 * when they complete AddBa negotiation.
6900 *
6901 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6902 * @addr: station mac address
6903 * @tid: the rx tid
6904 */
6905static inline void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
6906 const u8 *addr, u16 tid)
6907{
6908 if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
6909 return;
6910 ieee80211_manage_rx_ba_offl(vif, addr, tid);
6911}
6912
6913/**
6914 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
6915 *
6916 * Some device drivers may offload part of the Rx aggregation flow including
6917 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
6918 * reordering.
6919 *
6920 * Destroy structures responsible for reordering so device drivers may call here
6921 * when they complete DelBa negotiation.
6922 *
6923 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6924 * @addr: station mac address
6925 * @tid: the rx tid
6926 */
6927static inline void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
6928 const u8 *addr, u16 tid)
6929{
6930 if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
6931 return;
6932 ieee80211_manage_rx_ba_offl(vif, addr, tid + IEEE80211_NUM_TIDS);
6933}
6934
6935/**
6936 * ieee80211_rx_ba_timer_expired - stop a Rx BA session due to timeout
6937 *
6938 * Some device drivers do not offload AddBa/DelBa negotiation, but handle rx
6939 * buffer reording internally, and therefore also handle the session timer.
6940 *
6941 * Trigger the timeout flow, which sends a DelBa.
6942 *
6943 * @vif: &struct ieee80211_vif pointer from the add_interface callback
6944 * @addr: station mac address
6945 * @tid: the rx tid
6946 */
6947void ieee80211_rx_ba_timer_expired(struct ieee80211_vif *vif,
6948 const u8 *addr, unsigned int tid);
6949
6950/* Rate control API */
6951
6952/**
6953 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
6954 *
6955 * @hw: The hardware the algorithm is invoked for.
6956 * @sband: The band this frame is being transmitted on.
6957 * @bss_conf: the current BSS configuration
6958 * @skb: the skb that will be transmitted, the control information in it needs
6959 * to be filled in
6960 * @reported_rate: The rate control algorithm can fill this in to indicate
6961 * which rate should be reported to userspace as the current rate and
6962 * used for rate calculations in the mesh network.
6963 * @rts: whether RTS will be used for this frame because it is longer than the
6964 * RTS threshold
6965 * @short_preamble: whether mac80211 will request short-preamble transmission
6966 * if the selected rate supports it
6967 * @rate_idx_mask: user-requested (legacy) rate mask
6968 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
6969 * @bss: whether this frame is sent out in AP or IBSS mode
6970 */
6971struct ieee80211_tx_rate_control {
6972 struct ieee80211_hw *hw;
6973 struct ieee80211_supported_band *sband;
6974 struct ieee80211_bss_conf *bss_conf;
6975 struct sk_buff *skb;
6976 struct ieee80211_tx_rate reported_rate;
6977 bool rts, short_preamble;
6978 u32 rate_idx_mask;
6979 u8 *rate_idx_mcs_mask;
6980 bool bss;
6981};
6982
6983/**
6984 * enum rate_control_capabilities - rate control capabilities
6985 */
6986enum rate_control_capabilities {
6987 /**
6988 * @RATE_CTRL_CAPA_VHT_EXT_NSS_BW:
6989 * Support for extended NSS BW support (dot11VHTExtendedNSSCapable)
6990 * Note that this is only looked at if the minimum number of chains
6991 * that the AP uses is < the number of TX chains the hardware has,
6992 * otherwise the NSS difference doesn't bother us.
6993 */
6994 RATE_CTRL_CAPA_VHT_EXT_NSS_BW = BIT(0),
6995 /**
6996 * @RATE_CTRL_CAPA_AMPDU_TRIGGER:
6997 * mac80211 should start A-MPDU sessions on tx
6998 */
6999 RATE_CTRL_CAPA_AMPDU_TRIGGER = BIT(1),
7000};
7001
7002struct rate_control_ops {
7003 unsigned long capa;
7004 const char *name;
7005 void *(*alloc)(struct ieee80211_hw *hw);
7006 void (*add_debugfs)(struct ieee80211_hw *hw, void *priv,
7007 struct dentry *debugfsdir);
7008 void (*free)(void *priv);
7009
7010 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
7011 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
7012 struct cfg80211_chan_def *chandef,
7013 struct ieee80211_sta *sta, void *priv_sta);
7014 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
7015 struct cfg80211_chan_def *chandef,
7016 struct ieee80211_sta *sta, void *priv_sta,
7017 u32 changed);
7018 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
7019 void *priv_sta);
7020
7021 void (*tx_status_ext)(void *priv,
7022 struct ieee80211_supported_band *sband,
7023 void *priv_sta, struct ieee80211_tx_status *st);
7024 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
7025 struct ieee80211_sta *sta, void *priv_sta,
7026 struct sk_buff *skb);
7027 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
7028 struct ieee80211_tx_rate_control *txrc);
7029
7030 void (*add_sta_debugfs)(void *priv, void *priv_sta,
7031 struct dentry *dir);
7032
7033 u32 (*get_expected_throughput)(void *priv_sta);
7034};
7035
7036static inline int rate_supported(struct ieee80211_sta *sta,
7037 enum nl80211_band band,
7038 int index)
7039{
7040 return (sta == NULL || sta->deflink.supp_rates[band] & BIT(index));
7041}
7042
7043static inline s8
7044rate_lowest_index(struct ieee80211_supported_band *sband,
7045 struct ieee80211_sta *sta)
7046{
7047 int i;
7048
7049 for (i = 0; i < sband->n_bitrates; i++)
7050 if (rate_supported(sta, sband->band, i))
7051 return i;
7052
7053 /* warn when we cannot find a rate. */
7054 WARN_ON_ONCE(1);
7055
7056 /* and return 0 (the lowest index) */
7057 return 0;
7058}
7059
7060static inline
7061bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
7062 struct ieee80211_sta *sta)
7063{
7064 unsigned int i;
7065
7066 for (i = 0; i < sband->n_bitrates; i++)
7067 if (rate_supported(sta, sband->band, i))
7068 return true;
7069 return false;
7070}
7071
7072/**
7073 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
7074 *
7075 * When not doing a rate control probe to test rates, rate control should pass
7076 * its rate selection to mac80211. If the driver supports receiving a station
7077 * rate table, it will use it to ensure that frames are always sent based on
7078 * the most recent rate control module decision.
7079 *
7080 * @hw: pointer as obtained from ieee80211_alloc_hw()
7081 * @pubsta: &struct ieee80211_sta pointer to the target destination.
7082 * @rates: new tx rate set to be used for this station.
7083 *
7084 * Return: 0 on success. An error code otherwise.
7085 */
7086int rate_control_set_rates(struct ieee80211_hw *hw,
7087 struct ieee80211_sta *pubsta,
7088 struct ieee80211_sta_rates *rates);
7089
7090int ieee80211_rate_control_register(const struct rate_control_ops *ops);
7091void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
7092
7093static inline bool
7094conf_is_ht20(struct ieee80211_conf *conf)
7095{
7096 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
7097}
7098
7099static inline bool
7100conf_is_ht40_minus(struct ieee80211_conf *conf)
7101{
7102 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
7103 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
7104}
7105
7106static inline bool
7107conf_is_ht40_plus(struct ieee80211_conf *conf)
7108{
7109 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
7110 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
7111}
7112
7113static inline bool
7114conf_is_ht40(struct ieee80211_conf *conf)
7115{
7116 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
7117}
7118
7119static inline bool
7120conf_is_ht(struct ieee80211_conf *conf)
7121{
7122 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
7123 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
7124 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
7125}
7126
7127static inline enum nl80211_iftype
7128ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
7129{
7130 if (p2p) {
7131 switch (type) {
7132 case NL80211_IFTYPE_STATION:
7133 return NL80211_IFTYPE_P2P_CLIENT;
7134 case NL80211_IFTYPE_AP:
7135 return NL80211_IFTYPE_P2P_GO;
7136 default:
7137 break;
7138 }
7139 }
7140 return type;
7141}
7142
7143static inline enum nl80211_iftype
7144ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
7145{
7146 return ieee80211_iftype_p2p(vif->type, vif->p2p);
7147}
7148
7149/**
7150 * ieee80211_get_he_iftype_cap_vif - return HE capabilities for sband/vif
7151 * @sband: the sband to search for the iftype on
7152 * @vif: the vif to get the iftype from
7153 *
7154 * Return: pointer to the struct ieee80211_sta_he_cap, or %NULL is none found
7155 */
7156static inline const struct ieee80211_sta_he_cap *
7157ieee80211_get_he_iftype_cap_vif(const struct ieee80211_supported_band *sband,
7158 struct ieee80211_vif *vif)
7159{
7160 return ieee80211_get_he_iftype_cap(sband, ieee80211_vif_type_p2p(vif));
7161}
7162
7163/**
7164 * ieee80211_get_he_6ghz_capa_vif - return HE 6 GHz capabilities
7165 * @sband: the sband to search for the STA on
7166 * @vif: the vif to get the iftype from
7167 *
7168 * Return: the 6GHz capabilities
7169 */
7170static inline __le16
7171ieee80211_get_he_6ghz_capa_vif(const struct ieee80211_supported_band *sband,
7172 struct ieee80211_vif *vif)
7173{
7174 return ieee80211_get_he_6ghz_capa(sband, ieee80211_vif_type_p2p(vif));
7175}
7176
7177/**
7178 * ieee80211_get_eht_iftype_cap_vif - return ETH capabilities for sband/vif
7179 * @sband: the sband to search for the iftype on
7180 * @vif: the vif to get the iftype from
7181 *
7182 * Return: pointer to the struct ieee80211_sta_eht_cap, or %NULL is none found
7183 */
7184static inline const struct ieee80211_sta_eht_cap *
7185ieee80211_get_eht_iftype_cap_vif(const struct ieee80211_supported_band *sband,
7186 struct ieee80211_vif *vif)
7187{
7188 return ieee80211_get_eht_iftype_cap(sband, ieee80211_vif_type_p2p(vif));
7189}
7190
7191/**
7192 * ieee80211_update_mu_groups - set the VHT MU-MIMO groud data
7193 *
7194 * @vif: the specified virtual interface
7195 * @link_id: the link ID for MLO, otherwise 0
7196 * @membership: 64 bits array - a bit is set if station is member of the group
7197 * @position: 2 bits per group id indicating the position in the group
7198 *
7199 * Note: This function assumes that the given vif is valid and the position and
7200 * membership data is of the correct size and are in the same byte order as the
7201 * matching GroupId management frame.
7202 * Calls to this function need to be serialized with RX path.
7203 */
7204void ieee80211_update_mu_groups(struct ieee80211_vif *vif, unsigned int link_id,
7205 const u8 *membership, const u8 *position);
7206
7207void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
7208 int rssi_min_thold,
7209 int rssi_max_thold);
7210
7211void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
7212
7213/**
7214 * ieee80211_ave_rssi - report the average RSSI for the specified interface
7215 *
7216 * @vif: the specified virtual interface
7217 *
7218 * Note: This function assumes that the given vif is valid.
7219 *
7220 * Return: The average RSSI value for the requested interface, or 0 if not
7221 * applicable.
7222 */
7223int ieee80211_ave_rssi(struct ieee80211_vif *vif);
7224
7225/**
7226 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
7227 * @vif: virtual interface
7228 * @wakeup: wakeup reason(s)
7229 * @gfp: allocation flags
7230 *
7231 * See cfg80211_report_wowlan_wakeup().
7232 */
7233void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
7234 struct cfg80211_wowlan_wakeup *wakeup,
7235 gfp_t gfp);
7236
7237/**
7238 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
7239 * @hw: pointer as obtained from ieee80211_alloc_hw()
7240 * @vif: virtual interface
7241 * @skb: frame to be sent from within the driver
7242 * @band: the band to transmit on
7243 * @sta: optional pointer to get the station to send the frame to
7244 *
7245 * Return: %true if the skb was prepared, %false otherwise
7246 *
7247 * Note: must be called under RCU lock
7248 */
7249bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
7250 struct ieee80211_vif *vif, struct sk_buff *skb,
7251 int band, struct ieee80211_sta **sta);
7252
7253/**
7254 * ieee80211_parse_tx_radiotap - Sanity-check and parse the radiotap header
7255 * of injected frames.
7256 *
7257 * To accurately parse and take into account rate and retransmission fields,
7258 * you must initialize the chandef field in the ieee80211_tx_info structure
7259 * of the skb before calling this function.
7260 *
7261 * @skb: packet injected by userspace
7262 * @dev: the &struct device of this 802.11 device
7263 *
7264 * Return: %true if the radiotap header was parsed, %false otherwise
7265 */
7266bool ieee80211_parse_tx_radiotap(struct sk_buff *skb,
7267 struct net_device *dev);
7268
7269/**
7270 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
7271 *
7272 * @next_tsf: TSF timestamp of the next absent state change
7273 * @has_next_tsf: next absent state change event pending
7274 *
7275 * @absent: descriptor bitmask, set if GO is currently absent
7276 *
7277 * private:
7278 *
7279 * @count: count fields from the NoA descriptors
7280 * @desc: adjusted data from the NoA
7281 */
7282struct ieee80211_noa_data {
7283 u32 next_tsf;
7284 bool has_next_tsf;
7285
7286 u8 absent;
7287
7288 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
7289 struct {
7290 u32 start;
7291 u32 duration;
7292 u32 interval;
7293 } desc[IEEE80211_P2P_NOA_DESC_MAX];
7294};
7295
7296/**
7297 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
7298 *
7299 * @attr: P2P NoA IE
7300 * @data: NoA tracking data
7301 * @tsf: current TSF timestamp
7302 *
7303 * Return: number of successfully parsed descriptors
7304 */
7305int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
7306 struct ieee80211_noa_data *data, u32 tsf);
7307
7308/**
7309 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
7310 *
7311 * @data: NoA tracking data
7312 * @tsf: current TSF timestamp
7313 */
7314void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
7315
7316/**
7317 * ieee80211_tdls_oper_request - request userspace to perform a TDLS operation
7318 * @vif: virtual interface
7319 * @peer: the peer's destination address
7320 * @oper: the requested TDLS operation
7321 * @reason_code: reason code for the operation, valid for TDLS teardown
7322 * @gfp: allocation flags
7323 *
7324 * See cfg80211_tdls_oper_request().
7325 */
7326void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
7327 enum nl80211_tdls_operation oper,
7328 u16 reason_code, gfp_t gfp);
7329
7330/**
7331 * ieee80211_reserve_tid - request to reserve a specific TID
7332 *
7333 * There is sometimes a need (such as in TDLS) for blocking the driver from
7334 * using a specific TID so that the FW can use it for certain operations such
7335 * as sending PTI requests. To make sure that the driver doesn't use that TID,
7336 * this function must be called as it flushes out packets on this TID and marks
7337 * it as blocked, so that any transmit for the station on this TID will be
7338 * redirected to the alternative TID in the same AC.
7339 *
7340 * Note that this function blocks and may call back into the driver, so it
7341 * should be called without driver locks held. Also note this function should
7342 * only be called from the driver's @sta_state callback.
7343 *
7344 * @sta: the station to reserve the TID for
7345 * @tid: the TID to reserve
7346 *
7347 * Returns: 0 on success, else on failure
7348 */
7349int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
7350
7351/**
7352 * ieee80211_unreserve_tid - request to unreserve a specific TID
7353 *
7354 * Once there is no longer any need for reserving a certain TID, this function
7355 * should be called, and no longer will packets have their TID modified for
7356 * preventing use of this TID in the driver.
7357 *
7358 * Note that this function blocks and acquires a lock, so it should be called
7359 * without driver locks held. Also note this function should only be called
7360 * from the driver's @sta_state callback.
7361 *
7362 * @sta: the station
7363 * @tid: the TID to unreserve
7364 */
7365void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
7366
7367/**
7368 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
7369 *
7370 * @hw: pointer as obtained from ieee80211_alloc_hw()
7371 * @txq: pointer obtained from station or virtual interface, or from
7372 * ieee80211_next_txq()
7373 *
7374 * Return: the skb if successful, %NULL if no frame was available.
7375 *
7376 * Note that this must be called in an rcu_read_lock() critical section,
7377 * which can only be released after the SKB was handled. Some pointers in
7378 * skb->cb, e.g. the key pointer, are protected by RCU and thus the
7379 * critical section must persist not just for the duration of this call
7380 * but for the duration of the frame handling.
7381 * However, also note that while in the wake_tx_queue() method,
7382 * rcu_read_lock() is already held.
7383 *
7384 * softirqs must also be disabled when this function is called.
7385 * In process context, use ieee80211_tx_dequeue_ni() instead.
7386 */
7387struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw,
7388 struct ieee80211_txq *txq);
7389
7390/**
7391 * ieee80211_tx_dequeue_ni - dequeue a packet from a software tx queue
7392 * (in process context)
7393 *
7394 * Like ieee80211_tx_dequeue() but can be called in process context
7395 * (internally disables bottom halves).
7396 *
7397 * @hw: pointer as obtained from ieee80211_alloc_hw()
7398 * @txq: pointer obtained from station or virtual interface, or from
7399 * ieee80211_next_txq()
7400 *
7401 * Return: the skb if successful, %NULL if no frame was available.
7402 */
7403static inline struct sk_buff *ieee80211_tx_dequeue_ni(struct ieee80211_hw *hw,
7404 struct ieee80211_txq *txq)
7405{
7406 struct sk_buff *skb;
7407
7408 local_bh_disable();
7409 skb = ieee80211_tx_dequeue(hw, txq);
7410 local_bh_enable();
7411
7412 return skb;
7413}
7414
7415/**
7416 * ieee80211_handle_wake_tx_queue - mac80211 handler for wake_tx_queue callback
7417 *
7418 * @hw: pointer as obtained from wake_tx_queue() callback().
7419 * @txq: pointer as obtained from wake_tx_queue() callback().
7420 *
7421 * Drivers can use this function for the mandatory mac80211 wake_tx_queue
7422 * callback in struct ieee80211_ops. They should not call this function.
7423 */
7424void ieee80211_handle_wake_tx_queue(struct ieee80211_hw *hw,
7425 struct ieee80211_txq *txq);
7426
7427/**
7428 * ieee80211_next_txq - get next tx queue to pull packets from
7429 *
7430 * @hw: pointer as obtained from ieee80211_alloc_hw()
7431 * @ac: AC number to return packets from.
7432 *
7433 * Return: the next txq if successful, %NULL if no queue is eligible. If a txq
7434 * is returned, it should be returned with ieee80211_return_txq() after the
7435 * driver has finished scheduling it.
7436 */
7437struct ieee80211_txq *ieee80211_next_txq(struct ieee80211_hw *hw, u8 ac);
7438
7439/**
7440 * ieee80211_txq_schedule_start - start new scheduling round for TXQs
7441 *
7442 * @hw: pointer as obtained from ieee80211_alloc_hw()
7443 * @ac: AC number to acquire locks for
7444 *
7445 * Should be called before ieee80211_next_txq() or ieee80211_return_txq().
7446 * The driver must not call multiple TXQ scheduling rounds concurrently.
7447 */
7448void ieee80211_txq_schedule_start(struct ieee80211_hw *hw, u8 ac);
7449
7450/* (deprecated) */
7451static inline void ieee80211_txq_schedule_end(struct ieee80211_hw *hw, u8 ac)
7452{
7453}
7454
7455void __ieee80211_schedule_txq(struct ieee80211_hw *hw,
7456 struct ieee80211_txq *txq, bool force);
7457
7458/**
7459 * ieee80211_schedule_txq - schedule a TXQ for transmission
7460 *
7461 * @hw: pointer as obtained from ieee80211_alloc_hw()
7462 * @txq: pointer obtained from station or virtual interface
7463 *
7464 * Schedules a TXQ for transmission if it is not already scheduled,
7465 * even if mac80211 does not have any packets buffered.
7466 *
7467 * The driver may call this function if it has buffered packets for
7468 * this TXQ internally.
7469 */
7470static inline void
7471ieee80211_schedule_txq(struct ieee80211_hw *hw, struct ieee80211_txq *txq)
7472{
7473 __ieee80211_schedule_txq(hw, txq, true);
7474}
7475
7476/**
7477 * ieee80211_return_txq - return a TXQ previously acquired by ieee80211_next_txq()
7478 *
7479 * @hw: pointer as obtained from ieee80211_alloc_hw()
7480 * @txq: pointer obtained from station or virtual interface
7481 * @force: schedule txq even if mac80211 does not have any buffered packets.
7482 *
7483 * The driver may set force=true if it has buffered packets for this TXQ
7484 * internally.
7485 */
7486static inline void
7487ieee80211_return_txq(struct ieee80211_hw *hw, struct ieee80211_txq *txq,
7488 bool force)
7489{
7490 __ieee80211_schedule_txq(hw, txq, force);
7491}
7492
7493/**
7494 * ieee80211_txq_may_transmit - check whether TXQ is allowed to transmit
7495 *
7496 * This function is used to check whether given txq is allowed to transmit by
7497 * the airtime scheduler, and can be used by drivers to access the airtime
7498 * fairness accounting without using the scheduling order enforced by
7499 * next_txq().
7500 *
7501 * Returns %true if the airtime scheduler thinks the TXQ should be allowed to
7502 * transmit, and %false if it should be throttled. This function can also have
7503 * the side effect of rotating the TXQ in the scheduler rotation, which will
7504 * eventually bring the deficit to positive and allow the station to transmit
7505 * again.
7506 *
7507 * The API ieee80211_txq_may_transmit() also ensures that TXQ list will be
7508 * aligned against driver's own round-robin scheduler list. i.e it rotates
7509 * the TXQ list till it makes the requested node becomes the first entry
7510 * in TXQ list. Thus both the TXQ list and driver's list are in sync. If this
7511 * function returns %true, the driver is expected to schedule packets
7512 * for transmission, and then return the TXQ through ieee80211_return_txq().
7513 *
7514 * @hw: pointer as obtained from ieee80211_alloc_hw()
7515 * @txq: pointer obtained from station or virtual interface
7516 *
7517 * Return: %true if transmission is allowed, %false otherwise
7518 */
7519bool ieee80211_txq_may_transmit(struct ieee80211_hw *hw,
7520 struct ieee80211_txq *txq);
7521
7522/**
7523 * ieee80211_txq_get_depth - get pending frame/byte count of given txq
7524 *
7525 * The values are not guaranteed to be coherent with regard to each other, i.e.
7526 * txq state can change half-way of this function and the caller may end up
7527 * with "new" frame_cnt and "old" byte_cnt or vice-versa.
7528 *
7529 * @txq: pointer obtained from station or virtual interface
7530 * @frame_cnt: pointer to store frame count
7531 * @byte_cnt: pointer to store byte count
7532 */
7533void ieee80211_txq_get_depth(struct ieee80211_txq *txq,
7534 unsigned long *frame_cnt,
7535 unsigned long *byte_cnt);
7536
7537/**
7538 * ieee80211_nan_func_terminated - notify about NAN function termination.
7539 *
7540 * This function is used to notify mac80211 about NAN function termination.
7541 * Note that this function can't be called from hard irq.
7542 *
7543 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
7544 * @inst_id: the local instance id
7545 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
7546 * @gfp: allocation flags
7547 */
7548void ieee80211_nan_func_terminated(struct ieee80211_vif *vif,
7549 u8 inst_id,
7550 enum nl80211_nan_func_term_reason reason,
7551 gfp_t gfp);
7552
7553/**
7554 * ieee80211_nan_func_match - notify about NAN function match event.
7555 *
7556 * This function is used to notify mac80211 about NAN function match. The
7557 * cookie inside the match struct will be assigned by mac80211.
7558 * Note that this function can't be called from hard irq.
7559 *
7560 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
7561 * @match: match event information
7562 * @gfp: allocation flags
7563 */
7564void ieee80211_nan_func_match(struct ieee80211_vif *vif,
7565 struct cfg80211_nan_match_params *match,
7566 gfp_t gfp);
7567
7568/**
7569 * ieee80211_calc_rx_airtime - calculate estimated transmission airtime for RX.
7570 *
7571 * This function calculates the estimated airtime usage of a frame based on the
7572 * rate information in the RX status struct and the frame length.
7573 *
7574 * @hw: pointer as obtained from ieee80211_alloc_hw()
7575 * @status: &struct ieee80211_rx_status containing the transmission rate
7576 * information.
7577 * @len: frame length in bytes
7578 *
7579 * Return: the airtime estimate
7580 */
7581u32 ieee80211_calc_rx_airtime(struct ieee80211_hw *hw,
7582 struct ieee80211_rx_status *status,
7583 int len);
7584
7585/**
7586 * ieee80211_calc_tx_airtime - calculate estimated transmission airtime for TX.
7587 *
7588 * This function calculates the estimated airtime usage of a frame based on the
7589 * rate information in the TX info struct and the frame length.
7590 *
7591 * @hw: pointer as obtained from ieee80211_alloc_hw()
7592 * @info: &struct ieee80211_tx_info of the frame.
7593 * @len: frame length in bytes
7594 *
7595 * Return: the airtime estimate
7596 */
7597u32 ieee80211_calc_tx_airtime(struct ieee80211_hw *hw,
7598 struct ieee80211_tx_info *info,
7599 int len);
7600/**
7601 * ieee80211_get_fils_discovery_tmpl - Get FILS discovery template.
7602 * @hw: pointer obtained from ieee80211_alloc_hw().
7603 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
7604 *
7605 * The driver is responsible for freeing the returned skb.
7606 *
7607 * Return: FILS discovery template. %NULL on error.
7608 */
7609struct sk_buff *ieee80211_get_fils_discovery_tmpl(struct ieee80211_hw *hw,
7610 struct ieee80211_vif *vif);
7611
7612/**
7613 * ieee80211_get_unsol_bcast_probe_resp_tmpl - Get unsolicited broadcast
7614 * probe response template.
7615 * @hw: pointer obtained from ieee80211_alloc_hw().
7616 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
7617 *
7618 * The driver is responsible for freeing the returned skb.
7619 *
7620 * Return: Unsolicited broadcast probe response template. %NULL on error.
7621 */
7622struct sk_buff *
7623ieee80211_get_unsol_bcast_probe_resp_tmpl(struct ieee80211_hw *hw,
7624 struct ieee80211_vif *vif);
7625
7626/**
7627 * ieee80211_obss_color_collision_notify - notify userland about a BSS color
7628 * collision.
7629 * @link_id: valid link_id during MLO or 0 for non-MLO
7630 *
7631 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
7632 * @color_bitmap: a 64 bit bitmap representing the colors that the local BSS is
7633 * aware of.
7634 */
7635void
7636ieee80211_obss_color_collision_notify(struct ieee80211_vif *vif,
7637 u64 color_bitmap, u8 link_id);
7638
7639/**
7640 * ieee80211_is_tx_data - check if frame is a data frame
7641 *
7642 * The function is used to check if a frame is a data frame. Frames with
7643 * hardware encapsulation enabled are data frames.
7644 *
7645 * @skb: the frame to be transmitted.
7646 *
7647 * Return: %true if @skb is a data frame, %false otherwise
7648 */
7649static inline bool ieee80211_is_tx_data(struct sk_buff *skb)
7650{
7651 struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
7652 struct ieee80211_hdr *hdr = (void *) skb->data;
7653
7654 return info->flags & IEEE80211_TX_CTL_HW_80211_ENCAP ||
7655 ieee80211_is_data(hdr->frame_control);
7656}
7657
7658/**
7659 * ieee80211_set_active_links - set active links in client mode
7660 * @vif: interface to set active links on
7661 * @active_links: the new active links bitmap
7662 *
7663 * Context: Must be called with wiphy mutex held; may sleep; calls
7664 * back into the driver.
7665 *
7666 * This changes the active links on an interface. The interface
7667 * must be in client mode (in AP mode, all links are always active),
7668 * and @active_links must be a subset of the vif's valid_links.
7669 *
7670 * If a link is switched off and another is switched on at the same
7671 * time (e.g. active_links going from 0x1 to 0x10) then you will get
7672 * a sequence of calls like
7673 *
7674 * - change_vif_links(0x11)
7675 * - unassign_vif_chanctx(link_id=0)
7676 * - assign_vif_chanctx(link_id=4)
7677 * - change_sta_links(0x11) for each affected STA (the AP)
7678 * (TDLS connections on now inactive links should be torn down)
7679 * - remove group keys on the old link (link_id 0)
7680 * - add new group keys (GTK/IGTK/BIGTK) on the new link (link_id 4)
7681 * - change_sta_links(0x10) for each affected STA (the AP)
7682 * - change_vif_links(0x10)
7683 *
7684 * Return: 0 on success. An error code otherwise.
7685 */
7686int ieee80211_set_active_links(struct ieee80211_vif *vif, u16 active_links);
7687
7688/**
7689 * ieee80211_set_active_links_async - asynchronously set active links
7690 * @vif: interface to set active links on
7691 * @active_links: the new active links bitmap
7692 *
7693 * See ieee80211_set_active_links() for more information, the only
7694 * difference here is that the link change is triggered async and
7695 * can be called in any context, but the link switch will only be
7696 * completed after it returns.
7697 */
7698void ieee80211_set_active_links_async(struct ieee80211_vif *vif,
7699 u16 active_links);
7700
7701/**
7702 * ieee80211_send_teardown_neg_ttlm - tear down a negotiated TTLM request
7703 * @vif: the interface on which the tear down request should be sent.
7704 *
7705 * This function can be used to tear down a previously accepted negotiated
7706 * TTLM request.
7707 */
7708void ieee80211_send_teardown_neg_ttlm(struct ieee80211_vif *vif);
7709
7710/**
7711 * ieee80211_chan_width_to_rx_bw - convert channel width to STA RX bandwidth
7712 * @width: the channel width value to convert
7713 * Return: the STA RX bandwidth value for the channel width
7714 */
7715static inline enum ieee80211_sta_rx_bandwidth
7716ieee80211_chan_width_to_rx_bw(enum nl80211_chan_width width)
7717{
7718 switch (width) {
7719 default:
7720 WARN_ON_ONCE(1);
7721 fallthrough;
7722 case NL80211_CHAN_WIDTH_20_NOHT:
7723 case NL80211_CHAN_WIDTH_20:
7724 return IEEE80211_STA_RX_BW_20;
7725 case NL80211_CHAN_WIDTH_40:
7726 return IEEE80211_STA_RX_BW_40;
7727 case NL80211_CHAN_WIDTH_80:
7728 return IEEE80211_STA_RX_BW_80;
7729 case NL80211_CHAN_WIDTH_160:
7730 case NL80211_CHAN_WIDTH_80P80:
7731 return IEEE80211_STA_RX_BW_160;
7732 case NL80211_CHAN_WIDTH_320:
7733 return IEEE80211_STA_RX_BW_320;
7734 }
7735}
7736
7737/* for older drivers - let's not document these ... */
7738int ieee80211_emulate_add_chanctx(struct ieee80211_hw *hw,
7739 struct ieee80211_chanctx_conf *ctx);
7740void ieee80211_emulate_remove_chanctx(struct ieee80211_hw *hw,
7741 struct ieee80211_chanctx_conf *ctx);
7742void ieee80211_emulate_change_chanctx(struct ieee80211_hw *hw,
7743 struct ieee80211_chanctx_conf *ctx,
7744 u32 changed);
7745int ieee80211_emulate_switch_vif_chanctx(struct ieee80211_hw *hw,
7746 struct ieee80211_vif_chanctx_switch *vifs,
7747 int n_vifs,
7748 enum ieee80211_chanctx_switch_mode mode);
7749
7750#endif /* MAC80211_H */
1/*
2 * mac80211 <-> driver interface
3 *
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
7 * Copyright 2013-2014 Intel Mobile Communications GmbH
8 * Copyright (C) 2015 - 2017 Intel Deutschland GmbH
9 * Copyright (C) 2018 Intel Corporation
10 *
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2 as
13 * published by the Free Software Foundation.
14 */
15
16#ifndef MAC80211_H
17#define MAC80211_H
18
19#include <linux/bug.h>
20#include <linux/kernel.h>
21#include <linux/if_ether.h>
22#include <linux/skbuff.h>
23#include <linux/ieee80211.h>
24#include <net/cfg80211.h>
25#include <net/codel.h>
26#include <asm/unaligned.h>
27
28/**
29 * DOC: Introduction
30 *
31 * mac80211 is the Linux stack for 802.11 hardware that implements
32 * only partial functionality in hard- or firmware. This document
33 * defines the interface between mac80211 and low-level hardware
34 * drivers.
35 */
36
37/**
38 * DOC: Calling mac80211 from interrupts
39 *
40 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
41 * called in hardware interrupt context. The low-level driver must not call any
42 * other functions in hardware interrupt context. If there is a need for such
43 * call, the low-level driver should first ACK the interrupt and perform the
44 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
45 * tasklet function.
46 *
47 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
48 * use the non-IRQ-safe functions!
49 */
50
51/**
52 * DOC: Warning
53 *
54 * If you're reading this document and not the header file itself, it will
55 * be incomplete because not all documentation has been converted yet.
56 */
57
58/**
59 * DOC: Frame format
60 *
61 * As a general rule, when frames are passed between mac80211 and the driver,
62 * they start with the IEEE 802.11 header and include the same octets that are
63 * sent over the air except for the FCS which should be calculated by the
64 * hardware.
65 *
66 * There are, however, various exceptions to this rule for advanced features:
67 *
68 * The first exception is for hardware encryption and decryption offload
69 * where the IV/ICV may or may not be generated in hardware.
70 *
71 * Secondly, when the hardware handles fragmentation, the frame handed to
72 * the driver from mac80211 is the MSDU, not the MPDU.
73 */
74
75/**
76 * DOC: mac80211 workqueue
77 *
78 * mac80211 provides its own workqueue for drivers and internal mac80211 use.
79 * The workqueue is a single threaded workqueue and can only be accessed by
80 * helpers for sanity checking. Drivers must ensure all work added onto the
81 * mac80211 workqueue should be cancelled on the driver stop() callback.
82 *
83 * mac80211 will flushed the workqueue upon interface removal and during
84 * suspend.
85 *
86 * All work performed on the mac80211 workqueue must not acquire the RTNL lock.
87 *
88 */
89
90/**
91 * DOC: mac80211 software tx queueing
92 *
93 * mac80211 provides an optional intermediate queueing implementation designed
94 * to allow the driver to keep hardware queues short and provide some fairness
95 * between different stations/interfaces.
96 * In this model, the driver pulls data frames from the mac80211 queue instead
97 * of letting mac80211 push them via drv_tx().
98 * Other frames (e.g. control or management) are still pushed using drv_tx().
99 *
100 * Drivers indicate that they use this model by implementing the .wake_tx_queue
101 * driver operation.
102 *
103 * Intermediate queues (struct ieee80211_txq) are kept per-sta per-tid, with a
104 * single per-vif queue for multicast data frames.
105 *
106 * The driver is expected to initialize its private per-queue data for stations
107 * and interfaces in the .add_interface and .sta_add ops.
108 *
109 * The driver can't access the queue directly. To dequeue a frame, it calls
110 * ieee80211_tx_dequeue(). Whenever mac80211 adds a new frame to a queue, it
111 * calls the .wake_tx_queue driver op.
112 *
113 * For AP powersave TIM handling, the driver only needs to indicate if it has
114 * buffered packets in the driver specific data structures by calling
115 * ieee80211_sta_set_buffered(). For frames buffered in the ieee80211_txq
116 * struct, mac80211 sets the appropriate TIM PVB bits and calls
117 * .release_buffered_frames().
118 * In that callback the driver is therefore expected to release its own
119 * buffered frames and afterwards also frames from the ieee80211_txq (obtained
120 * via the usual ieee80211_tx_dequeue).
121 */
122
123struct device;
124
125/**
126 * enum ieee80211_max_queues - maximum number of queues
127 *
128 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
129 * @IEEE80211_MAX_QUEUE_MAP: bitmap with maximum queues set
130 */
131enum ieee80211_max_queues {
132 IEEE80211_MAX_QUEUES = 16,
133 IEEE80211_MAX_QUEUE_MAP = BIT(IEEE80211_MAX_QUEUES) - 1,
134};
135
136#define IEEE80211_INVAL_HW_QUEUE 0xff
137
138/**
139 * enum ieee80211_ac_numbers - AC numbers as used in mac80211
140 * @IEEE80211_AC_VO: voice
141 * @IEEE80211_AC_VI: video
142 * @IEEE80211_AC_BE: best effort
143 * @IEEE80211_AC_BK: background
144 */
145enum ieee80211_ac_numbers {
146 IEEE80211_AC_VO = 0,
147 IEEE80211_AC_VI = 1,
148 IEEE80211_AC_BE = 2,
149 IEEE80211_AC_BK = 3,
150};
151
152/**
153 * struct ieee80211_tx_queue_params - transmit queue configuration
154 *
155 * The information provided in this structure is required for QoS
156 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
157 *
158 * @aifs: arbitration interframe space [0..255]
159 * @cw_min: minimum contention window [a value of the form
160 * 2^n-1 in the range 1..32767]
161 * @cw_max: maximum contention window [like @cw_min]
162 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
163 * @acm: is mandatory admission control required for the access category
164 * @uapsd: is U-APSD mode enabled for the queue
165 */
166struct ieee80211_tx_queue_params {
167 u16 txop;
168 u16 cw_min;
169 u16 cw_max;
170 u8 aifs;
171 bool acm;
172 bool uapsd;
173};
174
175struct ieee80211_low_level_stats {
176 unsigned int dot11ACKFailureCount;
177 unsigned int dot11RTSFailureCount;
178 unsigned int dot11FCSErrorCount;
179 unsigned int dot11RTSSuccessCount;
180};
181
182/**
183 * enum ieee80211_chanctx_change - change flag for channel context
184 * @IEEE80211_CHANCTX_CHANGE_WIDTH: The channel width changed
185 * @IEEE80211_CHANCTX_CHANGE_RX_CHAINS: The number of RX chains changed
186 * @IEEE80211_CHANCTX_CHANGE_RADAR: radar detection flag changed
187 * @IEEE80211_CHANCTX_CHANGE_CHANNEL: switched to another operating channel,
188 * this is used only with channel switching with CSA
189 * @IEEE80211_CHANCTX_CHANGE_MIN_WIDTH: The min required channel width changed
190 */
191enum ieee80211_chanctx_change {
192 IEEE80211_CHANCTX_CHANGE_WIDTH = BIT(0),
193 IEEE80211_CHANCTX_CHANGE_RX_CHAINS = BIT(1),
194 IEEE80211_CHANCTX_CHANGE_RADAR = BIT(2),
195 IEEE80211_CHANCTX_CHANGE_CHANNEL = BIT(3),
196 IEEE80211_CHANCTX_CHANGE_MIN_WIDTH = BIT(4),
197};
198
199/**
200 * struct ieee80211_chanctx_conf - channel context that vifs may be tuned to
201 *
202 * This is the driver-visible part. The ieee80211_chanctx
203 * that contains it is visible in mac80211 only.
204 *
205 * @def: the channel definition
206 * @min_def: the minimum channel definition currently required.
207 * @rx_chains_static: The number of RX chains that must always be
208 * active on the channel to receive MIMO transmissions
209 * @rx_chains_dynamic: The number of RX chains that must be enabled
210 * after RTS/CTS handshake to receive SMPS MIMO transmissions;
211 * this will always be >= @rx_chains_static.
212 * @radar_enabled: whether radar detection is enabled on this channel.
213 * @drv_priv: data area for driver use, will always be aligned to
214 * sizeof(void *), size is determined in hw information.
215 */
216struct ieee80211_chanctx_conf {
217 struct cfg80211_chan_def def;
218 struct cfg80211_chan_def min_def;
219
220 u8 rx_chains_static, rx_chains_dynamic;
221
222 bool radar_enabled;
223
224 u8 drv_priv[0] __aligned(sizeof(void *));
225};
226
227/**
228 * enum ieee80211_chanctx_switch_mode - channel context switch mode
229 * @CHANCTX_SWMODE_REASSIGN_VIF: Both old and new contexts already
230 * exist (and will continue to exist), but the virtual interface
231 * needs to be switched from one to the other.
232 * @CHANCTX_SWMODE_SWAP_CONTEXTS: The old context exists but will stop
233 * to exist with this call, the new context doesn't exist but
234 * will be active after this call, the virtual interface switches
235 * from the old to the new (note that the driver may of course
236 * implement this as an on-the-fly chandef switch of the existing
237 * hardware context, but the mac80211 pointer for the old context
238 * will cease to exist and only the new one will later be used
239 * for changes/removal.)
240 */
241enum ieee80211_chanctx_switch_mode {
242 CHANCTX_SWMODE_REASSIGN_VIF,
243 CHANCTX_SWMODE_SWAP_CONTEXTS,
244};
245
246/**
247 * struct ieee80211_vif_chanctx_switch - vif chanctx switch information
248 *
249 * This is structure is used to pass information about a vif that
250 * needs to switch from one chanctx to another. The
251 * &ieee80211_chanctx_switch_mode defines how the switch should be
252 * done.
253 *
254 * @vif: the vif that should be switched from old_ctx to new_ctx
255 * @old_ctx: the old context to which the vif was assigned
256 * @new_ctx: the new context to which the vif must be assigned
257 */
258struct ieee80211_vif_chanctx_switch {
259 struct ieee80211_vif *vif;
260 struct ieee80211_chanctx_conf *old_ctx;
261 struct ieee80211_chanctx_conf *new_ctx;
262};
263
264/**
265 * enum ieee80211_bss_change - BSS change notification flags
266 *
267 * These flags are used with the bss_info_changed() callback
268 * to indicate which BSS parameter changed.
269 *
270 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
271 * also implies a change in the AID.
272 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
273 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
274 * @BSS_CHANGED_ERP_SLOT: slot timing changed
275 * @BSS_CHANGED_HT: 802.11n parameters changed
276 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
277 * @BSS_CHANGED_BEACON_INT: Beacon interval changed
278 * @BSS_CHANGED_BSSID: BSSID changed, for whatever
279 * reason (IBSS and managed mode)
280 * @BSS_CHANGED_BEACON: Beacon data changed, retrieve
281 * new beacon (beaconing modes)
282 * @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
283 * enabled/disabled (beaconing modes)
284 * @BSS_CHANGED_CQM: Connection quality monitor config changed
285 * @BSS_CHANGED_IBSS: IBSS join status changed
286 * @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
287 * @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
288 * that it is only ever disabled for station mode.
289 * @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
290 * @BSS_CHANGED_SSID: SSID changed for this BSS (AP and IBSS mode)
291 * @BSS_CHANGED_AP_PROBE_RESP: Probe Response changed for this BSS (AP mode)
292 * @BSS_CHANGED_PS: PS changed for this BSS (STA mode)
293 * @BSS_CHANGED_TXPOWER: TX power setting changed for this interface
294 * @BSS_CHANGED_P2P_PS: P2P powersave settings (CTWindow, opportunistic PS)
295 * changed
296 * @BSS_CHANGED_BEACON_INFO: Data from the AP's beacon became available:
297 * currently dtim_period only is under consideration.
298 * @BSS_CHANGED_BANDWIDTH: The bandwidth used by this interface changed,
299 * note that this is only called when it changes after the channel
300 * context had been assigned.
301 * @BSS_CHANGED_OCB: OCB join status changed
302 * @BSS_CHANGED_MU_GROUPS: VHT MU-MIMO group id or user position changed
303 * @BSS_CHANGED_KEEP_ALIVE: keep alive options (idle period or protected
304 * keep alive) changed.
305 * @BSS_CHANGED_MCAST_RATE: Multicast Rate setting changed for this interface
306 *
307 */
308enum ieee80211_bss_change {
309 BSS_CHANGED_ASSOC = 1<<0,
310 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
311 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
312 BSS_CHANGED_ERP_SLOT = 1<<3,
313 BSS_CHANGED_HT = 1<<4,
314 BSS_CHANGED_BASIC_RATES = 1<<5,
315 BSS_CHANGED_BEACON_INT = 1<<6,
316 BSS_CHANGED_BSSID = 1<<7,
317 BSS_CHANGED_BEACON = 1<<8,
318 BSS_CHANGED_BEACON_ENABLED = 1<<9,
319 BSS_CHANGED_CQM = 1<<10,
320 BSS_CHANGED_IBSS = 1<<11,
321 BSS_CHANGED_ARP_FILTER = 1<<12,
322 BSS_CHANGED_QOS = 1<<13,
323 BSS_CHANGED_IDLE = 1<<14,
324 BSS_CHANGED_SSID = 1<<15,
325 BSS_CHANGED_AP_PROBE_RESP = 1<<16,
326 BSS_CHANGED_PS = 1<<17,
327 BSS_CHANGED_TXPOWER = 1<<18,
328 BSS_CHANGED_P2P_PS = 1<<19,
329 BSS_CHANGED_BEACON_INFO = 1<<20,
330 BSS_CHANGED_BANDWIDTH = 1<<21,
331 BSS_CHANGED_OCB = 1<<22,
332 BSS_CHANGED_MU_GROUPS = 1<<23,
333 BSS_CHANGED_KEEP_ALIVE = 1<<24,
334 BSS_CHANGED_MCAST_RATE = 1<<25,
335
336 /* when adding here, make sure to change ieee80211_reconfig */
337};
338
339/*
340 * The maximum number of IPv4 addresses listed for ARP filtering. If the number
341 * of addresses for an interface increase beyond this value, hardware ARP
342 * filtering will be disabled.
343 */
344#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
345
346/**
347 * enum ieee80211_event_type - event to be notified to the low level driver
348 * @RSSI_EVENT: AP's rssi crossed the a threshold set by the driver.
349 * @MLME_EVENT: event related to MLME
350 * @BAR_RX_EVENT: a BAR was received
351 * @BA_FRAME_TIMEOUT: Frames were released from the reordering buffer because
352 * they timed out. This won't be called for each frame released, but only
353 * once each time the timeout triggers.
354 */
355enum ieee80211_event_type {
356 RSSI_EVENT,
357 MLME_EVENT,
358 BAR_RX_EVENT,
359 BA_FRAME_TIMEOUT,
360};
361
362/**
363 * enum ieee80211_rssi_event_data - relevant when event type is %RSSI_EVENT
364 * @RSSI_EVENT_HIGH: AP's rssi went below the threshold set by the driver.
365 * @RSSI_EVENT_LOW: AP's rssi went above the threshold set by the driver.
366 */
367enum ieee80211_rssi_event_data {
368 RSSI_EVENT_HIGH,
369 RSSI_EVENT_LOW,
370};
371
372/**
373 * struct ieee80211_rssi_event - data attached to an %RSSI_EVENT
374 * @data: See &enum ieee80211_rssi_event_data
375 */
376struct ieee80211_rssi_event {
377 enum ieee80211_rssi_event_data data;
378};
379
380/**
381 * enum ieee80211_mlme_event_data - relevant when event type is %MLME_EVENT
382 * @AUTH_EVENT: the MLME operation is authentication
383 * @ASSOC_EVENT: the MLME operation is association
384 * @DEAUTH_RX_EVENT: deauth received..
385 * @DEAUTH_TX_EVENT: deauth sent.
386 */
387enum ieee80211_mlme_event_data {
388 AUTH_EVENT,
389 ASSOC_EVENT,
390 DEAUTH_RX_EVENT,
391 DEAUTH_TX_EVENT,
392};
393
394/**
395 * enum ieee80211_mlme_event_status - relevant when event type is %MLME_EVENT
396 * @MLME_SUCCESS: the MLME operation completed successfully.
397 * @MLME_DENIED: the MLME operation was denied by the peer.
398 * @MLME_TIMEOUT: the MLME operation timed out.
399 */
400enum ieee80211_mlme_event_status {
401 MLME_SUCCESS,
402 MLME_DENIED,
403 MLME_TIMEOUT,
404};
405
406/**
407 * struct ieee80211_mlme_event - data attached to an %MLME_EVENT
408 * @data: See &enum ieee80211_mlme_event_data
409 * @status: See &enum ieee80211_mlme_event_status
410 * @reason: the reason code if applicable
411 */
412struct ieee80211_mlme_event {
413 enum ieee80211_mlme_event_data data;
414 enum ieee80211_mlme_event_status status;
415 u16 reason;
416};
417
418/**
419 * struct ieee80211_ba_event - data attached for BlockAck related events
420 * @sta: pointer to the &ieee80211_sta to which this event relates
421 * @tid: the tid
422 * @ssn: the starting sequence number (for %BAR_RX_EVENT)
423 */
424struct ieee80211_ba_event {
425 struct ieee80211_sta *sta;
426 u16 tid;
427 u16 ssn;
428};
429
430/**
431 * struct ieee80211_event - event to be sent to the driver
432 * @type: The event itself. See &enum ieee80211_event_type.
433 * @rssi: relevant if &type is %RSSI_EVENT
434 * @mlme: relevant if &type is %AUTH_EVENT
435 * @ba: relevant if &type is %BAR_RX_EVENT or %BA_FRAME_TIMEOUT
436 * @u:union holding the fields above
437 */
438struct ieee80211_event {
439 enum ieee80211_event_type type;
440 union {
441 struct ieee80211_rssi_event rssi;
442 struct ieee80211_mlme_event mlme;
443 struct ieee80211_ba_event ba;
444 } u;
445};
446
447/**
448 * struct ieee80211_mu_group_data - STA's VHT MU-MIMO group data
449 *
450 * This structure describes the group id data of VHT MU-MIMO
451 *
452 * @membership: 64 bits array - a bit is set if station is member of the group
453 * @position: 2 bits per group id indicating the position in the group
454 */
455struct ieee80211_mu_group_data {
456 u8 membership[WLAN_MEMBERSHIP_LEN];
457 u8 position[WLAN_USER_POSITION_LEN];
458};
459
460/**
461 * struct ieee80211_bss_conf - holds the BSS's changing parameters
462 *
463 * This structure keeps information about a BSS (and an association
464 * to that BSS) that can change during the lifetime of the BSS.
465 *
466 * @assoc: association status
467 * @ibss_joined: indicates whether this station is part of an IBSS
468 * or not
469 * @ibss_creator: indicates if a new IBSS network is being created
470 * @aid: association ID number, valid only when @assoc is true
471 * @use_cts_prot: use CTS protection
472 * @use_short_preamble: use 802.11b short preamble
473 * @use_short_slot: use short slot time (only relevant for ERP)
474 * @dtim_period: num of beacons before the next DTIM, for beaconing,
475 * valid in station mode only if after the driver was notified
476 * with the %BSS_CHANGED_BEACON_INFO flag, will be non-zero then.
477 * @sync_tsf: last beacon's/probe response's TSF timestamp (could be old
478 * as it may have been received during scanning long ago). If the
479 * HW flag %IEEE80211_HW_TIMING_BEACON_ONLY is set, then this can
480 * only come from a beacon, but might not become valid until after
481 * association when a beacon is received (which is notified with the
482 * %BSS_CHANGED_DTIM flag.). See also sync_dtim_count important notice.
483 * @sync_device_ts: the device timestamp corresponding to the sync_tsf,
484 * the driver/device can use this to calculate synchronisation
485 * (see @sync_tsf). See also sync_dtim_count important notice.
486 * @sync_dtim_count: Only valid when %IEEE80211_HW_TIMING_BEACON_ONLY
487 * is requested, see @sync_tsf/@sync_device_ts.
488 * IMPORTANT: These three sync_* parameters would possibly be out of sync
489 * by the time the driver will use them. The synchronized view is currently
490 * guaranteed only in certain callbacks.
491 * @beacon_int: beacon interval
492 * @assoc_capability: capabilities taken from assoc resp
493 * @basic_rates: bitmap of basic rates, each bit stands for an
494 * index into the rate table configured by the driver in
495 * the current band.
496 * @beacon_rate: associated AP's beacon TX rate
497 * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
498 * @bssid: The BSSID for this BSS
499 * @enable_beacon: whether beaconing should be enabled or not
500 * @chandef: Channel definition for this BSS -- the hardware might be
501 * configured a higher bandwidth than this BSS uses, for example.
502 * @mu_group: VHT MU-MIMO group membership data
503 * @ht_operation_mode: HT operation mode like in &struct ieee80211_ht_operation.
504 * This field is only valid when the channel is a wide HT/VHT channel.
505 * Note that with TDLS this can be the case (channel is HT, protection must
506 * be used from this field) even when the BSS association isn't using HT.
507 * @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
508 * implies disabled. As with the cfg80211 callback, a change here should
509 * cause an event to be sent indicating where the current value is in
510 * relation to the newly configured threshold.
511 * @cqm_rssi_low: Connection quality monitor RSSI lower threshold, a zero value
512 * implies disabled. This is an alternative mechanism to the single
513 * threshold event and can't be enabled simultaneously with it.
514 * @cqm_rssi_high: Connection quality monitor RSSI upper threshold.
515 * @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
516 * @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
517 * may filter ARP queries targeted for other addresses than listed here.
518 * The driver must allow ARP queries targeted for all address listed here
519 * to pass through. An empty list implies no ARP queries need to pass.
520 * @arp_addr_cnt: Number of addresses currently on the list. Note that this
521 * may be larger than %IEEE80211_BSS_ARP_ADDR_LIST_LEN (the arp_addr_list
522 * array size), it's up to the driver what to do in that case.
523 * @qos: This is a QoS-enabled BSS.
524 * @idle: This interface is idle. There's also a global idle flag in the
525 * hardware config which may be more appropriate depending on what
526 * your driver/device needs to do.
527 * @ps: power-save mode (STA only). This flag is NOT affected by
528 * offchannel/dynamic_ps operations.
529 * @ssid: The SSID of the current vif. Valid in AP and IBSS mode.
530 * @ssid_len: Length of SSID given in @ssid.
531 * @hidden_ssid: The SSID of the current vif is hidden. Only valid in AP-mode.
532 * @txpower: TX power in dBm
533 * @txpower_type: TX power adjustment used to control per packet Transmit
534 * Power Control (TPC) in lower driver for the current vif. In particular
535 * TPC is enabled if value passed in %txpower_type is
536 * NL80211_TX_POWER_LIMITED (allow using less than specified from
537 * userspace), whereas TPC is disabled if %txpower_type is set to
538 * NL80211_TX_POWER_FIXED (use value configured from userspace)
539 * @p2p_noa_attr: P2P NoA attribute for P2P powersave
540 * @allow_p2p_go_ps: indication for AP or P2P GO interface, whether it's allowed
541 * to use P2P PS mechanism or not. AP/P2P GO is not allowed to use P2P PS
542 * if it has associated clients without P2P PS support.
543 * @max_idle_period: the time period during which the station can refrain from
544 * transmitting frames to its associated AP without being disassociated.
545 * In units of 1000 TUs. Zero value indicates that the AP did not include
546 * a (valid) BSS Max Idle Period Element.
547 * @protected_keep_alive: if set, indicates that the station should send an RSN
548 * protected frame to the AP to reset the idle timer at the AP for the
549 * station.
550 */
551struct ieee80211_bss_conf {
552 const u8 *bssid;
553 /* association related data */
554 bool assoc, ibss_joined;
555 bool ibss_creator;
556 u16 aid;
557 /* erp related data */
558 bool use_cts_prot;
559 bool use_short_preamble;
560 bool use_short_slot;
561 bool enable_beacon;
562 u8 dtim_period;
563 u16 beacon_int;
564 u16 assoc_capability;
565 u64 sync_tsf;
566 u32 sync_device_ts;
567 u8 sync_dtim_count;
568 u32 basic_rates;
569 struct ieee80211_rate *beacon_rate;
570 int mcast_rate[NUM_NL80211_BANDS];
571 u16 ht_operation_mode;
572 s32 cqm_rssi_thold;
573 u32 cqm_rssi_hyst;
574 s32 cqm_rssi_low;
575 s32 cqm_rssi_high;
576 struct cfg80211_chan_def chandef;
577 struct ieee80211_mu_group_data mu_group;
578 __be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
579 int arp_addr_cnt;
580 bool qos;
581 bool idle;
582 bool ps;
583 u8 ssid[IEEE80211_MAX_SSID_LEN];
584 size_t ssid_len;
585 bool hidden_ssid;
586 int txpower;
587 enum nl80211_tx_power_setting txpower_type;
588 struct ieee80211_p2p_noa_attr p2p_noa_attr;
589 bool allow_p2p_go_ps;
590 u16 max_idle_period;
591 bool protected_keep_alive;
592};
593
594/**
595 * enum mac80211_tx_info_flags - flags to describe transmission information/status
596 *
597 * These flags are used with the @flags member of &ieee80211_tx_info.
598 *
599 * @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
600 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
601 * number to this frame, taking care of not overwriting the fragment
602 * number and increasing the sequence number only when the
603 * IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
604 * assign sequence numbers to QoS-data frames but cannot do so correctly
605 * for non-QoS-data and management frames because beacons need them from
606 * that counter as well and mac80211 cannot guarantee proper sequencing.
607 * If this flag is set, the driver should instruct the hardware to
608 * assign a sequence number to the frame or assign one itself. Cf. IEEE
609 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
610 * beacons and always be clear for frames without a sequence number field.
611 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
612 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
613 * station
614 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
615 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
616 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
617 * @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
618 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
619 * because the destination STA was in powersave mode. Note that to
620 * avoid race conditions, the filter must be set by the hardware or
621 * firmware upon receiving a frame that indicates that the station
622 * went to sleep (must be done on device to filter frames already on
623 * the queue) and may only be unset after mac80211 gives the OK for
624 * that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
625 * since only then is it guaranteed that no more frames are in the
626 * hardware queue.
627 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
628 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
629 * is for the whole aggregation.
630 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
631 * so consider using block ack request (BAR).
632 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
633 * set by rate control algorithms to indicate probe rate, will
634 * be cleared for fragmented frames (except on the last fragment)
635 * @IEEE80211_TX_INTFL_OFFCHAN_TX_OK: Internal to mac80211. Used to indicate
636 * that a frame can be transmitted while the queues are stopped for
637 * off-channel operation.
638 * @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
639 * used to indicate that a pending frame requires TX processing before
640 * it can be sent out.
641 * @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
642 * used to indicate that a frame was already retried due to PS
643 * @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
644 * used to indicate frame should not be encrypted
645 * @IEEE80211_TX_CTL_NO_PS_BUFFER: This frame is a response to a poll
646 * frame (PS-Poll or uAPSD) or a non-bufferable MMPDU and must
647 * be sent although the station is in powersave mode.
648 * @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
649 * transmit function after the current frame, this can be used
650 * by drivers to kick the DMA queue only if unset or when the
651 * queue gets full.
652 * @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
653 * after TX status because the destination was asleep, it must not
654 * be modified again (no seqno assignment, crypto, etc.)
655 * @IEEE80211_TX_INTFL_MLME_CONN_TX: This frame was transmitted by the MLME
656 * code for connection establishment, this indicates that its status
657 * should kick the MLME state machine.
658 * @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
659 * MLME command (internal to mac80211 to figure out whether to send TX
660 * status to user space)
661 * @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
662 * @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
663 * frame and selects the maximum number of streams that it can use.
664 * @IEEE80211_TX_CTL_TX_OFFCHAN: Marks this packet to be transmitted on
665 * the off-channel channel when a remain-on-channel offload is done
666 * in hardware -- normal packets still flow and are expected to be
667 * handled properly by the device.
668 * @IEEE80211_TX_INTFL_TKIP_MIC_FAILURE: Marks this packet to be used for TKIP
669 * testing. It will be sent out with incorrect Michael MIC key to allow
670 * TKIP countermeasures to be tested.
671 * @IEEE80211_TX_CTL_NO_CCK_RATE: This frame will be sent at non CCK rate.
672 * This flag is actually used for management frame especially for P2P
673 * frames not being sent at CCK rate in 2GHz band.
674 * @IEEE80211_TX_STATUS_EOSP: This packet marks the end of service period,
675 * when its status is reported the service period ends. For frames in
676 * an SP that mac80211 transmits, it is already set; for driver frames
677 * the driver may set this flag. It is also used to do the same for
678 * PS-Poll responses.
679 * @IEEE80211_TX_CTL_USE_MINRATE: This frame will be sent at lowest rate.
680 * This flag is used to send nullfunc frame at minimum rate when
681 * the nullfunc is used for connection monitoring purpose.
682 * @IEEE80211_TX_CTL_DONTFRAG: Don't fragment this packet even if it
683 * would be fragmented by size (this is optional, only used for
684 * monitor injection).
685 * @IEEE80211_TX_STAT_NOACK_TRANSMITTED: A frame that was marked with
686 * IEEE80211_TX_CTL_NO_ACK has been successfully transmitted without
687 * any errors (like issues specific to the driver/HW).
688 * This flag must not be set for frames that don't request no-ack
689 * behaviour with IEEE80211_TX_CTL_NO_ACK.
690 *
691 * Note: If you have to add new flags to the enumeration, then don't
692 * forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
693 */
694enum mac80211_tx_info_flags {
695 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
696 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
697 IEEE80211_TX_CTL_NO_ACK = BIT(2),
698 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
699 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
700 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
701 IEEE80211_TX_CTL_AMPDU = BIT(6),
702 IEEE80211_TX_CTL_INJECTED = BIT(7),
703 IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
704 IEEE80211_TX_STAT_ACK = BIT(9),
705 IEEE80211_TX_STAT_AMPDU = BIT(10),
706 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
707 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
708 IEEE80211_TX_INTFL_OFFCHAN_TX_OK = BIT(13),
709 IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
710 IEEE80211_TX_INTFL_RETRIED = BIT(15),
711 IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
712 IEEE80211_TX_CTL_NO_PS_BUFFER = BIT(17),
713 IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
714 IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
715 IEEE80211_TX_INTFL_MLME_CONN_TX = BIT(20),
716 IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
717 IEEE80211_TX_CTL_LDPC = BIT(22),
718 IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
719 IEEE80211_TX_CTL_TX_OFFCHAN = BIT(25),
720 IEEE80211_TX_INTFL_TKIP_MIC_FAILURE = BIT(26),
721 IEEE80211_TX_CTL_NO_CCK_RATE = BIT(27),
722 IEEE80211_TX_STATUS_EOSP = BIT(28),
723 IEEE80211_TX_CTL_USE_MINRATE = BIT(29),
724 IEEE80211_TX_CTL_DONTFRAG = BIT(30),
725 IEEE80211_TX_STAT_NOACK_TRANSMITTED = BIT(31),
726};
727
728#define IEEE80211_TX_CTL_STBC_SHIFT 23
729
730/**
731 * enum mac80211_tx_control_flags - flags to describe transmit control
732 *
733 * @IEEE80211_TX_CTRL_PORT_CTRL_PROTO: this frame is a port control
734 * protocol frame (e.g. EAP)
735 * @IEEE80211_TX_CTRL_PS_RESPONSE: This frame is a response to a poll
736 * frame (PS-Poll or uAPSD).
737 * @IEEE80211_TX_CTRL_RATE_INJECT: This frame is injected with rate information
738 * @IEEE80211_TX_CTRL_AMSDU: This frame is an A-MSDU frame
739 * @IEEE80211_TX_CTRL_FAST_XMIT: This frame is going through the fast_xmit path
740 *
741 * These flags are used in tx_info->control.flags.
742 */
743enum mac80211_tx_control_flags {
744 IEEE80211_TX_CTRL_PORT_CTRL_PROTO = BIT(0),
745 IEEE80211_TX_CTRL_PS_RESPONSE = BIT(1),
746 IEEE80211_TX_CTRL_RATE_INJECT = BIT(2),
747 IEEE80211_TX_CTRL_AMSDU = BIT(3),
748 IEEE80211_TX_CTRL_FAST_XMIT = BIT(4),
749};
750
751/*
752 * This definition is used as a mask to clear all temporary flags, which are
753 * set by the tx handlers for each transmission attempt by the mac80211 stack.
754 */
755#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
756 IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
757 IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
758 IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
759 IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
760 IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_NO_PS_BUFFER | \
761 IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
762 IEEE80211_TX_CTL_STBC | IEEE80211_TX_STATUS_EOSP)
763
764/**
765 * enum mac80211_rate_control_flags - per-rate flags set by the
766 * Rate Control algorithm.
767 *
768 * These flags are set by the Rate control algorithm for each rate during tx,
769 * in the @flags member of struct ieee80211_tx_rate.
770 *
771 * @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
772 * @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
773 * This is set if the current BSS requires ERP protection.
774 * @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
775 * @IEEE80211_TX_RC_MCS: HT rate.
776 * @IEEE80211_TX_RC_VHT_MCS: VHT MCS rate, in this case the idx field is split
777 * into a higher 4 bits (Nss) and lower 4 bits (MCS number)
778 * @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
779 * Greenfield mode.
780 * @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
781 * @IEEE80211_TX_RC_80_MHZ_WIDTH: Indicates 80 MHz transmission
782 * @IEEE80211_TX_RC_160_MHZ_WIDTH: Indicates 160 MHz transmission
783 * (80+80 isn't supported yet)
784 * @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
785 * adjacent 20 MHz channels, if the current channel type is
786 * NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
787 * @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
788 */
789enum mac80211_rate_control_flags {
790 IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
791 IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
792 IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
793
794 /* rate index is an HT/VHT MCS instead of an index */
795 IEEE80211_TX_RC_MCS = BIT(3),
796 IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
797 IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
798 IEEE80211_TX_RC_DUP_DATA = BIT(6),
799 IEEE80211_TX_RC_SHORT_GI = BIT(7),
800 IEEE80211_TX_RC_VHT_MCS = BIT(8),
801 IEEE80211_TX_RC_80_MHZ_WIDTH = BIT(9),
802 IEEE80211_TX_RC_160_MHZ_WIDTH = BIT(10),
803};
804
805
806/* there are 40 bytes if you don't need the rateset to be kept */
807#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
808
809/* if you do need the rateset, then you have less space */
810#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
811
812/* maximum number of rate stages */
813#define IEEE80211_TX_MAX_RATES 4
814
815/* maximum number of rate table entries */
816#define IEEE80211_TX_RATE_TABLE_SIZE 4
817
818/**
819 * struct ieee80211_tx_rate - rate selection/status
820 *
821 * @idx: rate index to attempt to send with
822 * @flags: rate control flags (&enum mac80211_rate_control_flags)
823 * @count: number of tries in this rate before going to the next rate
824 *
825 * A value of -1 for @idx indicates an invalid rate and, if used
826 * in an array of retry rates, that no more rates should be tried.
827 *
828 * When used for transmit status reporting, the driver should
829 * always report the rate along with the flags it used.
830 *
831 * &struct ieee80211_tx_info contains an array of these structs
832 * in the control information, and it will be filled by the rate
833 * control algorithm according to what should be sent. For example,
834 * if this array contains, in the format { <idx>, <count> } the
835 * information::
836 *
837 * { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
838 *
839 * then this means that the frame should be transmitted
840 * up to twice at rate 3, up to twice at rate 2, and up to four
841 * times at rate 1 if it doesn't get acknowledged. Say it gets
842 * acknowledged by the peer after the fifth attempt, the status
843 * information should then contain::
844 *
845 * { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
846 *
847 * since it was transmitted twice at rate 3, twice at rate 2
848 * and once at rate 1 after which we received an acknowledgement.
849 */
850struct ieee80211_tx_rate {
851 s8 idx;
852 u16 count:5,
853 flags:11;
854} __packed;
855
856#define IEEE80211_MAX_TX_RETRY 31
857
858static inline void ieee80211_rate_set_vht(struct ieee80211_tx_rate *rate,
859 u8 mcs, u8 nss)
860{
861 WARN_ON(mcs & ~0xF);
862 WARN_ON((nss - 1) & ~0x7);
863 rate->idx = ((nss - 1) << 4) | mcs;
864}
865
866static inline u8
867ieee80211_rate_get_vht_mcs(const struct ieee80211_tx_rate *rate)
868{
869 return rate->idx & 0xF;
870}
871
872static inline u8
873ieee80211_rate_get_vht_nss(const struct ieee80211_tx_rate *rate)
874{
875 return (rate->idx >> 4) + 1;
876}
877
878/**
879 * struct ieee80211_tx_info - skb transmit information
880 *
881 * This structure is placed in skb->cb for three uses:
882 * (1) mac80211 TX control - mac80211 tells the driver what to do
883 * (2) driver internal use (if applicable)
884 * (3) TX status information - driver tells mac80211 what happened
885 *
886 * @flags: transmit info flags, defined above
887 * @band: the band to transmit on (use for checking for races)
888 * @hw_queue: HW queue to put the frame on, skb_get_queue_mapping() gives the AC
889 * @ack_frame_id: internal frame ID for TX status, used internally
890 * @control: union for control data
891 * @status: union for status data
892 * @driver_data: array of driver_data pointers
893 * @ampdu_ack_len: number of acked aggregated frames.
894 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
895 * @ampdu_len: number of aggregated frames.
896 * relevant only if IEEE80211_TX_STAT_AMPDU was set.
897 * @ack_signal: signal strength of the ACK frame
898 */
899struct ieee80211_tx_info {
900 /* common information */
901 u32 flags;
902 u8 band;
903
904 u8 hw_queue;
905
906 u16 ack_frame_id;
907
908 union {
909 struct {
910 union {
911 /* rate control */
912 struct {
913 struct ieee80211_tx_rate rates[
914 IEEE80211_TX_MAX_RATES];
915 s8 rts_cts_rate_idx;
916 u8 use_rts:1;
917 u8 use_cts_prot:1;
918 u8 short_preamble:1;
919 u8 skip_table:1;
920 /* 2 bytes free */
921 };
922 /* only needed before rate control */
923 unsigned long jiffies;
924 };
925 /* NB: vif can be NULL for injected frames */
926 struct ieee80211_vif *vif;
927 struct ieee80211_key_conf *hw_key;
928 u32 flags;
929 codel_time_t enqueue_time;
930 } control;
931 struct {
932 u64 cookie;
933 } ack;
934 struct {
935 struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
936 s32 ack_signal;
937 u8 ampdu_ack_len;
938 u8 ampdu_len;
939 u8 antenna;
940 u16 tx_time;
941 bool is_valid_ack_signal;
942 void *status_driver_data[19 / sizeof(void *)];
943 } status;
944 struct {
945 struct ieee80211_tx_rate driver_rates[
946 IEEE80211_TX_MAX_RATES];
947 u8 pad[4];
948
949 void *rate_driver_data[
950 IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
951 };
952 void *driver_data[
953 IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
954 };
955};
956
957/**
958 * struct ieee80211_tx_status - extended tx staus info for rate control
959 *
960 * @sta: Station that the packet was transmitted for
961 * @info: Basic tx status information
962 * @skb: Packet skb (can be NULL if not provided by the driver)
963 */
964struct ieee80211_tx_status {
965 struct ieee80211_sta *sta;
966 struct ieee80211_tx_info *info;
967 struct sk_buff *skb;
968};
969
970/**
971 * struct ieee80211_scan_ies - descriptors for different blocks of IEs
972 *
973 * This structure is used to point to different blocks of IEs in HW scan
974 * and scheduled scan. These blocks contain the IEs passed by userspace
975 * and the ones generated by mac80211.
976 *
977 * @ies: pointers to band specific IEs.
978 * @len: lengths of band_specific IEs.
979 * @common_ies: IEs for all bands (especially vendor specific ones)
980 * @common_ie_len: length of the common_ies
981 */
982struct ieee80211_scan_ies {
983 const u8 *ies[NUM_NL80211_BANDS];
984 size_t len[NUM_NL80211_BANDS];
985 const u8 *common_ies;
986 size_t common_ie_len;
987};
988
989
990static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
991{
992 return (struct ieee80211_tx_info *)skb->cb;
993}
994
995static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
996{
997 return (struct ieee80211_rx_status *)skb->cb;
998}
999
1000/**
1001 * ieee80211_tx_info_clear_status - clear TX status
1002 *
1003 * @info: The &struct ieee80211_tx_info to be cleared.
1004 *
1005 * When the driver passes an skb back to mac80211, it must report
1006 * a number of things in TX status. This function clears everything
1007 * in the TX status but the rate control information (it does clear
1008 * the count since you need to fill that in anyway).
1009 *
1010 * NOTE: You can only use this function if you do NOT use
1011 * info->driver_data! Use info->rate_driver_data
1012 * instead if you need only the less space that allows.
1013 */
1014static inline void
1015ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
1016{
1017 int i;
1018
1019 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1020 offsetof(struct ieee80211_tx_info, control.rates));
1021 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
1022 offsetof(struct ieee80211_tx_info, driver_rates));
1023 BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
1024 /* clear the rate counts */
1025 for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
1026 info->status.rates[i].count = 0;
1027
1028 BUILD_BUG_ON(
1029 offsetof(struct ieee80211_tx_info, status.ack_signal) != 20);
1030 memset(&info->status.ampdu_ack_len, 0,
1031 sizeof(struct ieee80211_tx_info) -
1032 offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
1033}
1034
1035
1036/**
1037 * enum mac80211_rx_flags - receive flags
1038 *
1039 * These flags are used with the @flag member of &struct ieee80211_rx_status.
1040 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
1041 * Use together with %RX_FLAG_MMIC_STRIPPED.
1042 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
1043 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
1044 * verification has been done by the hardware.
1045 * @RX_FLAG_IV_STRIPPED: The IV and ICV are stripped from this frame.
1046 * If this flag is set, the stack cannot do any replay detection
1047 * hence the driver or hardware will have to do that.
1048 * @RX_FLAG_PN_VALIDATED: Currently only valid for CCMP/GCMP frames, this
1049 * flag indicates that the PN was verified for replay protection.
1050 * Note that this flag is also currently only supported when a frame
1051 * is also decrypted (ie. @RX_FLAG_DECRYPTED must be set)
1052 * @RX_FLAG_DUP_VALIDATED: The driver should set this flag if it did
1053 * de-duplication by itself.
1054 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
1055 * the frame.
1056 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
1057 * the frame.
1058 * @RX_FLAG_MACTIME_START: The timestamp passed in the RX status (@mactime
1059 * field) is valid and contains the time the first symbol of the MPDU
1060 * was received. This is useful in monitor mode and for proper IBSS
1061 * merging.
1062 * @RX_FLAG_MACTIME_END: The timestamp passed in the RX status (@mactime
1063 * field) is valid and contains the time the last symbol of the MPDU
1064 * (including FCS) was received.
1065 * @RX_FLAG_MACTIME_PLCP_START: The timestamp passed in the RX status (@mactime
1066 * field) is valid and contains the time the SYNC preamble was received.
1067 * @RX_FLAG_NO_SIGNAL_VAL: The signal strength value is not present.
1068 * Valid only for data frames (mainly A-MPDU)
1069 * @RX_FLAG_AMPDU_DETAILS: A-MPDU details are known, in particular the reference
1070 * number (@ampdu_reference) must be populated and be a distinct number for
1071 * each A-MPDU
1072 * @RX_FLAG_AMPDU_LAST_KNOWN: last subframe is known, should be set on all
1073 * subframes of a single A-MPDU
1074 * @RX_FLAG_AMPDU_IS_LAST: this subframe is the last subframe of the A-MPDU
1075 * @RX_FLAG_AMPDU_DELIM_CRC_ERROR: A delimiter CRC error has been detected
1076 * on this subframe
1077 * @RX_FLAG_AMPDU_DELIM_CRC_KNOWN: The delimiter CRC field is known (the CRC
1078 * is stored in the @ampdu_delimiter_crc field)
1079 * @RX_FLAG_MIC_STRIPPED: The mic was stripped of this packet. Decryption was
1080 * done by the hardware
1081 * @RX_FLAG_ONLY_MONITOR: Report frame only to monitor interfaces without
1082 * processing it in any regular way.
1083 * This is useful if drivers offload some frames but still want to report
1084 * them for sniffing purposes.
1085 * @RX_FLAG_SKIP_MONITOR: Process and report frame to all interfaces except
1086 * monitor interfaces.
1087 * This is useful if drivers offload some frames but still want to report
1088 * them for sniffing purposes.
1089 * @RX_FLAG_AMSDU_MORE: Some drivers may prefer to report separate A-MSDU
1090 * subframes instead of a one huge frame for performance reasons.
1091 * All, but the last MSDU from an A-MSDU should have this flag set. E.g.
1092 * if an A-MSDU has 3 frames, the first 2 must have the flag set, while
1093 * the 3rd (last) one must not have this flag set. The flag is used to
1094 * deal with retransmission/duplication recovery properly since A-MSDU
1095 * subframes share the same sequence number. Reported subframes can be
1096 * either regular MSDU or singly A-MSDUs. Subframes must not be
1097 * interleaved with other frames.
1098 * @RX_FLAG_RADIOTAP_VENDOR_DATA: This frame contains vendor-specific
1099 * radiotap data in the skb->data (before the frame) as described by
1100 * the &struct ieee80211_vendor_radiotap.
1101 * @RX_FLAG_ALLOW_SAME_PN: Allow the same PN as same packet before.
1102 * This is used for AMSDU subframes which can have the same PN as
1103 * the first subframe.
1104 * @RX_FLAG_ICV_STRIPPED: The ICV is stripped from this frame. CRC checking must
1105 * be done in the hardware.
1106 * @RX_FLAG_AMPDU_EOF_BIT: Value of the EOF bit in the A-MPDU delimiter for this
1107 * frame
1108 * @RX_FLAG_AMPDU_EOF_BIT_KNOWN: The EOF value is known
1109 */
1110enum mac80211_rx_flags {
1111 RX_FLAG_MMIC_ERROR = BIT(0),
1112 RX_FLAG_DECRYPTED = BIT(1),
1113 RX_FLAG_MACTIME_PLCP_START = BIT(2),
1114 RX_FLAG_MMIC_STRIPPED = BIT(3),
1115 RX_FLAG_IV_STRIPPED = BIT(4),
1116 RX_FLAG_FAILED_FCS_CRC = BIT(5),
1117 RX_FLAG_FAILED_PLCP_CRC = BIT(6),
1118 RX_FLAG_MACTIME_START = BIT(7),
1119 RX_FLAG_NO_SIGNAL_VAL = BIT(8),
1120 RX_FLAG_AMPDU_DETAILS = BIT(9),
1121 RX_FLAG_PN_VALIDATED = BIT(10),
1122 RX_FLAG_DUP_VALIDATED = BIT(11),
1123 RX_FLAG_AMPDU_LAST_KNOWN = BIT(12),
1124 RX_FLAG_AMPDU_IS_LAST = BIT(13),
1125 RX_FLAG_AMPDU_DELIM_CRC_ERROR = BIT(14),
1126 RX_FLAG_AMPDU_DELIM_CRC_KNOWN = BIT(15),
1127 RX_FLAG_MACTIME_END = BIT(16),
1128 RX_FLAG_ONLY_MONITOR = BIT(17),
1129 RX_FLAG_SKIP_MONITOR = BIT(18),
1130 RX_FLAG_AMSDU_MORE = BIT(19),
1131 RX_FLAG_RADIOTAP_VENDOR_DATA = BIT(20),
1132 RX_FLAG_MIC_STRIPPED = BIT(21),
1133 RX_FLAG_ALLOW_SAME_PN = BIT(22),
1134 RX_FLAG_ICV_STRIPPED = BIT(23),
1135 RX_FLAG_AMPDU_EOF_BIT = BIT(24),
1136 RX_FLAG_AMPDU_EOF_BIT_KNOWN = BIT(25),
1137};
1138
1139/**
1140 * enum mac80211_rx_encoding_flags - MCS & bandwidth flags
1141 *
1142 * @RX_ENC_FLAG_SHORTPRE: Short preamble was used for this frame
1143 * @RX_ENC_FLAG_SHORT_GI: Short guard interval was used
1144 * @RX_ENC_FLAG_HT_GF: This frame was received in a HT-greenfield transmission,
1145 * if the driver fills this value it should add
1146 * %IEEE80211_RADIOTAP_MCS_HAVE_FMT
1147 * to hw.radiotap_mcs_details to advertise that fact
1148 * @RX_ENC_FLAG_LDPC: LDPC was used
1149 * @RX_ENC_FLAG_STBC_MASK: STBC 2 bit bitmask. 1 - Nss=1, 2 - Nss=2, 3 - Nss=3
1150 * @RX_ENC_FLAG_BF: packet was beamformed
1151 */
1152enum mac80211_rx_encoding_flags {
1153 RX_ENC_FLAG_SHORTPRE = BIT(0),
1154 RX_ENC_FLAG_SHORT_GI = BIT(2),
1155 RX_ENC_FLAG_HT_GF = BIT(3),
1156 RX_ENC_FLAG_STBC_MASK = BIT(4) | BIT(5),
1157 RX_ENC_FLAG_LDPC = BIT(6),
1158 RX_ENC_FLAG_BF = BIT(7),
1159};
1160
1161#define RX_ENC_FLAG_STBC_SHIFT 4
1162
1163enum mac80211_rx_encoding {
1164 RX_ENC_LEGACY = 0,
1165 RX_ENC_HT,
1166 RX_ENC_VHT,
1167};
1168
1169/**
1170 * struct ieee80211_rx_status - receive status
1171 *
1172 * The low-level driver should provide this information (the subset
1173 * supported by hardware) to the 802.11 code with each received
1174 * frame, in the skb's control buffer (cb).
1175 *
1176 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
1177 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
1178 * @boottime_ns: CLOCK_BOOTTIME timestamp the frame was received at, this is
1179 * needed only for beacons and probe responses that update the scan cache.
1180 * @device_timestamp: arbitrary timestamp for the device, mac80211 doesn't use
1181 * it but can store it and pass it back to the driver for synchronisation
1182 * @band: the active band when this frame was received
1183 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
1184 * This field must be set for management frames, but isn't strictly needed
1185 * for data (other) frames - for those it only affects radiotap reporting.
1186 * @signal: signal strength when receiving this frame, either in dBm, in dB or
1187 * unspecified depending on the hardware capabilities flags
1188 * @IEEE80211_HW_SIGNAL_*
1189 * @chains: bitmask of receive chains for which separate signal strength
1190 * values were filled.
1191 * @chain_signal: per-chain signal strength, in dBm (unlike @signal, doesn't
1192 * support dB or unspecified units)
1193 * @antenna: antenna used
1194 * @rate_idx: index of data rate into band's supported rates or MCS index if
1195 * HT or VHT is used (%RX_FLAG_HT/%RX_FLAG_VHT)
1196 * @nss: number of streams (VHT and HE only)
1197 * @flag: %RX_FLAG_\*
1198 * @encoding: &enum mac80211_rx_encoding
1199 * @bw: &enum rate_info_bw
1200 * @enc_flags: uses bits from &enum mac80211_rx_encoding_flags
1201 * @rx_flags: internal RX flags for mac80211
1202 * @ampdu_reference: A-MPDU reference number, must be a different value for
1203 * each A-MPDU but the same for each subframe within one A-MPDU
1204 * @ampdu_delimiter_crc: A-MPDU delimiter CRC
1205 */
1206struct ieee80211_rx_status {
1207 u64 mactime;
1208 u64 boottime_ns;
1209 u32 device_timestamp;
1210 u32 ampdu_reference;
1211 u32 flag;
1212 u16 freq;
1213 u8 enc_flags;
1214 u8 encoding:2, bw:3;
1215 u8 rate_idx;
1216 u8 nss;
1217 u8 rx_flags;
1218 u8 band;
1219 u8 antenna;
1220 s8 signal;
1221 u8 chains;
1222 s8 chain_signal[IEEE80211_MAX_CHAINS];
1223 u8 ampdu_delimiter_crc;
1224};
1225
1226/**
1227 * struct ieee80211_vendor_radiotap - vendor radiotap data information
1228 * @present: presence bitmap for this vendor namespace
1229 * (this could be extended in the future if any vendor needs more
1230 * bits, the radiotap spec does allow for that)
1231 * @align: radiotap vendor namespace alignment. This defines the needed
1232 * alignment for the @data field below, not for the vendor namespace
1233 * description itself (which has a fixed 2-byte alignment)
1234 * Must be a power of two, and be set to at least 1!
1235 * @oui: radiotap vendor namespace OUI
1236 * @subns: radiotap vendor sub namespace
1237 * @len: radiotap vendor sub namespace skip length, if alignment is done
1238 * then that's added to this, i.e. this is only the length of the
1239 * @data field.
1240 * @pad: number of bytes of padding after the @data, this exists so that
1241 * the skb data alignment can be preserved even if the data has odd
1242 * length
1243 * @data: the actual vendor namespace data
1244 *
1245 * This struct, including the vendor data, goes into the skb->data before
1246 * the 802.11 header. It's split up in mac80211 using the align/oui/subns
1247 * data.
1248 */
1249struct ieee80211_vendor_radiotap {
1250 u32 present;
1251 u8 align;
1252 u8 oui[3];
1253 u8 subns;
1254 u8 pad;
1255 u16 len;
1256 u8 data[];
1257} __packed;
1258
1259/**
1260 * enum ieee80211_conf_flags - configuration flags
1261 *
1262 * Flags to define PHY configuration options
1263 *
1264 * @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
1265 * to determine for example whether to calculate timestamps for packets
1266 * or not, do not use instead of filter flags!
1267 * @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
1268 * This is the power save mode defined by IEEE 802.11-2007 section 11.2,
1269 * meaning that the hardware still wakes up for beacons, is able to
1270 * transmit frames and receive the possible acknowledgment frames.
1271 * Not to be confused with hardware specific wakeup/sleep states,
1272 * driver is responsible for that. See the section "Powersave support"
1273 * for more.
1274 * @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
1275 * the driver should be prepared to handle configuration requests but
1276 * may turn the device off as much as possible. Typically, this flag will
1277 * be set when an interface is set UP but not associated or scanning, but
1278 * it can also be unset in that case when monitor interfaces are active.
1279 * @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
1280 * operating channel.
1281 */
1282enum ieee80211_conf_flags {
1283 IEEE80211_CONF_MONITOR = (1<<0),
1284 IEEE80211_CONF_PS = (1<<1),
1285 IEEE80211_CONF_IDLE = (1<<2),
1286 IEEE80211_CONF_OFFCHANNEL = (1<<3),
1287};
1288
1289
1290/**
1291 * enum ieee80211_conf_changed - denotes which configuration changed
1292 *
1293 * @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
1294 * @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
1295 * @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
1296 * @IEEE80211_CONF_CHANGE_POWER: the TX power changed
1297 * @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
1298 * @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
1299 * @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
1300 * @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
1301 * Note that this is only valid if channel contexts are not used,
1302 * otherwise each channel context has the number of chains listed.
1303 */
1304enum ieee80211_conf_changed {
1305 IEEE80211_CONF_CHANGE_SMPS = BIT(1),
1306 IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
1307 IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
1308 IEEE80211_CONF_CHANGE_PS = BIT(4),
1309 IEEE80211_CONF_CHANGE_POWER = BIT(5),
1310 IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
1311 IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
1312 IEEE80211_CONF_CHANGE_IDLE = BIT(8),
1313};
1314
1315/**
1316 * enum ieee80211_smps_mode - spatial multiplexing power save mode
1317 *
1318 * @IEEE80211_SMPS_AUTOMATIC: automatic
1319 * @IEEE80211_SMPS_OFF: off
1320 * @IEEE80211_SMPS_STATIC: static
1321 * @IEEE80211_SMPS_DYNAMIC: dynamic
1322 * @IEEE80211_SMPS_NUM_MODES: internal, don't use
1323 */
1324enum ieee80211_smps_mode {
1325 IEEE80211_SMPS_AUTOMATIC,
1326 IEEE80211_SMPS_OFF,
1327 IEEE80211_SMPS_STATIC,
1328 IEEE80211_SMPS_DYNAMIC,
1329
1330 /* keep last */
1331 IEEE80211_SMPS_NUM_MODES,
1332};
1333
1334/**
1335 * struct ieee80211_conf - configuration of the device
1336 *
1337 * This struct indicates how the driver shall configure the hardware.
1338 *
1339 * @flags: configuration flags defined above
1340 *
1341 * @listen_interval: listen interval in units of beacon interval
1342 * @ps_dtim_period: The DTIM period of the AP we're connected to, for use
1343 * in power saving. Power saving will not be enabled until a beacon
1344 * has been received and the DTIM period is known.
1345 * @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
1346 * powersave documentation below. This variable is valid only when
1347 * the CONF_PS flag is set.
1348 *
1349 * @power_level: requested transmit power (in dBm), backward compatibility
1350 * value only that is set to the minimum of all interfaces
1351 *
1352 * @chandef: the channel definition to tune to
1353 * @radar_enabled: whether radar detection is enabled
1354 *
1355 * @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
1356 * (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
1357 * but actually means the number of transmissions not the number of retries
1358 * @short_frame_max_tx_count: Maximum number of transmissions for a "short"
1359 * frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
1360 * number of transmissions not the number of retries
1361 *
1362 * @smps_mode: spatial multiplexing powersave mode; note that
1363 * %IEEE80211_SMPS_STATIC is used when the device is not
1364 * configured for an HT channel.
1365 * Note that this is only valid if channel contexts are not used,
1366 * otherwise each channel context has the number of chains listed.
1367 */
1368struct ieee80211_conf {
1369 u32 flags;
1370 int power_level, dynamic_ps_timeout;
1371
1372 u16 listen_interval;
1373 u8 ps_dtim_period;
1374
1375 u8 long_frame_max_tx_count, short_frame_max_tx_count;
1376
1377 struct cfg80211_chan_def chandef;
1378 bool radar_enabled;
1379 enum ieee80211_smps_mode smps_mode;
1380};
1381
1382/**
1383 * struct ieee80211_channel_switch - holds the channel switch data
1384 *
1385 * The information provided in this structure is required for channel switch
1386 * operation.
1387 *
1388 * @timestamp: value in microseconds of the 64-bit Time Synchronization
1389 * Function (TSF) timer when the frame containing the channel switch
1390 * announcement was received. This is simply the rx.mactime parameter
1391 * the driver passed into mac80211.
1392 * @device_timestamp: arbitrary timestamp for the device, this is the
1393 * rx.device_timestamp parameter the driver passed to mac80211.
1394 * @block_tx: Indicates whether transmission must be blocked before the
1395 * scheduled channel switch, as indicated by the AP.
1396 * @chandef: the new channel to switch to
1397 * @count: the number of TBTT's until the channel switch event
1398 */
1399struct ieee80211_channel_switch {
1400 u64 timestamp;
1401 u32 device_timestamp;
1402 bool block_tx;
1403 struct cfg80211_chan_def chandef;
1404 u8 count;
1405};
1406
1407/**
1408 * enum ieee80211_vif_flags - virtual interface flags
1409 *
1410 * @IEEE80211_VIF_BEACON_FILTER: the device performs beacon filtering
1411 * on this virtual interface to avoid unnecessary CPU wakeups
1412 * @IEEE80211_VIF_SUPPORTS_CQM_RSSI: the device can do connection quality
1413 * monitoring on this virtual interface -- i.e. it can monitor
1414 * connection quality related parameters, such as the RSSI level and
1415 * provide notifications if configured trigger levels are reached.
1416 * @IEEE80211_VIF_SUPPORTS_UAPSD: The device can do U-APSD for this
1417 * interface. This flag should be set during interface addition,
1418 * but may be set/cleared as late as authentication to an AP. It is
1419 * only valid for managed/station mode interfaces.
1420 * @IEEE80211_VIF_GET_NOA_UPDATE: request to handle NOA attributes
1421 * and send P2P_PS notification to the driver if NOA changed, even
1422 * this is not pure P2P vif.
1423 */
1424enum ieee80211_vif_flags {
1425 IEEE80211_VIF_BEACON_FILTER = BIT(0),
1426 IEEE80211_VIF_SUPPORTS_CQM_RSSI = BIT(1),
1427 IEEE80211_VIF_SUPPORTS_UAPSD = BIT(2),
1428 IEEE80211_VIF_GET_NOA_UPDATE = BIT(3),
1429};
1430
1431/**
1432 * struct ieee80211_vif - per-interface data
1433 *
1434 * Data in this structure is continually present for driver
1435 * use during the life of a virtual interface.
1436 *
1437 * @type: type of this virtual interface
1438 * @bss_conf: BSS configuration for this interface, either our own
1439 * or the BSS we're associated to
1440 * @addr: address of this interface
1441 * @p2p: indicates whether this AP or STA interface is a p2p
1442 * interface, i.e. a GO or p2p-sta respectively
1443 * @csa_active: marks whether a channel switch is going on. Internally it is
1444 * write-protected by sdata_lock and local->mtx so holding either is fine
1445 * for read access.
1446 * @mu_mimo_owner: indicates interface owns MU-MIMO capability
1447 * @driver_flags: flags/capabilities the driver has for this interface,
1448 * these need to be set (or cleared) when the interface is added
1449 * or, if supported by the driver, the interface type is changed
1450 * at runtime, mac80211 will never touch this field
1451 * @hw_queue: hardware queue for each AC
1452 * @cab_queue: content-after-beacon (DTIM beacon really) queue, AP mode only
1453 * @chanctx_conf: The channel context this interface is assigned to, or %NULL
1454 * when it is not assigned. This pointer is RCU-protected due to the TX
1455 * path needing to access it; even though the netdev carrier will always
1456 * be off when it is %NULL there can still be races and packets could be
1457 * processed after it switches back to %NULL.
1458 * @debugfs_dir: debugfs dentry, can be used by drivers to create own per
1459 * interface debug files. Note that it will be NULL for the virtual
1460 * monitor interface (if that is requested.)
1461 * @probe_req_reg: probe requests should be reported to mac80211 for this
1462 * interface.
1463 * @drv_priv: data area for driver use, will always be aligned to
1464 * sizeof(void \*).
1465 * @txq: the multicast data TX queue (if driver uses the TXQ abstraction)
1466 */
1467struct ieee80211_vif {
1468 enum nl80211_iftype type;
1469 struct ieee80211_bss_conf bss_conf;
1470 u8 addr[ETH_ALEN] __aligned(2);
1471 bool p2p;
1472 bool csa_active;
1473 bool mu_mimo_owner;
1474
1475 u8 cab_queue;
1476 u8 hw_queue[IEEE80211_NUM_ACS];
1477
1478 struct ieee80211_txq *txq;
1479
1480 struct ieee80211_chanctx_conf __rcu *chanctx_conf;
1481
1482 u32 driver_flags;
1483
1484#ifdef CONFIG_MAC80211_DEBUGFS
1485 struct dentry *debugfs_dir;
1486#endif
1487
1488 unsigned int probe_req_reg;
1489
1490 /* must be last */
1491 u8 drv_priv[0] __aligned(sizeof(void *));
1492};
1493
1494static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
1495{
1496#ifdef CONFIG_MAC80211_MESH
1497 return vif->type == NL80211_IFTYPE_MESH_POINT;
1498#endif
1499 return false;
1500}
1501
1502/**
1503 * wdev_to_ieee80211_vif - return a vif struct from a wdev
1504 * @wdev: the wdev to get the vif for
1505 *
1506 * This can be used by mac80211 drivers with direct cfg80211 APIs
1507 * (like the vendor commands) that get a wdev.
1508 *
1509 * Note that this function may return %NULL if the given wdev isn't
1510 * associated with a vif that the driver knows about (e.g. monitor
1511 * or AP_VLAN interfaces.)
1512 */
1513struct ieee80211_vif *wdev_to_ieee80211_vif(struct wireless_dev *wdev);
1514
1515/**
1516 * ieee80211_vif_to_wdev - return a wdev struct from a vif
1517 * @vif: the vif to get the wdev for
1518 *
1519 * This can be used by mac80211 drivers with direct cfg80211 APIs
1520 * (like the vendor commands) that needs to get the wdev for a vif.
1521 *
1522 * Note that this function may return %NULL if the given wdev isn't
1523 * associated with a vif that the driver knows about (e.g. monitor
1524 * or AP_VLAN interfaces.)
1525 */
1526struct wireless_dev *ieee80211_vif_to_wdev(struct ieee80211_vif *vif);
1527
1528/**
1529 * enum ieee80211_key_flags - key flags
1530 *
1531 * These flags are used for communication about keys between the driver
1532 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
1533 *
1534 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
1535 * driver to indicate that it requires IV generation for this
1536 * particular key. Setting this flag does not necessarily mean that SKBs
1537 * will have sufficient tailroom for ICV or MIC.
1538 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
1539 * the driver for a TKIP key if it requires Michael MIC
1540 * generation in software.
1541 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
1542 * that the key is pairwise rather then a shared key.
1543 * @IEEE80211_KEY_FLAG_SW_MGMT_TX: This flag should be set by the driver for a
1544 * CCMP/GCMP key if it requires CCMP/GCMP encryption of management frames
1545 * (MFP) to be done in software.
1546 * @IEEE80211_KEY_FLAG_PUT_IV_SPACE: This flag should be set by the driver
1547 * if space should be prepared for the IV, but the IV
1548 * itself should not be generated. Do not set together with
1549 * @IEEE80211_KEY_FLAG_GENERATE_IV on the same key. Setting this flag does
1550 * not necessarily mean that SKBs will have sufficient tailroom for ICV or
1551 * MIC.
1552 * @IEEE80211_KEY_FLAG_RX_MGMT: This key will be used to decrypt received
1553 * management frames. The flag can help drivers that have a hardware
1554 * crypto implementation that doesn't deal with management frames
1555 * properly by allowing them to not upload the keys to hardware and
1556 * fall back to software crypto. Note that this flag deals only with
1557 * RX, if your crypto engine can't deal with TX you can also set the
1558 * %IEEE80211_KEY_FLAG_SW_MGMT_TX flag to encrypt such frames in SW.
1559 * @IEEE80211_KEY_FLAG_GENERATE_IV_MGMT: This flag should be set by the
1560 * driver for a CCMP/GCMP key to indicate that is requires IV generation
1561 * only for managment frames (MFP).
1562 * @IEEE80211_KEY_FLAG_RESERVE_TAILROOM: This flag should be set by the
1563 * driver for a key to indicate that sufficient tailroom must always
1564 * be reserved for ICV or MIC, even when HW encryption is enabled.
1565 * @IEEE80211_KEY_FLAG_PUT_MIC_SPACE: This flag should be set by the driver for
1566 * a TKIP key if it only requires MIC space. Do not set together with
1567 * @IEEE80211_KEY_FLAG_GENERATE_MMIC on the same key.
1568 */
1569enum ieee80211_key_flags {
1570 IEEE80211_KEY_FLAG_GENERATE_IV_MGMT = BIT(0),
1571 IEEE80211_KEY_FLAG_GENERATE_IV = BIT(1),
1572 IEEE80211_KEY_FLAG_GENERATE_MMIC = BIT(2),
1573 IEEE80211_KEY_FLAG_PAIRWISE = BIT(3),
1574 IEEE80211_KEY_FLAG_SW_MGMT_TX = BIT(4),
1575 IEEE80211_KEY_FLAG_PUT_IV_SPACE = BIT(5),
1576 IEEE80211_KEY_FLAG_RX_MGMT = BIT(6),
1577 IEEE80211_KEY_FLAG_RESERVE_TAILROOM = BIT(7),
1578 IEEE80211_KEY_FLAG_PUT_MIC_SPACE = BIT(8),
1579};
1580
1581/**
1582 * struct ieee80211_key_conf - key information
1583 *
1584 * This key information is given by mac80211 to the driver by
1585 * the set_key() callback in &struct ieee80211_ops.
1586 *
1587 * @hw_key_idx: To be set by the driver, this is the key index the driver
1588 * wants to be given when a frame is transmitted and needs to be
1589 * encrypted in hardware.
1590 * @cipher: The key's cipher suite selector.
1591 * @tx_pn: PN used for TX keys, may be used by the driver as well if it
1592 * needs to do software PN assignment by itself (e.g. due to TSO)
1593 * @flags: key flags, see &enum ieee80211_key_flags.
1594 * @keyidx: the key index (0-3)
1595 * @keylen: key material length
1596 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
1597 * data block:
1598 * - Temporal Encryption Key (128 bits)
1599 * - Temporal Authenticator Tx MIC Key (64 bits)
1600 * - Temporal Authenticator Rx MIC Key (64 bits)
1601 * @icv_len: The ICV length for this key type
1602 * @iv_len: The IV length for this key type
1603 */
1604struct ieee80211_key_conf {
1605 atomic64_t tx_pn;
1606 u32 cipher;
1607 u8 icv_len;
1608 u8 iv_len;
1609 u8 hw_key_idx;
1610 s8 keyidx;
1611 u16 flags;
1612 u8 keylen;
1613 u8 key[0];
1614};
1615
1616#define IEEE80211_MAX_PN_LEN 16
1617
1618#define TKIP_PN_TO_IV16(pn) ((u16)(pn & 0xffff))
1619#define TKIP_PN_TO_IV32(pn) ((u32)((pn >> 16) & 0xffffffff))
1620
1621/**
1622 * struct ieee80211_key_seq - key sequence counter
1623 *
1624 * @tkip: TKIP data, containing IV32 and IV16 in host byte order
1625 * @ccmp: PN data, most significant byte first (big endian,
1626 * reverse order than in packet)
1627 * @aes_cmac: PN data, most significant byte first (big endian,
1628 * reverse order than in packet)
1629 * @aes_gmac: PN data, most significant byte first (big endian,
1630 * reverse order than in packet)
1631 * @gcmp: PN data, most significant byte first (big endian,
1632 * reverse order than in packet)
1633 * @hw: data for HW-only (e.g. cipher scheme) keys
1634 */
1635struct ieee80211_key_seq {
1636 union {
1637 struct {
1638 u32 iv32;
1639 u16 iv16;
1640 } tkip;
1641 struct {
1642 u8 pn[6];
1643 } ccmp;
1644 struct {
1645 u8 pn[6];
1646 } aes_cmac;
1647 struct {
1648 u8 pn[6];
1649 } aes_gmac;
1650 struct {
1651 u8 pn[6];
1652 } gcmp;
1653 struct {
1654 u8 seq[IEEE80211_MAX_PN_LEN];
1655 u8 seq_len;
1656 } hw;
1657 };
1658};
1659
1660/**
1661 * struct ieee80211_cipher_scheme - cipher scheme
1662 *
1663 * This structure contains a cipher scheme information defining
1664 * the secure packet crypto handling.
1665 *
1666 * @cipher: a cipher suite selector
1667 * @iftype: a cipher iftype bit mask indicating an allowed cipher usage
1668 * @hdr_len: a length of a security header used the cipher
1669 * @pn_len: a length of a packet number in the security header
1670 * @pn_off: an offset of pn from the beginning of the security header
1671 * @key_idx_off: an offset of key index byte in the security header
1672 * @key_idx_mask: a bit mask of key_idx bits
1673 * @key_idx_shift: a bit shift needed to get key_idx
1674 * key_idx value calculation:
1675 * (sec_header_base[key_idx_off] & key_idx_mask) >> key_idx_shift
1676 * @mic_len: a mic length in bytes
1677 */
1678struct ieee80211_cipher_scheme {
1679 u32 cipher;
1680 u16 iftype;
1681 u8 hdr_len;
1682 u8 pn_len;
1683 u8 pn_off;
1684 u8 key_idx_off;
1685 u8 key_idx_mask;
1686 u8 key_idx_shift;
1687 u8 mic_len;
1688};
1689
1690/**
1691 * enum set_key_cmd - key command
1692 *
1693 * Used with the set_key() callback in &struct ieee80211_ops, this
1694 * indicates whether a key is being removed or added.
1695 *
1696 * @SET_KEY: a key is set
1697 * @DISABLE_KEY: a key must be disabled
1698 */
1699enum set_key_cmd {
1700 SET_KEY, DISABLE_KEY,
1701};
1702
1703/**
1704 * enum ieee80211_sta_state - station state
1705 *
1706 * @IEEE80211_STA_NOTEXIST: station doesn't exist at all,
1707 * this is a special state for add/remove transitions
1708 * @IEEE80211_STA_NONE: station exists without special state
1709 * @IEEE80211_STA_AUTH: station is authenticated
1710 * @IEEE80211_STA_ASSOC: station is associated
1711 * @IEEE80211_STA_AUTHORIZED: station is authorized (802.1X)
1712 */
1713enum ieee80211_sta_state {
1714 /* NOTE: These need to be ordered correctly! */
1715 IEEE80211_STA_NOTEXIST,
1716 IEEE80211_STA_NONE,
1717 IEEE80211_STA_AUTH,
1718 IEEE80211_STA_ASSOC,
1719 IEEE80211_STA_AUTHORIZED,
1720};
1721
1722/**
1723 * enum ieee80211_sta_rx_bandwidth - station RX bandwidth
1724 * @IEEE80211_STA_RX_BW_20: station can only receive 20 MHz
1725 * @IEEE80211_STA_RX_BW_40: station can receive up to 40 MHz
1726 * @IEEE80211_STA_RX_BW_80: station can receive up to 80 MHz
1727 * @IEEE80211_STA_RX_BW_160: station can receive up to 160 MHz
1728 * (including 80+80 MHz)
1729 *
1730 * Implementation note: 20 must be zero to be initialized
1731 * correctly, the values must be sorted.
1732 */
1733enum ieee80211_sta_rx_bandwidth {
1734 IEEE80211_STA_RX_BW_20 = 0,
1735 IEEE80211_STA_RX_BW_40,
1736 IEEE80211_STA_RX_BW_80,
1737 IEEE80211_STA_RX_BW_160,
1738};
1739
1740/**
1741 * struct ieee80211_sta_rates - station rate selection table
1742 *
1743 * @rcu_head: RCU head used for freeing the table on update
1744 * @rate: transmit rates/flags to be used by default.
1745 * Overriding entries per-packet is possible by using cb tx control.
1746 */
1747struct ieee80211_sta_rates {
1748 struct rcu_head rcu_head;
1749 struct {
1750 s8 idx;
1751 u8 count;
1752 u8 count_cts;
1753 u8 count_rts;
1754 u16 flags;
1755 } rate[IEEE80211_TX_RATE_TABLE_SIZE];
1756};
1757
1758/**
1759 * struct ieee80211_sta - station table entry
1760 *
1761 * A station table entry represents a station we are possibly
1762 * communicating with. Since stations are RCU-managed in
1763 * mac80211, any ieee80211_sta pointer you get access to must
1764 * either be protected by rcu_read_lock() explicitly or implicitly,
1765 * or you must take good care to not use such a pointer after a
1766 * call to your sta_remove callback that removed it.
1767 *
1768 * @addr: MAC address
1769 * @aid: AID we assigned to the station if we're an AP
1770 * @supp_rates: Bitmap of supported rates (per band)
1771 * @ht_cap: HT capabilities of this STA; restricted to our own capabilities
1772 * @vht_cap: VHT capabilities of this STA; restricted to our own capabilities
1773 * @max_rx_aggregation_subframes: maximal amount of frames in a single AMPDU
1774 * that this station is allowed to transmit to us.
1775 * Can be modified by driver.
1776 * @wme: indicates whether the STA supports QoS/WME (if local devices does,
1777 * otherwise always false)
1778 * @drv_priv: data area for driver use, will always be aligned to
1779 * sizeof(void \*), size is determined in hw information.
1780 * @uapsd_queues: bitmap of queues configured for uapsd. Only valid
1781 * if wme is supported. The bits order is like in
1782 * IEEE80211_WMM_IE_STA_QOSINFO_AC_*.
1783 * @max_sp: max Service Period. Only valid if wme is supported.
1784 * @bandwidth: current bandwidth the station can receive with
1785 * @rx_nss: in HT/VHT, the maximum number of spatial streams the
1786 * station can receive at the moment, changed by operating mode
1787 * notifications and capabilities. The value is only valid after
1788 * the station moves to associated state.
1789 * @smps_mode: current SMPS mode (off, static or dynamic)
1790 * @rates: rate control selection table
1791 * @tdls: indicates whether the STA is a TDLS peer
1792 * @tdls_initiator: indicates the STA is an initiator of the TDLS link. Only
1793 * valid if the STA is a TDLS peer in the first place.
1794 * @mfp: indicates whether the STA uses management frame protection or not.
1795 * @max_amsdu_subframes: indicates the maximal number of MSDUs in a single
1796 * A-MSDU. Taken from the Extended Capabilities element. 0 means
1797 * unlimited.
1798 * @support_p2p_ps: indicates whether the STA supports P2P PS mechanism or not.
1799 * @max_rc_amsdu_len: Maximum A-MSDU size in bytes recommended by rate control.
1800 * @txq: per-TID data TX queues (if driver uses the TXQ abstraction)
1801 */
1802struct ieee80211_sta {
1803 u32 supp_rates[NUM_NL80211_BANDS];
1804 u8 addr[ETH_ALEN];
1805 u16 aid;
1806 struct ieee80211_sta_ht_cap ht_cap;
1807 struct ieee80211_sta_vht_cap vht_cap;
1808 u8 max_rx_aggregation_subframes;
1809 bool wme;
1810 u8 uapsd_queues;
1811 u8 max_sp;
1812 u8 rx_nss;
1813 enum ieee80211_sta_rx_bandwidth bandwidth;
1814 enum ieee80211_smps_mode smps_mode;
1815 struct ieee80211_sta_rates __rcu *rates;
1816 bool tdls;
1817 bool tdls_initiator;
1818 bool mfp;
1819 u8 max_amsdu_subframes;
1820
1821 /**
1822 * @max_amsdu_len:
1823 * indicates the maximal length of an A-MSDU in bytes.
1824 * This field is always valid for packets with a VHT preamble.
1825 * For packets with a HT preamble, additional limits apply:
1826 *
1827 * * If the skb is transmitted as part of a BA agreement, the
1828 * A-MSDU maximal size is min(max_amsdu_len, 4065) bytes.
1829 * * If the skb is not part of a BA aggreement, the A-MSDU maximal
1830 * size is min(max_amsdu_len, 7935) bytes.
1831 *
1832 * Both additional HT limits must be enforced by the low level
1833 * driver. This is defined by the spec (IEEE 802.11-2012 section
1834 * 8.3.2.2 NOTE 2).
1835 */
1836 u16 max_amsdu_len;
1837 bool support_p2p_ps;
1838 u16 max_rc_amsdu_len;
1839
1840 struct ieee80211_txq *txq[IEEE80211_NUM_TIDS];
1841
1842 /* must be last */
1843 u8 drv_priv[0] __aligned(sizeof(void *));
1844};
1845
1846/**
1847 * enum sta_notify_cmd - sta notify command
1848 *
1849 * Used with the sta_notify() callback in &struct ieee80211_ops, this
1850 * indicates if an associated station made a power state transition.
1851 *
1852 * @STA_NOTIFY_SLEEP: a station is now sleeping
1853 * @STA_NOTIFY_AWAKE: a sleeping station woke up
1854 */
1855enum sta_notify_cmd {
1856 STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
1857};
1858
1859/**
1860 * struct ieee80211_tx_control - TX control data
1861 *
1862 * @sta: station table entry, this sta pointer may be NULL and
1863 * it is not allowed to copy the pointer, due to RCU.
1864 */
1865struct ieee80211_tx_control {
1866 struct ieee80211_sta *sta;
1867};
1868
1869/**
1870 * struct ieee80211_txq - Software intermediate tx queue
1871 *
1872 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
1873 * @sta: station table entry, %NULL for per-vif queue
1874 * @tid: the TID for this queue (unused for per-vif queue)
1875 * @ac: the AC for this queue
1876 * @drv_priv: driver private area, sized by hw->txq_data_size
1877 *
1878 * The driver can obtain packets from this queue by calling
1879 * ieee80211_tx_dequeue().
1880 */
1881struct ieee80211_txq {
1882 struct ieee80211_vif *vif;
1883 struct ieee80211_sta *sta;
1884 u8 tid;
1885 u8 ac;
1886
1887 /* must be last */
1888 u8 drv_priv[0] __aligned(sizeof(void *));
1889};
1890
1891/**
1892 * enum ieee80211_hw_flags - hardware flags
1893 *
1894 * These flags are used to indicate hardware capabilities to
1895 * the stack. Generally, flags here should have their meaning
1896 * done in a way that the simplest hardware doesn't need setting
1897 * any particular flags. There are some exceptions to this rule,
1898 * however, so you are advised to review these flags carefully.
1899 *
1900 * @IEEE80211_HW_HAS_RATE_CONTROL:
1901 * The hardware or firmware includes rate control, and cannot be
1902 * controlled by the stack. As such, no rate control algorithm
1903 * should be instantiated, and the TX rate reported to userspace
1904 * will be taken from the TX status instead of the rate control
1905 * algorithm.
1906 * Note that this requires that the driver implement a number of
1907 * callbacks so it has the correct information, it needs to have
1908 * the @set_rts_threshold callback and must look at the BSS config
1909 * @use_cts_prot for G/N protection, @use_short_slot for slot
1910 * timing in 2.4 GHz and @use_short_preamble for preambles for
1911 * CCK frames.
1912 *
1913 * @IEEE80211_HW_RX_INCLUDES_FCS:
1914 * Indicates that received frames passed to the stack include
1915 * the FCS at the end.
1916 *
1917 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
1918 * Some wireless LAN chipsets buffer broadcast/multicast frames
1919 * for power saving stations in the hardware/firmware and others
1920 * rely on the host system for such buffering. This option is used
1921 * to configure the IEEE 802.11 upper layer to buffer broadcast and
1922 * multicast frames when there are power saving stations so that
1923 * the driver can fetch them with ieee80211_get_buffered_bc().
1924 *
1925 * @IEEE80211_HW_SIGNAL_UNSPEC:
1926 * Hardware can provide signal values but we don't know its units. We
1927 * expect values between 0 and @max_signal.
1928 * If possible please provide dB or dBm instead.
1929 *
1930 * @IEEE80211_HW_SIGNAL_DBM:
1931 * Hardware gives signal values in dBm, decibel difference from
1932 * one milliwatt. This is the preferred method since it is standardized
1933 * between different devices. @max_signal does not need to be set.
1934 *
1935 * @IEEE80211_HW_SPECTRUM_MGMT:
1936 * Hardware supports spectrum management defined in 802.11h
1937 * Measurement, Channel Switch, Quieting, TPC
1938 *
1939 * @IEEE80211_HW_AMPDU_AGGREGATION:
1940 * Hardware supports 11n A-MPDU aggregation.
1941 *
1942 * @IEEE80211_HW_SUPPORTS_PS:
1943 * Hardware has power save support (i.e. can go to sleep).
1944 *
1945 * @IEEE80211_HW_PS_NULLFUNC_STACK:
1946 * Hardware requires nullfunc frame handling in stack, implies
1947 * stack support for dynamic PS.
1948 *
1949 * @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1950 * Hardware has support for dynamic PS.
1951 *
1952 * @IEEE80211_HW_MFP_CAPABLE:
1953 * Hardware supports management frame protection (MFP, IEEE 802.11w).
1954 *
1955 * @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1956 * Hardware can provide ack status reports of Tx frames to
1957 * the stack.
1958 *
1959 * @IEEE80211_HW_CONNECTION_MONITOR:
1960 * The hardware performs its own connection monitoring, including
1961 * periodic keep-alives to the AP and probing the AP on beacon loss.
1962 *
1963 * @IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC:
1964 * This device needs to get data from beacon before association (i.e.
1965 * dtim_period).
1966 *
1967 * @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1968 * per-station GTKs as used by IBSS RSN or during fast transition. If
1969 * the device doesn't support per-station GTKs, but can be asked not
1970 * to decrypt group addressed frames, then IBSS RSN support is still
1971 * possible but software crypto will be used. Advertise the wiphy flag
1972 * only in that case.
1973 *
1974 * @IEEE80211_HW_AP_LINK_PS: When operating in AP mode the device
1975 * autonomously manages the PS status of connected stations. When
1976 * this flag is set mac80211 will not trigger PS mode for connected
1977 * stations based on the PM bit of incoming frames.
1978 * Use ieee80211_start_ps()/ieee8021_end_ps() to manually configure
1979 * the PS mode of connected stations.
1980 *
1981 * @IEEE80211_HW_TX_AMPDU_SETUP_IN_HW: The device handles TX A-MPDU session
1982 * setup strictly in HW. mac80211 should not attempt to do this in
1983 * software.
1984 *
1985 * @IEEE80211_HW_WANT_MONITOR_VIF: The driver would like to be informed of
1986 * a virtual monitor interface when monitor interfaces are the only
1987 * active interfaces.
1988 *
1989 * @IEEE80211_HW_NO_AUTO_VIF: The driver would like for no wlanX to
1990 * be created. It is expected user-space will create vifs as
1991 * desired (and thus have them named as desired).
1992 *
1993 * @IEEE80211_HW_SW_CRYPTO_CONTROL: The driver wants to control which of the
1994 * crypto algorithms can be done in software - so don't automatically
1995 * try to fall back to it if hardware crypto fails, but do so only if
1996 * the driver returns 1. This also forces the driver to advertise its
1997 * supported cipher suites.
1998 *
1999 * @IEEE80211_HW_SUPPORT_FAST_XMIT: The driver/hardware supports fast-xmit,
2000 * this currently requires only the ability to calculate the duration
2001 * for frames.
2002 *
2003 * @IEEE80211_HW_QUEUE_CONTROL: The driver wants to control per-interface
2004 * queue mapping in order to use different queues (not just one per AC)
2005 * for different virtual interfaces. See the doc section on HW queue
2006 * control for more details.
2007 *
2008 * @IEEE80211_HW_SUPPORTS_RC_TABLE: The driver supports using a rate
2009 * selection table provided by the rate control algorithm.
2010 *
2011 * @IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF: Use the P2P Device address for any
2012 * P2P Interface. This will be honoured even if more than one interface
2013 * is supported.
2014 *
2015 * @IEEE80211_HW_TIMING_BEACON_ONLY: Use sync timing from beacon frames
2016 * only, to allow getting TBTT of a DTIM beacon.
2017 *
2018 * @IEEE80211_HW_SUPPORTS_HT_CCK_RATES: Hardware supports mixing HT/CCK rates
2019 * and can cope with CCK rates in an aggregation session (e.g. by not
2020 * using aggregation for such frames.)
2021 *
2022 * @IEEE80211_HW_CHANCTX_STA_CSA: Support 802.11h based channel-switch (CSA)
2023 * for a single active channel while using channel contexts. When support
2024 * is not enabled the default action is to disconnect when getting the
2025 * CSA frame.
2026 *
2027 * @IEEE80211_HW_SUPPORTS_CLONED_SKBS: The driver will never modify the payload
2028 * or tailroom of TX skbs without copying them first.
2029 *
2030 * @IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS: The HW supports scanning on all bands
2031 * in one command, mac80211 doesn't have to run separate scans per band.
2032 *
2033 * @IEEE80211_HW_TDLS_WIDER_BW: The device/driver supports wider bandwidth
2034 * than then BSS bandwidth for a TDLS link on the base channel.
2035 *
2036 * @IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU: The driver supports receiving A-MSDUs
2037 * within A-MPDU.
2038 *
2039 * @IEEE80211_HW_BEACON_TX_STATUS: The device/driver provides TX status
2040 * for sent beacons.
2041 *
2042 * @IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR: Hardware (or driver) requires that each
2043 * station has a unique address, i.e. each station entry can be identified
2044 * by just its MAC address; this prevents, for example, the same station
2045 * from connecting to two virtual AP interfaces at the same time.
2046 *
2047 * @IEEE80211_HW_SUPPORTS_REORDERING_BUFFER: Hardware (or driver) manages the
2048 * reordering buffer internally, guaranteeing mac80211 receives frames in
2049 * order and does not need to manage its own reorder buffer or BA session
2050 * timeout.
2051 *
2052 * @IEEE80211_HW_USES_RSS: The device uses RSS and thus requires parallel RX,
2053 * which implies using per-CPU station statistics.
2054 *
2055 * @IEEE80211_HW_TX_AMSDU: Hardware (or driver) supports software aggregated
2056 * A-MSDU frames. Requires software tx queueing and fast-xmit support.
2057 * When not using minstrel/minstrel_ht rate control, the driver must
2058 * limit the maximum A-MSDU size based on the current tx rate by setting
2059 * max_rc_amsdu_len in struct ieee80211_sta.
2060 *
2061 * @IEEE80211_HW_TX_FRAG_LIST: Hardware (or driver) supports sending frag_list
2062 * skbs, needed for zero-copy software A-MSDU.
2063 *
2064 * @IEEE80211_HW_REPORTS_LOW_ACK: The driver (or firmware) reports low ack event
2065 * by ieee80211_report_low_ack() based on its own algorithm. For such
2066 * drivers, mac80211 packet loss mechanism will not be triggered and driver
2067 * is completely depending on firmware event for station kickout.
2068 *
2069 * @IEEE80211_HW_SUPPORTS_TX_FRAG: Hardware does fragmentation by itself.
2070 * The stack will not do fragmentation.
2071 * The callback for @set_frag_threshold should be set as well.
2072 *
2073 * @IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA: Hardware supports buffer STA on
2074 * TDLS links.
2075 *
2076 * @IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP: The driver requires the
2077 * mgd_prepare_tx() callback to be called before transmission of a
2078 * deauthentication frame in case the association was completed but no
2079 * beacon was heard. This is required in multi-channel scenarios, where the
2080 * virtual interface might not be given air time for the transmission of
2081 * the frame, as it is not synced with the AP/P2P GO yet, and thus the
2082 * deauthentication frame might not be transmitted.
2083 *
2084 * @IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP: The driver (or firmware) doesn't
2085 * support QoS NDP for AP probing - that's most likely a driver bug.
2086 *
2087 * @NUM_IEEE80211_HW_FLAGS: number of hardware flags, used for sizing arrays
2088 */
2089enum ieee80211_hw_flags {
2090 IEEE80211_HW_HAS_RATE_CONTROL,
2091 IEEE80211_HW_RX_INCLUDES_FCS,
2092 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING,
2093 IEEE80211_HW_SIGNAL_UNSPEC,
2094 IEEE80211_HW_SIGNAL_DBM,
2095 IEEE80211_HW_NEED_DTIM_BEFORE_ASSOC,
2096 IEEE80211_HW_SPECTRUM_MGMT,
2097 IEEE80211_HW_AMPDU_AGGREGATION,
2098 IEEE80211_HW_SUPPORTS_PS,
2099 IEEE80211_HW_PS_NULLFUNC_STACK,
2100 IEEE80211_HW_SUPPORTS_DYNAMIC_PS,
2101 IEEE80211_HW_MFP_CAPABLE,
2102 IEEE80211_HW_WANT_MONITOR_VIF,
2103 IEEE80211_HW_NO_AUTO_VIF,
2104 IEEE80211_HW_SW_CRYPTO_CONTROL,
2105 IEEE80211_HW_SUPPORT_FAST_XMIT,
2106 IEEE80211_HW_REPORTS_TX_ACK_STATUS,
2107 IEEE80211_HW_CONNECTION_MONITOR,
2108 IEEE80211_HW_QUEUE_CONTROL,
2109 IEEE80211_HW_SUPPORTS_PER_STA_GTK,
2110 IEEE80211_HW_AP_LINK_PS,
2111 IEEE80211_HW_TX_AMPDU_SETUP_IN_HW,
2112 IEEE80211_HW_SUPPORTS_RC_TABLE,
2113 IEEE80211_HW_P2P_DEV_ADDR_FOR_INTF,
2114 IEEE80211_HW_TIMING_BEACON_ONLY,
2115 IEEE80211_HW_SUPPORTS_HT_CCK_RATES,
2116 IEEE80211_HW_CHANCTX_STA_CSA,
2117 IEEE80211_HW_SUPPORTS_CLONED_SKBS,
2118 IEEE80211_HW_SINGLE_SCAN_ON_ALL_BANDS,
2119 IEEE80211_HW_TDLS_WIDER_BW,
2120 IEEE80211_HW_SUPPORTS_AMSDU_IN_AMPDU,
2121 IEEE80211_HW_BEACON_TX_STATUS,
2122 IEEE80211_HW_NEEDS_UNIQUE_STA_ADDR,
2123 IEEE80211_HW_SUPPORTS_REORDERING_BUFFER,
2124 IEEE80211_HW_USES_RSS,
2125 IEEE80211_HW_TX_AMSDU,
2126 IEEE80211_HW_TX_FRAG_LIST,
2127 IEEE80211_HW_REPORTS_LOW_ACK,
2128 IEEE80211_HW_SUPPORTS_TX_FRAG,
2129 IEEE80211_HW_SUPPORTS_TDLS_BUFFER_STA,
2130 IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP,
2131 IEEE80211_HW_DOESNT_SUPPORT_QOS_NDP,
2132
2133 /* keep last, obviously */
2134 NUM_IEEE80211_HW_FLAGS
2135};
2136
2137/**
2138 * struct ieee80211_hw - hardware information and state
2139 *
2140 * This structure contains the configuration and hardware
2141 * information for an 802.11 PHY.
2142 *
2143 * @wiphy: This points to the &struct wiphy allocated for this
2144 * 802.11 PHY. You must fill in the @perm_addr and @dev
2145 * members of this structure using SET_IEEE80211_DEV()
2146 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
2147 * bands (with channels, bitrates) are registered here.
2148 *
2149 * @conf: &struct ieee80211_conf, device configuration, don't use.
2150 *
2151 * @priv: pointer to private area that was allocated for driver use
2152 * along with this structure.
2153 *
2154 * @flags: hardware flags, see &enum ieee80211_hw_flags.
2155 *
2156 * @extra_tx_headroom: headroom to reserve in each transmit skb
2157 * for use by the driver (e.g. for transmit headers.)
2158 *
2159 * @extra_beacon_tailroom: tailroom to reserve in each beacon tx skb.
2160 * Can be used by drivers to add extra IEs.
2161 *
2162 * @max_signal: Maximum value for signal (rssi) in RX information, used
2163 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
2164 *
2165 * @max_listen_interval: max listen interval in units of beacon interval
2166 * that HW supports
2167 *
2168 * @queues: number of available hardware transmit queues for
2169 * data packets. WMM/QoS requires at least four, these
2170 * queues need to have configurable access parameters.
2171 *
2172 * @rate_control_algorithm: rate control algorithm for this hardware.
2173 * If unset (NULL), the default algorithm will be used. Must be
2174 * set before calling ieee80211_register_hw().
2175 *
2176 * @vif_data_size: size (in bytes) of the drv_priv data area
2177 * within &struct ieee80211_vif.
2178 * @sta_data_size: size (in bytes) of the drv_priv data area
2179 * within &struct ieee80211_sta.
2180 * @chanctx_data_size: size (in bytes) of the drv_priv data area
2181 * within &struct ieee80211_chanctx_conf.
2182 * @txq_data_size: size (in bytes) of the drv_priv data area
2183 * within @struct ieee80211_txq.
2184 *
2185 * @max_rates: maximum number of alternate rate retry stages the hw
2186 * can handle.
2187 * @max_report_rates: maximum number of alternate rate retry stages
2188 * the hw can report back.
2189 * @max_rate_tries: maximum number of tries for each stage
2190 *
2191 * @max_rx_aggregation_subframes: maximum buffer size (number of
2192 * sub-frames) to be used for A-MPDU block ack receiver
2193 * aggregation.
2194 * This is only relevant if the device has restrictions on the
2195 * number of subframes, if it relies on mac80211 to do reordering
2196 * it shouldn't be set.
2197 *
2198 * @max_tx_aggregation_subframes: maximum number of subframes in an
2199 * aggregate an HT driver will transmit. Though ADDBA will advertise
2200 * a constant value of 64 as some older APs can crash if the window
2201 * size is smaller (an example is LinkSys WRT120N with FW v1.0.07
2202 * build 002 Jun 18 2012).
2203 *
2204 * @max_tx_fragments: maximum number of tx buffers per (A)-MSDU, sum
2205 * of 1 + skb_shinfo(skb)->nr_frags for each skb in the frag_list.
2206 *
2207 * @offchannel_tx_hw_queue: HW queue ID to use for offchannel TX
2208 * (if %IEEE80211_HW_QUEUE_CONTROL is set)
2209 *
2210 * @radiotap_mcs_details: lists which MCS information can the HW
2211 * reports, by default it is set to _MCS, _GI and _BW but doesn't
2212 * include _FMT. Use %IEEE80211_RADIOTAP_MCS_HAVE_\* values, only
2213 * adding _BW is supported today.
2214 *
2215 * @radiotap_vht_details: lists which VHT MCS information the HW reports,
2216 * the default is _GI | _BANDWIDTH.
2217 * Use the %IEEE80211_RADIOTAP_VHT_KNOWN_\* values.
2218 *
2219 * @radiotap_timestamp: Information for the radiotap timestamp field; if the
2220 * 'units_pos' member is set to a non-negative value it must be set to
2221 * a combination of a IEEE80211_RADIOTAP_TIMESTAMP_UNIT_* and a
2222 * IEEE80211_RADIOTAP_TIMESTAMP_SPOS_* value, and then the timestamp
2223 * field will be added and populated from the &struct ieee80211_rx_status
2224 * device_timestamp. If the 'accuracy' member is non-negative, it's put
2225 * into the accuracy radiotap field and the accuracy known flag is set.
2226 *
2227 * @netdev_features: netdev features to be set in each netdev created
2228 * from this HW. Note that not all features are usable with mac80211,
2229 * other features will be rejected during HW registration.
2230 *
2231 * @uapsd_queues: This bitmap is included in (re)association frame to indicate
2232 * for each access category if it is uAPSD trigger-enabled and delivery-
2233 * enabled. Use IEEE80211_WMM_IE_STA_QOSINFO_AC_* to set this bitmap.
2234 * Each bit corresponds to different AC. Value '1' in specific bit means
2235 * that corresponding AC is both trigger- and delivery-enabled. '0' means
2236 * neither enabled.
2237 *
2238 * @uapsd_max_sp_len: maximum number of total buffered frames the WMM AP may
2239 * deliver to a WMM STA during any Service Period triggered by the WMM STA.
2240 * Use IEEE80211_WMM_IE_STA_QOSINFO_SP_* for correct values.
2241 *
2242 * @n_cipher_schemes: a size of an array of cipher schemes definitions.
2243 * @cipher_schemes: a pointer to an array of cipher scheme definitions
2244 * supported by HW.
2245 * @max_nan_de_entries: maximum number of NAN DE functions supported by the
2246 * device.
2247 */
2248struct ieee80211_hw {
2249 struct ieee80211_conf conf;
2250 struct wiphy *wiphy;
2251 const char *rate_control_algorithm;
2252 void *priv;
2253 unsigned long flags[BITS_TO_LONGS(NUM_IEEE80211_HW_FLAGS)];
2254 unsigned int extra_tx_headroom;
2255 unsigned int extra_beacon_tailroom;
2256 int vif_data_size;
2257 int sta_data_size;
2258 int chanctx_data_size;
2259 int txq_data_size;
2260 u16 queues;
2261 u16 max_listen_interval;
2262 s8 max_signal;
2263 u8 max_rates;
2264 u8 max_report_rates;
2265 u8 max_rate_tries;
2266 u8 max_rx_aggregation_subframes;
2267 u8 max_tx_aggregation_subframes;
2268 u8 max_tx_fragments;
2269 u8 offchannel_tx_hw_queue;
2270 u8 radiotap_mcs_details;
2271 u16 radiotap_vht_details;
2272 struct {
2273 int units_pos;
2274 s16 accuracy;
2275 } radiotap_timestamp;
2276 netdev_features_t netdev_features;
2277 u8 uapsd_queues;
2278 u8 uapsd_max_sp_len;
2279 u8 n_cipher_schemes;
2280 const struct ieee80211_cipher_scheme *cipher_schemes;
2281 u8 max_nan_de_entries;
2282};
2283
2284static inline bool _ieee80211_hw_check(struct ieee80211_hw *hw,
2285 enum ieee80211_hw_flags flg)
2286{
2287 return test_bit(flg, hw->flags);
2288}
2289#define ieee80211_hw_check(hw, flg) _ieee80211_hw_check(hw, IEEE80211_HW_##flg)
2290
2291static inline void _ieee80211_hw_set(struct ieee80211_hw *hw,
2292 enum ieee80211_hw_flags flg)
2293{
2294 return __set_bit(flg, hw->flags);
2295}
2296#define ieee80211_hw_set(hw, flg) _ieee80211_hw_set(hw, IEEE80211_HW_##flg)
2297
2298/**
2299 * struct ieee80211_scan_request - hw scan request
2300 *
2301 * @ies: pointers different parts of IEs (in req.ie)
2302 * @req: cfg80211 request.
2303 */
2304struct ieee80211_scan_request {
2305 struct ieee80211_scan_ies ies;
2306
2307 /* Keep last */
2308 struct cfg80211_scan_request req;
2309};
2310
2311/**
2312 * struct ieee80211_tdls_ch_sw_params - TDLS channel switch parameters
2313 *
2314 * @sta: peer this TDLS channel-switch request/response came from
2315 * @chandef: channel referenced in a TDLS channel-switch request
2316 * @action_code: see &enum ieee80211_tdls_actioncode
2317 * @status: channel-switch response status
2318 * @timestamp: time at which the frame was received
2319 * @switch_time: switch-timing parameter received in the frame
2320 * @switch_timeout: switch-timing parameter received in the frame
2321 * @tmpl_skb: TDLS switch-channel response template
2322 * @ch_sw_tm_ie: offset of the channel-switch timing IE inside @tmpl_skb
2323 */
2324struct ieee80211_tdls_ch_sw_params {
2325 struct ieee80211_sta *sta;
2326 struct cfg80211_chan_def *chandef;
2327 u8 action_code;
2328 u32 status;
2329 u32 timestamp;
2330 u16 switch_time;
2331 u16 switch_timeout;
2332 struct sk_buff *tmpl_skb;
2333 u32 ch_sw_tm_ie;
2334};
2335
2336/**
2337 * wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
2338 *
2339 * @wiphy: the &struct wiphy which we want to query
2340 *
2341 * mac80211 drivers can use this to get to their respective
2342 * &struct ieee80211_hw. Drivers wishing to get to their own private
2343 * structure can then access it via hw->priv. Note that mac802111 drivers should
2344 * not use wiphy_priv() to try to get their private driver structure as this
2345 * is already used internally by mac80211.
2346 *
2347 * Return: The mac80211 driver hw struct of @wiphy.
2348 */
2349struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
2350
2351/**
2352 * SET_IEEE80211_DEV - set device for 802.11 hardware
2353 *
2354 * @hw: the &struct ieee80211_hw to set the device for
2355 * @dev: the &struct device of this 802.11 device
2356 */
2357static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
2358{
2359 set_wiphy_dev(hw->wiphy, dev);
2360}
2361
2362/**
2363 * SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
2364 *
2365 * @hw: the &struct ieee80211_hw to set the MAC address for
2366 * @addr: the address to set
2367 */
2368static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, const u8 *addr)
2369{
2370 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
2371}
2372
2373static inline struct ieee80211_rate *
2374ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
2375 const struct ieee80211_tx_info *c)
2376{
2377 if (WARN_ON_ONCE(c->control.rates[0].idx < 0))
2378 return NULL;
2379 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
2380}
2381
2382static inline struct ieee80211_rate *
2383ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
2384 const struct ieee80211_tx_info *c)
2385{
2386 if (c->control.rts_cts_rate_idx < 0)
2387 return NULL;
2388 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
2389}
2390
2391static inline struct ieee80211_rate *
2392ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
2393 const struct ieee80211_tx_info *c, int idx)
2394{
2395 if (c->control.rates[idx + 1].idx < 0)
2396 return NULL;
2397 return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
2398}
2399
2400/**
2401 * ieee80211_free_txskb - free TX skb
2402 * @hw: the hardware
2403 * @skb: the skb
2404 *
2405 * Free a transmit skb. Use this funtion when some failure
2406 * to transmit happened and thus status cannot be reported.
2407 */
2408void ieee80211_free_txskb(struct ieee80211_hw *hw, struct sk_buff *skb);
2409
2410/**
2411 * DOC: Hardware crypto acceleration
2412 *
2413 * mac80211 is capable of taking advantage of many hardware
2414 * acceleration designs for encryption and decryption operations.
2415 *
2416 * The set_key() callback in the &struct ieee80211_ops for a given
2417 * device is called to enable hardware acceleration of encryption and
2418 * decryption. The callback takes a @sta parameter that will be NULL
2419 * for default keys or keys used for transmission only, or point to
2420 * the station information for the peer for individual keys.
2421 * Multiple transmission keys with the same key index may be used when
2422 * VLANs are configured for an access point.
2423 *
2424 * When transmitting, the TX control data will use the @hw_key_idx
2425 * selected by the driver by modifying the &struct ieee80211_key_conf
2426 * pointed to by the @key parameter to the set_key() function.
2427 *
2428 * The set_key() call for the %SET_KEY command should return 0 if
2429 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
2430 * added; if you return 0 then hw_key_idx must be assigned to the
2431 * hardware key index, you are free to use the full u8 range.
2432 *
2433 * Note that in the case that the @IEEE80211_HW_SW_CRYPTO_CONTROL flag is
2434 * set, mac80211 will not automatically fall back to software crypto if
2435 * enabling hardware crypto failed. The set_key() call may also return the
2436 * value 1 to permit this specific key/algorithm to be done in software.
2437 *
2438 * When the cmd is %DISABLE_KEY then it must succeed.
2439 *
2440 * Note that it is permissible to not decrypt a frame even if a key
2441 * for it has been uploaded to hardware, the stack will not make any
2442 * decision based on whether a key has been uploaded or not but rather
2443 * based on the receive flags.
2444 *
2445 * The &struct ieee80211_key_conf structure pointed to by the @key
2446 * parameter is guaranteed to be valid until another call to set_key()
2447 * removes it, but it can only be used as a cookie to differentiate
2448 * keys.
2449 *
2450 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
2451 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
2452 * handler.
2453 * The update_tkip_key() call updates the driver with the new phase 1 key.
2454 * This happens every time the iv16 wraps around (every 65536 packets). The
2455 * set_key() call will happen only once for each key (unless the AP did
2456 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
2457 * provided by update_tkip_key only. The trigger that makes mac80211 call this
2458 * handler is software decryption with wrap around of iv16.
2459 *
2460 * The set_default_unicast_key() call updates the default WEP key index
2461 * configured to the hardware for WEP encryption type. This is required
2462 * for devices that support offload of data packets (e.g. ARP responses).
2463 */
2464
2465/**
2466 * DOC: Powersave support
2467 *
2468 * mac80211 has support for various powersave implementations.
2469 *
2470 * First, it can support hardware that handles all powersaving by itself,
2471 * such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
2472 * flag. In that case, it will be told about the desired powersave mode
2473 * with the %IEEE80211_CONF_PS flag depending on the association status.
2474 * The hardware must take care of sending nullfunc frames when necessary,
2475 * i.e. when entering and leaving powersave mode. The hardware is required
2476 * to look at the AID in beacons and signal to the AP that it woke up when
2477 * it finds traffic directed to it.
2478 *
2479 * %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
2480 * IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
2481 * with hardware wakeup and sleep states. Driver is responsible for waking
2482 * up the hardware before issuing commands to the hardware and putting it
2483 * back to sleep at appropriate times.
2484 *
2485 * When PS is enabled, hardware needs to wakeup for beacons and receive the
2486 * buffered multicast/broadcast frames after the beacon. Also it must be
2487 * possible to send frames and receive the acknowledment frame.
2488 *
2489 * Other hardware designs cannot send nullfunc frames by themselves and also
2490 * need software support for parsing the TIM bitmap. This is also supported
2491 * by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
2492 * %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
2493 * required to pass up beacons. The hardware is still required to handle
2494 * waking up for multicast traffic; if it cannot the driver must handle that
2495 * as best as it can, mac80211 is too slow to do that.
2496 *
2497 * Dynamic powersave is an extension to normal powersave in which the
2498 * hardware stays awake for a user-specified period of time after sending a
2499 * frame so that reply frames need not be buffered and therefore delayed to
2500 * the next wakeup. It's compromise of getting good enough latency when
2501 * there's data traffic and still saving significantly power in idle
2502 * periods.
2503 *
2504 * Dynamic powersave is simply supported by mac80211 enabling and disabling
2505 * PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
2506 * flag and mac80211 will handle everything automatically. Additionally,
2507 * hardware having support for the dynamic PS feature may set the
2508 * %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
2509 * dynamic PS mode itself. The driver needs to look at the
2510 * @dynamic_ps_timeout hardware configuration value and use it that value
2511 * whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
2512 * dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
2513 * enabled whenever user has enabled powersave.
2514 *
2515 * Driver informs U-APSD client support by enabling
2516 * %IEEE80211_VIF_SUPPORTS_UAPSD flag. The mode is configured through the
2517 * uapsd parameter in conf_tx() operation. Hardware needs to send the QoS
2518 * Nullfunc frames and stay awake until the service period has ended. To
2519 * utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
2520 * from that AC are transmitted with powersave enabled.
2521 *
2522 * Note: U-APSD client mode is not yet supported with
2523 * %IEEE80211_HW_PS_NULLFUNC_STACK.
2524 */
2525
2526/**
2527 * DOC: Beacon filter support
2528 *
2529 * Some hardware have beacon filter support to reduce host cpu wakeups
2530 * which will reduce system power consumption. It usually works so that
2531 * the firmware creates a checksum of the beacon but omits all constantly
2532 * changing elements (TSF, TIM etc). Whenever the checksum changes the
2533 * beacon is forwarded to the host, otherwise it will be just dropped. That
2534 * way the host will only receive beacons where some relevant information
2535 * (for example ERP protection or WMM settings) have changed.
2536 *
2537 * Beacon filter support is advertised with the %IEEE80211_VIF_BEACON_FILTER
2538 * interface capability. The driver needs to enable beacon filter support
2539 * whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
2540 * power save is enabled, the stack will not check for beacon loss and the
2541 * driver needs to notify about loss of beacons with ieee80211_beacon_loss().
2542 *
2543 * The time (or number of beacons missed) until the firmware notifies the
2544 * driver of a beacon loss event (which in turn causes the driver to call
2545 * ieee80211_beacon_loss()) should be configurable and will be controlled
2546 * by mac80211 and the roaming algorithm in the future.
2547 *
2548 * Since there may be constantly changing information elements that nothing
2549 * in the software stack cares about, we will, in the future, have mac80211
2550 * tell the driver which information elements are interesting in the sense
2551 * that we want to see changes in them. This will include
2552 *
2553 * - a list of information element IDs
2554 * - a list of OUIs for the vendor information element
2555 *
2556 * Ideally, the hardware would filter out any beacons without changes in the
2557 * requested elements, but if it cannot support that it may, at the expense
2558 * of some efficiency, filter out only a subset. For example, if the device
2559 * doesn't support checking for OUIs it should pass up all changes in all
2560 * vendor information elements.
2561 *
2562 * Note that change, for the sake of simplification, also includes information
2563 * elements appearing or disappearing from the beacon.
2564 *
2565 * Some hardware supports an "ignore list" instead, just make sure nothing
2566 * that was requested is on the ignore list, and include commonly changing
2567 * information element IDs in the ignore list, for example 11 (BSS load) and
2568 * the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
2569 * 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
2570 * it could also include some currently unused IDs.
2571 *
2572 *
2573 * In addition to these capabilities, hardware should support notifying the
2574 * host of changes in the beacon RSSI. This is relevant to implement roaming
2575 * when no traffic is flowing (when traffic is flowing we see the RSSI of
2576 * the received data packets). This can consist in notifying the host when
2577 * the RSSI changes significantly or when it drops below or rises above
2578 * configurable thresholds. In the future these thresholds will also be
2579 * configured by mac80211 (which gets them from userspace) to implement
2580 * them as the roaming algorithm requires.
2581 *
2582 * If the hardware cannot implement this, the driver should ask it to
2583 * periodically pass beacon frames to the host so that software can do the
2584 * signal strength threshold checking.
2585 */
2586
2587/**
2588 * DOC: Spatial multiplexing power save
2589 *
2590 * SMPS (Spatial multiplexing power save) is a mechanism to conserve
2591 * power in an 802.11n implementation. For details on the mechanism
2592 * and rationale, please refer to 802.11 (as amended by 802.11n-2009)
2593 * "11.2.3 SM power save".
2594 *
2595 * The mac80211 implementation is capable of sending action frames
2596 * to update the AP about the station's SMPS mode, and will instruct
2597 * the driver to enter the specific mode. It will also announce the
2598 * requested SMPS mode during the association handshake. Hardware
2599 * support for this feature is required, and can be indicated by
2600 * hardware flags.
2601 *
2602 * The default mode will be "automatic", which nl80211/cfg80211
2603 * defines to be dynamic SMPS in (regular) powersave, and SMPS
2604 * turned off otherwise.
2605 *
2606 * To support this feature, the driver must set the appropriate
2607 * hardware support flags, and handle the SMPS flag to the config()
2608 * operation. It will then with this mechanism be instructed to
2609 * enter the requested SMPS mode while associated to an HT AP.
2610 */
2611
2612/**
2613 * DOC: Frame filtering
2614 *
2615 * mac80211 requires to see many management frames for proper
2616 * operation, and users may want to see many more frames when
2617 * in monitor mode. However, for best CPU usage and power consumption,
2618 * having as few frames as possible percolate through the stack is
2619 * desirable. Hence, the hardware should filter as much as possible.
2620 *
2621 * To achieve this, mac80211 uses filter flags (see below) to tell
2622 * the driver's configure_filter() function which frames should be
2623 * passed to mac80211 and which should be filtered out.
2624 *
2625 * Before configure_filter() is invoked, the prepare_multicast()
2626 * callback is invoked with the parameters @mc_count and @mc_list
2627 * for the combined multicast address list of all virtual interfaces.
2628 * It's use is optional, and it returns a u64 that is passed to
2629 * configure_filter(). Additionally, configure_filter() has the
2630 * arguments @changed_flags telling which flags were changed and
2631 * @total_flags with the new flag states.
2632 *
2633 * If your device has no multicast address filters your driver will
2634 * need to check both the %FIF_ALLMULTI flag and the @mc_count
2635 * parameter to see whether multicast frames should be accepted
2636 * or dropped.
2637 *
2638 * All unsupported flags in @total_flags must be cleared.
2639 * Hardware does not support a flag if it is incapable of _passing_
2640 * the frame to the stack. Otherwise the driver must ignore
2641 * the flag, but not clear it.
2642 * You must _only_ clear the flag (announce no support for the
2643 * flag to mac80211) if you are not able to pass the packet type
2644 * to the stack (so the hardware always filters it).
2645 * So for example, you should clear @FIF_CONTROL, if your hardware
2646 * always filters control frames. If your hardware always passes
2647 * control frames to the kernel and is incapable of filtering them,
2648 * you do _not_ clear the @FIF_CONTROL flag.
2649 * This rule applies to all other FIF flags as well.
2650 */
2651
2652/**
2653 * DOC: AP support for powersaving clients
2654 *
2655 * In order to implement AP and P2P GO modes, mac80211 has support for
2656 * client powersaving, both "legacy" PS (PS-Poll/null data) and uAPSD.
2657 * There currently is no support for sAPSD.
2658 *
2659 * There is one assumption that mac80211 makes, namely that a client
2660 * will not poll with PS-Poll and trigger with uAPSD at the same time.
2661 * Both are supported, and both can be used by the same client, but
2662 * they can't be used concurrently by the same client. This simplifies
2663 * the driver code.
2664 *
2665 * The first thing to keep in mind is that there is a flag for complete
2666 * driver implementation: %IEEE80211_HW_AP_LINK_PS. If this flag is set,
2667 * mac80211 expects the driver to handle most of the state machine for
2668 * powersaving clients and will ignore the PM bit in incoming frames.
2669 * Drivers then use ieee80211_sta_ps_transition() to inform mac80211 of
2670 * stations' powersave transitions. In this mode, mac80211 also doesn't
2671 * handle PS-Poll/uAPSD.
2672 *
2673 * In the mode without %IEEE80211_HW_AP_LINK_PS, mac80211 will check the
2674 * PM bit in incoming frames for client powersave transitions. When a
2675 * station goes to sleep, we will stop transmitting to it. There is,
2676 * however, a race condition: a station might go to sleep while there is
2677 * data buffered on hardware queues. If the device has support for this
2678 * it will reject frames, and the driver should give the frames back to
2679 * mac80211 with the %IEEE80211_TX_STAT_TX_FILTERED flag set which will
2680 * cause mac80211 to retry the frame when the station wakes up. The
2681 * driver is also notified of powersave transitions by calling its
2682 * @sta_notify callback.
2683 *
2684 * When the station is asleep, it has three choices: it can wake up,
2685 * it can PS-Poll, or it can possibly start a uAPSD service period.
2686 * Waking up is implemented by simply transmitting all buffered (and
2687 * filtered) frames to the station. This is the easiest case. When
2688 * the station sends a PS-Poll or a uAPSD trigger frame, mac80211
2689 * will inform the driver of this with the @allow_buffered_frames
2690 * callback; this callback is optional. mac80211 will then transmit
2691 * the frames as usual and set the %IEEE80211_TX_CTL_NO_PS_BUFFER
2692 * on each frame. The last frame in the service period (or the only
2693 * response to a PS-Poll) also has %IEEE80211_TX_STATUS_EOSP set to
2694 * indicate that it ends the service period; as this frame must have
2695 * TX status report it also sets %IEEE80211_TX_CTL_REQ_TX_STATUS.
2696 * When TX status is reported for this frame, the service period is
2697 * marked has having ended and a new one can be started by the peer.
2698 *
2699 * Additionally, non-bufferable MMPDUs can also be transmitted by
2700 * mac80211 with the %IEEE80211_TX_CTL_NO_PS_BUFFER set in them.
2701 *
2702 * Another race condition can happen on some devices like iwlwifi
2703 * when there are frames queued for the station and it wakes up
2704 * or polls; the frames that are already queued could end up being
2705 * transmitted first instead, causing reordering and/or wrong
2706 * processing of the EOSP. The cause is that allowing frames to be
2707 * transmitted to a certain station is out-of-band communication to
2708 * the device. To allow this problem to be solved, the driver can
2709 * call ieee80211_sta_block_awake() if frames are buffered when it
2710 * is notified that the station went to sleep. When all these frames
2711 * have been filtered (see above), it must call the function again
2712 * to indicate that the station is no longer blocked.
2713 *
2714 * If the driver buffers frames in the driver for aggregation in any
2715 * way, it must use the ieee80211_sta_set_buffered() call when it is
2716 * notified of the station going to sleep to inform mac80211 of any
2717 * TIDs that have frames buffered. Note that when a station wakes up
2718 * this information is reset (hence the requirement to call it when
2719 * informed of the station going to sleep). Then, when a service
2720 * period starts for any reason, @release_buffered_frames is called
2721 * with the number of frames to be released and which TIDs they are
2722 * to come from. In this case, the driver is responsible for setting
2723 * the EOSP (for uAPSD) and MORE_DATA bits in the released frames,
2724 * to help the @more_data parameter is passed to tell the driver if
2725 * there is more data on other TIDs -- the TIDs to release frames
2726 * from are ignored since mac80211 doesn't know how many frames the
2727 * buffers for those TIDs contain.
2728 *
2729 * If the driver also implement GO mode, where absence periods may
2730 * shorten service periods (or abort PS-Poll responses), it must
2731 * filter those response frames except in the case of frames that
2732 * are buffered in the driver -- those must remain buffered to avoid
2733 * reordering. Because it is possible that no frames are released
2734 * in this case, the driver must call ieee80211_sta_eosp()
2735 * to indicate to mac80211 that the service period ended anyway.
2736 *
2737 * Finally, if frames from multiple TIDs are released from mac80211
2738 * but the driver might reorder them, it must clear & set the flags
2739 * appropriately (only the last frame may have %IEEE80211_TX_STATUS_EOSP)
2740 * and also take care of the EOSP and MORE_DATA bits in the frame.
2741 * The driver may also use ieee80211_sta_eosp() in this case.
2742 *
2743 * Note that if the driver ever buffers frames other than QoS-data
2744 * frames, it must take care to never send a non-QoS-data frame as
2745 * the last frame in a service period, adding a QoS-nulldata frame
2746 * after a non-QoS-data frame if needed.
2747 */
2748
2749/**
2750 * DOC: HW queue control
2751 *
2752 * Before HW queue control was introduced, mac80211 only had a single static
2753 * assignment of per-interface AC software queues to hardware queues. This
2754 * was problematic for a few reasons:
2755 * 1) off-channel transmissions might get stuck behind other frames
2756 * 2) multiple virtual interfaces couldn't be handled correctly
2757 * 3) after-DTIM frames could get stuck behind other frames
2758 *
2759 * To solve this, hardware typically uses multiple different queues for all
2760 * the different usages, and this needs to be propagated into mac80211 so it
2761 * won't have the same problem with the software queues.
2762 *
2763 * Therefore, mac80211 now offers the %IEEE80211_HW_QUEUE_CONTROL capability
2764 * flag that tells it that the driver implements its own queue control. To do
2765 * so, the driver will set up the various queues in each &struct ieee80211_vif
2766 * and the offchannel queue in &struct ieee80211_hw. In response, mac80211 will
2767 * use those queue IDs in the hw_queue field of &struct ieee80211_tx_info and
2768 * if necessary will queue the frame on the right software queue that mirrors
2769 * the hardware queue.
2770 * Additionally, the driver has to then use these HW queue IDs for the queue
2771 * management functions (ieee80211_stop_queue() et al.)
2772 *
2773 * The driver is free to set up the queue mappings as needed, multiple virtual
2774 * interfaces may map to the same hardware queues if needed. The setup has to
2775 * happen during add_interface or change_interface callbacks. For example, a
2776 * driver supporting station+station and station+AP modes might decide to have
2777 * 10 hardware queues to handle different scenarios:
2778 *
2779 * 4 AC HW queues for 1st vif: 0, 1, 2, 3
2780 * 4 AC HW queues for 2nd vif: 4, 5, 6, 7
2781 * after-DTIM queue for AP: 8
2782 * off-channel queue: 9
2783 *
2784 * It would then set up the hardware like this:
2785 * hw.offchannel_tx_hw_queue = 9
2786 *
2787 * and the first virtual interface that is added as follows:
2788 * vif.hw_queue[IEEE80211_AC_VO] = 0
2789 * vif.hw_queue[IEEE80211_AC_VI] = 1
2790 * vif.hw_queue[IEEE80211_AC_BE] = 2
2791 * vif.hw_queue[IEEE80211_AC_BK] = 3
2792 * vif.cab_queue = 8 // if AP mode, otherwise %IEEE80211_INVAL_HW_QUEUE
2793 * and the second virtual interface with 4-7.
2794 *
2795 * If queue 6 gets full, for example, mac80211 would only stop the second
2796 * virtual interface's BE queue since virtual interface queues are per AC.
2797 *
2798 * Note that the vif.cab_queue value should be set to %IEEE80211_INVAL_HW_QUEUE
2799 * whenever the queue is not used (i.e. the interface is not in AP mode) if the
2800 * queue could potentially be shared since mac80211 will look at cab_queue when
2801 * a queue is stopped/woken even if the interface is not in AP mode.
2802 */
2803
2804/**
2805 * enum ieee80211_filter_flags - hardware filter flags
2806 *
2807 * These flags determine what the filter in hardware should be
2808 * programmed to let through and what should not be passed to the
2809 * stack. It is always safe to pass more frames than requested,
2810 * but this has negative impact on power consumption.
2811 *
2812 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
2813 * by the user or if the hardware is not capable of filtering by
2814 * multicast address.
2815 *
2816 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
2817 * %RX_FLAG_FAILED_FCS_CRC for them)
2818 *
2819 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
2820 * the %RX_FLAG_FAILED_PLCP_CRC for them
2821 *
2822 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
2823 * to the hardware that it should not filter beacons or probe responses
2824 * by BSSID. Filtering them can greatly reduce the amount of processing
2825 * mac80211 needs to do and the amount of CPU wakeups, so you should
2826 * honour this flag if possible.
2827 *
2828 * @FIF_CONTROL: pass control frames (except for PS Poll) addressed to this
2829 * station
2830 *
2831 * @FIF_OTHER_BSS: pass frames destined to other BSSes
2832 *
2833 * @FIF_PSPOLL: pass PS Poll frames
2834 *
2835 * @FIF_PROBE_REQ: pass probe request frames
2836 */
2837enum ieee80211_filter_flags {
2838 FIF_ALLMULTI = 1<<1,
2839 FIF_FCSFAIL = 1<<2,
2840 FIF_PLCPFAIL = 1<<3,
2841 FIF_BCN_PRBRESP_PROMISC = 1<<4,
2842 FIF_CONTROL = 1<<5,
2843 FIF_OTHER_BSS = 1<<6,
2844 FIF_PSPOLL = 1<<7,
2845 FIF_PROBE_REQ = 1<<8,
2846};
2847
2848/**
2849 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
2850 *
2851 * These flags are used with the ampdu_action() callback in
2852 * &struct ieee80211_ops to indicate which action is needed.
2853 *
2854 * Note that drivers MUST be able to deal with a TX aggregation
2855 * session being stopped even before they OK'ed starting it by
2856 * calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
2857 * might receive the addBA frame and send a delBA right away!
2858 *
2859 * @IEEE80211_AMPDU_RX_START: start RX aggregation
2860 * @IEEE80211_AMPDU_RX_STOP: stop RX aggregation
2861 * @IEEE80211_AMPDU_TX_START: start TX aggregation
2862 * @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
2863 * @IEEE80211_AMPDU_TX_STOP_CONT: stop TX aggregation but continue transmitting
2864 * queued packets, now unaggregated. After all packets are transmitted the
2865 * driver has to call ieee80211_stop_tx_ba_cb_irqsafe().
2866 * @IEEE80211_AMPDU_TX_STOP_FLUSH: stop TX aggregation and flush all packets,
2867 * called when the station is removed. There's no need or reason to call
2868 * ieee80211_stop_tx_ba_cb_irqsafe() in this case as mac80211 assumes the
2869 * session is gone and removes the station.
2870 * @IEEE80211_AMPDU_TX_STOP_FLUSH_CONT: called when TX aggregation is stopped
2871 * but the driver hasn't called ieee80211_stop_tx_ba_cb_irqsafe() yet and
2872 * now the connection is dropped and the station will be removed. Drivers
2873 * should clean up and drop remaining packets when this is called.
2874 */
2875enum ieee80211_ampdu_mlme_action {
2876 IEEE80211_AMPDU_RX_START,
2877 IEEE80211_AMPDU_RX_STOP,
2878 IEEE80211_AMPDU_TX_START,
2879 IEEE80211_AMPDU_TX_STOP_CONT,
2880 IEEE80211_AMPDU_TX_STOP_FLUSH,
2881 IEEE80211_AMPDU_TX_STOP_FLUSH_CONT,
2882 IEEE80211_AMPDU_TX_OPERATIONAL,
2883};
2884
2885/**
2886 * struct ieee80211_ampdu_params - AMPDU action parameters
2887 *
2888 * @action: the ampdu action, value from %ieee80211_ampdu_mlme_action.
2889 * @sta: peer of this AMPDU session
2890 * @tid: tid of the BA session
2891 * @ssn: start sequence number of the session. TX/RX_STOP can pass 0. When
2892 * action is set to %IEEE80211_AMPDU_RX_START the driver passes back the
2893 * actual ssn value used to start the session and writes the value here.
2894 * @buf_size: reorder buffer size (number of subframes). Valid only when the
2895 * action is set to %IEEE80211_AMPDU_RX_START or
2896 * %IEEE80211_AMPDU_TX_OPERATIONAL
2897 * @amsdu: indicates the peer's ability to receive A-MSDU within A-MPDU.
2898 * valid when the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL
2899 * @timeout: BA session timeout. Valid only when the action is set to
2900 * %IEEE80211_AMPDU_RX_START
2901 */
2902struct ieee80211_ampdu_params {
2903 enum ieee80211_ampdu_mlme_action action;
2904 struct ieee80211_sta *sta;
2905 u16 tid;
2906 u16 ssn;
2907 u8 buf_size;
2908 bool amsdu;
2909 u16 timeout;
2910};
2911
2912/**
2913 * enum ieee80211_frame_release_type - frame release reason
2914 * @IEEE80211_FRAME_RELEASE_PSPOLL: frame released for PS-Poll
2915 * @IEEE80211_FRAME_RELEASE_UAPSD: frame(s) released due to
2916 * frame received on trigger-enabled AC
2917 */
2918enum ieee80211_frame_release_type {
2919 IEEE80211_FRAME_RELEASE_PSPOLL,
2920 IEEE80211_FRAME_RELEASE_UAPSD,
2921};
2922
2923/**
2924 * enum ieee80211_rate_control_changed - flags to indicate what changed
2925 *
2926 * @IEEE80211_RC_BW_CHANGED: The bandwidth that can be used to transmit
2927 * to this station changed. The actual bandwidth is in the station
2928 * information -- for HT20/40 the IEEE80211_HT_CAP_SUP_WIDTH_20_40
2929 * flag changes, for HT and VHT the bandwidth field changes.
2930 * @IEEE80211_RC_SMPS_CHANGED: The SMPS state of the station changed.
2931 * @IEEE80211_RC_SUPP_RATES_CHANGED: The supported rate set of this peer
2932 * changed (in IBSS mode) due to discovering more information about
2933 * the peer.
2934 * @IEEE80211_RC_NSS_CHANGED: N_SS (number of spatial streams) was changed
2935 * by the peer
2936 */
2937enum ieee80211_rate_control_changed {
2938 IEEE80211_RC_BW_CHANGED = BIT(0),
2939 IEEE80211_RC_SMPS_CHANGED = BIT(1),
2940 IEEE80211_RC_SUPP_RATES_CHANGED = BIT(2),
2941 IEEE80211_RC_NSS_CHANGED = BIT(3),
2942};
2943
2944/**
2945 * enum ieee80211_roc_type - remain on channel type
2946 *
2947 * With the support for multi channel contexts and multi channel operations,
2948 * remain on channel operations might be limited/deferred/aborted by other
2949 * flows/operations which have higher priority (and vise versa).
2950 * Specifying the ROC type can be used by devices to prioritize the ROC
2951 * operations compared to other operations/flows.
2952 *
2953 * @IEEE80211_ROC_TYPE_NORMAL: There are no special requirements for this ROC.
2954 * @IEEE80211_ROC_TYPE_MGMT_TX: The remain on channel request is required
2955 * for sending managment frames offchannel.
2956 */
2957enum ieee80211_roc_type {
2958 IEEE80211_ROC_TYPE_NORMAL = 0,
2959 IEEE80211_ROC_TYPE_MGMT_TX,
2960};
2961
2962/**
2963 * enum ieee80211_reconfig_complete_type - reconfig type
2964 *
2965 * This enum is used by the reconfig_complete() callback to indicate what
2966 * reconfiguration type was completed.
2967 *
2968 * @IEEE80211_RECONFIG_TYPE_RESTART: hw restart type
2969 * (also due to resume() callback returning 1)
2970 * @IEEE80211_RECONFIG_TYPE_SUSPEND: suspend type (regardless
2971 * of wowlan configuration)
2972 */
2973enum ieee80211_reconfig_type {
2974 IEEE80211_RECONFIG_TYPE_RESTART,
2975 IEEE80211_RECONFIG_TYPE_SUSPEND,
2976};
2977
2978/**
2979 * struct ieee80211_ops - callbacks from mac80211 to the driver
2980 *
2981 * This structure contains various callbacks that the driver may
2982 * handle or, in some cases, must handle, for example to configure
2983 * the hardware to a new channel or to transmit a frame.
2984 *
2985 * @tx: Handler that 802.11 module calls for each transmitted frame.
2986 * skb contains the buffer starting from the IEEE 802.11 header.
2987 * The low-level driver should send the frame out based on
2988 * configuration in the TX control data. This handler should,
2989 * preferably, never fail and stop queues appropriately.
2990 * Must be atomic.
2991 *
2992 * @start: Called before the first netdevice attached to the hardware
2993 * is enabled. This should turn on the hardware and must turn on
2994 * frame reception (for possibly enabled monitor interfaces.)
2995 * Returns negative error codes, these may be seen in userspace,
2996 * or zero.
2997 * When the device is started it should not have a MAC address
2998 * to avoid acknowledging frames before a non-monitor device
2999 * is added.
3000 * Must be implemented and can sleep.
3001 *
3002 * @stop: Called after last netdevice attached to the hardware
3003 * is disabled. This should turn off the hardware (at least
3004 * it must turn off frame reception.)
3005 * May be called right after add_interface if that rejects
3006 * an interface. If you added any work onto the mac80211 workqueue
3007 * you should ensure to cancel it on this callback.
3008 * Must be implemented and can sleep.
3009 *
3010 * @suspend: Suspend the device; mac80211 itself will quiesce before and
3011 * stop transmitting and doing any other configuration, and then
3012 * ask the device to suspend. This is only invoked when WoWLAN is
3013 * configured, otherwise the device is deconfigured completely and
3014 * reconfigured at resume time.
3015 * The driver may also impose special conditions under which it
3016 * wants to use the "normal" suspend (deconfigure), say if it only
3017 * supports WoWLAN when the device is associated. In this case, it
3018 * must return 1 from this function.
3019 *
3020 * @resume: If WoWLAN was configured, this indicates that mac80211 is
3021 * now resuming its operation, after this the device must be fully
3022 * functional again. If this returns an error, the only way out is
3023 * to also unregister the device. If it returns 1, then mac80211
3024 * will also go through the regular complete restart on resume.
3025 *
3026 * @set_wakeup: Enable or disable wakeup when WoWLAN configuration is
3027 * modified. The reason is that device_set_wakeup_enable() is
3028 * supposed to be called when the configuration changes, not only
3029 * in suspend().
3030 *
3031 * @add_interface: Called when a netdevice attached to the hardware is
3032 * enabled. Because it is not called for monitor mode devices, @start
3033 * and @stop must be implemented.
3034 * The driver should perform any initialization it needs before
3035 * the device can be enabled. The initial configuration for the
3036 * interface is given in the conf parameter.
3037 * The callback may refuse to add an interface by returning a
3038 * negative error code (which will be seen in userspace.)
3039 * Must be implemented and can sleep.
3040 *
3041 * @change_interface: Called when a netdevice changes type. This callback
3042 * is optional, but only if it is supported can interface types be
3043 * switched while the interface is UP. The callback may sleep.
3044 * Note that while an interface is being switched, it will not be
3045 * found by the interface iteration callbacks.
3046 *
3047 * @remove_interface: Notifies a driver that an interface is going down.
3048 * The @stop callback is called after this if it is the last interface
3049 * and no monitor interfaces are present.
3050 * When all interfaces are removed, the MAC address in the hardware
3051 * must be cleared so the device no longer acknowledges packets,
3052 * the mac_addr member of the conf structure is, however, set to the
3053 * MAC address of the device going away.
3054 * Hence, this callback must be implemented. It can sleep.
3055 *
3056 * @config: Handler for configuration requests. IEEE 802.11 code calls this
3057 * function to change hardware configuration, e.g., channel.
3058 * This function should never fail but returns a negative error code
3059 * if it does. The callback can sleep.
3060 *
3061 * @bss_info_changed: Handler for configuration requests related to BSS
3062 * parameters that may vary during BSS's lifespan, and may affect low
3063 * level driver (e.g. assoc/disassoc status, erp parameters).
3064 * This function should not be used if no BSS has been set, unless
3065 * for association indication. The @changed parameter indicates which
3066 * of the bss parameters has changed when a call is made. The callback
3067 * can sleep.
3068 *
3069 * @prepare_multicast: Prepare for multicast filter configuration.
3070 * This callback is optional, and its return value is passed
3071 * to configure_filter(). This callback must be atomic.
3072 *
3073 * @configure_filter: Configure the device's RX filter.
3074 * See the section "Frame filtering" for more information.
3075 * This callback must be implemented and can sleep.
3076 *
3077 * @config_iface_filter: Configure the interface's RX filter.
3078 * This callback is optional and is used to configure which frames
3079 * should be passed to mac80211. The filter_flags is the combination
3080 * of FIF_* flags. The changed_flags is a bit mask that indicates
3081 * which flags are changed.
3082 * This callback can sleep.
3083 *
3084 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
3085 * must be set or cleared for a given STA. Must be atomic.
3086 *
3087 * @set_key: See the section "Hardware crypto acceleration"
3088 * This callback is only called between add_interface and
3089 * remove_interface calls, i.e. while the given virtual interface
3090 * is enabled.
3091 * Returns a negative error code if the key can't be added.
3092 * The callback can sleep.
3093 *
3094 * @update_tkip_key: See the section "Hardware crypto acceleration"
3095 * This callback will be called in the context of Rx. Called for drivers
3096 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
3097 * The callback must be atomic.
3098 *
3099 * @set_rekey_data: If the device supports GTK rekeying, for example while the
3100 * host is suspended, it can assign this callback to retrieve the data
3101 * necessary to do GTK rekeying, this is the KEK, KCK and replay counter.
3102 * After rekeying was done it should (for example during resume) notify
3103 * userspace of the new replay counter using ieee80211_gtk_rekey_notify().
3104 *
3105 * @set_default_unicast_key: Set the default (unicast) key index, useful for
3106 * WEP when the device sends data packets autonomously, e.g. for ARP
3107 * offloading. The index can be 0-3, or -1 for unsetting it.
3108 *
3109 * @hw_scan: Ask the hardware to service the scan request, no need to start
3110 * the scan state machine in stack. The scan must honour the channel
3111 * configuration done by the regulatory agent in the wiphy's
3112 * registered bands. The hardware (or the driver) needs to make sure
3113 * that power save is disabled.
3114 * The @req ie/ie_len members are rewritten by mac80211 to contain the
3115 * entire IEs after the SSID, so that drivers need not look at these
3116 * at all but just send them after the SSID -- mac80211 includes the
3117 * (extended) supported rates and HT information (where applicable).
3118 * When the scan finishes, ieee80211_scan_completed() must be called;
3119 * note that it also must be called when the scan cannot finish due to
3120 * any error unless this callback returned a negative error code.
3121 * The callback can sleep.
3122 *
3123 * @cancel_hw_scan: Ask the low-level tp cancel the active hw scan.
3124 * The driver should ask the hardware to cancel the scan (if possible),
3125 * but the scan will be completed only after the driver will call
3126 * ieee80211_scan_completed().
3127 * This callback is needed for wowlan, to prevent enqueueing a new
3128 * scan_work after the low-level driver was already suspended.
3129 * The callback can sleep.
3130 *
3131 * @sched_scan_start: Ask the hardware to start scanning repeatedly at
3132 * specific intervals. The driver must call the
3133 * ieee80211_sched_scan_results() function whenever it finds results.
3134 * This process will continue until sched_scan_stop is called.
3135 *
3136 * @sched_scan_stop: Tell the hardware to stop an ongoing scheduled scan.
3137 * In this case, ieee80211_sched_scan_stopped() must not be called.
3138 *
3139 * @sw_scan_start: Notifier function that is called just before a software scan
3140 * is started. Can be NULL, if the driver doesn't need this notification.
3141 * The mac_addr parameter allows supporting NL80211_SCAN_FLAG_RANDOM_ADDR,
3142 * the driver may set the NL80211_FEATURE_SCAN_RANDOM_MAC_ADDR flag if it
3143 * can use this parameter. The callback can sleep.
3144 *
3145 * @sw_scan_complete: Notifier function that is called just after a
3146 * software scan finished. Can be NULL, if the driver doesn't need
3147 * this notification.
3148 * The callback can sleep.
3149 *
3150 * @get_stats: Return low-level statistics.
3151 * Returns zero if statistics are available.
3152 * The callback can sleep.
3153 *
3154 * @get_key_seq: If your device implements encryption in hardware and does
3155 * IV/PN assignment then this callback should be provided to read the
3156 * IV/PN for the given key from hardware.
3157 * The callback must be atomic.
3158 *
3159 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this
3160 * if the device does fragmentation by itself. Note that to prevent the
3161 * stack from doing fragmentation IEEE80211_HW_SUPPORTS_TX_FRAG
3162 * should be set as well.
3163 * The callback can sleep.
3164 *
3165 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
3166 * The callback can sleep.
3167 *
3168 * @sta_add: Notifies low level driver about addition of an associated station,
3169 * AP, IBSS/WDS/mesh peer etc. This callback can sleep.
3170 *
3171 * @sta_remove: Notifies low level driver about removal of an associated
3172 * station, AP, IBSS/WDS/mesh peer etc. Note that after the callback
3173 * returns it isn't safe to use the pointer, not even RCU protected;
3174 * no RCU grace period is guaranteed between returning here and freeing
3175 * the station. See @sta_pre_rcu_remove if needed.
3176 * This callback can sleep.
3177 *
3178 * @sta_add_debugfs: Drivers can use this callback to add debugfs files
3179 * when a station is added to mac80211's station list. This callback
3180 * should be within a CONFIG_MAC80211_DEBUGFS conditional. This
3181 * callback can sleep.
3182 *
3183 * @sta_notify: Notifies low level driver about power state transition of an
3184 * associated station, AP, IBSS/WDS/mesh peer etc. For a VIF operating
3185 * in AP mode, this callback will not be called when the flag
3186 * %IEEE80211_HW_AP_LINK_PS is set. Must be atomic.
3187 *
3188 * @sta_state: Notifies low level driver about state transition of a
3189 * station (which can be the AP, a client, IBSS/WDS/mesh peer etc.)
3190 * This callback is mutually exclusive with @sta_add/@sta_remove.
3191 * It must not fail for down transitions but may fail for transitions
3192 * up the list of states. Also note that after the callback returns it
3193 * isn't safe to use the pointer, not even RCU protected - no RCU grace
3194 * period is guaranteed between returning here and freeing the station.
3195 * See @sta_pre_rcu_remove if needed.
3196 * The callback can sleep.
3197 *
3198 * @sta_pre_rcu_remove: Notify driver about station removal before RCU
3199 * synchronisation. This is useful if a driver needs to have station
3200 * pointers protected using RCU, it can then use this call to clear
3201 * the pointers instead of waiting for an RCU grace period to elapse
3202 * in @sta_state.
3203 * The callback can sleep.
3204 *
3205 * @sta_rc_update: Notifies the driver of changes to the bitrates that can be
3206 * used to transmit to the station. The changes are advertised with bits
3207 * from &enum ieee80211_rate_control_changed and the values are reflected
3208 * in the station data. This callback should only be used when the driver
3209 * uses hardware rate control (%IEEE80211_HW_HAS_RATE_CONTROL) since
3210 * otherwise the rate control algorithm is notified directly.
3211 * Must be atomic.
3212 * @sta_rate_tbl_update: Notifies the driver that the rate table changed. This
3213 * is only used if the configured rate control algorithm actually uses
3214 * the new rate table API, and is therefore optional. Must be atomic.
3215 *
3216 * @sta_statistics: Get statistics for this station. For example with beacon
3217 * filtering, the statistics kept by mac80211 might not be accurate, so
3218 * let the driver pre-fill the statistics. The driver can fill most of
3219 * the values (indicating which by setting the filled bitmap), but not
3220 * all of them make sense - see the source for which ones are possible.
3221 * Statistics that the driver doesn't fill will be filled by mac80211.
3222 * The callback can sleep.
3223 *
3224 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
3225 * bursting) for a hardware TX queue.
3226 * Returns a negative error code on failure.
3227 * The callback can sleep.
3228 *
3229 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
3230 * this is only used for IBSS mode BSSID merging and debugging. Is not a
3231 * required function.
3232 * The callback can sleep.
3233 *
3234 * @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
3235 * Currently, this is only used for IBSS mode debugging. Is not a
3236 * required function.
3237 * The callback can sleep.
3238 *
3239 * @offset_tsf: Offset the TSF timer by the specified value in the
3240 * firmware/hardware. Preferred to set_tsf as it avoids delay between
3241 * calling set_tsf() and hardware getting programmed, which will show up
3242 * as TSF delay. Is not a required function.
3243 * The callback can sleep.
3244 *
3245 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
3246 * with other STAs in the IBSS. This is only used in IBSS mode. This
3247 * function is optional if the firmware/hardware takes full care of
3248 * TSF synchronization.
3249 * The callback can sleep.
3250 *
3251 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
3252 * This is needed only for IBSS mode and the result of this function is
3253 * used to determine whether to reply to Probe Requests.
3254 * Returns non-zero if this device sent the last beacon.
3255 * The callback can sleep.
3256 *
3257 * @get_survey: Return per-channel survey information
3258 *
3259 * @rfkill_poll: Poll rfkill hardware state. If you need this, you also
3260 * need to set wiphy->rfkill_poll to %true before registration,
3261 * and need to call wiphy_rfkill_set_hw_state() in the callback.
3262 * The callback can sleep.
3263 *
3264 * @set_coverage_class: Set slot time for given coverage class as specified
3265 * in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
3266 * accordingly; coverage class equals to -1 to enable ACK timeout
3267 * estimation algorithm (dynack). To disable dynack set valid value for
3268 * coverage class. This callback is not required and may sleep.
3269 *
3270 * @testmode_cmd: Implement a cfg80211 test mode command. The passed @vif may
3271 * be %NULL. The callback can sleep.
3272 * @testmode_dump: Implement a cfg80211 test mode dump. The callback can sleep.
3273 *
3274 * @flush: Flush all pending frames from the hardware queue, making sure
3275 * that the hardware queues are empty. The @queues parameter is a bitmap
3276 * of queues to flush, which is useful if different virtual interfaces
3277 * use different hardware queues; it may also indicate all queues.
3278 * If the parameter @drop is set to %true, pending frames may be dropped.
3279 * Note that vif can be NULL.
3280 * The callback can sleep.
3281 *
3282 * @channel_switch: Drivers that need (or want) to offload the channel
3283 * switch operation for CSAs received from the AP may implement this
3284 * callback. They must then call ieee80211_chswitch_done() to indicate
3285 * completion of the channel switch.
3286 *
3287 * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3288 * Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3289 * reject TX/RX mask combinations they cannot support by returning -EINVAL
3290 * (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3291 *
3292 * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3293 *
3294 * @remain_on_channel: Starts an off-channel period on the given channel, must
3295 * call back to ieee80211_ready_on_channel() when on that channel. Note
3296 * that normal channel traffic is not stopped as this is intended for hw
3297 * offload. Frames to transmit on the off-channel channel are transmitted
3298 * normally except for the %IEEE80211_TX_CTL_TX_OFFCHAN flag. When the
3299 * duration (which will always be non-zero) expires, the driver must call
3300 * ieee80211_remain_on_channel_expired().
3301 * Note that this callback may be called while the device is in IDLE and
3302 * must be accepted in this case.
3303 * This callback may sleep.
3304 * @cancel_remain_on_channel: Requests that an ongoing off-channel period is
3305 * aborted before it expires. This callback may sleep.
3306 *
3307 * @set_ringparam: Set tx and rx ring sizes.
3308 *
3309 * @get_ringparam: Get tx and rx ring current and maximum sizes.
3310 *
3311 * @tx_frames_pending: Check if there is any pending frame in the hardware
3312 * queues before entering power save.
3313 *
3314 * @set_bitrate_mask: Set a mask of rates to be used for rate control selection
3315 * when transmitting a frame. Currently only legacy rates are handled.
3316 * The callback can sleep.
3317 * @event_callback: Notify driver about any event in mac80211. See
3318 * &enum ieee80211_event_type for the different types.
3319 * The callback must be atomic.
3320 *
3321 * @release_buffered_frames: Release buffered frames according to the given
3322 * parameters. In the case where the driver buffers some frames for
3323 * sleeping stations mac80211 will use this callback to tell the driver
3324 * to release some frames, either for PS-poll or uAPSD.
3325 * Note that if the @more_data parameter is %false the driver must check
3326 * if there are more frames on the given TIDs, and if there are more than
3327 * the frames being released then it must still set the more-data bit in
3328 * the frame. If the @more_data parameter is %true, then of course the
3329 * more-data bit must always be set.
3330 * The @tids parameter tells the driver which TIDs to release frames
3331 * from, for PS-poll it will always have only a single bit set.
3332 * In the case this is used for a PS-poll initiated release, the
3333 * @num_frames parameter will always be 1 so code can be shared. In
3334 * this case the driver must also set %IEEE80211_TX_STATUS_EOSP flag
3335 * on the TX status (and must report TX status) so that the PS-poll
3336 * period is properly ended. This is used to avoid sending multiple
3337 * responses for a retried PS-poll frame.
3338 * In the case this is used for uAPSD, the @num_frames parameter may be
3339 * bigger than one, but the driver may send fewer frames (it must send
3340 * at least one, however). In this case it is also responsible for
3341 * setting the EOSP flag in the QoS header of the frames. Also, when the
3342 * service period ends, the driver must set %IEEE80211_TX_STATUS_EOSP
3343 * on the last frame in the SP. Alternatively, it may call the function
3344 * ieee80211_sta_eosp() to inform mac80211 of the end of the SP.
3345 * This callback must be atomic.
3346 * @allow_buffered_frames: Prepare device to allow the given number of frames
3347 * to go out to the given station. The frames will be sent by mac80211
3348 * via the usual TX path after this call. The TX information for frames
3349 * released will also have the %IEEE80211_TX_CTL_NO_PS_BUFFER flag set
3350 * and the last one will also have %IEEE80211_TX_STATUS_EOSP set. In case
3351 * frames from multiple TIDs are released and the driver might reorder
3352 * them between the TIDs, it must set the %IEEE80211_TX_STATUS_EOSP flag
3353 * on the last frame and clear it on all others and also handle the EOSP
3354 * bit in the QoS header correctly. Alternatively, it can also call the
3355 * ieee80211_sta_eosp() function.
3356 * The @tids parameter is a bitmap and tells the driver which TIDs the
3357 * frames will be on; it will at most have two bits set.
3358 * This callback must be atomic.
3359 *
3360 * @get_et_sset_count: Ethtool API to get string-set count.
3361 *
3362 * @get_et_stats: Ethtool API to get a set of u64 stats.
3363 *
3364 * @get_et_strings: Ethtool API to get a set of strings to describe stats
3365 * and perhaps other supported types of ethtool data-sets.
3366 *
3367 * @mgd_prepare_tx: Prepare for transmitting a management frame for association
3368 * before associated. In multi-channel scenarios, a virtual interface is
3369 * bound to a channel before it is associated, but as it isn't associated
3370 * yet it need not necessarily be given airtime, in particular since any
3371 * transmission to a P2P GO needs to be synchronized against the GO's
3372 * powersave state. mac80211 will call this function before transmitting a
3373 * management frame prior to having successfully associated to allow the
3374 * driver to give it channel time for the transmission, to get a response
3375 * and to be able to synchronize with the GO.
3376 * For drivers that set %IEEE80211_HW_DEAUTH_NEED_MGD_TX_PREP, mac80211
3377 * would also call this function before transmitting a deauthentication
3378 * frame in case that no beacon was heard from the AP/P2P GO.
3379 * The callback will be called before each transmission and upon return
3380 * mac80211 will transmit the frame right away.
3381 * The callback is optional and can (should!) sleep.
3382 *
3383 * @mgd_protect_tdls_discover: Protect a TDLS discovery session. After sending
3384 * a TDLS discovery-request, we expect a reply to arrive on the AP's
3385 * channel. We must stay on the channel (no PSM, scan, etc.), since a TDLS
3386 * setup-response is a direct packet not buffered by the AP.
3387 * mac80211 will call this function just before the transmission of a TDLS
3388 * discovery-request. The recommended period of protection is at least
3389 * 2 * (DTIM period).
3390 * The callback is optional and can sleep.
3391 *
3392 * @add_chanctx: Notifies device driver about new channel context creation.
3393 * This callback may sleep.
3394 * @remove_chanctx: Notifies device driver about channel context destruction.
3395 * This callback may sleep.
3396 * @change_chanctx: Notifies device driver about channel context changes that
3397 * may happen when combining different virtual interfaces on the same
3398 * channel context with different settings
3399 * This callback may sleep.
3400 * @assign_vif_chanctx: Notifies device driver about channel context being bound
3401 * to vif. Possible use is for hw queue remapping.
3402 * This callback may sleep.
3403 * @unassign_vif_chanctx: Notifies device driver about channel context being
3404 * unbound from vif.
3405 * This callback may sleep.
3406 * @switch_vif_chanctx: switch a number of vifs from one chanctx to
3407 * another, as specified in the list of
3408 * @ieee80211_vif_chanctx_switch passed to the driver, according
3409 * to the mode defined in &ieee80211_chanctx_switch_mode.
3410 * This callback may sleep.
3411 *
3412 * @start_ap: Start operation on the AP interface, this is called after all the
3413 * information in bss_conf is set and beacon can be retrieved. A channel
3414 * context is bound before this is called. Note that if the driver uses
3415 * software scan or ROC, this (and @stop_ap) isn't called when the AP is
3416 * just "paused" for scanning/ROC, which is indicated by the beacon being
3417 * disabled/enabled via @bss_info_changed.
3418 * @stop_ap: Stop operation on the AP interface.
3419 *
3420 * @reconfig_complete: Called after a call to ieee80211_restart_hw() and
3421 * during resume, when the reconfiguration has completed.
3422 * This can help the driver implement the reconfiguration step (and
3423 * indicate mac80211 is ready to receive frames).
3424 * This callback may sleep.
3425 *
3426 * @ipv6_addr_change: IPv6 address assignment on the given interface changed.
3427 * Currently, this is only called for managed or P2P client interfaces.
3428 * This callback is optional; it must not sleep.
3429 *
3430 * @channel_switch_beacon: Starts a channel switch to a new channel.
3431 * Beacons are modified to include CSA or ECSA IEs before calling this
3432 * function. The corresponding count fields in these IEs must be
3433 * decremented, and when they reach 1 the driver must call
3434 * ieee80211_csa_finish(). Drivers which use ieee80211_beacon_get()
3435 * get the csa counter decremented by mac80211, but must check if it is
3436 * 1 using ieee80211_csa_is_complete() after the beacon has been
3437 * transmitted and then call ieee80211_csa_finish().
3438 * If the CSA count starts as zero or 1, this function will not be called,
3439 * since there won't be any time to beacon before the switch anyway.
3440 * @pre_channel_switch: This is an optional callback that is called
3441 * before a channel switch procedure is started (ie. when a STA
3442 * gets a CSA or a userspace initiated channel-switch), allowing
3443 * the driver to prepare for the channel switch.
3444 * @post_channel_switch: This is an optional callback that is called
3445 * after a channel switch procedure is completed, allowing the
3446 * driver to go back to a normal configuration.
3447 *
3448 * @join_ibss: Join an IBSS (on an IBSS interface); this is called after all
3449 * information in bss_conf is set up and the beacon can be retrieved. A
3450 * channel context is bound before this is called.
3451 * @leave_ibss: Leave the IBSS again.
3452 *
3453 * @get_expected_throughput: extract the expected throughput towards the
3454 * specified station. The returned value is expressed in Kbps. It returns 0
3455 * if the RC algorithm does not have proper data to provide.
3456 *
3457 * @get_txpower: get current maximum tx power (in dBm) based on configuration
3458 * and hardware limits.
3459 *
3460 * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3461 * is responsible for continually initiating channel-switching operations
3462 * and returning to the base channel for communication with the AP. The
3463 * driver receives a channel-switch request template and the location of
3464 * the switch-timing IE within the template as part of the invocation.
3465 * The template is valid only within the call, and the driver can
3466 * optionally copy the skb for further re-use.
3467 * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3468 * peers must be on the base channel when the call completes.
3469 * @tdls_recv_channel_switch: a TDLS channel-switch related frame (request or
3470 * response) has been received from a remote peer. The driver gets
3471 * parameters parsed from the incoming frame and may use them to continue
3472 * an ongoing channel-switch operation. In addition, a channel-switch
3473 * response template is provided, together with the location of the
3474 * switch-timing IE within the template. The skb can only be used within
3475 * the function call.
3476 *
3477 * @wake_tx_queue: Called when new packets have been added to the queue.
3478 * @sync_rx_queues: Process all pending frames in RSS queues. This is a
3479 * synchronization which is needed in case driver has in its RSS queues
3480 * pending frames that were received prior to the control path action
3481 * currently taken (e.g. disassociation) but are not processed yet.
3482 *
3483 * @start_nan: join an existing NAN cluster, or create a new one.
3484 * @stop_nan: leave the NAN cluster.
3485 * @nan_change_conf: change NAN configuration. The data in cfg80211_nan_conf
3486 * contains full new configuration and changes specify which parameters
3487 * are changed with respect to the last NAN config.
3488 * The driver gets both full configuration and the changed parameters since
3489 * some devices may need the full configuration while others need only the
3490 * changed parameters.
3491 * @add_nan_func: Add a NAN function. Returns 0 on success. The data in
3492 * cfg80211_nan_func must not be referenced outside the scope of
3493 * this call.
3494 * @del_nan_func: Remove a NAN function. The driver must call
3495 * ieee80211_nan_func_terminated() with
3496 * NL80211_NAN_FUNC_TERM_REASON_USER_REQUEST reason code upon removal.
3497 */
3498struct ieee80211_ops {
3499 void (*tx)(struct ieee80211_hw *hw,
3500 struct ieee80211_tx_control *control,
3501 struct sk_buff *skb);
3502 int (*start)(struct ieee80211_hw *hw);
3503 void (*stop)(struct ieee80211_hw *hw);
3504#ifdef CONFIG_PM
3505 int (*suspend)(struct ieee80211_hw *hw, struct cfg80211_wowlan *wowlan);
3506 int (*resume)(struct ieee80211_hw *hw);
3507 void (*set_wakeup)(struct ieee80211_hw *hw, bool enabled);
3508#endif
3509 int (*add_interface)(struct ieee80211_hw *hw,
3510 struct ieee80211_vif *vif);
3511 int (*change_interface)(struct ieee80211_hw *hw,
3512 struct ieee80211_vif *vif,
3513 enum nl80211_iftype new_type, bool p2p);
3514 void (*remove_interface)(struct ieee80211_hw *hw,
3515 struct ieee80211_vif *vif);
3516 int (*config)(struct ieee80211_hw *hw, u32 changed);
3517 void (*bss_info_changed)(struct ieee80211_hw *hw,
3518 struct ieee80211_vif *vif,
3519 struct ieee80211_bss_conf *info,
3520 u32 changed);
3521
3522 int (*start_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3523 void (*stop_ap)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3524
3525 u64 (*prepare_multicast)(struct ieee80211_hw *hw,
3526 struct netdev_hw_addr_list *mc_list);
3527 void (*configure_filter)(struct ieee80211_hw *hw,
3528 unsigned int changed_flags,
3529 unsigned int *total_flags,
3530 u64 multicast);
3531 void (*config_iface_filter)(struct ieee80211_hw *hw,
3532 struct ieee80211_vif *vif,
3533 unsigned int filter_flags,
3534 unsigned int changed_flags);
3535 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
3536 bool set);
3537 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
3538 struct ieee80211_vif *vif, struct ieee80211_sta *sta,
3539 struct ieee80211_key_conf *key);
3540 void (*update_tkip_key)(struct ieee80211_hw *hw,
3541 struct ieee80211_vif *vif,
3542 struct ieee80211_key_conf *conf,
3543 struct ieee80211_sta *sta,
3544 u32 iv32, u16 *phase1key);
3545 void (*set_rekey_data)(struct ieee80211_hw *hw,
3546 struct ieee80211_vif *vif,
3547 struct cfg80211_gtk_rekey_data *data);
3548 void (*set_default_unicast_key)(struct ieee80211_hw *hw,
3549 struct ieee80211_vif *vif, int idx);
3550 int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3551 struct ieee80211_scan_request *req);
3552 void (*cancel_hw_scan)(struct ieee80211_hw *hw,
3553 struct ieee80211_vif *vif);
3554 int (*sched_scan_start)(struct ieee80211_hw *hw,
3555 struct ieee80211_vif *vif,
3556 struct cfg80211_sched_scan_request *req,
3557 struct ieee80211_scan_ies *ies);
3558 int (*sched_scan_stop)(struct ieee80211_hw *hw,
3559 struct ieee80211_vif *vif);
3560 void (*sw_scan_start)(struct ieee80211_hw *hw,
3561 struct ieee80211_vif *vif,
3562 const u8 *mac_addr);
3563 void (*sw_scan_complete)(struct ieee80211_hw *hw,
3564 struct ieee80211_vif *vif);
3565 int (*get_stats)(struct ieee80211_hw *hw,
3566 struct ieee80211_low_level_stats *stats);
3567 void (*get_key_seq)(struct ieee80211_hw *hw,
3568 struct ieee80211_key_conf *key,
3569 struct ieee80211_key_seq *seq);
3570 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
3571 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
3572 int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3573 struct ieee80211_sta *sta);
3574 int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3575 struct ieee80211_sta *sta);
3576#ifdef CONFIG_MAC80211_DEBUGFS
3577 void (*sta_add_debugfs)(struct ieee80211_hw *hw,
3578 struct ieee80211_vif *vif,
3579 struct ieee80211_sta *sta,
3580 struct dentry *dir);
3581#endif
3582 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3583 enum sta_notify_cmd, struct ieee80211_sta *sta);
3584 int (*sta_state)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3585 struct ieee80211_sta *sta,
3586 enum ieee80211_sta_state old_state,
3587 enum ieee80211_sta_state new_state);
3588 void (*sta_pre_rcu_remove)(struct ieee80211_hw *hw,
3589 struct ieee80211_vif *vif,
3590 struct ieee80211_sta *sta);
3591 void (*sta_rc_update)(struct ieee80211_hw *hw,
3592 struct ieee80211_vif *vif,
3593 struct ieee80211_sta *sta,
3594 u32 changed);
3595 void (*sta_rate_tbl_update)(struct ieee80211_hw *hw,
3596 struct ieee80211_vif *vif,
3597 struct ieee80211_sta *sta);
3598 void (*sta_statistics)(struct ieee80211_hw *hw,
3599 struct ieee80211_vif *vif,
3600 struct ieee80211_sta *sta,
3601 struct station_info *sinfo);
3602 int (*conf_tx)(struct ieee80211_hw *hw,
3603 struct ieee80211_vif *vif, u16 ac,
3604 const struct ieee80211_tx_queue_params *params);
3605 u64 (*get_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3606 void (*set_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3607 u64 tsf);
3608 void (*offset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3609 s64 offset);
3610 void (*reset_tsf)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3611 int (*tx_last_beacon)(struct ieee80211_hw *hw);
3612
3613 /**
3614 * @ampdu_action:
3615 * Perform a certain A-MPDU action.
3616 * The RA/TID combination determines the destination and TID we want
3617 * the ampdu action to be performed for. The action is defined through
3618 * ieee80211_ampdu_mlme_action.
3619 * When the action is set to %IEEE80211_AMPDU_TX_OPERATIONAL the driver
3620 * may neither send aggregates containing more subframes than @buf_size
3621 * nor send aggregates in a way that lost frames would exceed the
3622 * buffer size. If just limiting the aggregate size, this would be
3623 * possible with a buf_size of 8:
3624 *
3625 * - ``TX: 1.....7``
3626 * - ``RX: 2....7`` (lost frame #1)
3627 * - ``TX: 8..1...``
3628 *
3629 * which is invalid since #1 was now re-transmitted well past the
3630 * buffer size of 8. Correct ways to retransmit #1 would be:
3631 *
3632 * - ``TX: 1 or``
3633 * - ``TX: 18 or``
3634 * - ``TX: 81``
3635 *
3636 * Even ``189`` would be wrong since 1 could be lost again.
3637 *
3638 * Returns a negative error code on failure.
3639 * The callback can sleep.
3640 */
3641 int (*ampdu_action)(struct ieee80211_hw *hw,
3642 struct ieee80211_vif *vif,
3643 struct ieee80211_ampdu_params *params);
3644 int (*get_survey)(struct ieee80211_hw *hw, int idx,
3645 struct survey_info *survey);
3646 void (*rfkill_poll)(struct ieee80211_hw *hw);
3647 void (*set_coverage_class)(struct ieee80211_hw *hw, s16 coverage_class);
3648#ifdef CONFIG_NL80211_TESTMODE
3649 int (*testmode_cmd)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3650 void *data, int len);
3651 int (*testmode_dump)(struct ieee80211_hw *hw, struct sk_buff *skb,
3652 struct netlink_callback *cb,
3653 void *data, int len);
3654#endif
3655 void (*flush)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3656 u32 queues, bool drop);
3657 void (*channel_switch)(struct ieee80211_hw *hw,
3658 struct ieee80211_vif *vif,
3659 struct ieee80211_channel_switch *ch_switch);
3660 int (*set_antenna)(struct ieee80211_hw *hw, u32 tx_ant, u32 rx_ant);
3661 int (*get_antenna)(struct ieee80211_hw *hw, u32 *tx_ant, u32 *rx_ant);
3662
3663 int (*remain_on_channel)(struct ieee80211_hw *hw,
3664 struct ieee80211_vif *vif,
3665 struct ieee80211_channel *chan,
3666 int duration,
3667 enum ieee80211_roc_type type);
3668 int (*cancel_remain_on_channel)(struct ieee80211_hw *hw);
3669 int (*set_ringparam)(struct ieee80211_hw *hw, u32 tx, u32 rx);
3670 void (*get_ringparam)(struct ieee80211_hw *hw,
3671 u32 *tx, u32 *tx_max, u32 *rx, u32 *rx_max);
3672 bool (*tx_frames_pending)(struct ieee80211_hw *hw);
3673 int (*set_bitrate_mask)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3674 const struct cfg80211_bitrate_mask *mask);
3675 void (*event_callback)(struct ieee80211_hw *hw,
3676 struct ieee80211_vif *vif,
3677 const struct ieee80211_event *event);
3678
3679 void (*allow_buffered_frames)(struct ieee80211_hw *hw,
3680 struct ieee80211_sta *sta,
3681 u16 tids, int num_frames,
3682 enum ieee80211_frame_release_type reason,
3683 bool more_data);
3684 void (*release_buffered_frames)(struct ieee80211_hw *hw,
3685 struct ieee80211_sta *sta,
3686 u16 tids, int num_frames,
3687 enum ieee80211_frame_release_type reason,
3688 bool more_data);
3689
3690 int (*get_et_sset_count)(struct ieee80211_hw *hw,
3691 struct ieee80211_vif *vif, int sset);
3692 void (*get_et_stats)(struct ieee80211_hw *hw,
3693 struct ieee80211_vif *vif,
3694 struct ethtool_stats *stats, u64 *data);
3695 void (*get_et_strings)(struct ieee80211_hw *hw,
3696 struct ieee80211_vif *vif,
3697 u32 sset, u8 *data);
3698
3699 void (*mgd_prepare_tx)(struct ieee80211_hw *hw,
3700 struct ieee80211_vif *vif);
3701
3702 void (*mgd_protect_tdls_discover)(struct ieee80211_hw *hw,
3703 struct ieee80211_vif *vif);
3704
3705 int (*add_chanctx)(struct ieee80211_hw *hw,
3706 struct ieee80211_chanctx_conf *ctx);
3707 void (*remove_chanctx)(struct ieee80211_hw *hw,
3708 struct ieee80211_chanctx_conf *ctx);
3709 void (*change_chanctx)(struct ieee80211_hw *hw,
3710 struct ieee80211_chanctx_conf *ctx,
3711 u32 changed);
3712 int (*assign_vif_chanctx)(struct ieee80211_hw *hw,
3713 struct ieee80211_vif *vif,
3714 struct ieee80211_chanctx_conf *ctx);
3715 void (*unassign_vif_chanctx)(struct ieee80211_hw *hw,
3716 struct ieee80211_vif *vif,
3717 struct ieee80211_chanctx_conf *ctx);
3718 int (*switch_vif_chanctx)(struct ieee80211_hw *hw,
3719 struct ieee80211_vif_chanctx_switch *vifs,
3720 int n_vifs,
3721 enum ieee80211_chanctx_switch_mode mode);
3722
3723 void (*reconfig_complete)(struct ieee80211_hw *hw,
3724 enum ieee80211_reconfig_type reconfig_type);
3725
3726#if IS_ENABLED(CONFIG_IPV6)
3727 void (*ipv6_addr_change)(struct ieee80211_hw *hw,
3728 struct ieee80211_vif *vif,
3729 struct inet6_dev *idev);
3730#endif
3731 void (*channel_switch_beacon)(struct ieee80211_hw *hw,
3732 struct ieee80211_vif *vif,
3733 struct cfg80211_chan_def *chandef);
3734 int (*pre_channel_switch)(struct ieee80211_hw *hw,
3735 struct ieee80211_vif *vif,
3736 struct ieee80211_channel_switch *ch_switch);
3737
3738 int (*post_channel_switch)(struct ieee80211_hw *hw,
3739 struct ieee80211_vif *vif);
3740
3741 int (*join_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3742 void (*leave_ibss)(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
3743 u32 (*get_expected_throughput)(struct ieee80211_hw *hw,
3744 struct ieee80211_sta *sta);
3745 int (*get_txpower)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
3746 int *dbm);
3747
3748 int (*tdls_channel_switch)(struct ieee80211_hw *hw,
3749 struct ieee80211_vif *vif,
3750 struct ieee80211_sta *sta, u8 oper_class,
3751 struct cfg80211_chan_def *chandef,
3752 struct sk_buff *tmpl_skb, u32 ch_sw_tm_ie);
3753 void (*tdls_cancel_channel_switch)(struct ieee80211_hw *hw,
3754 struct ieee80211_vif *vif,
3755 struct ieee80211_sta *sta);
3756 void (*tdls_recv_channel_switch)(struct ieee80211_hw *hw,
3757 struct ieee80211_vif *vif,
3758 struct ieee80211_tdls_ch_sw_params *params);
3759
3760 void (*wake_tx_queue)(struct ieee80211_hw *hw,
3761 struct ieee80211_txq *txq);
3762 void (*sync_rx_queues)(struct ieee80211_hw *hw);
3763
3764 int (*start_nan)(struct ieee80211_hw *hw,
3765 struct ieee80211_vif *vif,
3766 struct cfg80211_nan_conf *conf);
3767 int (*stop_nan)(struct ieee80211_hw *hw,
3768 struct ieee80211_vif *vif);
3769 int (*nan_change_conf)(struct ieee80211_hw *hw,
3770 struct ieee80211_vif *vif,
3771 struct cfg80211_nan_conf *conf, u32 changes);
3772 int (*add_nan_func)(struct ieee80211_hw *hw,
3773 struct ieee80211_vif *vif,
3774 const struct cfg80211_nan_func *nan_func);
3775 void (*del_nan_func)(struct ieee80211_hw *hw,
3776 struct ieee80211_vif *vif,
3777 u8 instance_id);
3778};
3779
3780/**
3781 * ieee80211_alloc_hw_nm - Allocate a new hardware device
3782 *
3783 * This must be called once for each hardware device. The returned pointer
3784 * must be used to refer to this device when calling other functions.
3785 * mac80211 allocates a private data area for the driver pointed to by
3786 * @priv in &struct ieee80211_hw, the size of this area is given as
3787 * @priv_data_len.
3788 *
3789 * @priv_data_len: length of private data
3790 * @ops: callbacks for this device
3791 * @requested_name: Requested name for this device.
3792 * NULL is valid value, and means use the default naming (phy%d)
3793 *
3794 * Return: A pointer to the new hardware device, or %NULL on error.
3795 */
3796struct ieee80211_hw *ieee80211_alloc_hw_nm(size_t priv_data_len,
3797 const struct ieee80211_ops *ops,
3798 const char *requested_name);
3799
3800/**
3801 * ieee80211_alloc_hw - Allocate a new hardware device
3802 *
3803 * This must be called once for each hardware device. The returned pointer
3804 * must be used to refer to this device when calling other functions.
3805 * mac80211 allocates a private data area for the driver pointed to by
3806 * @priv in &struct ieee80211_hw, the size of this area is given as
3807 * @priv_data_len.
3808 *
3809 * @priv_data_len: length of private data
3810 * @ops: callbacks for this device
3811 *
3812 * Return: A pointer to the new hardware device, or %NULL on error.
3813 */
3814static inline
3815struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
3816 const struct ieee80211_ops *ops)
3817{
3818 return ieee80211_alloc_hw_nm(priv_data_len, ops, NULL);
3819}
3820
3821/**
3822 * ieee80211_register_hw - Register hardware device
3823 *
3824 * You must call this function before any other functions in
3825 * mac80211. Note that before a hardware can be registered, you
3826 * need to fill the contained wiphy's information.
3827 *
3828 * @hw: the device to register as returned by ieee80211_alloc_hw()
3829 *
3830 * Return: 0 on success. An error code otherwise.
3831 */
3832int ieee80211_register_hw(struct ieee80211_hw *hw);
3833
3834/**
3835 * struct ieee80211_tpt_blink - throughput blink description
3836 * @throughput: throughput in Kbit/sec
3837 * @blink_time: blink time in milliseconds
3838 * (full cycle, ie. one off + one on period)
3839 */
3840struct ieee80211_tpt_blink {
3841 int throughput;
3842 int blink_time;
3843};
3844
3845/**
3846 * enum ieee80211_tpt_led_trigger_flags - throughput trigger flags
3847 * @IEEE80211_TPT_LEDTRIG_FL_RADIO: enable blinking with radio
3848 * @IEEE80211_TPT_LEDTRIG_FL_WORK: enable blinking when working
3849 * @IEEE80211_TPT_LEDTRIG_FL_CONNECTED: enable blinking when at least one
3850 * interface is connected in some way, including being an AP
3851 */
3852enum ieee80211_tpt_led_trigger_flags {
3853 IEEE80211_TPT_LEDTRIG_FL_RADIO = BIT(0),
3854 IEEE80211_TPT_LEDTRIG_FL_WORK = BIT(1),
3855 IEEE80211_TPT_LEDTRIG_FL_CONNECTED = BIT(2),
3856};
3857
3858#ifdef CONFIG_MAC80211_LEDS
3859const char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
3860const char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
3861const char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
3862const char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
3863const char *
3864__ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw,
3865 unsigned int flags,
3866 const struct ieee80211_tpt_blink *blink_table,
3867 unsigned int blink_table_len);
3868#endif
3869/**
3870 * ieee80211_get_tx_led_name - get name of TX LED
3871 *
3872 * mac80211 creates a transmit LED trigger for each wireless hardware
3873 * that can be used to drive LEDs if your driver registers a LED device.
3874 * This function returns the name (or %NULL if not configured for LEDs)
3875 * of the trigger so you can automatically link the LED device.
3876 *
3877 * @hw: the hardware to get the LED trigger name for
3878 *
3879 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3880 */
3881static inline const char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
3882{
3883#ifdef CONFIG_MAC80211_LEDS
3884 return __ieee80211_get_tx_led_name(hw);
3885#else
3886 return NULL;
3887#endif
3888}
3889
3890/**
3891 * ieee80211_get_rx_led_name - get name of RX LED
3892 *
3893 * mac80211 creates a receive LED trigger for each wireless hardware
3894 * that can be used to drive LEDs if your driver registers a LED device.
3895 * This function returns the name (or %NULL if not configured for LEDs)
3896 * of the trigger so you can automatically link the LED device.
3897 *
3898 * @hw: the hardware to get the LED trigger name for
3899 *
3900 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3901 */
3902static inline const char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
3903{
3904#ifdef CONFIG_MAC80211_LEDS
3905 return __ieee80211_get_rx_led_name(hw);
3906#else
3907 return NULL;
3908#endif
3909}
3910
3911/**
3912 * ieee80211_get_assoc_led_name - get name of association LED
3913 *
3914 * mac80211 creates a association LED trigger for each wireless hardware
3915 * that can be used to drive LEDs if your driver registers a LED device.
3916 * This function returns the name (or %NULL if not configured for LEDs)
3917 * of the trigger so you can automatically link the LED device.
3918 *
3919 * @hw: the hardware to get the LED trigger name for
3920 *
3921 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3922 */
3923static inline const char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
3924{
3925#ifdef CONFIG_MAC80211_LEDS
3926 return __ieee80211_get_assoc_led_name(hw);
3927#else
3928 return NULL;
3929#endif
3930}
3931
3932/**
3933 * ieee80211_get_radio_led_name - get name of radio LED
3934 *
3935 * mac80211 creates a radio change LED trigger for each wireless hardware
3936 * that can be used to drive LEDs if your driver registers a LED device.
3937 * This function returns the name (or %NULL if not configured for LEDs)
3938 * of the trigger so you can automatically link the LED device.
3939 *
3940 * @hw: the hardware to get the LED trigger name for
3941 *
3942 * Return: The name of the LED trigger. %NULL if not configured for LEDs.
3943 */
3944static inline const char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
3945{
3946#ifdef CONFIG_MAC80211_LEDS
3947 return __ieee80211_get_radio_led_name(hw);
3948#else
3949 return NULL;
3950#endif
3951}
3952
3953/**
3954 * ieee80211_create_tpt_led_trigger - create throughput LED trigger
3955 * @hw: the hardware to create the trigger for
3956 * @flags: trigger flags, see &enum ieee80211_tpt_led_trigger_flags
3957 * @blink_table: the blink table -- needs to be ordered by throughput
3958 * @blink_table_len: size of the blink table
3959 *
3960 * Return: %NULL (in case of error, or if no LED triggers are
3961 * configured) or the name of the new trigger.
3962 *
3963 * Note: This function must be called before ieee80211_register_hw().
3964 */
3965static inline const char *
3966ieee80211_create_tpt_led_trigger(struct ieee80211_hw *hw, unsigned int flags,
3967 const struct ieee80211_tpt_blink *blink_table,
3968 unsigned int blink_table_len)
3969{
3970#ifdef CONFIG_MAC80211_LEDS
3971 return __ieee80211_create_tpt_led_trigger(hw, flags, blink_table,
3972 blink_table_len);
3973#else
3974 return NULL;
3975#endif
3976}
3977
3978/**
3979 * ieee80211_unregister_hw - Unregister a hardware device
3980 *
3981 * This function instructs mac80211 to free allocated resources
3982 * and unregister netdevices from the networking subsystem.
3983 *
3984 * @hw: the hardware to unregister
3985 */
3986void ieee80211_unregister_hw(struct ieee80211_hw *hw);
3987
3988/**
3989 * ieee80211_free_hw - free hardware descriptor
3990 *
3991 * This function frees everything that was allocated, including the
3992 * private data for the driver. You must call ieee80211_unregister_hw()
3993 * before calling this function.
3994 *
3995 * @hw: the hardware to free
3996 */
3997void ieee80211_free_hw(struct ieee80211_hw *hw);
3998
3999/**
4000 * ieee80211_restart_hw - restart hardware completely
4001 *
4002 * Call this function when the hardware was restarted for some reason
4003 * (hardware error, ...) and the driver is unable to restore its state
4004 * by itself. mac80211 assumes that at this point the driver/hardware
4005 * is completely uninitialised and stopped, it starts the process by
4006 * calling the ->start() operation. The driver will need to reset all
4007 * internal state that it has prior to calling this function.
4008 *
4009 * @hw: the hardware to restart
4010 */
4011void ieee80211_restart_hw(struct ieee80211_hw *hw);
4012
4013/**
4014 * ieee80211_rx_napi - receive frame from NAPI context
4015 *
4016 * Use this function to hand received frames to mac80211. The receive
4017 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4018 * paged @skb is used, the driver is recommended to put the ieee80211
4019 * header of the frame on the linear part of the @skb to avoid memory
4020 * allocation and/or memcpy by the stack.
4021 *
4022 * This function may not be called in IRQ context. Calls to this function
4023 * for a single hardware must be synchronized against each other. Calls to
4024 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4025 * mixed for a single hardware. Must not run concurrently with
4026 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4027 *
4028 * This function must be called with BHs disabled.
4029 *
4030 * @hw: the hardware this frame came in on
4031 * @sta: the station the frame was received from, or %NULL
4032 * @skb: the buffer to receive, owned by mac80211 after this call
4033 * @napi: the NAPI context
4034 */
4035void ieee80211_rx_napi(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
4036 struct sk_buff *skb, struct napi_struct *napi);
4037
4038/**
4039 * ieee80211_rx - receive frame
4040 *
4041 * Use this function to hand received frames to mac80211. The receive
4042 * buffer in @skb must start with an IEEE 802.11 header. In case of a
4043 * paged @skb is used, the driver is recommended to put the ieee80211
4044 * header of the frame on the linear part of the @skb to avoid memory
4045 * allocation and/or memcpy by the stack.
4046 *
4047 * This function may not be called in IRQ context. Calls to this function
4048 * for a single hardware must be synchronized against each other. Calls to
4049 * this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
4050 * mixed for a single hardware. Must not run concurrently with
4051 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4052 *
4053 * In process context use instead ieee80211_rx_ni().
4054 *
4055 * @hw: the hardware this frame came in on
4056 * @skb: the buffer to receive, owned by mac80211 after this call
4057 */
4058static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb)
4059{
4060 ieee80211_rx_napi(hw, NULL, skb, NULL);
4061}
4062
4063/**
4064 * ieee80211_rx_irqsafe - receive frame
4065 *
4066 * Like ieee80211_rx() but can be called in IRQ context
4067 * (internally defers to a tasklet.)
4068 *
4069 * Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
4070 * be mixed for a single hardware.Must not run concurrently with
4071 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4072 *
4073 * @hw: the hardware this frame came in on
4074 * @skb: the buffer to receive, owned by mac80211 after this call
4075 */
4076void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
4077
4078/**
4079 * ieee80211_rx_ni - receive frame (in process context)
4080 *
4081 * Like ieee80211_rx() but can be called in process context
4082 * (internally disables bottom halves).
4083 *
4084 * Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
4085 * not be mixed for a single hardware. Must not run concurrently with
4086 * ieee80211_tx_status() or ieee80211_tx_status_ni().
4087 *
4088 * @hw: the hardware this frame came in on
4089 * @skb: the buffer to receive, owned by mac80211 after this call
4090 */
4091static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
4092 struct sk_buff *skb)
4093{
4094 local_bh_disable();
4095 ieee80211_rx(hw, skb);
4096 local_bh_enable();
4097}
4098
4099/**
4100 * ieee80211_sta_ps_transition - PS transition for connected sta
4101 *
4102 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS
4103 * flag set, use this function to inform mac80211 about a connected station
4104 * entering/leaving PS mode.
4105 *
4106 * This function may not be called in IRQ context or with softirqs enabled.
4107 *
4108 * Calls to this function for a single hardware must be synchronized against
4109 * each other.
4110 *
4111 * @sta: currently connected sta
4112 * @start: start or stop PS
4113 *
4114 * Return: 0 on success. -EINVAL when the requested PS mode is already set.
4115 */
4116int ieee80211_sta_ps_transition(struct ieee80211_sta *sta, bool start);
4117
4118/**
4119 * ieee80211_sta_ps_transition_ni - PS transition for connected sta
4120 * (in process context)
4121 *
4122 * Like ieee80211_sta_ps_transition() but can be called in process context
4123 * (internally disables bottom halves). Concurrent call restriction still
4124 * applies.
4125 *
4126 * @sta: currently connected sta
4127 * @start: start or stop PS
4128 *
4129 * Return: Like ieee80211_sta_ps_transition().
4130 */
4131static inline int ieee80211_sta_ps_transition_ni(struct ieee80211_sta *sta,
4132 bool start)
4133{
4134 int ret;
4135
4136 local_bh_disable();
4137 ret = ieee80211_sta_ps_transition(sta, start);
4138 local_bh_enable();
4139
4140 return ret;
4141}
4142
4143/**
4144 * ieee80211_sta_pspoll - PS-Poll frame received
4145 * @sta: currently connected station
4146 *
4147 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4148 * use this function to inform mac80211 that a PS-Poll frame from a
4149 * connected station was received.
4150 * This must be used in conjunction with ieee80211_sta_ps_transition()
4151 * and possibly ieee80211_sta_uapsd_trigger(); calls to all three must
4152 * be serialized.
4153 */
4154void ieee80211_sta_pspoll(struct ieee80211_sta *sta);
4155
4156/**
4157 * ieee80211_sta_uapsd_trigger - (potential) U-APSD trigger frame received
4158 * @sta: currently connected station
4159 * @tid: TID of the received (potential) trigger frame
4160 *
4161 * When operating in AP mode with the %IEEE80211_HW_AP_LINK_PS flag set,
4162 * use this function to inform mac80211 that a (potential) trigger frame
4163 * from a connected station was received.
4164 * This must be used in conjunction with ieee80211_sta_ps_transition()
4165 * and possibly ieee80211_sta_pspoll(); calls to all three must be
4166 * serialized.
4167 * %IEEE80211_NUM_TIDS can be passed as the tid if the tid is unknown.
4168 * In this case, mac80211 will not check that this tid maps to an AC
4169 * that is trigger enabled and assume that the caller did the proper
4170 * checks.
4171 */
4172void ieee80211_sta_uapsd_trigger(struct ieee80211_sta *sta, u8 tid);
4173
4174/*
4175 * The TX headroom reserved by mac80211 for its own tx_status functions.
4176 * This is enough for the radiotap header.
4177 */
4178#define IEEE80211_TX_STATUS_HEADROOM ALIGN(14, 4)
4179
4180/**
4181 * ieee80211_sta_set_buffered - inform mac80211 about driver-buffered frames
4182 * @sta: &struct ieee80211_sta pointer for the sleeping station
4183 * @tid: the TID that has buffered frames
4184 * @buffered: indicates whether or not frames are buffered for this TID
4185 *
4186 * If a driver buffers frames for a powersave station instead of passing
4187 * them back to mac80211 for retransmission, the station may still need
4188 * to be told that there are buffered frames via the TIM bit.
4189 *
4190 * This function informs mac80211 whether or not there are frames that are
4191 * buffered in the driver for a given TID; mac80211 can then use this data
4192 * to set the TIM bit (NOTE: This may call back into the driver's set_tim
4193 * call! Beware of the locking!)
4194 *
4195 * If all frames are released to the station (due to PS-poll or uAPSD)
4196 * then the driver needs to inform mac80211 that there no longer are
4197 * frames buffered. However, when the station wakes up mac80211 assumes
4198 * that all buffered frames will be transmitted and clears this data,
4199 * drivers need to make sure they inform mac80211 about all buffered
4200 * frames on the sleep transition (sta_notify() with %STA_NOTIFY_SLEEP).
4201 *
4202 * Note that technically mac80211 only needs to know this per AC, not per
4203 * TID, but since driver buffering will inevitably happen per TID (since
4204 * it is related to aggregation) it is easier to make mac80211 map the
4205 * TID to the AC as required instead of keeping track in all drivers that
4206 * use this API.
4207 */
4208void ieee80211_sta_set_buffered(struct ieee80211_sta *sta,
4209 u8 tid, bool buffered);
4210
4211/**
4212 * ieee80211_get_tx_rates - get the selected transmit rates for a packet
4213 *
4214 * Call this function in a driver with per-packet rate selection support
4215 * to combine the rate info in the packet tx info with the most recent
4216 * rate selection table for the station entry.
4217 *
4218 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4219 * @sta: the receiver station to which this packet is sent.
4220 * @skb: the frame to be transmitted.
4221 * @dest: buffer for extracted rate/retry information
4222 * @max_rates: maximum number of rates to fetch
4223 */
4224void ieee80211_get_tx_rates(struct ieee80211_vif *vif,
4225 struct ieee80211_sta *sta,
4226 struct sk_buff *skb,
4227 struct ieee80211_tx_rate *dest,
4228 int max_rates);
4229
4230/**
4231 * ieee80211_sta_set_expected_throughput - set the expected tpt for a station
4232 *
4233 * Call this function to notify mac80211 about a change in expected throughput
4234 * to a station. A driver for a device that does rate control in firmware can
4235 * call this function when the expected throughput estimate towards a station
4236 * changes. The information is used to tune the CoDel AQM applied to traffic
4237 * going towards that station (which can otherwise be too aggressive and cause
4238 * slow stations to starve).
4239 *
4240 * @pubsta: the station to set throughput for.
4241 * @thr: the current expected throughput in kbps.
4242 */
4243void ieee80211_sta_set_expected_throughput(struct ieee80211_sta *pubsta,
4244 u32 thr);
4245
4246/**
4247 * ieee80211_tx_status - transmit status callback
4248 *
4249 * Call this function for all transmitted frames after they have been
4250 * transmitted. It is permissible to not call this function for
4251 * multicast frames but this can affect statistics.
4252 *
4253 * This function may not be called in IRQ context. Calls to this function
4254 * for a single hardware must be synchronized against each other. Calls
4255 * to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
4256 * may not be mixed for a single hardware. Must not run concurrently with
4257 * ieee80211_rx() or ieee80211_rx_ni().
4258 *
4259 * @hw: the hardware the frame was transmitted by
4260 * @skb: the frame that was transmitted, owned by mac80211 after this call
4261 */
4262void ieee80211_tx_status(struct ieee80211_hw *hw,
4263 struct sk_buff *skb);
4264
4265/**
4266 * ieee80211_tx_status_ext - extended transmit status callback
4267 *
4268 * This function can be used as a replacement for ieee80211_tx_status
4269 * in drivers that may want to provide extra information that does not
4270 * fit into &struct ieee80211_tx_info.
4271 *
4272 * Calls to this function for a single hardware must be synchronized
4273 * against each other. Calls to this function, ieee80211_tx_status_ni()
4274 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4275 *
4276 * @hw: the hardware the frame was transmitted by
4277 * @status: tx status information
4278 */
4279void ieee80211_tx_status_ext(struct ieee80211_hw *hw,
4280 struct ieee80211_tx_status *status);
4281
4282/**
4283 * ieee80211_tx_status_noskb - transmit status callback without skb
4284 *
4285 * This function can be used as a replacement for ieee80211_tx_status
4286 * in drivers that cannot reliably map tx status information back to
4287 * specific skbs.
4288 *
4289 * Calls to this function for a single hardware must be synchronized
4290 * against each other. Calls to this function, ieee80211_tx_status_ni()
4291 * and ieee80211_tx_status_irqsafe() may not be mixed for a single hardware.
4292 *
4293 * @hw: the hardware the frame was transmitted by
4294 * @sta: the receiver station to which this packet is sent
4295 * (NULL for multicast packets)
4296 * @info: tx status information
4297 */
4298static inline void ieee80211_tx_status_noskb(struct ieee80211_hw *hw,
4299 struct ieee80211_sta *sta,
4300 struct ieee80211_tx_info *info)
4301{
4302 struct ieee80211_tx_status status = {
4303 .sta = sta,
4304 .info = info,
4305 };
4306
4307 ieee80211_tx_status_ext(hw, &status);
4308}
4309
4310/**
4311 * ieee80211_tx_status_ni - transmit status callback (in process context)
4312 *
4313 * Like ieee80211_tx_status() but can be called in process context.
4314 *
4315 * Calls to this function, ieee80211_tx_status() and
4316 * ieee80211_tx_status_irqsafe() may not be mixed
4317 * for a single hardware.
4318 *
4319 * @hw: the hardware the frame was transmitted by
4320 * @skb: the frame that was transmitted, owned by mac80211 after this call
4321 */
4322static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
4323 struct sk_buff *skb)
4324{
4325 local_bh_disable();
4326 ieee80211_tx_status(hw, skb);
4327 local_bh_enable();
4328}
4329
4330/**
4331 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
4332 *
4333 * Like ieee80211_tx_status() but can be called in IRQ context
4334 * (internally defers to a tasklet.)
4335 *
4336 * Calls to this function, ieee80211_tx_status() and
4337 * ieee80211_tx_status_ni() may not be mixed for a single hardware.
4338 *
4339 * @hw: the hardware the frame was transmitted by
4340 * @skb: the frame that was transmitted, owned by mac80211 after this call
4341 */
4342void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
4343 struct sk_buff *skb);
4344
4345/**
4346 * ieee80211_report_low_ack - report non-responding station
4347 *
4348 * When operating in AP-mode, call this function to report a non-responding
4349 * connected STA.
4350 *
4351 * @sta: the non-responding connected sta
4352 * @num_packets: number of packets sent to @sta without a response
4353 */
4354void ieee80211_report_low_ack(struct ieee80211_sta *sta, u32 num_packets);
4355
4356#define IEEE80211_MAX_CSA_COUNTERS_NUM 2
4357
4358/**
4359 * struct ieee80211_mutable_offsets - mutable beacon offsets
4360 * @tim_offset: position of TIM element
4361 * @tim_length: size of TIM element
4362 * @csa_counter_offs: array of IEEE80211_MAX_CSA_COUNTERS_NUM offsets
4363 * to CSA counters. This array can contain zero values which
4364 * should be ignored.
4365 */
4366struct ieee80211_mutable_offsets {
4367 u16 tim_offset;
4368 u16 tim_length;
4369
4370 u16 csa_counter_offs[IEEE80211_MAX_CSA_COUNTERS_NUM];
4371};
4372
4373/**
4374 * ieee80211_beacon_get_template - beacon template generation function
4375 * @hw: pointer obtained from ieee80211_alloc_hw().
4376 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4377 * @offs: &struct ieee80211_mutable_offsets pointer to struct that will
4378 * receive the offsets that may be updated by the driver.
4379 *
4380 * If the driver implements beaconing modes, it must use this function to
4381 * obtain the beacon template.
4382 *
4383 * This function should be used if the beacon frames are generated by the
4384 * device, and then the driver must use the returned beacon as the template
4385 * The driver or the device are responsible to update the DTIM and, when
4386 * applicable, the CSA count.
4387 *
4388 * The driver is responsible for freeing the returned skb.
4389 *
4390 * Return: The beacon template. %NULL on error.
4391 */
4392struct sk_buff *
4393ieee80211_beacon_get_template(struct ieee80211_hw *hw,
4394 struct ieee80211_vif *vif,
4395 struct ieee80211_mutable_offsets *offs);
4396
4397/**
4398 * ieee80211_beacon_get_tim - beacon generation function
4399 * @hw: pointer obtained from ieee80211_alloc_hw().
4400 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4401 * @tim_offset: pointer to variable that will receive the TIM IE offset.
4402 * Set to 0 if invalid (in non-AP modes).
4403 * @tim_length: pointer to variable that will receive the TIM IE length,
4404 * (including the ID and length bytes!).
4405 * Set to 0 if invalid (in non-AP modes).
4406 *
4407 * If the driver implements beaconing modes, it must use this function to
4408 * obtain the beacon frame.
4409 *
4410 * If the beacon frames are generated by the host system (i.e., not in
4411 * hardware/firmware), the driver uses this function to get each beacon
4412 * frame from mac80211 -- it is responsible for calling this function exactly
4413 * once before the beacon is needed (e.g. based on hardware interrupt).
4414 *
4415 * The driver is responsible for freeing the returned skb.
4416 *
4417 * Return: The beacon template. %NULL on error.
4418 */
4419struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
4420 struct ieee80211_vif *vif,
4421 u16 *tim_offset, u16 *tim_length);
4422
4423/**
4424 * ieee80211_beacon_get - beacon generation function
4425 * @hw: pointer obtained from ieee80211_alloc_hw().
4426 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4427 *
4428 * See ieee80211_beacon_get_tim().
4429 *
4430 * Return: See ieee80211_beacon_get_tim().
4431 */
4432static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
4433 struct ieee80211_vif *vif)
4434{
4435 return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
4436}
4437
4438/**
4439 * ieee80211_csa_update_counter - request mac80211 to decrement the csa counter
4440 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4441 *
4442 * The csa counter should be updated after each beacon transmission.
4443 * This function is called implicitly when
4444 * ieee80211_beacon_get/ieee80211_beacon_get_tim are called, however if the
4445 * beacon frames are generated by the device, the driver should call this
4446 * function after each beacon transmission to sync mac80211's csa counters.
4447 *
4448 * Return: new csa counter value
4449 */
4450u8 ieee80211_csa_update_counter(struct ieee80211_vif *vif);
4451
4452/**
4453 * ieee80211_csa_finish - notify mac80211 about channel switch
4454 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4455 *
4456 * After a channel switch announcement was scheduled and the counter in this
4457 * announcement hits 1, this function must be called by the driver to
4458 * notify mac80211 that the channel can be changed.
4459 */
4460void ieee80211_csa_finish(struct ieee80211_vif *vif);
4461
4462/**
4463 * ieee80211_csa_is_complete - find out if counters reached 1
4464 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4465 *
4466 * This function returns whether the channel switch counters reached zero.
4467 */
4468bool ieee80211_csa_is_complete(struct ieee80211_vif *vif);
4469
4470
4471/**
4472 * ieee80211_proberesp_get - retrieve a Probe Response template
4473 * @hw: pointer obtained from ieee80211_alloc_hw().
4474 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4475 *
4476 * Creates a Probe Response template which can, for example, be uploaded to
4477 * hardware. The destination address should be set by the caller.
4478 *
4479 * Can only be called in AP mode.
4480 *
4481 * Return: The Probe Response template. %NULL on error.
4482 */
4483struct sk_buff *ieee80211_proberesp_get(struct ieee80211_hw *hw,
4484 struct ieee80211_vif *vif);
4485
4486/**
4487 * ieee80211_pspoll_get - retrieve a PS Poll template
4488 * @hw: pointer obtained from ieee80211_alloc_hw().
4489 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4490 *
4491 * Creates a PS Poll a template which can, for example, uploaded to
4492 * hardware. The template must be updated after association so that correct
4493 * AID, BSSID and MAC address is used.
4494 *
4495 * Note: Caller (or hardware) is responsible for setting the
4496 * &IEEE80211_FCTL_PM bit.
4497 *
4498 * Return: The PS Poll template. %NULL on error.
4499 */
4500struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
4501 struct ieee80211_vif *vif);
4502
4503/**
4504 * ieee80211_nullfunc_get - retrieve a nullfunc template
4505 * @hw: pointer obtained from ieee80211_alloc_hw().
4506 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4507 * @qos_ok: QoS NDP is acceptable to the caller, this should be set
4508 * if at all possible
4509 *
4510 * Creates a Nullfunc template which can, for example, uploaded to
4511 * hardware. The template must be updated after association so that correct
4512 * BSSID and address is used.
4513 *
4514 * If @qos_ndp is set and the association is to an AP with QoS/WMM, the
4515 * returned packet will be QoS NDP.
4516 *
4517 * Note: Caller (or hardware) is responsible for setting the
4518 * &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
4519 *
4520 * Return: The nullfunc template. %NULL on error.
4521 */
4522struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
4523 struct ieee80211_vif *vif,
4524 bool qos_ok);
4525
4526/**
4527 * ieee80211_probereq_get - retrieve a Probe Request template
4528 * @hw: pointer obtained from ieee80211_alloc_hw().
4529 * @src_addr: source MAC address
4530 * @ssid: SSID buffer
4531 * @ssid_len: length of SSID
4532 * @tailroom: tailroom to reserve at end of SKB for IEs
4533 *
4534 * Creates a Probe Request template which can, for example, be uploaded to
4535 * hardware.
4536 *
4537 * Return: The Probe Request template. %NULL on error.
4538 */
4539struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
4540 const u8 *src_addr,
4541 const u8 *ssid, size_t ssid_len,
4542 size_t tailroom);
4543
4544/**
4545 * ieee80211_rts_get - RTS frame generation function
4546 * @hw: pointer obtained from ieee80211_alloc_hw().
4547 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4548 * @frame: pointer to the frame that is going to be protected by the RTS.
4549 * @frame_len: the frame length (in octets).
4550 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4551 * @rts: The buffer where to store the RTS frame.
4552 *
4553 * If the RTS frames are generated by the host system (i.e., not in
4554 * hardware/firmware), the low-level driver uses this function to receive
4555 * the next RTS frame from the 802.11 code. The low-level is responsible
4556 * for calling this function before and RTS frame is needed.
4557 */
4558void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
4559 const void *frame, size_t frame_len,
4560 const struct ieee80211_tx_info *frame_txctl,
4561 struct ieee80211_rts *rts);
4562
4563/**
4564 * ieee80211_rts_duration - Get the duration field for an RTS frame
4565 * @hw: pointer obtained from ieee80211_alloc_hw().
4566 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4567 * @frame_len: the length of the frame that is going to be protected by the RTS.
4568 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4569 *
4570 * If the RTS is generated in firmware, but the host system must provide
4571 * the duration field, the low-level driver uses this function to receive
4572 * the duration field value in little-endian byteorder.
4573 *
4574 * Return: The duration.
4575 */
4576__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
4577 struct ieee80211_vif *vif, size_t frame_len,
4578 const struct ieee80211_tx_info *frame_txctl);
4579
4580/**
4581 * ieee80211_ctstoself_get - CTS-to-self frame generation function
4582 * @hw: pointer obtained from ieee80211_alloc_hw().
4583 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4584 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
4585 * @frame_len: the frame length (in octets).
4586 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4587 * @cts: The buffer where to store the CTS-to-self frame.
4588 *
4589 * If the CTS-to-self frames are generated by the host system (i.e., not in
4590 * hardware/firmware), the low-level driver uses this function to receive
4591 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
4592 * for calling this function before and CTS-to-self frame is needed.
4593 */
4594void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
4595 struct ieee80211_vif *vif,
4596 const void *frame, size_t frame_len,
4597 const struct ieee80211_tx_info *frame_txctl,
4598 struct ieee80211_cts *cts);
4599
4600/**
4601 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
4602 * @hw: pointer obtained from ieee80211_alloc_hw().
4603 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4604 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
4605 * @frame_txctl: &struct ieee80211_tx_info of the frame.
4606 *
4607 * If the CTS-to-self is generated in firmware, but the host system must provide
4608 * the duration field, the low-level driver uses this function to receive
4609 * the duration field value in little-endian byteorder.
4610 *
4611 * Return: The duration.
4612 */
4613__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
4614 struct ieee80211_vif *vif,
4615 size_t frame_len,
4616 const struct ieee80211_tx_info *frame_txctl);
4617
4618/**
4619 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
4620 * @hw: pointer obtained from ieee80211_alloc_hw().
4621 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4622 * @band: the band to calculate the frame duration on
4623 * @frame_len: the length of the frame.
4624 * @rate: the rate at which the frame is going to be transmitted.
4625 *
4626 * Calculate the duration field of some generic frame, given its
4627 * length and transmission rate (in 100kbps).
4628 *
4629 * Return: The duration.
4630 */
4631__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
4632 struct ieee80211_vif *vif,
4633 enum nl80211_band band,
4634 size_t frame_len,
4635 struct ieee80211_rate *rate);
4636
4637/**
4638 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
4639 * @hw: pointer as obtained from ieee80211_alloc_hw().
4640 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
4641 *
4642 * Function for accessing buffered broadcast and multicast frames. If
4643 * hardware/firmware does not implement buffering of broadcast/multicast
4644 * frames when power saving is used, 802.11 code buffers them in the host
4645 * memory. The low-level driver uses this function to fetch next buffered
4646 * frame. In most cases, this is used when generating beacon frame.
4647 *
4648 * Return: A pointer to the next buffered skb or NULL if no more buffered
4649 * frames are available.
4650 *
4651 * Note: buffered frames are returned only after DTIM beacon frame was
4652 * generated with ieee80211_beacon_get() and the low-level driver must thus
4653 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
4654 * NULL if the previous generated beacon was not DTIM, so the low-level driver
4655 * does not need to check for DTIM beacons separately and should be able to
4656 * use common code for all beacons.
4657 */
4658struct sk_buff *
4659ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
4660
4661/**
4662 * ieee80211_get_tkip_p1k_iv - get a TKIP phase 1 key for IV32
4663 *
4664 * This function returns the TKIP phase 1 key for the given IV32.
4665 *
4666 * @keyconf: the parameter passed with the set key
4667 * @iv32: IV32 to get the P1K for
4668 * @p1k: a buffer to which the key will be written, as 5 u16 values
4669 */
4670void ieee80211_get_tkip_p1k_iv(struct ieee80211_key_conf *keyconf,
4671 u32 iv32, u16 *p1k);
4672
4673/**
4674 * ieee80211_get_tkip_p1k - get a TKIP phase 1 key
4675 *
4676 * This function returns the TKIP phase 1 key for the IV32 taken
4677 * from the given packet.
4678 *
4679 * @keyconf: the parameter passed with the set key
4680 * @skb: the packet to take the IV32 value from that will be encrypted
4681 * with this P1K
4682 * @p1k: a buffer to which the key will be written, as 5 u16 values
4683 */
4684static inline void ieee80211_get_tkip_p1k(struct ieee80211_key_conf *keyconf,
4685 struct sk_buff *skb, u16 *p1k)
4686{
4687 struct ieee80211_hdr *hdr = (struct ieee80211_hdr *)skb->data;
4688 const u8 *data = (u8 *)hdr + ieee80211_hdrlen(hdr->frame_control);
4689 u32 iv32 = get_unaligned_le32(&data[4]);
4690
4691 ieee80211_get_tkip_p1k_iv(keyconf, iv32, p1k);
4692}
4693
4694/**
4695 * ieee80211_get_tkip_rx_p1k - get a TKIP phase 1 key for RX
4696 *
4697 * This function returns the TKIP phase 1 key for the given IV32
4698 * and transmitter address.
4699 *
4700 * @keyconf: the parameter passed with the set key
4701 * @ta: TA that will be used with the key
4702 * @iv32: IV32 to get the P1K for
4703 * @p1k: a buffer to which the key will be written, as 5 u16 values
4704 */
4705void ieee80211_get_tkip_rx_p1k(struct ieee80211_key_conf *keyconf,
4706 const u8 *ta, u32 iv32, u16 *p1k);
4707
4708/**
4709 * ieee80211_get_tkip_p2k - get a TKIP phase 2 key
4710 *
4711 * This function computes the TKIP RC4 key for the IV values
4712 * in the packet.
4713 *
4714 * @keyconf: the parameter passed with the set key
4715 * @skb: the packet to take the IV32/IV16 values from that will be
4716 * encrypted with this key
4717 * @p2k: a buffer to which the key will be written, 16 bytes
4718 */
4719void ieee80211_get_tkip_p2k(struct ieee80211_key_conf *keyconf,
4720 struct sk_buff *skb, u8 *p2k);
4721
4722/**
4723 * ieee80211_tkip_add_iv - write TKIP IV and Ext. IV to pos
4724 *
4725 * @pos: start of crypto header
4726 * @keyconf: the parameter passed with the set key
4727 * @pn: PN to add
4728 *
4729 * Returns: pointer to the octet following IVs (i.e. beginning of
4730 * the packet payload)
4731 *
4732 * This function writes the tkip IV value to pos (which should
4733 * point to the crypto header)
4734 */
4735u8 *ieee80211_tkip_add_iv(u8 *pos, struct ieee80211_key_conf *keyconf, u64 pn);
4736
4737/**
4738 * ieee80211_get_key_rx_seq - get key RX sequence counter
4739 *
4740 * @keyconf: the parameter passed with the set key
4741 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4742 * the value on TID 0 is also used for non-QoS frames. For
4743 * CMAC, only TID 0 is valid.
4744 * @seq: buffer to receive the sequence data
4745 *
4746 * This function allows a driver to retrieve the current RX IV/PNs
4747 * for the given key. It must not be called if IV checking is done
4748 * by the device and not by mac80211.
4749 *
4750 * Note that this function may only be called when no RX processing
4751 * can be done concurrently.
4752 */
4753void ieee80211_get_key_rx_seq(struct ieee80211_key_conf *keyconf,
4754 int tid, struct ieee80211_key_seq *seq);
4755
4756/**
4757 * ieee80211_set_key_rx_seq - set key RX sequence counter
4758 *
4759 * @keyconf: the parameter passed with the set key
4760 * @tid: The TID, or -1 for the management frame value (CCMP/GCMP only);
4761 * the value on TID 0 is also used for non-QoS frames. For
4762 * CMAC, only TID 0 is valid.
4763 * @seq: new sequence data
4764 *
4765 * This function allows a driver to set the current RX IV/PNs for the
4766 * given key. This is useful when resuming from WoWLAN sleep and GTK
4767 * rekey may have been done while suspended. It should not be called
4768 * if IV checking is done by the device and not by mac80211.
4769 *
4770 * Note that this function may only be called when no RX processing
4771 * can be done concurrently.
4772 */
4773void ieee80211_set_key_rx_seq(struct ieee80211_key_conf *keyconf,
4774 int tid, struct ieee80211_key_seq *seq);
4775
4776/**
4777 * ieee80211_remove_key - remove the given key
4778 * @keyconf: the parameter passed with the set key
4779 *
4780 * Remove the given key. If the key was uploaded to the hardware at the
4781 * time this function is called, it is not deleted in the hardware but
4782 * instead assumed to have been removed already.
4783 *
4784 * Note that due to locking considerations this function can (currently)
4785 * only be called during key iteration (ieee80211_iter_keys().)
4786 */
4787void ieee80211_remove_key(struct ieee80211_key_conf *keyconf);
4788
4789/**
4790 * ieee80211_gtk_rekey_add - add a GTK key from rekeying during WoWLAN
4791 * @vif: the virtual interface to add the key on
4792 * @keyconf: new key data
4793 *
4794 * When GTK rekeying was done while the system was suspended, (a) new
4795 * key(s) will be available. These will be needed by mac80211 for proper
4796 * RX processing, so this function allows setting them.
4797 *
4798 * The function returns the newly allocated key structure, which will
4799 * have similar contents to the passed key configuration but point to
4800 * mac80211-owned memory. In case of errors, the function returns an
4801 * ERR_PTR(), use IS_ERR() etc.
4802 *
4803 * Note that this function assumes the key isn't added to hardware
4804 * acceleration, so no TX will be done with the key. Since it's a GTK
4805 * on managed (station) networks, this is true anyway. If the driver
4806 * calls this function from the resume callback and subsequently uses
4807 * the return code 1 to reconfigure the device, this key will be part
4808 * of the reconfiguration.
4809 *
4810 * Note that the driver should also call ieee80211_set_key_rx_seq()
4811 * for the new key for each TID to set up sequence counters properly.
4812 *
4813 * IMPORTANT: If this replaces a key that is present in the hardware,
4814 * then it will attempt to remove it during this call. In many cases
4815 * this isn't what you want, so call ieee80211_remove_key() first for
4816 * the key that's being replaced.
4817 */
4818struct ieee80211_key_conf *
4819ieee80211_gtk_rekey_add(struct ieee80211_vif *vif,
4820 struct ieee80211_key_conf *keyconf);
4821
4822/**
4823 * ieee80211_gtk_rekey_notify - notify userspace supplicant of rekeying
4824 * @vif: virtual interface the rekeying was done on
4825 * @bssid: The BSSID of the AP, for checking association
4826 * @replay_ctr: the new replay counter after GTK rekeying
4827 * @gfp: allocation flags
4828 */
4829void ieee80211_gtk_rekey_notify(struct ieee80211_vif *vif, const u8 *bssid,
4830 const u8 *replay_ctr, gfp_t gfp);
4831
4832/**
4833 * ieee80211_wake_queue - wake specific queue
4834 * @hw: pointer as obtained from ieee80211_alloc_hw().
4835 * @queue: queue number (counted from zero).
4836 *
4837 * Drivers should use this function instead of netif_wake_queue.
4838 */
4839void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
4840
4841/**
4842 * ieee80211_stop_queue - stop specific queue
4843 * @hw: pointer as obtained from ieee80211_alloc_hw().
4844 * @queue: queue number (counted from zero).
4845 *
4846 * Drivers should use this function instead of netif_stop_queue.
4847 */
4848void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
4849
4850/**
4851 * ieee80211_queue_stopped - test status of the queue
4852 * @hw: pointer as obtained from ieee80211_alloc_hw().
4853 * @queue: queue number (counted from zero).
4854 *
4855 * Drivers should use this function instead of netif_stop_queue.
4856 *
4857 * Return: %true if the queue is stopped. %false otherwise.
4858 */
4859
4860int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
4861
4862/**
4863 * ieee80211_stop_queues - stop all queues
4864 * @hw: pointer as obtained from ieee80211_alloc_hw().
4865 *
4866 * Drivers should use this function instead of netif_stop_queue.
4867 */
4868void ieee80211_stop_queues(struct ieee80211_hw *hw);
4869
4870/**
4871 * ieee80211_wake_queues - wake all queues
4872 * @hw: pointer as obtained from ieee80211_alloc_hw().
4873 *
4874 * Drivers should use this function instead of netif_wake_queue.
4875 */
4876void ieee80211_wake_queues(struct ieee80211_hw *hw);
4877
4878/**
4879 * ieee80211_scan_completed - completed hardware scan
4880 *
4881 * When hardware scan offload is used (i.e. the hw_scan() callback is
4882 * assigned) this function needs to be called by the driver to notify
4883 * mac80211 that the scan finished. This function can be called from
4884 * any context, including hardirq context.
4885 *
4886 * @hw: the hardware that finished the scan
4887 * @info: information about the completed scan
4888 */
4889void ieee80211_scan_completed(struct ieee80211_hw *hw,
4890 struct cfg80211_scan_info *info);
4891
4892/**
4893 * ieee80211_sched_scan_results - got results from scheduled scan
4894 *
4895 * When a scheduled scan is running, this function needs to be called by the
4896 * driver whenever there are new scan results available.
4897 *
4898 * @hw: the hardware that is performing scheduled scans
4899 */
4900void ieee80211_sched_scan_results(struct ieee80211_hw *hw);
4901
4902/**
4903 * ieee80211_sched_scan_stopped - inform that the scheduled scan has stopped
4904 *
4905 * When a scheduled scan is running, this function can be called by
4906 * the driver if it needs to stop the scan to perform another task.
4907 * Usual scenarios are drivers that cannot continue the scheduled scan
4908 * while associating, for instance.
4909 *
4910 * @hw: the hardware that is performing scheduled scans
4911 */
4912void ieee80211_sched_scan_stopped(struct ieee80211_hw *hw);
4913
4914/**
4915 * enum ieee80211_interface_iteration_flags - interface iteration flags
4916 * @IEEE80211_IFACE_ITER_NORMAL: Iterate over all interfaces that have
4917 * been added to the driver; However, note that during hardware
4918 * reconfiguration (after restart_hw) it will iterate over a new
4919 * interface and over all the existing interfaces even if they
4920 * haven't been re-added to the driver yet.
4921 * @IEEE80211_IFACE_ITER_RESUME_ALL: During resume, iterate over all
4922 * interfaces, even if they haven't been re-added to the driver yet.
4923 * @IEEE80211_IFACE_ITER_ACTIVE: Iterate only active interfaces (netdev is up).
4924 */
4925enum ieee80211_interface_iteration_flags {
4926 IEEE80211_IFACE_ITER_NORMAL = 0,
4927 IEEE80211_IFACE_ITER_RESUME_ALL = BIT(0),
4928 IEEE80211_IFACE_ITER_ACTIVE = BIT(1),
4929};
4930
4931/**
4932 * ieee80211_iterate_interfaces - iterate interfaces
4933 *
4934 * This function iterates over the interfaces associated with a given
4935 * hardware and calls the callback for them. This includes active as well as
4936 * inactive interfaces. This function allows the iterator function to sleep.
4937 * Will iterate over a new interface during add_interface().
4938 *
4939 * @hw: the hardware struct of which the interfaces should be iterated over
4940 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4941 * @iterator: the iterator function to call
4942 * @data: first argument of the iterator function
4943 */
4944void ieee80211_iterate_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4945 void (*iterator)(void *data, u8 *mac,
4946 struct ieee80211_vif *vif),
4947 void *data);
4948
4949/**
4950 * ieee80211_iterate_active_interfaces - iterate active interfaces
4951 *
4952 * This function iterates over the interfaces associated with a given
4953 * hardware that are currently active and calls the callback for them.
4954 * This function allows the iterator function to sleep, when the iterator
4955 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
4956 * be used.
4957 * Does not iterate over a new interface during add_interface().
4958 *
4959 * @hw: the hardware struct of which the interfaces should be iterated over
4960 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4961 * @iterator: the iterator function to call
4962 * @data: first argument of the iterator function
4963 */
4964static inline void
4965ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw, u32 iter_flags,
4966 void (*iterator)(void *data, u8 *mac,
4967 struct ieee80211_vif *vif),
4968 void *data)
4969{
4970 ieee80211_iterate_interfaces(hw,
4971 iter_flags | IEEE80211_IFACE_ITER_ACTIVE,
4972 iterator, data);
4973}
4974
4975/**
4976 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
4977 *
4978 * This function iterates over the interfaces associated with a given
4979 * hardware that are currently active and calls the callback for them.
4980 * This function requires the iterator callback function to be atomic,
4981 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
4982 * Does not iterate over a new interface during add_interface().
4983 *
4984 * @hw: the hardware struct of which the interfaces should be iterated over
4985 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
4986 * @iterator: the iterator function to call, cannot sleep
4987 * @data: first argument of the iterator function
4988 */
4989void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
4990 u32 iter_flags,
4991 void (*iterator)(void *data,
4992 u8 *mac,
4993 struct ieee80211_vif *vif),
4994 void *data);
4995
4996/**
4997 * ieee80211_iterate_active_interfaces_rtnl - iterate active interfaces
4998 *
4999 * This function iterates over the interfaces associated with a given
5000 * hardware that are currently active and calls the callback for them.
5001 * This version can only be used while holding the RTNL.
5002 *
5003 * @hw: the hardware struct of which the interfaces should be iterated over
5004 * @iter_flags: iteration flags, see &enum ieee80211_interface_iteration_flags
5005 * @iterator: the iterator function to call, cannot sleep
5006 * @data: first argument of the iterator function
5007 */
5008void ieee80211_iterate_active_interfaces_rtnl(struct ieee80211_hw *hw,
5009 u32 iter_flags,
5010 void (*iterator)(void *data,
5011 u8 *mac,
5012 struct ieee80211_vif *vif),
5013 void *data);
5014
5015/**
5016 * ieee80211_iterate_stations_atomic - iterate stations
5017 *
5018 * This function iterates over all stations associated with a given
5019 * hardware that are currently uploaded to the driver and calls the callback
5020 * function for them.
5021 * This function requires the iterator callback function to be atomic,
5022 *
5023 * @hw: the hardware struct of which the interfaces should be iterated over
5024 * @iterator: the iterator function to call, cannot sleep
5025 * @data: first argument of the iterator function
5026 */
5027void ieee80211_iterate_stations_atomic(struct ieee80211_hw *hw,
5028 void (*iterator)(void *data,
5029 struct ieee80211_sta *sta),
5030 void *data);
5031/**
5032 * ieee80211_queue_work - add work onto the mac80211 workqueue
5033 *
5034 * Drivers and mac80211 use this to add work onto the mac80211 workqueue.
5035 * This helper ensures drivers are not queueing work when they should not be.
5036 *
5037 * @hw: the hardware struct for the interface we are adding work for
5038 * @work: the work we want to add onto the mac80211 workqueue
5039 */
5040void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
5041
5042/**
5043 * ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
5044 *
5045 * Drivers and mac80211 use this to queue delayed work onto the mac80211
5046 * workqueue.
5047 *
5048 * @hw: the hardware struct for the interface we are adding work for
5049 * @dwork: delayable work to queue onto the mac80211 workqueue
5050 * @delay: number of jiffies to wait before queueing
5051 */
5052void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
5053 struct delayed_work *dwork,
5054 unsigned long delay);
5055
5056/**
5057 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
5058 * @sta: the station for which to start a BA session
5059 * @tid: the TID to BA on.
5060 * @timeout: session timeout value (in TUs)
5061 *
5062 * Return: success if addBA request was sent, failure otherwise
5063 *
5064 * Although mac80211/low level driver/user space application can estimate
5065 * the need to start aggregation on a certain RA/TID, the session level
5066 * will be managed by the mac80211.
5067 */
5068int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid,
5069 u16 timeout);
5070
5071/**
5072 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
5073 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5074 * @ra: receiver address of the BA session recipient.
5075 * @tid: the TID to BA on.
5076 *
5077 * This function must be called by low level driver once it has
5078 * finished with preparations for the BA session. It can be called
5079 * from any context.
5080 */
5081void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
5082 u16 tid);
5083
5084/**
5085 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
5086 * @sta: the station whose BA session to stop
5087 * @tid: the TID to stop BA.
5088 *
5089 * Return: negative error if the TID is invalid, or no aggregation active
5090 *
5091 * Although mac80211/low level driver/user space application can estimate
5092 * the need to stop aggregation on a certain RA/TID, the session level
5093 * will be managed by the mac80211.
5094 */
5095int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
5096
5097/**
5098 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
5099 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5100 * @ra: receiver address of the BA session recipient.
5101 * @tid: the desired TID to BA on.
5102 *
5103 * This function must be called by low level driver once it has
5104 * finished with preparations for the BA session tear down. It
5105 * can be called from any context.
5106 */
5107void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
5108 u16 tid);
5109
5110/**
5111 * ieee80211_find_sta - find a station
5112 *
5113 * @vif: virtual interface to look for station on
5114 * @addr: station's address
5115 *
5116 * Return: The station, if found. %NULL otherwise.
5117 *
5118 * Note: This function must be called under RCU lock and the
5119 * resulting pointer is only valid under RCU lock as well.
5120 */
5121struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
5122 const u8 *addr);
5123
5124/**
5125 * ieee80211_find_sta_by_ifaddr - find a station on hardware
5126 *
5127 * @hw: pointer as obtained from ieee80211_alloc_hw()
5128 * @addr: remote station's address
5129 * @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
5130 *
5131 * Return: The station, if found. %NULL otherwise.
5132 *
5133 * Note: This function must be called under RCU lock and the
5134 * resulting pointer is only valid under RCU lock as well.
5135 *
5136 * NOTE: You may pass NULL for localaddr, but then you will just get
5137 * the first STA that matches the remote address 'addr'.
5138 * We can have multiple STA associated with multiple
5139 * logical stations (e.g. consider a station connecting to another
5140 * BSSID on the same AP hardware without disconnecting first).
5141 * In this case, the result of this method with localaddr NULL
5142 * is not reliable.
5143 *
5144 * DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
5145 */
5146struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
5147 const u8 *addr,
5148 const u8 *localaddr);
5149
5150/**
5151 * ieee80211_sta_block_awake - block station from waking up
5152 * @hw: the hardware
5153 * @pubsta: the station
5154 * @block: whether to block or unblock
5155 *
5156 * Some devices require that all frames that are on the queues
5157 * for a specific station that went to sleep are flushed before
5158 * a poll response or frames after the station woke up can be
5159 * delivered to that it. Note that such frames must be rejected
5160 * by the driver as filtered, with the appropriate status flag.
5161 *
5162 * This function allows implementing this mode in a race-free
5163 * manner.
5164 *
5165 * To do this, a driver must keep track of the number of frames
5166 * still enqueued for a specific station. If this number is not
5167 * zero when the station goes to sleep, the driver must call
5168 * this function to force mac80211 to consider the station to
5169 * be asleep regardless of the station's actual state. Once the
5170 * number of outstanding frames reaches zero, the driver must
5171 * call this function again to unblock the station. That will
5172 * cause mac80211 to be able to send ps-poll responses, and if
5173 * the station queried in the meantime then frames will also
5174 * be sent out as a result of this. Additionally, the driver
5175 * will be notified that the station woke up some time after
5176 * it is unblocked, regardless of whether the station actually
5177 * woke up while blocked or not.
5178 */
5179void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
5180 struct ieee80211_sta *pubsta, bool block);
5181
5182/**
5183 * ieee80211_sta_eosp - notify mac80211 about end of SP
5184 * @pubsta: the station
5185 *
5186 * When a device transmits frames in a way that it can't tell
5187 * mac80211 in the TX status about the EOSP, it must clear the
5188 * %IEEE80211_TX_STATUS_EOSP bit and call this function instead.
5189 * This applies for PS-Poll as well as uAPSD.
5190 *
5191 * Note that just like with _tx_status() and _rx() drivers must
5192 * not mix calls to irqsafe/non-irqsafe versions, this function
5193 * must not be mixed with those either. Use the all irqsafe, or
5194 * all non-irqsafe, don't mix!
5195 *
5196 * NB: the _irqsafe version of this function doesn't exist, no
5197 * driver needs it right now. Don't call this function if
5198 * you'd need the _irqsafe version, look at the git history
5199 * and restore the _irqsafe version!
5200 */
5201void ieee80211_sta_eosp(struct ieee80211_sta *pubsta);
5202
5203/**
5204 * ieee80211_send_eosp_nullfunc - ask mac80211 to send NDP with EOSP
5205 * @pubsta: the station
5206 * @tid: the tid of the NDP
5207 *
5208 * Sometimes the device understands that it needs to close
5209 * the Service Period unexpectedly. This can happen when
5210 * sending frames that are filling holes in the BA window.
5211 * In this case, the device can ask mac80211 to send a
5212 * Nullfunc frame with EOSP set. When that happens, the
5213 * driver must have called ieee80211_sta_set_buffered() to
5214 * let mac80211 know that there are no buffered frames any
5215 * more, otherwise mac80211 will get the more_data bit wrong.
5216 * The low level driver must have made sure that the frame
5217 * will be sent despite the station being in power-save.
5218 * Mac80211 won't call allow_buffered_frames().
5219 * Note that calling this function, doesn't exempt the driver
5220 * from closing the EOSP properly, it will still have to call
5221 * ieee80211_sta_eosp when the NDP is sent.
5222 */
5223void ieee80211_send_eosp_nullfunc(struct ieee80211_sta *pubsta, int tid);
5224
5225/**
5226 * ieee80211_iter_keys - iterate keys programmed into the device
5227 * @hw: pointer obtained from ieee80211_alloc_hw()
5228 * @vif: virtual interface to iterate, may be %NULL for all
5229 * @iter: iterator function that will be called for each key
5230 * @iter_data: custom data to pass to the iterator function
5231 *
5232 * This function can be used to iterate all the keys known to
5233 * mac80211, even those that weren't previously programmed into
5234 * the device. This is intended for use in WoWLAN if the device
5235 * needs reprogramming of the keys during suspend. Note that due
5236 * to locking reasons, it is also only safe to call this at few
5237 * spots since it must hold the RTNL and be able to sleep.
5238 *
5239 * The order in which the keys are iterated matches the order
5240 * in which they were originally installed and handed to the
5241 * set_key callback.
5242 */
5243void ieee80211_iter_keys(struct ieee80211_hw *hw,
5244 struct ieee80211_vif *vif,
5245 void (*iter)(struct ieee80211_hw *hw,
5246 struct ieee80211_vif *vif,
5247 struct ieee80211_sta *sta,
5248 struct ieee80211_key_conf *key,
5249 void *data),
5250 void *iter_data);
5251
5252/**
5253 * ieee80211_iter_keys_rcu - iterate keys programmed into the device
5254 * @hw: pointer obtained from ieee80211_alloc_hw()
5255 * @vif: virtual interface to iterate, may be %NULL for all
5256 * @iter: iterator function that will be called for each key
5257 * @iter_data: custom data to pass to the iterator function
5258 *
5259 * This function can be used to iterate all the keys known to
5260 * mac80211, even those that weren't previously programmed into
5261 * the device. Note that due to locking reasons, keys of station
5262 * in removal process will be skipped.
5263 *
5264 * This function requires being called in an RCU critical section,
5265 * and thus iter must be atomic.
5266 */
5267void ieee80211_iter_keys_rcu(struct ieee80211_hw *hw,
5268 struct ieee80211_vif *vif,
5269 void (*iter)(struct ieee80211_hw *hw,
5270 struct ieee80211_vif *vif,
5271 struct ieee80211_sta *sta,
5272 struct ieee80211_key_conf *key,
5273 void *data),
5274 void *iter_data);
5275
5276/**
5277 * ieee80211_iter_chan_contexts_atomic - iterate channel contexts
5278 * @hw: pointre obtained from ieee80211_alloc_hw().
5279 * @iter: iterator function
5280 * @iter_data: data passed to iterator function
5281 *
5282 * Iterate all active channel contexts. This function is atomic and
5283 * doesn't acquire any locks internally that might be held in other
5284 * places while calling into the driver.
5285 *
5286 * The iterator will not find a context that's being added (during
5287 * the driver callback to add it) but will find it while it's being
5288 * removed.
5289 *
5290 * Note that during hardware restart, all contexts that existed
5291 * before the restart are considered already present so will be
5292 * found while iterating, whether they've been re-added already
5293 * or not.
5294 */
5295void ieee80211_iter_chan_contexts_atomic(
5296 struct ieee80211_hw *hw,
5297 void (*iter)(struct ieee80211_hw *hw,
5298 struct ieee80211_chanctx_conf *chanctx_conf,
5299 void *data),
5300 void *iter_data);
5301
5302/**
5303 * ieee80211_ap_probereq_get - retrieve a Probe Request template
5304 * @hw: pointer obtained from ieee80211_alloc_hw().
5305 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5306 *
5307 * Creates a Probe Request template which can, for example, be uploaded to
5308 * hardware. The template is filled with bssid, ssid and supported rate
5309 * information. This function must only be called from within the
5310 * .bss_info_changed callback function and only in managed mode. The function
5311 * is only useful when the interface is associated, otherwise it will return
5312 * %NULL.
5313 *
5314 * Return: The Probe Request template. %NULL on error.
5315 */
5316struct sk_buff *ieee80211_ap_probereq_get(struct ieee80211_hw *hw,
5317 struct ieee80211_vif *vif);
5318
5319/**
5320 * ieee80211_beacon_loss - inform hardware does not receive beacons
5321 *
5322 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5323 *
5324 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER and
5325 * %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
5326 * hardware is not receiving beacons with this function.
5327 */
5328void ieee80211_beacon_loss(struct ieee80211_vif *vif);
5329
5330/**
5331 * ieee80211_connection_loss - inform hardware has lost connection to the AP
5332 *
5333 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5334 *
5335 * When beacon filtering is enabled with %IEEE80211_VIF_BEACON_FILTER, and
5336 * %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
5337 * needs to inform if the connection to the AP has been lost.
5338 * The function may also be called if the connection needs to be terminated
5339 * for some other reason, even if %IEEE80211_HW_CONNECTION_MONITOR isn't set.
5340 *
5341 * This function will cause immediate change to disassociated state,
5342 * without connection recovery attempts.
5343 */
5344void ieee80211_connection_loss(struct ieee80211_vif *vif);
5345
5346/**
5347 * ieee80211_resume_disconnect - disconnect from AP after resume
5348 *
5349 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5350 *
5351 * Instructs mac80211 to disconnect from the AP after resume.
5352 * Drivers can use this after WoWLAN if they know that the
5353 * connection cannot be kept up, for example because keys were
5354 * used while the device was asleep but the replay counters or
5355 * similar cannot be retrieved from the device during resume.
5356 *
5357 * Note that due to implementation issues, if the driver uses
5358 * the reconfiguration functionality during resume the interface
5359 * will still be added as associated first during resume and then
5360 * disconnect normally later.
5361 *
5362 * This function can only be called from the resume callback and
5363 * the driver must not be holding any of its own locks while it
5364 * calls this function, or at least not any locks it needs in the
5365 * key configuration paths (if it supports HW crypto).
5366 */
5367void ieee80211_resume_disconnect(struct ieee80211_vif *vif);
5368
5369/**
5370 * ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
5371 * rssi threshold triggered
5372 *
5373 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5374 * @rssi_event: the RSSI trigger event type
5375 * @rssi_level: new RSSI level value or 0 if not available
5376 * @gfp: context flags
5377 *
5378 * When the %IEEE80211_VIF_SUPPORTS_CQM_RSSI is set, and a connection quality
5379 * monitoring is configured with an rssi threshold, the driver will inform
5380 * whenever the rssi level reaches the threshold.
5381 */
5382void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
5383 enum nl80211_cqm_rssi_threshold_event rssi_event,
5384 s32 rssi_level,
5385 gfp_t gfp);
5386
5387/**
5388 * ieee80211_cqm_beacon_loss_notify - inform CQM of beacon loss
5389 *
5390 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5391 * @gfp: context flags
5392 */
5393void ieee80211_cqm_beacon_loss_notify(struct ieee80211_vif *vif, gfp_t gfp);
5394
5395/**
5396 * ieee80211_radar_detected - inform that a radar was detected
5397 *
5398 * @hw: pointer as obtained from ieee80211_alloc_hw()
5399 */
5400void ieee80211_radar_detected(struct ieee80211_hw *hw);
5401
5402/**
5403 * ieee80211_chswitch_done - Complete channel switch process
5404 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5405 * @success: make the channel switch successful or not
5406 *
5407 * Complete the channel switch post-process: set the new operational channel
5408 * and wake up the suspended queues.
5409 */
5410void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
5411
5412/**
5413 * ieee80211_request_smps - request SM PS transition
5414 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5415 * @smps_mode: new SM PS mode
5416 *
5417 * This allows the driver to request an SM PS transition in managed
5418 * mode. This is useful when the driver has more information than
5419 * the stack about possible interference, for example by bluetooth.
5420 */
5421void ieee80211_request_smps(struct ieee80211_vif *vif,
5422 enum ieee80211_smps_mode smps_mode);
5423
5424/**
5425 * ieee80211_ready_on_channel - notification of remain-on-channel start
5426 * @hw: pointer as obtained from ieee80211_alloc_hw()
5427 */
5428void ieee80211_ready_on_channel(struct ieee80211_hw *hw);
5429
5430/**
5431 * ieee80211_remain_on_channel_expired - remain_on_channel duration expired
5432 * @hw: pointer as obtained from ieee80211_alloc_hw()
5433 */
5434void ieee80211_remain_on_channel_expired(struct ieee80211_hw *hw);
5435
5436/**
5437 * ieee80211_stop_rx_ba_session - callback to stop existing BA sessions
5438 *
5439 * in order not to harm the system performance and user experience, the device
5440 * may request not to allow any rx ba session and tear down existing rx ba
5441 * sessions based on system constraints such as periodic BT activity that needs
5442 * to limit wlan activity (eg.sco or a2dp)."
5443 * in such cases, the intention is to limit the duration of the rx ppdu and
5444 * therefore prevent the peer device to use a-mpdu aggregation.
5445 *
5446 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5447 * @ba_rx_bitmap: Bit map of open rx ba per tid
5448 * @addr: & to bssid mac address
5449 */
5450void ieee80211_stop_rx_ba_session(struct ieee80211_vif *vif, u16 ba_rx_bitmap,
5451 const u8 *addr);
5452
5453/**
5454 * ieee80211_mark_rx_ba_filtered_frames - move RX BA window and mark filtered
5455 * @pubsta: station struct
5456 * @tid: the session's TID
5457 * @ssn: starting sequence number of the bitmap, all frames before this are
5458 * assumed to be out of the window after the call
5459 * @filtered: bitmap of filtered frames, BIT(0) is the @ssn entry etc.
5460 * @received_mpdus: number of received mpdus in firmware
5461 *
5462 * This function moves the BA window and releases all frames before @ssn, and
5463 * marks frames marked in the bitmap as having been filtered. Afterwards, it
5464 * checks if any frames in the window starting from @ssn can now be released
5465 * (in case they were only waiting for frames that were filtered.)
5466 */
5467void ieee80211_mark_rx_ba_filtered_frames(struct ieee80211_sta *pubsta, u8 tid,
5468 u16 ssn, u64 filtered,
5469 u16 received_mpdus);
5470
5471/**
5472 * ieee80211_send_bar - send a BlockAckReq frame
5473 *
5474 * can be used to flush pending frames from the peer's aggregation reorder
5475 * buffer.
5476 *
5477 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5478 * @ra: the peer's destination address
5479 * @tid: the TID of the aggregation session
5480 * @ssn: the new starting sequence number for the receiver
5481 */
5482void ieee80211_send_bar(struct ieee80211_vif *vif, u8 *ra, u16 tid, u16 ssn);
5483
5484/**
5485 * ieee80211_manage_rx_ba_offl - helper to queue an RX BA work
5486 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5487 * @addr: station mac address
5488 * @tid: the rx tid
5489 */
5490void ieee80211_manage_rx_ba_offl(struct ieee80211_vif *vif, const u8 *addr,
5491 unsigned int tid);
5492
5493/**
5494 * ieee80211_start_rx_ba_session_offl - start a Rx BA session
5495 *
5496 * Some device drivers may offload part of the Rx aggregation flow including
5497 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5498 * reordering.
5499 *
5500 * Create structures responsible for reordering so device drivers may call here
5501 * when they complete AddBa negotiation.
5502 *
5503 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5504 * @addr: station mac address
5505 * @tid: the rx tid
5506 */
5507static inline void ieee80211_start_rx_ba_session_offl(struct ieee80211_vif *vif,
5508 const u8 *addr, u16 tid)
5509{
5510 if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
5511 return;
5512 ieee80211_manage_rx_ba_offl(vif, addr, tid);
5513}
5514
5515/**
5516 * ieee80211_stop_rx_ba_session_offl - stop a Rx BA session
5517 *
5518 * Some device drivers may offload part of the Rx aggregation flow including
5519 * AddBa/DelBa negotiation but may otherwise be incapable of full Rx
5520 * reordering.
5521 *
5522 * Destroy structures responsible for reordering so device drivers may call here
5523 * when they complete DelBa negotiation.
5524 *
5525 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5526 * @addr: station mac address
5527 * @tid: the rx tid
5528 */
5529static inline void ieee80211_stop_rx_ba_session_offl(struct ieee80211_vif *vif,
5530 const u8 *addr, u16 tid)
5531{
5532 if (WARN_ON(tid >= IEEE80211_NUM_TIDS))
5533 return;
5534 ieee80211_manage_rx_ba_offl(vif, addr, tid + IEEE80211_NUM_TIDS);
5535}
5536
5537/**
5538 * ieee80211_rx_ba_timer_expired - stop a Rx BA session due to timeout
5539 *
5540 * Some device drivers do not offload AddBa/DelBa negotiation, but handle rx
5541 * buffer reording internally, and therefore also handle the session timer.
5542 *
5543 * Trigger the timeout flow, which sends a DelBa.
5544 *
5545 * @vif: &struct ieee80211_vif pointer from the add_interface callback
5546 * @addr: station mac address
5547 * @tid: the rx tid
5548 */
5549void ieee80211_rx_ba_timer_expired(struct ieee80211_vif *vif,
5550 const u8 *addr, unsigned int tid);
5551
5552/* Rate control API */
5553
5554/**
5555 * struct ieee80211_tx_rate_control - rate control information for/from RC algo
5556 *
5557 * @hw: The hardware the algorithm is invoked for.
5558 * @sband: The band this frame is being transmitted on.
5559 * @bss_conf: the current BSS configuration
5560 * @skb: the skb that will be transmitted, the control information in it needs
5561 * to be filled in
5562 * @reported_rate: The rate control algorithm can fill this in to indicate
5563 * which rate should be reported to userspace as the current rate and
5564 * used for rate calculations in the mesh network.
5565 * @rts: whether RTS will be used for this frame because it is longer than the
5566 * RTS threshold
5567 * @short_preamble: whether mac80211 will request short-preamble transmission
5568 * if the selected rate supports it
5569 * @rate_idx_mask: user-requested (legacy) rate mask
5570 * @rate_idx_mcs_mask: user-requested MCS rate mask (NULL if not in use)
5571 * @bss: whether this frame is sent out in AP or IBSS mode
5572 */
5573struct ieee80211_tx_rate_control {
5574 struct ieee80211_hw *hw;
5575 struct ieee80211_supported_band *sband;
5576 struct ieee80211_bss_conf *bss_conf;
5577 struct sk_buff *skb;
5578 struct ieee80211_tx_rate reported_rate;
5579 bool rts, short_preamble;
5580 u32 rate_idx_mask;
5581 u8 *rate_idx_mcs_mask;
5582 bool bss;
5583};
5584
5585struct rate_control_ops {
5586 const char *name;
5587 void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
5588 void (*free)(void *priv);
5589
5590 void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
5591 void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
5592 struct cfg80211_chan_def *chandef,
5593 struct ieee80211_sta *sta, void *priv_sta);
5594 void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
5595 struct cfg80211_chan_def *chandef,
5596 struct ieee80211_sta *sta, void *priv_sta,
5597 u32 changed);
5598 void (*free_sta)(void *priv, struct ieee80211_sta *sta,
5599 void *priv_sta);
5600
5601 void (*tx_status_ext)(void *priv,
5602 struct ieee80211_supported_band *sband,
5603 void *priv_sta, struct ieee80211_tx_status *st);
5604 void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
5605 struct ieee80211_sta *sta, void *priv_sta,
5606 struct sk_buff *skb);
5607 void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
5608 struct ieee80211_tx_rate_control *txrc);
5609
5610 void (*add_sta_debugfs)(void *priv, void *priv_sta,
5611 struct dentry *dir);
5612 void (*remove_sta_debugfs)(void *priv, void *priv_sta);
5613
5614 u32 (*get_expected_throughput)(void *priv_sta);
5615};
5616
5617static inline int rate_supported(struct ieee80211_sta *sta,
5618 enum nl80211_band band,
5619 int index)
5620{
5621 return (sta == NULL || sta->supp_rates[band] & BIT(index));
5622}
5623
5624/**
5625 * rate_control_send_low - helper for drivers for management/no-ack frames
5626 *
5627 * Rate control algorithms that agree to use the lowest rate to
5628 * send management frames and NO_ACK data with the respective hw
5629 * retries should use this in the beginning of their mac80211 get_rate
5630 * callback. If true is returned the rate control can simply return.
5631 * If false is returned we guarantee that sta and sta and priv_sta is
5632 * not null.
5633 *
5634 * Rate control algorithms wishing to do more intelligent selection of
5635 * rate for multicast/broadcast frames may choose to not use this.
5636 *
5637 * @sta: &struct ieee80211_sta pointer to the target destination. Note
5638 * that this may be null.
5639 * @priv_sta: private rate control structure. This may be null.
5640 * @txrc: rate control information we sholud populate for mac80211.
5641 */
5642bool rate_control_send_low(struct ieee80211_sta *sta,
5643 void *priv_sta,
5644 struct ieee80211_tx_rate_control *txrc);
5645
5646
5647static inline s8
5648rate_lowest_index(struct ieee80211_supported_band *sband,
5649 struct ieee80211_sta *sta)
5650{
5651 int i;
5652
5653 for (i = 0; i < sband->n_bitrates; i++)
5654 if (rate_supported(sta, sband->band, i))
5655 return i;
5656
5657 /* warn when we cannot find a rate. */
5658 WARN_ON_ONCE(1);
5659
5660 /* and return 0 (the lowest index) */
5661 return 0;
5662}
5663
5664static inline
5665bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
5666 struct ieee80211_sta *sta)
5667{
5668 unsigned int i;
5669
5670 for (i = 0; i < sband->n_bitrates; i++)
5671 if (rate_supported(sta, sband->band, i))
5672 return true;
5673 return false;
5674}
5675
5676/**
5677 * rate_control_set_rates - pass the sta rate selection to mac80211/driver
5678 *
5679 * When not doing a rate control probe to test rates, rate control should pass
5680 * its rate selection to mac80211. If the driver supports receiving a station
5681 * rate table, it will use it to ensure that frames are always sent based on
5682 * the most recent rate control module decision.
5683 *
5684 * @hw: pointer as obtained from ieee80211_alloc_hw()
5685 * @pubsta: &struct ieee80211_sta pointer to the target destination.
5686 * @rates: new tx rate set to be used for this station.
5687 */
5688int rate_control_set_rates(struct ieee80211_hw *hw,
5689 struct ieee80211_sta *pubsta,
5690 struct ieee80211_sta_rates *rates);
5691
5692int ieee80211_rate_control_register(const struct rate_control_ops *ops);
5693void ieee80211_rate_control_unregister(const struct rate_control_ops *ops);
5694
5695static inline bool
5696conf_is_ht20(struct ieee80211_conf *conf)
5697{
5698 return conf->chandef.width == NL80211_CHAN_WIDTH_20;
5699}
5700
5701static inline bool
5702conf_is_ht40_minus(struct ieee80211_conf *conf)
5703{
5704 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5705 conf->chandef.center_freq1 < conf->chandef.chan->center_freq;
5706}
5707
5708static inline bool
5709conf_is_ht40_plus(struct ieee80211_conf *conf)
5710{
5711 return conf->chandef.width == NL80211_CHAN_WIDTH_40 &&
5712 conf->chandef.center_freq1 > conf->chandef.chan->center_freq;
5713}
5714
5715static inline bool
5716conf_is_ht40(struct ieee80211_conf *conf)
5717{
5718 return conf->chandef.width == NL80211_CHAN_WIDTH_40;
5719}
5720
5721static inline bool
5722conf_is_ht(struct ieee80211_conf *conf)
5723{
5724 return (conf->chandef.width != NL80211_CHAN_WIDTH_5) &&
5725 (conf->chandef.width != NL80211_CHAN_WIDTH_10) &&
5726 (conf->chandef.width != NL80211_CHAN_WIDTH_20_NOHT);
5727}
5728
5729static inline enum nl80211_iftype
5730ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
5731{
5732 if (p2p) {
5733 switch (type) {
5734 case NL80211_IFTYPE_STATION:
5735 return NL80211_IFTYPE_P2P_CLIENT;
5736 case NL80211_IFTYPE_AP:
5737 return NL80211_IFTYPE_P2P_GO;
5738 default:
5739 break;
5740 }
5741 }
5742 return type;
5743}
5744
5745static inline enum nl80211_iftype
5746ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
5747{
5748 return ieee80211_iftype_p2p(vif->type, vif->p2p);
5749}
5750
5751/**
5752 * ieee80211_update_mu_groups - set the VHT MU-MIMO groud data
5753 *
5754 * @vif: the specified virtual interface
5755 * @membership: 64 bits array - a bit is set if station is member of the group
5756 * @position: 2 bits per group id indicating the position in the group
5757 *
5758 * Note: This function assumes that the given vif is valid and the position and
5759 * membership data is of the correct size and are in the same byte order as the
5760 * matching GroupId management frame.
5761 * Calls to this function need to be serialized with RX path.
5762 */
5763void ieee80211_update_mu_groups(struct ieee80211_vif *vif,
5764 const u8 *membership, const u8 *position);
5765
5766void ieee80211_enable_rssi_reports(struct ieee80211_vif *vif,
5767 int rssi_min_thold,
5768 int rssi_max_thold);
5769
5770void ieee80211_disable_rssi_reports(struct ieee80211_vif *vif);
5771
5772/**
5773 * ieee80211_ave_rssi - report the average RSSI for the specified interface
5774 *
5775 * @vif: the specified virtual interface
5776 *
5777 * Note: This function assumes that the given vif is valid.
5778 *
5779 * Return: The average RSSI value for the requested interface, or 0 if not
5780 * applicable.
5781 */
5782int ieee80211_ave_rssi(struct ieee80211_vif *vif);
5783
5784/**
5785 * ieee80211_report_wowlan_wakeup - report WoWLAN wakeup
5786 * @vif: virtual interface
5787 * @wakeup: wakeup reason(s)
5788 * @gfp: allocation flags
5789 *
5790 * See cfg80211_report_wowlan_wakeup().
5791 */
5792void ieee80211_report_wowlan_wakeup(struct ieee80211_vif *vif,
5793 struct cfg80211_wowlan_wakeup *wakeup,
5794 gfp_t gfp);
5795
5796/**
5797 * ieee80211_tx_prepare_skb - prepare an 802.11 skb for transmission
5798 * @hw: pointer as obtained from ieee80211_alloc_hw()
5799 * @vif: virtual interface
5800 * @skb: frame to be sent from within the driver
5801 * @band: the band to transmit on
5802 * @sta: optional pointer to get the station to send the frame to
5803 *
5804 * Note: must be called under RCU lock
5805 */
5806bool ieee80211_tx_prepare_skb(struct ieee80211_hw *hw,
5807 struct ieee80211_vif *vif, struct sk_buff *skb,
5808 int band, struct ieee80211_sta **sta);
5809
5810/**
5811 * struct ieee80211_noa_data - holds temporary data for tracking P2P NoA state
5812 *
5813 * @next_tsf: TSF timestamp of the next absent state change
5814 * @has_next_tsf: next absent state change event pending
5815 *
5816 * @absent: descriptor bitmask, set if GO is currently absent
5817 *
5818 * private:
5819 *
5820 * @count: count fields from the NoA descriptors
5821 * @desc: adjusted data from the NoA
5822 */
5823struct ieee80211_noa_data {
5824 u32 next_tsf;
5825 bool has_next_tsf;
5826
5827 u8 absent;
5828
5829 u8 count[IEEE80211_P2P_NOA_DESC_MAX];
5830 struct {
5831 u32 start;
5832 u32 duration;
5833 u32 interval;
5834 } desc[IEEE80211_P2P_NOA_DESC_MAX];
5835};
5836
5837/**
5838 * ieee80211_parse_p2p_noa - initialize NoA tracking data from P2P IE
5839 *
5840 * @attr: P2P NoA IE
5841 * @data: NoA tracking data
5842 * @tsf: current TSF timestamp
5843 *
5844 * Return: number of successfully parsed descriptors
5845 */
5846int ieee80211_parse_p2p_noa(const struct ieee80211_p2p_noa_attr *attr,
5847 struct ieee80211_noa_data *data, u32 tsf);
5848
5849/**
5850 * ieee80211_update_p2p_noa - get next pending P2P GO absent state change
5851 *
5852 * @data: NoA tracking data
5853 * @tsf: current TSF timestamp
5854 */
5855void ieee80211_update_p2p_noa(struct ieee80211_noa_data *data, u32 tsf);
5856
5857/**
5858 * ieee80211_tdls_oper - request userspace to perform a TDLS operation
5859 * @vif: virtual interface
5860 * @peer: the peer's destination address
5861 * @oper: the requested TDLS operation
5862 * @reason_code: reason code for the operation, valid for TDLS teardown
5863 * @gfp: allocation flags
5864 *
5865 * See cfg80211_tdls_oper_request().
5866 */
5867void ieee80211_tdls_oper_request(struct ieee80211_vif *vif, const u8 *peer,
5868 enum nl80211_tdls_operation oper,
5869 u16 reason_code, gfp_t gfp);
5870
5871/**
5872 * ieee80211_reserve_tid - request to reserve a specific TID
5873 *
5874 * There is sometimes a need (such as in TDLS) for blocking the driver from
5875 * using a specific TID so that the FW can use it for certain operations such
5876 * as sending PTI requests. To make sure that the driver doesn't use that TID,
5877 * this function must be called as it flushes out packets on this TID and marks
5878 * it as blocked, so that any transmit for the station on this TID will be
5879 * redirected to the alternative TID in the same AC.
5880 *
5881 * Note that this function blocks and may call back into the driver, so it
5882 * should be called without driver locks held. Also note this function should
5883 * only be called from the driver's @sta_state callback.
5884 *
5885 * @sta: the station to reserve the TID for
5886 * @tid: the TID to reserve
5887 *
5888 * Returns: 0 on success, else on failure
5889 */
5890int ieee80211_reserve_tid(struct ieee80211_sta *sta, u8 tid);
5891
5892/**
5893 * ieee80211_unreserve_tid - request to unreserve a specific TID
5894 *
5895 * Once there is no longer any need for reserving a certain TID, this function
5896 * should be called, and no longer will packets have their TID modified for
5897 * preventing use of this TID in the driver.
5898 *
5899 * Note that this function blocks and acquires a lock, so it should be called
5900 * without driver locks held. Also note this function should only be called
5901 * from the driver's @sta_state callback.
5902 *
5903 * @sta: the station
5904 * @tid: the TID to unreserve
5905 */
5906void ieee80211_unreserve_tid(struct ieee80211_sta *sta, u8 tid);
5907
5908/**
5909 * ieee80211_tx_dequeue - dequeue a packet from a software tx queue
5910 *
5911 * @hw: pointer as obtained from ieee80211_alloc_hw()
5912 * @txq: pointer obtained from station or virtual interface
5913 *
5914 * Returns the skb if successful, %NULL if no frame was available.
5915 */
5916struct sk_buff *ieee80211_tx_dequeue(struct ieee80211_hw *hw,
5917 struct ieee80211_txq *txq);
5918
5919/**
5920 * ieee80211_txq_get_depth - get pending frame/byte count of given txq
5921 *
5922 * The values are not guaranteed to be coherent with regard to each other, i.e.
5923 * txq state can change half-way of this function and the caller may end up
5924 * with "new" frame_cnt and "old" byte_cnt or vice-versa.
5925 *
5926 * @txq: pointer obtained from station or virtual interface
5927 * @frame_cnt: pointer to store frame count
5928 * @byte_cnt: pointer to store byte count
5929 */
5930void ieee80211_txq_get_depth(struct ieee80211_txq *txq,
5931 unsigned long *frame_cnt,
5932 unsigned long *byte_cnt);
5933
5934/**
5935 * ieee80211_nan_func_terminated - notify about NAN function termination.
5936 *
5937 * This function is used to notify mac80211 about NAN function termination.
5938 * Note that this function can't be called from hard irq.
5939 *
5940 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5941 * @inst_id: the local instance id
5942 * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
5943 * @gfp: allocation flags
5944 */
5945void ieee80211_nan_func_terminated(struct ieee80211_vif *vif,
5946 u8 inst_id,
5947 enum nl80211_nan_func_term_reason reason,
5948 gfp_t gfp);
5949
5950/**
5951 * ieee80211_nan_func_match - notify about NAN function match event.
5952 *
5953 * This function is used to notify mac80211 about NAN function match. The
5954 * cookie inside the match struct will be assigned by mac80211.
5955 * Note that this function can't be called from hard irq.
5956 *
5957 * @vif: &struct ieee80211_vif pointer from the add_interface callback.
5958 * @match: match event information
5959 * @gfp: allocation flags
5960 */
5961void ieee80211_nan_func_match(struct ieee80211_vif *vif,
5962 struct cfg80211_nan_match_params *match,
5963 gfp_t gfp);
5964
5965#endif /* MAC80211_H */