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