2
* mac80211 <-> driver interface
4
* Copyright 2002-2005, Devicescape Software, Inc.
5
* Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6
* Copyright 2007-2010 Johannes Berg <johannes@sipsolutions.net>
8
* This program is free software; you can redistribute it and/or modify
9
* it under the terms of the GNU General Public License version 2 as
10
* published by the Free Software Foundation.
16
#include <linux/kernel.h>
17
#include <linux/if_ether.h>
18
#include <linux/skbuff.h>
19
#include <linux/wireless.h>
20
#include <linux/device.h>
21
#include <linux/ieee80211.h>
22
#include <net/cfg80211.h>
27
* mac80211 is the Linux stack for 802.11 hardware that implements
28
* only partial functionality in hard- or firmware. This document
29
* defines the interface between mac80211 and low-level hardware
34
* DOC: Calling mac80211 from interrupts
36
* Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
37
* called in hardware interrupt context. The low-level driver must not call any
38
* other functions in hardware interrupt context. If there is a need for such
39
* call, the low-level driver should first ACK the interrupt and perform the
40
* IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
43
* NOTE: If the driver opts to use the _irqsafe() functions, it may not also
44
* use the non-IRQ-safe functions!
50
* If you're reading this document and not the header file itself, it will
51
* be incomplete because not all documentation has been converted yet.
57
* As a general rule, when frames are passed between mac80211 and the driver,
58
* they start with the IEEE 802.11 header and include the same octets that are
59
* sent over the air except for the FCS which should be calculated by the
62
* There are, however, various exceptions to this rule for advanced features:
64
* The first exception is for hardware encryption and decryption offload
65
* where the IV/ICV may or may not be generated in hardware.
67
* Secondly, when the hardware handles fragmentation, the frame handed to
68
* the driver from mac80211 is the MSDU, not the MPDU.
70
* Finally, for received frames, the driver is able to indicate that it has
71
* filled a radiotap header and put that in front of the frame; if it does
72
* not do so then mac80211 may add this under certain circumstances.
76
* DOC: mac80211 workqueue
78
* mac80211 provides its own workqueue for drivers and internal mac80211 use.
79
* The workqueue is a single threaded workqueue and can only be accessed by
80
* helpers for sanity checking. Drivers must ensure all work added onto the
81
* mac80211 workqueue should be cancelled on the driver stop() callback.
83
* mac80211 will flushed the workqueue upon interface removal and during
86
* All work performed on the mac80211 workqueue must not acquire the RTNL lock.
91
* enum ieee80211_max_queues - maximum number of queues
93
* @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
95
enum ieee80211_max_queues {
96
IEEE80211_MAX_QUEUES = 4,
100
* struct ieee80211_tx_queue_params - transmit queue configuration
102
* The information provided in this structure is required for QoS
103
* transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
105
* @aifs: arbitration interframe space [0..255]
106
* @cw_min: minimum contention window [a value of the form
107
* 2^n-1 in the range 1..32767]
108
* @cw_max: maximum contention window [like @cw_min]
109
* @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
110
* @uapsd: is U-APSD mode enabled for the queue
112
struct ieee80211_tx_queue_params {
120
struct ieee80211_low_level_stats {
121
unsigned int dot11ACKFailureCount;
122
unsigned int dot11RTSFailureCount;
123
unsigned int dot11FCSErrorCount;
124
unsigned int dot11RTSSuccessCount;
128
* enum ieee80211_bss_change - BSS change notification flags
130
* These flags are used with the bss_info_changed() callback
131
* to indicate which BSS parameter changed.
133
* @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
134
* also implies a change in the AID.
135
* @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
136
* @BSS_CHANGED_ERP_PREAMBLE: preamble changed
137
* @BSS_CHANGED_ERP_SLOT: slot timing changed
138
* @BSS_CHANGED_HT: 802.11n parameters changed
139
* @BSS_CHANGED_BASIC_RATES: Basic rateset changed
140
* @BSS_CHANGED_BEACON_INT: Beacon interval changed
141
* @BSS_CHANGED_BSSID: BSSID changed, for whatever
142
* reason (IBSS and managed mode)
143
* @BSS_CHANGED_BEACON: Beacon data changed, retrieve
144
* new beacon (beaconing modes)
145
* @BSS_CHANGED_BEACON_ENABLED: Beaconing should be
146
* enabled/disabled (beaconing modes)
147
* @BSS_CHANGED_CQM: Connection quality monitor config changed
148
* @BSS_CHANGED_IBSS: IBSS join status changed
149
* @BSS_CHANGED_ARP_FILTER: Hardware ARP filter address list or state changed.
150
* @BSS_CHANGED_QOS: QoS for this association was enabled/disabled. Note
151
* that it is only ever disabled for station mode.
152
* @BSS_CHANGED_IDLE: Idle changed for this BSS/interface.
154
enum ieee80211_bss_change {
155
BSS_CHANGED_ASSOC = 1<<0,
156
BSS_CHANGED_ERP_CTS_PROT = 1<<1,
157
BSS_CHANGED_ERP_PREAMBLE = 1<<2,
158
BSS_CHANGED_ERP_SLOT = 1<<3,
159
BSS_CHANGED_HT = 1<<4,
160
BSS_CHANGED_BASIC_RATES = 1<<5,
161
BSS_CHANGED_BEACON_INT = 1<<6,
162
BSS_CHANGED_BSSID = 1<<7,
163
BSS_CHANGED_BEACON = 1<<8,
164
BSS_CHANGED_BEACON_ENABLED = 1<<9,
165
BSS_CHANGED_CQM = 1<<10,
166
BSS_CHANGED_IBSS = 1<<11,
167
BSS_CHANGED_ARP_FILTER = 1<<12,
168
BSS_CHANGED_QOS = 1<<13,
169
BSS_CHANGED_IDLE = 1<<14,
171
/* when adding here, make sure to change ieee80211_reconfig */
175
* The maximum number of IPv4 addresses listed for ARP filtering. If the number
176
* of addresses for an interface increase beyond this value, hardware ARP
177
* filtering will be disabled.
179
#define IEEE80211_BSS_ARP_ADDR_LIST_LEN 4
182
* struct ieee80211_bss_conf - holds the BSS's changing parameters
184
* This structure keeps information about a BSS (and an association
185
* to that BSS) that can change during the lifetime of the BSS.
187
* @assoc: association status
188
* @ibss_joined: indicates whether this station is part of an IBSS
190
* @aid: association ID number, valid only when @assoc is true
191
* @use_cts_prot: use CTS protection
192
* @use_short_preamble: use 802.11b short preamble;
193
* if the hardware cannot handle this it must set the
194
* IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE hardware flag
195
* @use_short_slot: use short slot time (only relevant for ERP);
196
* if the hardware cannot handle this it must set the
197
* IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE hardware flag
198
* @dtim_period: num of beacons before the next DTIM, for beaconing,
199
* valid in station mode only while @assoc is true and if also
200
* requested by %IEEE80211_HW_NEED_DTIM_PERIOD (cf. also hw conf
202
* @timestamp: beacon timestamp
203
* @beacon_int: beacon interval
204
* @assoc_capability: capabilities taken from assoc resp
205
* @basic_rates: bitmap of basic rates, each bit stands for an
206
* index into the rate table configured by the driver in
208
* @bssid: The BSSID for this BSS
209
* @enable_beacon: whether beaconing should be enabled or not
210
* @channel_type: Channel type for this BSS -- the hardware might be
211
* configured for HT40+ while this BSS only uses no-HT, for
213
* @ht_operation_mode: HT operation mode (like in &struct ieee80211_ht_info).
214
* This field is only valid when the channel type is one of the HT types.
215
* @cqm_rssi_thold: Connection quality monitor RSSI threshold, a zero value
217
* @cqm_rssi_hyst: Connection quality monitor RSSI hysteresis
218
* @arp_addr_list: List of IPv4 addresses for hardware ARP filtering. The
219
* may filter ARP queries targeted for other addresses than listed here.
220
* The driver must allow ARP queries targeted for all address listed here
221
* to pass through. An empty list implies no ARP queries need to pass.
222
* @arp_addr_cnt: Number of addresses currently on the list.
223
* @arp_filter_enabled: Enable ARP filtering - if enabled, the hardware may
224
* filter ARP queries based on the @arp_addr_list, if disabled, the
225
* hardware must not perform any ARP filtering. Note, that the filter will
226
* be enabled also in promiscuous mode.
227
* @qos: This is a QoS-enabled BSS.
228
* @idle: This interface is idle. There's also a global idle flag in the
229
* hardware config which may be more appropriate depending on what
230
* your driver/device needs to do.
232
struct ieee80211_bss_conf {
234
/* association related data */
235
bool assoc, ibss_joined;
237
/* erp related data */
239
bool use_short_preamble;
244
u16 assoc_capability;
247
u16 ht_operation_mode;
250
enum nl80211_channel_type channel_type;
251
__be32 arp_addr_list[IEEE80211_BSS_ARP_ADDR_LIST_LEN];
253
bool arp_filter_enabled;
259
* enum mac80211_tx_control_flags - flags to describe transmission information/status
261
* These flags are used with the @flags member of &ieee80211_tx_info.
263
* @IEEE80211_TX_CTL_REQ_TX_STATUS: require TX status callback for this frame.
264
* @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
265
* number to this frame, taking care of not overwriting the fragment
266
* number and increasing the sequence number only when the
267
* IEEE80211_TX_CTL_FIRST_FRAGMENT flag is set. mac80211 will properly
268
* assign sequence numbers to QoS-data frames but cannot do so correctly
269
* for non-QoS-data and management frames because beacons need them from
270
* that counter as well and mac80211 cannot guarantee proper sequencing.
271
* If this flag is set, the driver should instruct the hardware to
272
* assign a sequence number to the frame or assign one itself. Cf. IEEE
273
* 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
274
* beacons and always be clear for frames without a sequence number field.
275
* @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
276
* @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
278
* @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
279
* @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
280
* @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
281
* @IEEE80211_TX_CTL_INJECTED: Frame was injected, internal to mac80211.
282
* @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
283
* because the destination STA was in powersave mode. Note that to
284
* avoid race conditions, the filter must be set by the hardware or
285
* firmware upon receiving a frame that indicates that the station
286
* went to sleep (must be done on device to filter frames already on
287
* the queue) and may only be unset after mac80211 gives the OK for
288
* that by setting the IEEE80211_TX_CTL_CLEAR_PS_FILT (see above),
289
* since only then is it guaranteed that no more frames are in the
291
* @IEEE80211_TX_STAT_ACK: Frame was acknowledged
292
* @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
293
* is for the whole aggregation.
294
* @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
295
* so consider using block ack request (BAR).
296
* @IEEE80211_TX_CTL_RATE_CTRL_PROBE: internal to mac80211, can be
297
* set by rate control algorithms to indicate probe rate, will
298
* be cleared for fragmented frames (except on the last fragment)
299
* @IEEE80211_TX_INTFL_NEED_TXPROCESSING: completely internal to mac80211,
300
* used to indicate that a pending frame requires TX processing before
301
* it can be sent out.
302
* @IEEE80211_TX_INTFL_RETRIED: completely internal to mac80211,
303
* used to indicate that a frame was already retried due to PS
304
* @IEEE80211_TX_INTFL_DONT_ENCRYPT: completely internal to mac80211,
305
* used to indicate frame should not be encrypted
306
* @IEEE80211_TX_CTL_PSPOLL_RESPONSE: (internal?)
307
* This frame is a response to a PS-poll frame and should be sent
308
* although the station is in powersave mode.
309
* @IEEE80211_TX_CTL_MORE_FRAMES: More frames will be passed to the
310
* transmit function after the current frame, this can be used
311
* by drivers to kick the DMA queue only if unset or when the
313
* @IEEE80211_TX_INTFL_RETRANSMISSION: This frame is being retransmitted
314
* after TX status because the destination was asleep, it must not
315
* be modified again (no seqno assignment, crypto, etc.)
316
* @IEEE80211_TX_INTFL_HAS_RADIOTAP: This frame was injected and still
317
* has a radiotap header at skb->data.
318
* @IEEE80211_TX_INTFL_NL80211_FRAME_TX: Frame was requested through nl80211
319
* MLME command (internal to mac80211 to figure out whether to send TX
320
* status to user space)
321
* @IEEE80211_TX_CTL_LDPC: tells the driver to use LDPC for this frame
322
* @IEEE80211_TX_CTL_STBC: Enables Space-Time Block Coding (STBC) for this
323
* frame and selects the maximum number of streams that it can use.
325
* Note: If you have to add new flags to the enumeration, then don't
326
* forget to update %IEEE80211_TX_TEMPORARY_FLAGS when necessary.
328
enum mac80211_tx_control_flags {
329
IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
330
IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(1),
331
IEEE80211_TX_CTL_NO_ACK = BIT(2),
332
IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(3),
333
IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(4),
334
IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(5),
335
IEEE80211_TX_CTL_AMPDU = BIT(6),
336
IEEE80211_TX_CTL_INJECTED = BIT(7),
337
IEEE80211_TX_STAT_TX_FILTERED = BIT(8),
338
IEEE80211_TX_STAT_ACK = BIT(9),
339
IEEE80211_TX_STAT_AMPDU = BIT(10),
340
IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(11),
341
IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(12),
342
IEEE80211_TX_INTFL_NEED_TXPROCESSING = BIT(14),
343
IEEE80211_TX_INTFL_RETRIED = BIT(15),
344
IEEE80211_TX_INTFL_DONT_ENCRYPT = BIT(16),
345
IEEE80211_TX_CTL_PSPOLL_RESPONSE = BIT(17),
346
IEEE80211_TX_CTL_MORE_FRAMES = BIT(18),
347
IEEE80211_TX_INTFL_RETRANSMISSION = BIT(19),
348
IEEE80211_TX_INTFL_HAS_RADIOTAP = BIT(20),
349
IEEE80211_TX_INTFL_NL80211_FRAME_TX = BIT(21),
350
IEEE80211_TX_CTL_LDPC = BIT(22),
351
IEEE80211_TX_CTL_STBC = BIT(23) | BIT(24),
354
#define IEEE80211_TX_CTL_STBC_SHIFT 23
357
* This definition is used as a mask to clear all temporary flags, which are
358
* set by the tx handlers for each transmission attempt by the mac80211 stack.
360
#define IEEE80211_TX_TEMPORARY_FLAGS (IEEE80211_TX_CTL_NO_ACK | \
361
IEEE80211_TX_CTL_CLEAR_PS_FILT | IEEE80211_TX_CTL_FIRST_FRAGMENT | \
362
IEEE80211_TX_CTL_SEND_AFTER_DTIM | IEEE80211_TX_CTL_AMPDU | \
363
IEEE80211_TX_STAT_TX_FILTERED | IEEE80211_TX_STAT_ACK | \
364
IEEE80211_TX_STAT_AMPDU | IEEE80211_TX_STAT_AMPDU_NO_BACK | \
365
IEEE80211_TX_CTL_RATE_CTRL_PROBE | IEEE80211_TX_CTL_PSPOLL_RESPONSE | \
366
IEEE80211_TX_CTL_MORE_FRAMES | IEEE80211_TX_CTL_LDPC | \
367
IEEE80211_TX_CTL_STBC)
370
* enum mac80211_rate_control_flags - per-rate flags set by the
371
* Rate Control algorithm.
373
* These flags are set by the Rate control algorithm for each rate during tx,
374
* in the @flags member of struct ieee80211_tx_rate.
376
* @IEEE80211_TX_RC_USE_RTS_CTS: Use RTS/CTS exchange for this rate.
377
* @IEEE80211_TX_RC_USE_CTS_PROTECT: CTS-to-self protection is required.
378
* This is set if the current BSS requires ERP protection.
379
* @IEEE80211_TX_RC_USE_SHORT_PREAMBLE: Use short preamble.
380
* @IEEE80211_TX_RC_MCS: HT rate.
381
* @IEEE80211_TX_RC_GREEN_FIELD: Indicates whether this rate should be used in
383
* @IEEE80211_TX_RC_40_MHZ_WIDTH: Indicates if the Channel Width should be 40 MHz.
384
* @IEEE80211_TX_RC_DUP_DATA: The frame should be transmitted on both of the
385
* adjacent 20 MHz channels, if the current channel type is
386
* NL80211_CHAN_HT40MINUS or NL80211_CHAN_HT40PLUS.
387
* @IEEE80211_TX_RC_SHORT_GI: Short Guard interval should be used for this rate.
389
enum mac80211_rate_control_flags {
390
IEEE80211_TX_RC_USE_RTS_CTS = BIT(0),
391
IEEE80211_TX_RC_USE_CTS_PROTECT = BIT(1),
392
IEEE80211_TX_RC_USE_SHORT_PREAMBLE = BIT(2),
394
/* rate index is an MCS rate number instead of an index */
395
IEEE80211_TX_RC_MCS = BIT(3),
396
IEEE80211_TX_RC_GREEN_FIELD = BIT(4),
397
IEEE80211_TX_RC_40_MHZ_WIDTH = BIT(5),
398
IEEE80211_TX_RC_DUP_DATA = BIT(6),
399
IEEE80211_TX_RC_SHORT_GI = BIT(7),
403
/* there are 40 bytes if you don't need the rateset to be kept */
404
#define IEEE80211_TX_INFO_DRIVER_DATA_SIZE 40
406
/* if you do need the rateset, then you have less space */
407
#define IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE 24
409
/* maximum number of rate stages */
410
#define IEEE80211_TX_MAX_RATES 5
413
* struct ieee80211_tx_rate - rate selection/status
415
* @idx: rate index to attempt to send with
416
* @flags: rate control flags (&enum mac80211_rate_control_flags)
417
* @count: number of tries in this rate before going to the next rate
419
* A value of -1 for @idx indicates an invalid rate and, if used
420
* in an array of retry rates, that no more rates should be tried.
422
* When used for transmit status reporting, the driver should
423
* always report the rate along with the flags it used.
425
* &struct ieee80211_tx_info contains an array of these structs
426
* in the control information, and it will be filled by the rate
427
* control algorithm according to what should be sent. For example,
428
* if this array contains, in the format { <idx>, <count> } the
430
* { 3, 2 }, { 2, 2 }, { 1, 4 }, { -1, 0 }, { -1, 0 }
431
* then this means that the frame should be transmitted
432
* up to twice at rate 3, up to twice at rate 2, and up to four
433
* times at rate 1 if it doesn't get acknowledged. Say it gets
434
* acknowledged by the peer after the fifth attempt, the status
435
* information should then contain
436
* { 3, 2 }, { 2, 2 }, { 1, 1 }, { -1, 0 } ...
437
* since it was transmitted twice at rate 3, twice at rate 2
438
* and once at rate 1 after which we received an acknowledgement.
440
struct ieee80211_tx_rate {
447
* struct ieee80211_tx_info - skb transmit information
449
* This structure is placed in skb->cb for three uses:
450
* (1) mac80211 TX control - mac80211 tells the driver what to do
451
* (2) driver internal use (if applicable)
452
* (3) TX status information - driver tells mac80211 what happened
454
* The TX control's sta pointer is only valid during the ->tx call,
457
* @flags: transmit info flags, defined above
458
* @band: the band to transmit on (use for checking for races)
459
* @antenna_sel_tx: antenna to use, 0 for automatic diversity
460
* @pad: padding, ignore
461
* @control: union for control data
462
* @status: union for status data
463
* @driver_data: array of driver_data pointers
464
* @ampdu_ack_len: number of acked aggregated frames.
465
* relevant only if IEEE80211_TX_STAT_AMPDU was set.
466
* @ampdu_len: number of aggregated frames.
467
* relevant only if IEEE80211_TX_STAT_AMPDU was set.
468
* @ack_signal: signal strength of the ACK frame
470
struct ieee80211_tx_info {
471
/* common information */
485
struct ieee80211_tx_rate rates[
486
IEEE80211_TX_MAX_RATES];
489
/* only needed before rate control */
490
unsigned long jiffies;
492
/* NB: vif can be NULL for injected frames */
493
struct ieee80211_vif *vif;
494
struct ieee80211_key_conf *hw_key;
495
struct ieee80211_sta *sta;
498
struct ieee80211_tx_rate rates[IEEE80211_TX_MAX_RATES];
505
struct ieee80211_tx_rate driver_rates[
506
IEEE80211_TX_MAX_RATES];
507
void *rate_driver_data[
508
IEEE80211_TX_INFO_RATE_DRIVER_DATA_SIZE / sizeof(void *)];
511
IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *)];
515
static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
517
return (struct ieee80211_tx_info *)skb->cb;
520
static inline struct ieee80211_rx_status *IEEE80211_SKB_RXCB(struct sk_buff *skb)
522
return (struct ieee80211_rx_status *)skb->cb;
526
* ieee80211_tx_info_clear_status - clear TX status
528
* @info: The &struct ieee80211_tx_info to be cleared.
530
* When the driver passes an skb back to mac80211, it must report
531
* a number of things in TX status. This function clears everything
532
* in the TX status but the rate control information (it does clear
533
* the count since you need to fill that in anyway).
535
* NOTE: You can only use this function if you do NOT use
536
* info->driver_data! Use info->rate_driver_data
537
* instead if you need only the less space that allows.
540
ieee80211_tx_info_clear_status(struct ieee80211_tx_info *info)
544
BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
545
offsetof(struct ieee80211_tx_info, control.rates));
546
BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) !=
547
offsetof(struct ieee80211_tx_info, driver_rates));
548
BUILD_BUG_ON(offsetof(struct ieee80211_tx_info, status.rates) != 8);
549
/* clear the rate counts */
550
for (i = 0; i < IEEE80211_TX_MAX_RATES; i++)
551
info->status.rates[i].count = 0;
554
offsetof(struct ieee80211_tx_info, status.ampdu_ack_len) != 23);
555
memset(&info->status.ampdu_ack_len, 0,
556
sizeof(struct ieee80211_tx_info) -
557
offsetof(struct ieee80211_tx_info, status.ampdu_ack_len));
562
* enum mac80211_rx_flags - receive flags
564
* These flags are used with the @flag member of &struct ieee80211_rx_status.
565
* @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
566
* Use together with %RX_FLAG_MMIC_STRIPPED.
567
* @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
568
* @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
569
* verification has been done by the hardware.
570
* @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
571
* If this flag is set, the stack cannot do any replay detection
572
* hence the driver or hardware will have to do that.
573
* @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
575
* @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
577
* @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
578
* is valid. This is useful in monitor mode and necessary for beacon frames
579
* to enable IBSS merging.
580
* @RX_FLAG_SHORTPRE: Short preamble was used for this frame
581
* @RX_FLAG_HT: HT MCS was used and rate_idx is MCS index
582
* @RX_FLAG_40MHZ: HT40 (40 MHz) was used
583
* @RX_FLAG_SHORT_GI: Short guard interval was used
585
enum mac80211_rx_flags {
586
RX_FLAG_MMIC_ERROR = 1<<0,
587
RX_FLAG_DECRYPTED = 1<<1,
588
RX_FLAG_MMIC_STRIPPED = 1<<3,
589
RX_FLAG_IV_STRIPPED = 1<<4,
590
RX_FLAG_FAILED_FCS_CRC = 1<<5,
591
RX_FLAG_FAILED_PLCP_CRC = 1<<6,
593
RX_FLAG_SHORTPRE = 1<<8,
595
RX_FLAG_40MHZ = 1<<10,
596
RX_FLAG_SHORT_GI = 1<<11,
600
* struct ieee80211_rx_status - receive status
602
* The low-level driver should provide this information (the subset
603
* supported by hardware) to the 802.11 code with each received
604
* frame, in the skb's control buffer (cb).
606
* @mactime: value in microseconds of the 64-bit Time Synchronization Function
607
* (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
608
* @band: the active band when this frame was received
609
* @freq: frequency the radio was tuned to when receiving this frame, in MHz
610
* @signal: signal strength when receiving this frame, either in dBm, in dB or
611
* unspecified depending on the hardware capabilities flags
612
* @IEEE80211_HW_SIGNAL_*
613
* @antenna: antenna used
614
* @rate_idx: index of data rate into band's supported rates or MCS index if
615
* HT rates are use (RX_FLAG_HT)
617
* @rx_flags: internal RX flags for mac80211
619
struct ieee80211_rx_status {
621
enum ieee80211_band band;
627
unsigned int rx_flags;
631
* enum ieee80211_conf_flags - configuration flags
633
* Flags to define PHY configuration options
635
* @IEEE80211_CONF_MONITOR: there's a monitor interface present -- use this
636
* to determine for example whether to calculate timestamps for packets
637
* or not, do not use instead of filter flags!
638
* @IEEE80211_CONF_PS: Enable 802.11 power save mode (managed mode only).
639
* This is the power save mode defined by IEEE 802.11-2007 section 11.2,
640
* meaning that the hardware still wakes up for beacons, is able to
641
* transmit frames and receive the possible acknowledgment frames.
642
* Not to be confused with hardware specific wakeup/sleep states,
643
* driver is responsible for that. See the section "Powersave support"
645
* @IEEE80211_CONF_IDLE: The device is running, but idle; if the flag is set
646
* the driver should be prepared to handle configuration requests but
647
* may turn the device off as much as possible. Typically, this flag will
648
* be set when an interface is set UP but not associated or scanning, but
649
* it can also be unset in that case when monitor interfaces are active.
650
* @IEEE80211_CONF_OFFCHANNEL: The device is currently not on its main
653
enum ieee80211_conf_flags {
654
IEEE80211_CONF_MONITOR = (1<<0),
655
IEEE80211_CONF_PS = (1<<1),
656
IEEE80211_CONF_IDLE = (1<<2),
657
IEEE80211_CONF_OFFCHANNEL = (1<<3),
662
* enum ieee80211_conf_changed - denotes which configuration changed
664
* @IEEE80211_CONF_CHANGE_LISTEN_INTERVAL: the listen interval changed
665
* @IEEE80211_CONF_CHANGE_MONITOR: the monitor flag changed
666
* @IEEE80211_CONF_CHANGE_PS: the PS flag or dynamic PS timeout changed
667
* @IEEE80211_CONF_CHANGE_POWER: the TX power changed
668
* @IEEE80211_CONF_CHANGE_CHANNEL: the channel/channel_type changed
669
* @IEEE80211_CONF_CHANGE_RETRY_LIMITS: retry limits changed
670
* @IEEE80211_CONF_CHANGE_IDLE: Idle flag changed
671
* @IEEE80211_CONF_CHANGE_SMPS: Spatial multiplexing powersave mode changed
673
enum ieee80211_conf_changed {
674
IEEE80211_CONF_CHANGE_SMPS = BIT(1),
675
IEEE80211_CONF_CHANGE_LISTEN_INTERVAL = BIT(2),
676
IEEE80211_CONF_CHANGE_MONITOR = BIT(3),
677
IEEE80211_CONF_CHANGE_PS = BIT(4),
678
IEEE80211_CONF_CHANGE_POWER = BIT(5),
679
IEEE80211_CONF_CHANGE_CHANNEL = BIT(6),
680
IEEE80211_CONF_CHANGE_RETRY_LIMITS = BIT(7),
681
IEEE80211_CONF_CHANGE_IDLE = BIT(8),
685
* enum ieee80211_smps_mode - spatial multiplexing power save mode
687
* @IEEE80211_SMPS_AUTOMATIC: automatic
688
* @IEEE80211_SMPS_OFF: off
689
* @IEEE80211_SMPS_STATIC: static
690
* @IEEE80211_SMPS_DYNAMIC: dynamic
691
* @IEEE80211_SMPS_NUM_MODES: internal, don't use
693
enum ieee80211_smps_mode {
694
IEEE80211_SMPS_AUTOMATIC,
696
IEEE80211_SMPS_STATIC,
697
IEEE80211_SMPS_DYNAMIC,
700
IEEE80211_SMPS_NUM_MODES,
704
* struct ieee80211_conf - configuration of the device
706
* This struct indicates how the driver shall configure the hardware.
708
* @flags: configuration flags defined above
710
* @listen_interval: listen interval in units of beacon interval
711
* @max_sleep_period: the maximum number of beacon intervals to sleep for
712
* before checking the beacon for a TIM bit (managed mode only); this
713
* value will be only achievable between DTIM frames, the hardware
714
* needs to check for the multicast traffic bit in DTIM beacons.
715
* This variable is valid only when the CONF_PS flag is set.
716
* @ps_dtim_period: The DTIM period of the AP we're connected to, for use
717
* in power saving. Power saving will not be enabled until a beacon
718
* has been received and the DTIM period is known.
719
* @dynamic_ps_timeout: The dynamic powersave timeout (in ms), see the
720
* powersave documentation below. This variable is valid only when
721
* the CONF_PS flag is set.
723
* @power_level: requested transmit power (in dBm)
725
* @channel: the channel to tune to
726
* @channel_type: the channel (HT) type
728
* @long_frame_max_tx_count: Maximum number of transmissions for a "long" frame
729
* (a frame not RTS protected), called "dot11LongRetryLimit" in 802.11,
730
* but actually means the number of transmissions not the number of retries
731
* @short_frame_max_tx_count: Maximum number of transmissions for a "short"
732
* frame, called "dot11ShortRetryLimit" in 802.11, but actually means the
733
* number of transmissions not the number of retries
735
* @smps_mode: spatial multiplexing powersave mode; note that
736
* %IEEE80211_SMPS_STATIC is used when the device is not
737
* configured for an HT channel
739
struct ieee80211_conf {
741
int power_level, dynamic_ps_timeout;
742
int max_sleep_period;
747
u8 long_frame_max_tx_count, short_frame_max_tx_count;
749
struct ieee80211_channel *channel;
750
enum nl80211_channel_type channel_type;
751
enum ieee80211_smps_mode smps_mode;
755
* struct ieee80211_channel_switch - holds the channel switch data
757
* The information provided in this structure is required for channel switch
760
* @timestamp: value in microseconds of the 64-bit Time Synchronization
761
* Function (TSF) timer when the frame containing the channel switch
762
* announcement was received. This is simply the rx.mactime parameter
763
* the driver passed into mac80211.
764
* @block_tx: Indicates whether transmission must be blocked before the
765
* scheduled channel switch, as indicated by the AP.
766
* @channel: the new channel to switch to
767
* @count: the number of TBTT's until the channel switch event
769
struct ieee80211_channel_switch {
772
struct ieee80211_channel *channel;
777
* struct ieee80211_vif - per-interface data
779
* Data in this structure is continually present for driver
780
* use during the life of a virtual interface.
782
* @type: type of this virtual interface
783
* @bss_conf: BSS configuration for this interface, either our own
784
* or the BSS we're associated to
785
* @addr: address of this interface
786
* @p2p: indicates whether this AP or STA interface is a p2p
787
* interface, i.e. a GO or p2p-sta respectively
788
* @drv_priv: data area for driver use, will always be aligned to
791
struct ieee80211_vif {
792
enum nl80211_iftype type;
793
struct ieee80211_bss_conf bss_conf;
797
u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
800
static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
802
#ifdef CONFIG_MAC80211_MESH
803
return vif->type == NL80211_IFTYPE_MESH_POINT;
809
* enum ieee80211_key_flags - key flags
811
* These flags are used for communication about keys between the driver
812
* and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
814
* @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
815
* that the STA this key will be used with could be using QoS.
816
* @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
817
* driver to indicate that it requires IV generation for this
819
* @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
820
* the driver for a TKIP key if it requires Michael MIC
821
* generation in software.
822
* @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
823
* that the key is pairwise rather then a shared key.
824
* @IEEE80211_KEY_FLAG_SW_MGMT: This flag should be set by the driver for a
825
* CCMP key if it requires CCMP encryption of management frames (MFP) to
826
* be done in software.
828
enum ieee80211_key_flags {
829
IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
830
IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
831
IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
832
IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
833
IEEE80211_KEY_FLAG_SW_MGMT = 1<<4,
837
* struct ieee80211_key_conf - key information
839
* This key information is given by mac80211 to the driver by
840
* the set_key() callback in &struct ieee80211_ops.
842
* @hw_key_idx: To be set by the driver, this is the key index the driver
843
* wants to be given when a frame is transmitted and needs to be
844
* encrypted in hardware.
845
* @cipher: The key's cipher suite selector.
846
* @flags: key flags, see &enum ieee80211_key_flags.
847
* @keyidx: the key index (0-3)
848
* @keylen: key material length
849
* @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
851
* - Temporal Encryption Key (128 bits)
852
* - Temporal Authenticator Tx MIC Key (64 bits)
853
* - Temporal Authenticator Rx MIC Key (64 bits)
854
* @icv_len: The ICV length for this key type
855
* @iv_len: The IV length for this key type
857
struct ieee80211_key_conf {
869
* enum set_key_cmd - key command
871
* Used with the set_key() callback in &struct ieee80211_ops, this
872
* indicates whether a key is being removed or added.
874
* @SET_KEY: a key is set
875
* @DISABLE_KEY: a key must be disabled
878
SET_KEY, DISABLE_KEY,
882
* struct ieee80211_sta - station table entry
884
* A station table entry represents a station we are possibly
885
* communicating with. Since stations are RCU-managed in
886
* mac80211, any ieee80211_sta pointer you get access to must
887
* either be protected by rcu_read_lock() explicitly or implicitly,
888
* or you must take good care to not use such a pointer after a
889
* call to your sta_remove callback that removed it.
892
* @aid: AID we assigned to the station if we're an AP
893
* @supp_rates: Bitmap of supported rates (per band)
894
* @ht_cap: HT capabilities of this STA; restricted to our own TX capabilities
895
* @drv_priv: data area for driver use, will always be aligned to
896
* sizeof(void *), size is determined in hw information.
898
struct ieee80211_sta {
899
u32 supp_rates[IEEE80211_NUM_BANDS];
902
struct ieee80211_sta_ht_cap ht_cap;
905
u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
909
* enum sta_notify_cmd - sta notify command
911
* Used with the sta_notify() callback in &struct ieee80211_ops, this
912
* indicates if an associated station made a power state transition.
914
* @STA_NOTIFY_SLEEP: a station is now sleeping
915
* @STA_NOTIFY_AWAKE: a sleeping station woke up
917
enum sta_notify_cmd {
918
STA_NOTIFY_SLEEP, STA_NOTIFY_AWAKE,
922
* enum ieee80211_tkip_key_type - get tkip key
924
* Used by drivers which need to get a tkip key for skb. Some drivers need a
925
* phase 1 key, others need a phase 2 key. A single function allows the driver
926
* to get the key, this enum indicates what type of key is required.
928
* @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
929
* @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
931
enum ieee80211_tkip_key_type {
932
IEEE80211_TKIP_P1_KEY,
933
IEEE80211_TKIP_P2_KEY,
937
* enum ieee80211_hw_flags - hardware flags
939
* These flags are used to indicate hardware capabilities to
940
* the stack. Generally, flags here should have their meaning
941
* done in a way that the simplest hardware doesn't need setting
942
* any particular flags. There are some exceptions to this rule,
943
* however, so you are advised to review these flags carefully.
945
* @IEEE80211_HW_HAS_RATE_CONTROL:
946
* The hardware or firmware includes rate control, and cannot be
947
* controlled by the stack. As such, no rate control algorithm
948
* should be instantiated, and the TX rate reported to userspace
949
* will be taken from the TX status instead of the rate control
951
* Note that this requires that the driver implement a number of
952
* callbacks so it has the correct information, it needs to have
953
* the @set_rts_threshold callback and must look at the BSS config
954
* @use_cts_prot for G/N protection, @use_short_slot for slot
955
* timing in 2.4 GHz and @use_short_preamble for preambles for
958
* @IEEE80211_HW_RX_INCLUDES_FCS:
959
* Indicates that received frames passed to the stack include
960
* the FCS at the end.
962
* @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
963
* Some wireless LAN chipsets buffer broadcast/multicast frames
964
* for power saving stations in the hardware/firmware and others
965
* rely on the host system for such buffering. This option is used
966
* to configure the IEEE 802.11 upper layer to buffer broadcast and
967
* multicast frames when there are power saving stations so that
968
* the driver can fetch them with ieee80211_get_buffered_bc().
970
* @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
971
* Hardware is not capable of short slot operation on the 2.4 GHz band.
973
* @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
974
* Hardware is not capable of receiving frames with short preamble on
977
* @IEEE80211_HW_SIGNAL_UNSPEC:
978
* Hardware can provide signal values but we don't know its units. We
979
* expect values between 0 and @max_signal.
980
* If possible please provide dB or dBm instead.
982
* @IEEE80211_HW_SIGNAL_DBM:
983
* Hardware gives signal values in dBm, decibel difference from
984
* one milliwatt. This is the preferred method since it is standardized
985
* between different devices. @max_signal does not need to be set.
987
* @IEEE80211_HW_SPECTRUM_MGMT:
988
* Hardware supports spectrum management defined in 802.11h
989
* Measurement, Channel Switch, Quieting, TPC
991
* @IEEE80211_HW_AMPDU_AGGREGATION:
992
* Hardware supports 11n A-MPDU aggregation.
994
* @IEEE80211_HW_SUPPORTS_PS:
995
* Hardware has power save support (i.e. can go to sleep).
997
* @IEEE80211_HW_PS_NULLFUNC_STACK:
998
* Hardware requires nullfunc frame handling in stack, implies
999
* stack support for dynamic PS.
1001
* @IEEE80211_HW_SUPPORTS_DYNAMIC_PS:
1002
* Hardware has support for dynamic PS.
1004
* @IEEE80211_HW_MFP_CAPABLE:
1005
* Hardware supports management frame protection (MFP, IEEE 802.11w).
1007
* @IEEE80211_HW_BEACON_FILTER:
1008
* Hardware supports dropping of irrelevant beacon frames to
1009
* avoid waking up cpu.
1011
* @IEEE80211_HW_SUPPORTS_STATIC_SMPS:
1012
* Hardware supports static spatial multiplexing powersave,
1013
* ie. can turn off all but one chain even on HT connections
1014
* that should be using more chains.
1016
* @IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS:
1017
* Hardware supports dynamic spatial multiplexing powersave,
1018
* ie. can turn off all but one chain and then wake the rest
1019
* up as required after, for example, rts/cts handshake.
1021
* @IEEE80211_HW_SUPPORTS_UAPSD:
1022
* Hardware supports Unscheduled Automatic Power Save Delivery
1023
* (U-APSD) in managed mode. The mode is configured with
1024
* conf_tx() operation.
1026
* @IEEE80211_HW_REPORTS_TX_ACK_STATUS:
1027
* Hardware can provide ack status reports of Tx frames to
1030
* @IEEE80211_HW_CONNECTION_MONITOR:
1031
* The hardware performs its own connection monitoring, including
1032
* periodic keep-alives to the AP and probing the AP on beacon loss.
1033
* When this flag is set, signaling beacon-loss will cause an immediate
1034
* change to disassociated state.
1036
* @IEEE80211_HW_SUPPORTS_CQM_RSSI:
1037
* Hardware can do connection quality monitoring - i.e. it can monitor
1038
* connection quality related parameters, such as the RSSI level and
1039
* provide notifications if configured trigger levels are reached.
1041
* @IEEE80211_HW_NEED_DTIM_PERIOD:
1042
* This device needs to know the DTIM period for the BSS before
1045
* @IEEE80211_HW_SUPPORTS_PER_STA_GTK: The device's crypto engine supports
1046
* per-station GTKs as used by IBSS RSN or during fast transition. If
1047
* the device doesn't support per-station GTKs, but can be asked not
1048
* to decrypt group addressed frames, then IBSS RSN support is still
1049
* possible but software crypto will be used. Advertise the wiphy flag
1050
* only in that case.
1052
enum ieee80211_hw_flags {
1053
IEEE80211_HW_HAS_RATE_CONTROL = 1<<0,
1054
IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
1055
IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
1056
IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
1057
IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
1058
IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
1059
IEEE80211_HW_SIGNAL_DBM = 1<<6,
1060
IEEE80211_HW_NEED_DTIM_PERIOD = 1<<7,
1061
IEEE80211_HW_SPECTRUM_MGMT = 1<<8,
1062
IEEE80211_HW_AMPDU_AGGREGATION = 1<<9,
1063
IEEE80211_HW_SUPPORTS_PS = 1<<10,
1064
IEEE80211_HW_PS_NULLFUNC_STACK = 1<<11,
1065
IEEE80211_HW_SUPPORTS_DYNAMIC_PS = 1<<12,
1066
IEEE80211_HW_MFP_CAPABLE = 1<<13,
1067
IEEE80211_HW_BEACON_FILTER = 1<<14,
1068
IEEE80211_HW_SUPPORTS_STATIC_SMPS = 1<<15,
1069
IEEE80211_HW_SUPPORTS_DYNAMIC_SMPS = 1<<16,
1070
IEEE80211_HW_SUPPORTS_UAPSD = 1<<17,
1071
IEEE80211_HW_REPORTS_TX_ACK_STATUS = 1<<18,
1072
IEEE80211_HW_CONNECTION_MONITOR = 1<<19,
1073
IEEE80211_HW_SUPPORTS_CQM_RSSI = 1<<20,
1074
IEEE80211_HW_SUPPORTS_PER_STA_GTK = 1<<21,
1078
* struct ieee80211_hw - hardware information and state
1080
* This structure contains the configuration and hardware
1081
* information for an 802.11 PHY.
1083
* @wiphy: This points to the &struct wiphy allocated for this
1084
* 802.11 PHY. You must fill in the @perm_addr and @dev
1085
* members of this structure using SET_IEEE80211_DEV()
1086
* and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
1087
* bands (with channels, bitrates) are registered here.
1089
* @conf: &struct ieee80211_conf, device configuration, don't use.
1091
* @priv: pointer to private area that was allocated for driver use
1092
* along with this structure.
1094
* @flags: hardware flags, see &enum ieee80211_hw_flags.
1096
* @extra_tx_headroom: headroom to reserve in each transmit skb
1097
* for use by the driver (e.g. for transmit headers.)
1099
* @channel_change_time: time (in microseconds) it takes to change channels.
1101
* @max_signal: Maximum value for signal (rssi) in RX information, used
1102
* only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
1104
* @max_listen_interval: max listen interval in units of beacon interval
1107
* @queues: number of available hardware transmit queues for
1108
* data packets. WMM/QoS requires at least four, these
1109
* queues need to have configurable access parameters.
1111
* @rate_control_algorithm: rate control algorithm for this hardware.
1112
* If unset (NULL), the default algorithm will be used. Must be
1113
* set before calling ieee80211_register_hw().
1115
* @vif_data_size: size (in bytes) of the drv_priv data area
1116
* within &struct ieee80211_vif.
1117
* @sta_data_size: size (in bytes) of the drv_priv data area
1118
* within &struct ieee80211_sta.
1120
* @max_rates: maximum number of alternate rate retry stages the hw
1122
* @max_report_rates: maximum number of alternate rate retry stages
1123
* the hw can report back.
1124
* @max_rate_tries: maximum number of tries for each stage
1126
* @napi_weight: weight used for NAPI polling. You must specify an
1127
* appropriate value here if a napi_poll operation is provided
1130
struct ieee80211_hw {
1131
struct ieee80211_conf conf;
1132
struct wiphy *wiphy;
1133
const char *rate_control_algorithm;
1136
unsigned int extra_tx_headroom;
1137
int channel_change_time;
1142
u16 max_listen_interval;
1145
u8 max_report_rates;
1150
* wiphy_to_ieee80211_hw - return a mac80211 driver hw struct from a wiphy
1152
* @wiphy: the &struct wiphy which we want to query
1154
* mac80211 drivers can use this to get to their respective
1155
* &struct ieee80211_hw. Drivers wishing to get to their own private
1156
* structure can then access it via hw->priv. Note that mac802111 drivers should
1157
* not use wiphy_priv() to try to get their private driver structure as this
1158
* is already used internally by mac80211.
1160
struct ieee80211_hw *wiphy_to_ieee80211_hw(struct wiphy *wiphy);
1163
* SET_IEEE80211_DEV - set device for 802.11 hardware
1165
* @hw: the &struct ieee80211_hw to set the device for
1166
* @dev: the &struct device of this 802.11 device
1168
static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
1170
set_wiphy_dev(hw->wiphy, dev);
1174
* SET_IEEE80211_PERM_ADDR - set the permanent MAC address for 802.11 hardware
1176
* @hw: the &struct ieee80211_hw to set the MAC address for
1177
* @addr: the address to set
1179
static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
1181
memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
1184
static inline struct ieee80211_rate *
1185
ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
1186
const struct ieee80211_tx_info *c)
1188
if (WARN_ON(c->control.rates[0].idx < 0))
1190
return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[0].idx];
1193
static inline struct ieee80211_rate *
1194
ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
1195
const struct ieee80211_tx_info *c)
1197
if (c->control.rts_cts_rate_idx < 0)
1199
return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
1202
static inline struct ieee80211_rate *
1203
ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
1204
const struct ieee80211_tx_info *c, int idx)
1206
if (c->control.rates[idx + 1].idx < 0)
1208
return &hw->wiphy->bands[c->band]->bitrates[c->control.rates[idx + 1].idx];
1212
* DOC: Hardware crypto acceleration
1214
* mac80211 is capable of taking advantage of many hardware
1215
* acceleration designs for encryption and decryption operations.
1217
* The set_key() callback in the &struct ieee80211_ops for a given
1218
* device is called to enable hardware acceleration of encryption and
1219
* decryption. The callback takes a @sta parameter that will be NULL
1220
* for default keys or keys used for transmission only, or point to
1221
* the station information for the peer for individual keys.
1222
* Multiple transmission keys with the same key index may be used when
1223
* VLANs are configured for an access point.
1225
* When transmitting, the TX control data will use the @hw_key_idx
1226
* selected by the driver by modifying the &struct ieee80211_key_conf
1227
* pointed to by the @key parameter to the set_key() function.
1229
* The set_key() call for the %SET_KEY command should return 0 if
1230
* the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
1231
* added; if you return 0 then hw_key_idx must be assigned to the
1232
* hardware key index, you are free to use the full u8 range.
1234
* When the cmd is %DISABLE_KEY then it must succeed.
1236
* Note that it is permissible to not decrypt a frame even if a key
1237
* for it has been uploaded to hardware, the stack will not make any
1238
* decision based on whether a key has been uploaded or not but rather
1239
* based on the receive flags.
1241
* The &struct ieee80211_key_conf structure pointed to by the @key
1242
* parameter is guaranteed to be valid until another call to set_key()
1243
* removes it, but it can only be used as a cookie to differentiate
1246
* In TKIP some HW need to be provided a phase 1 key, for RX decryption
1247
* acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
1249
* The update_tkip_key() call updates the driver with the new phase 1 key.
1250
* This happens everytime the iv16 wraps around (every 65536 packets). The
1251
* set_key() call will happen only once for each key (unless the AP did
1252
* rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
1253
* provided by update_tkip_key only. The trigger that makes mac80211 call this
1254
* handler is software decryption with wrap around of iv16.
1258
* DOC: Powersave support
1260
* mac80211 has support for various powersave implementations.
1262
* First, it can support hardware that handles all powersaving by itself,
1263
* such hardware should simply set the %IEEE80211_HW_SUPPORTS_PS hardware
1264
* flag. In that case, it will be told about the desired powersave mode
1265
* with the %IEEE80211_CONF_PS flag depending on the association status.
1266
* The hardware must take care of sending nullfunc frames when necessary,
1267
* i.e. when entering and leaving powersave mode. The hardware is required
1268
* to look at the AID in beacons and signal to the AP that it woke up when
1269
* it finds traffic directed to it.
1271
* %IEEE80211_CONF_PS flag enabled means that the powersave mode defined in
1272
* IEEE 802.11-2007 section 11.2 is enabled. This is not to be confused
1273
* with hardware wakeup and sleep states. Driver is responsible for waking
1274
* up the hardware before issuing commands to the hardware and putting it
1275
* back to sleep at appropriate times.
1277
* When PS is enabled, hardware needs to wakeup for beacons and receive the
1278
* buffered multicast/broadcast frames after the beacon. Also it must be
1279
* possible to send frames and receive the acknowledment frame.
1281
* Other hardware designs cannot send nullfunc frames by themselves and also
1282
* need software support for parsing the TIM bitmap. This is also supported
1283
* by mac80211 by combining the %IEEE80211_HW_SUPPORTS_PS and
1284
* %IEEE80211_HW_PS_NULLFUNC_STACK flags. The hardware is of course still
1285
* required to pass up beacons. The hardware is still required to handle
1286
* waking up for multicast traffic; if it cannot the driver must handle that
1287
* as best as it can, mac80211 is too slow to do that.
1289
* Dynamic powersave is an extension to normal powersave in which the
1290
* hardware stays awake for a user-specified period of time after sending a
1291
* frame so that reply frames need not be buffered and therefore delayed to
1292
* the next wakeup. It's compromise of getting good enough latency when
1293
* there's data traffic and still saving significantly power in idle
1296
* Dynamic powersave is simply supported by mac80211 enabling and disabling
1297
* PS based on traffic. Driver needs to only set %IEEE80211_HW_SUPPORTS_PS
1298
* flag and mac80211 will handle everything automatically. Additionally,
1299
* hardware having support for the dynamic PS feature may set the
1300
* %IEEE80211_HW_SUPPORTS_DYNAMIC_PS flag to indicate that it can support
1301
* dynamic PS mode itself. The driver needs to look at the
1302
* @dynamic_ps_timeout hardware configuration value and use it that value
1303
* whenever %IEEE80211_CONF_PS is set. In this case mac80211 will disable
1304
* dynamic PS feature in stack and will just keep %IEEE80211_CONF_PS
1305
* enabled whenever user has enabled powersave.
1307
* Some hardware need to toggle a single shared antenna between WLAN and
1308
* Bluetooth to facilitate co-existence. These types of hardware set
1309
* limitations on the use of host controlled dynamic powersave whenever there
1310
* is simultaneous WLAN and Bluetooth traffic. For these types of hardware, the
1311
* driver may request temporarily going into full power save, in order to
1312
* enable toggling the antenna between BT and WLAN. If the driver requests
1313
* disabling dynamic powersave, the @dynamic_ps_timeout value will be
1314
* temporarily set to zero until the driver re-enables dynamic powersave.
1316
* Driver informs U-APSD client support by enabling
1317
* %IEEE80211_HW_SUPPORTS_UAPSD flag. The mode is configured through the
1318
* uapsd paramater in conf_tx() operation. Hardware needs to send the QoS
1319
* Nullfunc frames and stay awake until the service period has ended. To
1320
* utilize U-APSD, dynamic powersave is disabled for voip AC and all frames
1321
* from that AC are transmitted with powersave enabled.
1323
* Note: U-APSD client mode is not yet supported with
1324
* %IEEE80211_HW_PS_NULLFUNC_STACK.
1328
* DOC: Beacon filter support
1330
* Some hardware have beacon filter support to reduce host cpu wakeups
1331
* which will reduce system power consumption. It usuallly works so that
1332
* the firmware creates a checksum of the beacon but omits all constantly
1333
* changing elements (TSF, TIM etc). Whenever the checksum changes the
1334
* beacon is forwarded to the host, otherwise it will be just dropped. That
1335
* way the host will only receive beacons where some relevant information
1336
* (for example ERP protection or WMM settings) have changed.
1338
* Beacon filter support is advertised with the %IEEE80211_HW_BEACON_FILTER
1339
* hardware capability. The driver needs to enable beacon filter support
1340
* whenever power save is enabled, that is %IEEE80211_CONF_PS is set. When
1341
* power save is enabled, the stack will not check for beacon loss and the
1342
* driver needs to notify about loss of beacons with ieee80211_beacon_loss().
1344
* The time (or number of beacons missed) until the firmware notifies the
1345
* driver of a beacon loss event (which in turn causes the driver to call
1346
* ieee80211_beacon_loss()) should be configurable and will be controlled
1347
* by mac80211 and the roaming algorithm in the future.
1349
* Since there may be constantly changing information elements that nothing
1350
* in the software stack cares about, we will, in the future, have mac80211
1351
* tell the driver which information elements are interesting in the sense
1352
* that we want to see changes in them. This will include
1353
* - a list of information element IDs
1354
* - a list of OUIs for the vendor information element
1356
* Ideally, the hardware would filter out any beacons without changes in the
1357
* requested elements, but if it cannot support that it may, at the expense
1358
* of some efficiency, filter out only a subset. For example, if the device
1359
* doesn't support checking for OUIs it should pass up all changes in all
1360
* vendor information elements.
1362
* Note that change, for the sake of simplification, also includes information
1363
* elements appearing or disappearing from the beacon.
1365
* Some hardware supports an "ignore list" instead, just make sure nothing
1366
* that was requested is on the ignore list, and include commonly changing
1367
* information element IDs in the ignore list, for example 11 (BSS load) and
1368
* the various vendor-assigned IEs with unknown contents (128, 129, 133-136,
1369
* 149, 150, 155, 156, 173, 176, 178, 179, 219); for forward compatibility
1370
* it could also include some currently unused IDs.
1373
* In addition to these capabilities, hardware should support notifying the
1374
* host of changes in the beacon RSSI. This is relevant to implement roaming
1375
* when no traffic is flowing (when traffic is flowing we see the RSSI of
1376
* the received data packets). This can consist in notifying the host when
1377
* the RSSI changes significantly or when it drops below or rises above
1378
* configurable thresholds. In the future these thresholds will also be
1379
* configured by mac80211 (which gets them from userspace) to implement
1380
* them as the roaming algorithm requires.
1382
* If the hardware cannot implement this, the driver should ask it to
1383
* periodically pass beacon frames to the host so that software can do the
1384
* signal strength threshold checking.
1388
* DOC: Spatial multiplexing power save
1390
* SMPS (Spatial multiplexing power save) is a mechanism to conserve
1391
* power in an 802.11n implementation. For details on the mechanism
1392
* and rationale, please refer to 802.11 (as amended by 802.11n-2009)
1393
* "11.2.3 SM power save".
1395
* The mac80211 implementation is capable of sending action frames
1396
* to update the AP about the station's SMPS mode, and will instruct
1397
* the driver to enter the specific mode. It will also announce the
1398
* requested SMPS mode during the association handshake. Hardware
1399
* support for this feature is required, and can be indicated by
1402
* The default mode will be "automatic", which nl80211/cfg80211
1403
* defines to be dynamic SMPS in (regular) powersave, and SMPS
1404
* turned off otherwise.
1406
* To support this feature, the driver must set the appropriate
1407
* hardware support flags, and handle the SMPS flag to the config()
1408
* operation. It will then with this mechanism be instructed to
1409
* enter the requested SMPS mode while associated to an HT AP.
1413
* DOC: Frame filtering
1415
* mac80211 requires to see many management frames for proper
1416
* operation, and users may want to see many more frames when
1417
* in monitor mode. However, for best CPU usage and power consumption,
1418
* having as few frames as possible percolate through the stack is
1419
* desirable. Hence, the hardware should filter as much as possible.
1421
* To achieve this, mac80211 uses filter flags (see below) to tell
1422
* the driver's configure_filter() function which frames should be
1423
* passed to mac80211 and which should be filtered out.
1425
* Before configure_filter() is invoked, the prepare_multicast()
1426
* callback is invoked with the parameters @mc_count and @mc_list
1427
* for the combined multicast address list of all virtual interfaces.
1428
* It's use is optional, and it returns a u64 that is passed to
1429
* configure_filter(). Additionally, configure_filter() has the
1430
* arguments @changed_flags telling which flags were changed and
1431
* @total_flags with the new flag states.
1433
* If your device has no multicast address filters your driver will
1434
* need to check both the %FIF_ALLMULTI flag and the @mc_count
1435
* parameter to see whether multicast frames should be accepted
1438
* All unsupported flags in @total_flags must be cleared.
1439
* Hardware does not support a flag if it is incapable of _passing_
1440
* the frame to the stack. Otherwise the driver must ignore
1441
* the flag, but not clear it.
1442
* You must _only_ clear the flag (announce no support for the
1443
* flag to mac80211) if you are not able to pass the packet type
1444
* to the stack (so the hardware always filters it).
1445
* So for example, you should clear @FIF_CONTROL, if your hardware
1446
* always filters control frames. If your hardware always passes
1447
* control frames to the kernel and is incapable of filtering them,
1448
* you do _not_ clear the @FIF_CONTROL flag.
1449
* This rule applies to all other FIF flags as well.
1453
* enum ieee80211_filter_flags - hardware filter flags
1455
* These flags determine what the filter in hardware should be
1456
* programmed to let through and what should not be passed to the
1457
* stack. It is always safe to pass more frames than requested,
1458
* but this has negative impact on power consumption.
1460
* @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1461
* think of the BSS as your network segment and then this corresponds
1462
* to the regular ethernet device promiscuous mode.
1464
* @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1465
* by the user or if the hardware is not capable of filtering by
1466
* multicast address.
1468
* @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1469
* %RX_FLAG_FAILED_FCS_CRC for them)
1471
* @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1472
* the %RX_FLAG_FAILED_PLCP_CRC for them
1474
* @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1475
* to the hardware that it should not filter beacons or probe responses
1476
* by BSSID. Filtering them can greatly reduce the amount of processing
1477
* mac80211 needs to do and the amount of CPU wakeups, so you should
1478
* honour this flag if possible.
1480
* @FIF_CONTROL: pass control frames (except for PS Poll), if PROMISC_IN_BSS
1481
* is not set then only those addressed to this station.
1483
* @FIF_OTHER_BSS: pass frames destined to other BSSes
1485
* @FIF_PSPOLL: pass PS Poll frames, if PROMISC_IN_BSS is not set then only
1486
* those addressed to this station.
1488
* @FIF_PROBE_REQ: pass probe request frames
1490
enum ieee80211_filter_flags {
1491
FIF_PROMISC_IN_BSS = 1<<0,
1492
FIF_ALLMULTI = 1<<1,
1494
FIF_PLCPFAIL = 1<<3,
1495
FIF_BCN_PRBRESP_PROMISC = 1<<4,
1497
FIF_OTHER_BSS = 1<<6,
1499
FIF_PROBE_REQ = 1<<8,
1503
* enum ieee80211_ampdu_mlme_action - A-MPDU actions
1505
* These flags are used with the ampdu_action() callback in
1506
* &struct ieee80211_ops to indicate which action is needed.
1508
* Note that drivers MUST be able to deal with a TX aggregation
1509
* session being stopped even before they OK'ed starting it by
1510
* calling ieee80211_start_tx_ba_cb_irqsafe, because the peer
1511
* might receive the addBA frame and send a delBA right away!
1513
* @IEEE80211_AMPDU_RX_START: start Rx aggregation
1514
* @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1515
* @IEEE80211_AMPDU_TX_START: start Tx aggregation
1516
* @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1517
* @IEEE80211_AMPDU_TX_OPERATIONAL: TX aggregation has become operational
1519
enum ieee80211_ampdu_mlme_action {
1520
IEEE80211_AMPDU_RX_START,
1521
IEEE80211_AMPDU_RX_STOP,
1522
IEEE80211_AMPDU_TX_START,
1523
IEEE80211_AMPDU_TX_STOP,
1524
IEEE80211_AMPDU_TX_OPERATIONAL,
1528
* struct ieee80211_ops - callbacks from mac80211 to the driver
1530
* This structure contains various callbacks that the driver may
1531
* handle or, in some cases, must handle, for example to configure
1532
* the hardware to a new channel or to transmit a frame.
1534
* @tx: Handler that 802.11 module calls for each transmitted frame.
1535
* skb contains the buffer starting from the IEEE 802.11 header.
1536
* The low-level driver should send the frame out based on
1537
* configuration in the TX control data. This handler should,
1538
* preferably, never fail and stop queues appropriately, more
1539
* importantly, however, it must never fail for A-MPDU-queues.
1540
* This function should return NETDEV_TX_OK except in very
1542
* Must be implemented and atomic.
1544
* @start: Called before the first netdevice attached to the hardware
1545
* is enabled. This should turn on the hardware and must turn on
1546
* frame reception (for possibly enabled monitor interfaces.)
1547
* Returns negative error codes, these may be seen in userspace,
1549
* When the device is started it should not have a MAC address
1550
* to avoid acknowledging frames before a non-monitor device
1552
* Must be implemented and can sleep.
1554
* @stop: Called after last netdevice attached to the hardware
1555
* is disabled. This should turn off the hardware (at least
1556
* it must turn off frame reception.)
1557
* May be called right after add_interface if that rejects
1558
* an interface. If you added any work onto the mac80211 workqueue
1559
* you should ensure to cancel it on this callback.
1560
* Must be implemented and can sleep.
1562
* @add_interface: Called when a netdevice attached to the hardware is
1563
* enabled. Because it is not called for monitor mode devices, @start
1564
* and @stop must be implemented.
1565
* The driver should perform any initialization it needs before
1566
* the device can be enabled. The initial configuration for the
1567
* interface is given in the conf parameter.
1568
* The callback may refuse to add an interface by returning a
1569
* negative error code (which will be seen in userspace.)
1570
* Must be implemented and can sleep.
1572
* @change_interface: Called when a netdevice changes type. This callback
1573
* is optional, but only if it is supported can interface types be
1574
* switched while the interface is UP. The callback may sleep.
1575
* Note that while an interface is being switched, it will not be
1576
* found by the interface iteration callbacks.
1578
* @remove_interface: Notifies a driver that an interface is going down.
1579
* The @stop callback is called after this if it is the last interface
1580
* and no monitor interfaces are present.
1581
* When all interfaces are removed, the MAC address in the hardware
1582
* must be cleared so the device no longer acknowledges packets,
1583
* the mac_addr member of the conf structure is, however, set to the
1584
* MAC address of the device going away.
1585
* Hence, this callback must be implemented. It can sleep.
1587
* @config: Handler for configuration requests. IEEE 802.11 code calls this
1588
* function to change hardware configuration, e.g., channel.
1589
* This function should never fail but returns a negative error code
1590
* if it does. The callback can sleep.
1592
* @bss_info_changed: Handler for configuration requests related to BSS
1593
* parameters that may vary during BSS's lifespan, and may affect low
1594
* level driver (e.g. assoc/disassoc status, erp parameters).
1595
* This function should not be used if no BSS has been set, unless
1596
* for association indication. The @changed parameter indicates which
1597
* of the bss parameters has changed when a call is made. The callback
1600
* @prepare_multicast: Prepare for multicast filter configuration.
1601
* This callback is optional, and its return value is passed
1602
* to configure_filter(). This callback must be atomic.
1604
* @configure_filter: Configure the device's RX filter.
1605
* See the section "Frame filtering" for more information.
1606
* This callback must be implemented and can sleep.
1608
* @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1609
* must be set or cleared for a given STA. Must be atomic.
1611
* @set_key: See the section "Hardware crypto acceleration"
1612
* This callback is only called between add_interface and
1613
* remove_interface calls, i.e. while the given virtual interface
1615
* Returns a negative error code if the key can't be added.
1616
* The callback can sleep.
1618
* @update_tkip_key: See the section "Hardware crypto acceleration"
1619
* This callback will be called in the context of Rx. Called for drivers
1620
* which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1621
* The callback must be atomic.
1623
* @hw_scan: Ask the hardware to service the scan request, no need to start
1624
* the scan state machine in stack. The scan must honour the channel
1625
* configuration done by the regulatory agent in the wiphy's
1626
* registered bands. The hardware (or the driver) needs to make sure
1627
* that power save is disabled.
1628
* The @req ie/ie_len members are rewritten by mac80211 to contain the
1629
* entire IEs after the SSID, so that drivers need not look at these
1630
* at all but just send them after the SSID -- mac80211 includes the
1631
* (extended) supported rates and HT information (where applicable).
1632
* When the scan finishes, ieee80211_scan_completed() must be called;
1633
* note that it also must be called when the scan cannot finish due to
1634
* any error unless this callback returned a negative error code.
1635
* The callback can sleep.
1637
* @sw_scan_start: Notifier function that is called just before a software scan
1638
* is started. Can be NULL, if the driver doesn't need this notification.
1639
* The callback can sleep.
1641
* @sw_scan_complete: Notifier function that is called just after a
1642
* software scan finished. Can be NULL, if the driver doesn't need
1643
* this notification.
1644
* The callback can sleep.
1646
* @get_stats: Return low-level statistics.
1647
* Returns zero if statistics are available.
1648
* The callback can sleep.
1650
* @get_tkip_seq: If your device implements TKIP encryption in hardware this
1651
* callback should be provided to read the TKIP transmit IVs (both IV32
1652
* and IV16) for the given key from hardware.
1653
* The callback must be atomic.
1655
* @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1656
* The callback can sleep.
1658
* @sta_add: Notifies low level driver about addition of an associated station,
1659
* AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1661
* @sta_remove: Notifies low level driver about removal of an associated
1662
* station, AP, IBSS/WDS/mesh peer etc. This callback can sleep.
1664
* @sta_notify: Notifies low level driver about power state transition of an
1665
* associated station, AP, IBSS/WDS/mesh peer etc. Must be atomic.
1667
* @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1668
* bursting) for a hardware TX queue.
1669
* Returns a negative error code on failure.
1670
* The callback can sleep.
1672
* @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1673
* this is only used for IBSS mode BSSID merging and debugging. Is not a
1674
* required function.
1675
* The callback can sleep.
1677
* @set_tsf: Set the TSF timer to the specified value in the firmware/hardware.
1678
* Currently, this is only used for IBSS mode debugging. Is not a
1679
* required function.
1680
* The callback can sleep.
1682
* @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1683
* with other STAs in the IBSS. This is only used in IBSS mode. This
1684
* function is optional if the firmware/hardware takes full care of
1685
* TSF synchronization.
1686
* The callback can sleep.
1688
* @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1689
* This is needed only for IBSS mode and the result of this function is
1690
* used to determine whether to reply to Probe Requests.
1691
* Returns non-zero if this device sent the last beacon.
1692
* The callback can sleep.
1694
* @ampdu_action: Perform a certain A-MPDU action
1695
* The RA/TID combination determines the destination and TID we want
1696
* the ampdu action to be performed for. The action is defined through
1697
* ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1698
* is the first frame we expect to perform the action on. Notice
1699
* that TX/RX_STOP can pass NULL for this parameter.
1700
* Returns a negative error code on failure.
1701
* The callback can sleep.
1703
* @get_survey: Return per-channel survey information
1705
* @rfkill_poll: Poll rfkill hardware state. If you need this, you also
1706
* need to set wiphy->rfkill_poll to %true before registration,
1707
* and need to call wiphy_rfkill_set_hw_state() in the callback.
1708
* The callback can sleep.
1710
* @set_coverage_class: Set slot time for given coverage class as specified
1711
* in IEEE 802.11-2007 section 17.3.8.6 and modify ACK timeout
1712
* accordingly. This callback is not required and may sleep.
1714
* @testmode_cmd: Implement a cfg80211 test mode command.
1715
* The callback can sleep.
1717
* @flush: Flush all pending frames from the hardware queue, making sure
1718
* that the hardware queues are empty. If the parameter @drop is set
1719
* to %true, pending frames may be dropped. The callback can sleep.
1721
* @channel_switch: Drivers that need (or want) to offload the channel
1722
* switch operation for CSAs received from the AP may implement this
1723
* callback. They must then call ieee80211_chswitch_done() to indicate
1724
* completion of the channel switch.
1726
* @napi_poll: Poll Rx queue for incoming data frames.
1728
struct ieee80211_ops {
1729
int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1730
int (*start)(struct ieee80211_hw *hw);
1731
void (*stop)(struct ieee80211_hw *hw);
1732
int (*add_interface)(struct ieee80211_hw *hw,
1733
struct ieee80211_vif *vif);
1734
int (*change_interface)(struct ieee80211_hw *hw,
1735
struct ieee80211_vif *vif,
1736
enum nl80211_iftype new_type, bool p2p);
1737
void (*remove_interface)(struct ieee80211_hw *hw,
1738
struct ieee80211_vif *vif);
1739
int (*config)(struct ieee80211_hw *hw, u32 changed);
1740
void (*bss_info_changed)(struct ieee80211_hw *hw,
1741
struct ieee80211_vif *vif,
1742
struct ieee80211_bss_conf *info,
1744
u64 (*prepare_multicast)(struct ieee80211_hw *hw,
1745
#if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35))
1746
struct netdev_hw_addr_list *mc_list);
1748
int mc_count, struct dev_addr_list *mc_list);
1750
void (*configure_filter)(struct ieee80211_hw *hw,
1751
unsigned int changed_flags,
1752
unsigned int *total_flags,
1754
int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1756
int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1757
struct ieee80211_vif *vif, struct ieee80211_sta *sta,
1758
struct ieee80211_key_conf *key);
1759
void (*update_tkip_key)(struct ieee80211_hw *hw,
1760
struct ieee80211_vif *vif,
1761
struct ieee80211_key_conf *conf,
1762
struct ieee80211_sta *sta,
1763
u32 iv32, u16 *phase1key);
1764
int (*hw_scan)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1765
struct cfg80211_scan_request *req);
1766
void (*sw_scan_start)(struct ieee80211_hw *hw);
1767
void (*sw_scan_complete)(struct ieee80211_hw *hw);
1768
int (*get_stats)(struct ieee80211_hw *hw,
1769
struct ieee80211_low_level_stats *stats);
1770
void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1771
u32 *iv32, u16 *iv16);
1772
int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1773
int (*sta_add)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1774
struct ieee80211_sta *sta);
1775
int (*sta_remove)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1776
struct ieee80211_sta *sta);
1777
void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1778
enum sta_notify_cmd, struct ieee80211_sta *sta);
1779
int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
1780
const struct ieee80211_tx_queue_params *params);
1781
u64 (*get_tsf)(struct ieee80211_hw *hw);
1782
void (*set_tsf)(struct ieee80211_hw *hw, u64 tsf);
1783
void (*reset_tsf)(struct ieee80211_hw *hw);
1784
int (*tx_last_beacon)(struct ieee80211_hw *hw);
1785
int (*ampdu_action)(struct ieee80211_hw *hw,
1786
struct ieee80211_vif *vif,
1787
enum ieee80211_ampdu_mlme_action action,
1788
struct ieee80211_sta *sta, u16 tid, u16 *ssn);
1789
int (*get_survey)(struct ieee80211_hw *hw, int idx,
1790
struct survey_info *survey);
1791
void (*rfkill_poll)(struct ieee80211_hw *hw);
1792
void (*set_coverage_class)(struct ieee80211_hw *hw, u8 coverage_class);
1793
#ifdef CONFIG_NL80211_TESTMODE
1794
int (*testmode_cmd)(struct ieee80211_hw *hw, void *data, int len);
1796
void (*flush)(struct ieee80211_hw *hw, bool drop);
1797
void (*channel_switch)(struct ieee80211_hw *hw,
1798
struct ieee80211_channel_switch *ch_switch);
1799
int (*napi_poll)(struct ieee80211_hw *hw, int budget);
1803
* ieee80211_alloc_hw - Allocate a new hardware device
1805
* This must be called once for each hardware device. The returned pointer
1806
* must be used to refer to this device when calling other functions.
1807
* mac80211 allocates a private data area for the driver pointed to by
1808
* @priv in &struct ieee80211_hw, the size of this area is given as
1811
* @priv_data_len: length of private data
1812
* @ops: callbacks for this device
1814
struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1815
const struct ieee80211_ops *ops);
1818
* ieee80211_register_hw - Register hardware device
1820
* You must call this function before any other functions in
1821
* mac80211. Note that before a hardware can be registered, you
1822
* need to fill the contained wiphy's information.
1824
* @hw: the device to register as returned by ieee80211_alloc_hw()
1826
int ieee80211_register_hw(struct ieee80211_hw *hw);
1828
#ifdef CONFIG_MAC80211_LEDS
1829
extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1830
extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1831
extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1832
extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1835
* ieee80211_get_tx_led_name - get name of TX LED
1837
* mac80211 creates a transmit LED trigger for each wireless hardware
1838
* that can be used to drive LEDs if your driver registers a LED device.
1839
* This function returns the name (or %NULL if not configured for LEDs)
1840
* of the trigger so you can automatically link the LED device.
1842
* @hw: the hardware to get the LED trigger name for
1844
static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1846
#ifdef CONFIG_MAC80211_LEDS
1847
return __ieee80211_get_tx_led_name(hw);
1854
* ieee80211_get_rx_led_name - get name of RX LED
1856
* mac80211 creates a receive LED trigger for each wireless hardware
1857
* that can be used to drive LEDs if your driver registers a LED device.
1858
* This function returns the name (or %NULL if not configured for LEDs)
1859
* of the trigger so you can automatically link the LED device.
1861
* @hw: the hardware to get the LED trigger name for
1863
static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1865
#ifdef CONFIG_MAC80211_LEDS
1866
return __ieee80211_get_rx_led_name(hw);
1873
* ieee80211_get_assoc_led_name - get name of association LED
1875
* mac80211 creates a association LED trigger for each wireless hardware
1876
* that can be used to drive LEDs if your driver registers a LED device.
1877
* This function returns the name (or %NULL if not configured for LEDs)
1878
* of the trigger so you can automatically link the LED device.
1880
* @hw: the hardware to get the LED trigger name for
1882
static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1884
#ifdef CONFIG_MAC80211_LEDS
1885
return __ieee80211_get_assoc_led_name(hw);
1892
* ieee80211_get_radio_led_name - get name of radio LED
1894
* mac80211 creates a radio change LED trigger for each wireless hardware
1895
* that can be used to drive LEDs if your driver registers a LED device.
1896
* This function returns the name (or %NULL if not configured for LEDs)
1897
* of the trigger so you can automatically link the LED device.
1899
* @hw: the hardware to get the LED trigger name for
1901
static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1903
#ifdef CONFIG_MAC80211_LEDS
1904
return __ieee80211_get_radio_led_name(hw);
1911
* ieee80211_unregister_hw - Unregister a hardware device
1913
* This function instructs mac80211 to free allocated resources
1914
* and unregister netdevices from the networking subsystem.
1916
* @hw: the hardware to unregister
1918
void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1921
* ieee80211_free_hw - free hardware descriptor
1923
* This function frees everything that was allocated, including the
1924
* private data for the driver. You must call ieee80211_unregister_hw()
1925
* before calling this function.
1927
* @hw: the hardware to free
1929
void ieee80211_free_hw(struct ieee80211_hw *hw);
1932
* ieee80211_restart_hw - restart hardware completely
1934
* Call this function when the hardware was restarted for some reason
1935
* (hardware error, ...) and the driver is unable to restore its state
1936
* by itself. mac80211 assumes that at this point the driver/hardware
1937
* is completely uninitialised and stopped, it starts the process by
1938
* calling the ->start() operation. The driver will need to reset all
1939
* internal state that it has prior to calling this function.
1941
* @hw: the hardware to restart
1943
void ieee80211_restart_hw(struct ieee80211_hw *hw);
1945
/** ieee80211_napi_schedule - schedule NAPI poll
1947
* Use this function to schedule NAPI polling on a device.
1949
* @hw: the hardware to start polling
1951
void ieee80211_napi_schedule(struct ieee80211_hw *hw);
1953
/** ieee80211_napi_complete - complete NAPI polling
1955
* Use this function to finish NAPI polling on a device.
1957
* @hw: the hardware to stop polling
1959
void ieee80211_napi_complete(struct ieee80211_hw *hw);
1962
* ieee80211_rx - receive frame
1964
* Use this function to hand received frames to mac80211. The receive
1965
* buffer in @skb must start with an IEEE 802.11 header. In case of a
1966
* paged @skb is used, the driver is recommended to put the ieee80211
1967
* header of the frame on the linear part of the @skb to avoid memory
1968
* allocation and/or memcpy by the stack.
1970
* This function may not be called in IRQ context. Calls to this function
1971
* for a single hardware must be synchronized against each other. Calls to
1972
* this function, ieee80211_rx_ni() and ieee80211_rx_irqsafe() may not be
1973
* mixed for a single hardware.
1975
* In process context use instead ieee80211_rx_ni().
1977
* @hw: the hardware this frame came in on
1978
* @skb: the buffer to receive, owned by mac80211 after this call
1980
void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb);
1983
* ieee80211_rx_irqsafe - receive frame
1985
* Like ieee80211_rx() but can be called in IRQ context
1986
* (internally defers to a tasklet.)
1988
* Calls to this function, ieee80211_rx() or ieee80211_rx_ni() may not
1989
* be mixed for a single hardware.
1991
* @hw: the hardware this frame came in on
1992
* @skb: the buffer to receive, owned by mac80211 after this call
1994
void ieee80211_rx_irqsafe(struct ieee80211_hw *hw, struct sk_buff *skb);
1997
* ieee80211_rx_ni - receive frame (in process context)
1999
* Like ieee80211_rx() but can be called in process context
2000
* (internally disables bottom halves).
2002
* Calls to this function, ieee80211_rx() and ieee80211_rx_irqsafe() may
2003
* not be mixed for a single hardware.
2005
* @hw: the hardware this frame came in on
2006
* @skb: the buffer to receive, owned by mac80211 after this call
2008
static inline void ieee80211_rx_ni(struct ieee80211_hw *hw,
2009
struct sk_buff *skb)
2012
ieee80211_rx(hw, skb);
2017
* The TX headroom reserved by mac80211 for its own tx_status functions.
2018
* This is enough for the radiotap header.
2020
#define IEEE80211_TX_STATUS_HEADROOM 13
2023
* ieee80211_tx_status - transmit status callback
2025
* Call this function for all transmitted frames after they have been
2026
* transmitted. It is permissible to not call this function for
2027
* multicast frames but this can affect statistics.
2029
* This function may not be called in IRQ context. Calls to this function
2030
* for a single hardware must be synchronized against each other. Calls
2031
* to this function, ieee80211_tx_status_ni() and ieee80211_tx_status_irqsafe()
2032
* may not be mixed for a single hardware.
2034
* @hw: the hardware the frame was transmitted by
2035
* @skb: the frame that was transmitted, owned by mac80211 after this call
2037
void ieee80211_tx_status(struct ieee80211_hw *hw,
2038
struct sk_buff *skb);
2041
* ieee80211_tx_status_ni - transmit status callback (in process context)
2043
* Like ieee80211_tx_status() but can be called in process context.
2045
* Calls to this function, ieee80211_tx_status() and
2046
* ieee80211_tx_status_irqsafe() may not be mixed
2047
* for a single hardware.
2049
* @hw: the hardware the frame was transmitted by
2050
* @skb: the frame that was transmitted, owned by mac80211 after this call
2052
static inline void ieee80211_tx_status_ni(struct ieee80211_hw *hw,
2053
struct sk_buff *skb)
2056
ieee80211_tx_status(hw, skb);
2061
* ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
2063
* Like ieee80211_tx_status() but can be called in IRQ context
2064
* (internally defers to a tasklet.)
2066
* Calls to this function, ieee80211_tx_status() and
2067
* ieee80211_tx_status_ni() may not be mixed for a single hardware.
2069
* @hw: the hardware the frame was transmitted by
2070
* @skb: the frame that was transmitted, owned by mac80211 after this call
2072
void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
2073
struct sk_buff *skb);
2076
* ieee80211_beacon_get_tim - beacon generation function
2077
* @hw: pointer obtained from ieee80211_alloc_hw().
2078
* @vif: &struct ieee80211_vif pointer from the add_interface callback.
2079
* @tim_offset: pointer to variable that will receive the TIM IE offset.
2080
* Set to 0 if invalid (in non-AP modes).
2081
* @tim_length: pointer to variable that will receive the TIM IE length,
2082
* (including the ID and length bytes!).
2083
* Set to 0 if invalid (in non-AP modes).
2085
* If the driver implements beaconing modes, it must use this function to
2086
* obtain the beacon frame/template.
2088
* If the beacon frames are generated by the host system (i.e., not in
2089
* hardware/firmware), the driver uses this function to get each beacon
2090
* frame from mac80211 -- it is responsible for calling this function
2091
* before the beacon is needed (e.g. based on hardware interrupt).
2093
* If the beacon frames are generated by the device, then the driver
2094
* must use the returned beacon as the template and change the TIM IE
2095
* according to the current DTIM parameters/TIM bitmap.
2097
* The driver is responsible for freeing the returned skb.
2099
struct sk_buff *ieee80211_beacon_get_tim(struct ieee80211_hw *hw,
2100
struct ieee80211_vif *vif,
2101
u16 *tim_offset, u16 *tim_length);
2104
* ieee80211_beacon_get - beacon generation function
2105
* @hw: pointer obtained from ieee80211_alloc_hw().
2106
* @vif: &struct ieee80211_vif pointer from the add_interface callback.
2108
* See ieee80211_beacon_get_tim().
2110
static inline struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
2111
struct ieee80211_vif *vif)
2113
return ieee80211_beacon_get_tim(hw, vif, NULL, NULL);
2117
* ieee80211_pspoll_get - retrieve a PS Poll template
2118
* @hw: pointer obtained from ieee80211_alloc_hw().
2119
* @vif: &struct ieee80211_vif pointer from the add_interface callback.
2121
* Creates a PS Poll a template which can, for example, uploaded to
2122
* hardware. The template must be updated after association so that correct
2123
* AID, BSSID and MAC address is used.
2125
* Note: Caller (or hardware) is responsible for setting the
2126
* &IEEE80211_FCTL_PM bit.
2128
struct sk_buff *ieee80211_pspoll_get(struct ieee80211_hw *hw,
2129
struct ieee80211_vif *vif);
2132
* ieee80211_nullfunc_get - retrieve a nullfunc template
2133
* @hw: pointer obtained from ieee80211_alloc_hw().
2134
* @vif: &struct ieee80211_vif pointer from the add_interface callback.
2136
* Creates a Nullfunc template which can, for example, uploaded to
2137
* hardware. The template must be updated after association so that correct
2138
* BSSID and address is used.
2140
* Note: Caller (or hardware) is responsible for setting the
2141
* &IEEE80211_FCTL_PM bit as well as Duration and Sequence Control fields.
2143
struct sk_buff *ieee80211_nullfunc_get(struct ieee80211_hw *hw,
2144
struct ieee80211_vif *vif);
2147
* ieee80211_probereq_get - retrieve a Probe Request template
2148
* @hw: pointer obtained from ieee80211_alloc_hw().
2149
* @vif: &struct ieee80211_vif pointer from the add_interface callback.
2150
* @ssid: SSID buffer
2151
* @ssid_len: length of SSID
2152
* @ie: buffer containing all IEs except SSID for the template
2153
* @ie_len: length of the IE buffer
2155
* Creates a Probe Request template which can, for example, be uploaded to
2158
struct sk_buff *ieee80211_probereq_get(struct ieee80211_hw *hw,
2159
struct ieee80211_vif *vif,
2160
const u8 *ssid, size_t ssid_len,
2161
const u8 *ie, size_t ie_len);
2164
* ieee80211_rts_get - RTS frame generation function
2165
* @hw: pointer obtained from ieee80211_alloc_hw().
2166
* @vif: &struct ieee80211_vif pointer from the add_interface callback.
2167
* @frame: pointer to the frame that is going to be protected by the RTS.
2168
* @frame_len: the frame length (in octets).
2169
* @frame_txctl: &struct ieee80211_tx_info of the frame.
2170
* @rts: The buffer where to store the RTS frame.
2172
* If the RTS frames are generated by the host system (i.e., not in
2173
* hardware/firmware), the low-level driver uses this function to receive
2174
* the next RTS frame from the 802.11 code. The low-level is responsible
2175
* for calling this function before and RTS frame is needed.
2177
void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
2178
const void *frame, size_t frame_len,
2179
const struct ieee80211_tx_info *frame_txctl,
2180
struct ieee80211_rts *rts);
2183
* ieee80211_rts_duration - Get the duration field for an RTS frame
2184
* @hw: pointer obtained from ieee80211_alloc_hw().
2185
* @vif: &struct ieee80211_vif pointer from the add_interface callback.
2186
* @frame_len: the length of the frame that is going to be protected by the RTS.
2187
* @frame_txctl: &struct ieee80211_tx_info of the frame.
2189
* If the RTS is generated in firmware, but the host system must provide
2190
* the duration field, the low-level driver uses this function to receive
2191
* the duration field value in little-endian byteorder.
2193
__le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
2194
struct ieee80211_vif *vif, size_t frame_len,
2195
const struct ieee80211_tx_info *frame_txctl);
2198
* ieee80211_ctstoself_get - CTS-to-self frame generation function
2199
* @hw: pointer obtained from ieee80211_alloc_hw().
2200
* @vif: &struct ieee80211_vif pointer from the add_interface callback.
2201
* @frame: pointer to the frame that is going to be protected by the CTS-to-self.
2202
* @frame_len: the frame length (in octets).
2203
* @frame_txctl: &struct ieee80211_tx_info of the frame.
2204
* @cts: The buffer where to store the CTS-to-self frame.
2206
* If the CTS-to-self frames are generated by the host system (i.e., not in
2207
* hardware/firmware), the low-level driver uses this function to receive
2208
* the next CTS-to-self frame from the 802.11 code. The low-level is responsible
2209
* for calling this function before and CTS-to-self frame is needed.
2211
void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
2212
struct ieee80211_vif *vif,
2213
const void *frame, size_t frame_len,
2214
const struct ieee80211_tx_info *frame_txctl,
2215
struct ieee80211_cts *cts);
2218
* ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
2219
* @hw: pointer obtained from ieee80211_alloc_hw().
2220
* @vif: &struct ieee80211_vif pointer from the add_interface callback.
2221
* @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
2222
* @frame_txctl: &struct ieee80211_tx_info of the frame.
2224
* If the CTS-to-self is generated in firmware, but the host system must provide
2225
* the duration field, the low-level driver uses this function to receive
2226
* the duration field value in little-endian byteorder.
2228
__le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
2229
struct ieee80211_vif *vif,
2231
const struct ieee80211_tx_info *frame_txctl);
2234
* ieee80211_generic_frame_duration - Calculate the duration field for a frame
2235
* @hw: pointer obtained from ieee80211_alloc_hw().
2236
* @vif: &struct ieee80211_vif pointer from the add_interface callback.
2237
* @frame_len: the length of the frame.
2238
* @rate: the rate at which the frame is going to be transmitted.
2240
* Calculate the duration field of some generic frame, given its
2241
* length and transmission rate (in 100kbps).
2243
__le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
2244
struct ieee80211_vif *vif,
2246
struct ieee80211_rate *rate);
2249
* ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
2250
* @hw: pointer as obtained from ieee80211_alloc_hw().
2251
* @vif: &struct ieee80211_vif pointer from the add_interface callback.
2253
* Function for accessing buffered broadcast and multicast frames. If
2254
* hardware/firmware does not implement buffering of broadcast/multicast
2255
* frames when power saving is used, 802.11 code buffers them in the host
2256
* memory. The low-level driver uses this function to fetch next buffered
2257
* frame. In most cases, this is used when generating beacon frame. This
2258
* function returns a pointer to the next buffered skb or NULL if no more
2259
* buffered frames are available.
2261
* Note: buffered frames are returned only after DTIM beacon frame was
2262
* generated with ieee80211_beacon_get() and the low-level driver must thus
2263
* call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
2264
* NULL if the previous generated beacon was not DTIM, so the low-level driver
2265
* does not need to check for DTIM beacons separately and should be able to
2266
* use common code for all beacons.
2269
ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
2272
* ieee80211_get_tkip_key - get a TKIP rc4 for skb
2274
* This function computes a TKIP rc4 key for an skb. It computes
2275
* a phase 1 key if needed (iv16 wraps around). This function is to
2276
* be used by drivers which can do HW encryption but need to compute
2277
* to phase 1/2 key in SW.
2279
* @keyconf: the parameter passed with the set key
2280
* @skb: the skb for which the key is needed
2282
* @key: a buffer to which the key will be written
2284
void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
2285
struct sk_buff *skb,
2286
enum ieee80211_tkip_key_type type, u8 *key);
2288
* ieee80211_wake_queue - wake specific queue
2289
* @hw: pointer as obtained from ieee80211_alloc_hw().
2290
* @queue: queue number (counted from zero).
2292
* Drivers should use this function instead of netif_wake_queue.
2294
void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
2297
* ieee80211_stop_queue - stop specific queue
2298
* @hw: pointer as obtained from ieee80211_alloc_hw().
2299
* @queue: queue number (counted from zero).
2301
* Drivers should use this function instead of netif_stop_queue.
2303
void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
2306
* ieee80211_queue_stopped - test status of the queue
2307
* @hw: pointer as obtained from ieee80211_alloc_hw().
2308
* @queue: queue number (counted from zero).
2310
* Drivers should use this function instead of netif_stop_queue.
2313
int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
2316
* ieee80211_stop_queues - stop all queues
2317
* @hw: pointer as obtained from ieee80211_alloc_hw().
2319
* Drivers should use this function instead of netif_stop_queue.
2321
void ieee80211_stop_queues(struct ieee80211_hw *hw);
2324
* ieee80211_wake_queues - wake all queues
2325
* @hw: pointer as obtained from ieee80211_alloc_hw().
2327
* Drivers should use this function instead of netif_wake_queue.
2329
void ieee80211_wake_queues(struct ieee80211_hw *hw);
2332
* ieee80211_scan_completed - completed hardware scan
2334
* When hardware scan offload is used (i.e. the hw_scan() callback is
2335
* assigned) this function needs to be called by the driver to notify
2336
* mac80211 that the scan finished. This function can be called from
2337
* any context, including hardirq context.
2339
* @hw: the hardware that finished the scan
2340
* @aborted: set to true if scan was aborted
2342
void ieee80211_scan_completed(struct ieee80211_hw *hw, bool aborted);
2345
* ieee80211_iterate_active_interfaces - iterate active interfaces
2347
* This function iterates over the interfaces associated with a given
2348
* hardware that are currently active and calls the callback for them.
2349
* This function allows the iterator function to sleep, when the iterator
2350
* function is atomic @ieee80211_iterate_active_interfaces_atomic can
2352
* Does not iterate over a new interface during add_interface()
2354
* @hw: the hardware struct of which the interfaces should be iterated over
2355
* @iterator: the iterator function to call
2356
* @data: first argument of the iterator function
2358
void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
2359
void (*iterator)(void *data, u8 *mac,
2360
struct ieee80211_vif *vif),
2364
* ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
2366
* This function iterates over the interfaces associated with a given
2367
* hardware that are currently active and calls the callback for them.
2368
* This function requires the iterator callback function to be atomic,
2369
* if that is not desired, use @ieee80211_iterate_active_interfaces instead.
2370
* Does not iterate over a new interface during add_interface()
2372
* @hw: the hardware struct of which the interfaces should be iterated over
2373
* @iterator: the iterator function to call, cannot sleep
2374
* @data: first argument of the iterator function
2376
void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
2377
void (*iterator)(void *data,
2379
struct ieee80211_vif *vif),
2383
* ieee80211_queue_work - add work onto the mac80211 workqueue
2385
* Drivers and mac80211 use this to add work onto the mac80211 workqueue.
2386
* This helper ensures drivers are not queueing work when they should not be.
2388
* @hw: the hardware struct for the interface we are adding work for
2389
* @work: the work we want to add onto the mac80211 workqueue
2391
void ieee80211_queue_work(struct ieee80211_hw *hw, struct work_struct *work);
2394
* ieee80211_queue_delayed_work - add work onto the mac80211 workqueue
2396
* Drivers and mac80211 use this to queue delayed work onto the mac80211
2399
* @hw: the hardware struct for the interface we are adding work for
2400
* @dwork: delayable work to queue onto the mac80211 workqueue
2401
* @delay: number of jiffies to wait before queueing
2403
void ieee80211_queue_delayed_work(struct ieee80211_hw *hw,
2404
struct delayed_work *dwork,
2405
unsigned long delay);
2408
* ieee80211_start_tx_ba_session - Start a tx Block Ack session.
2409
* @sta: the station for which to start a BA session
2410
* @tid: the TID to BA on.
2412
* Return: success if addBA request was sent, failure otherwise
2414
* Although mac80211/low level driver/user space application can estimate
2415
* the need to start aggregation on a certain RA/TID, the session level
2416
* will be managed by the mac80211.
2418
int ieee80211_start_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
2421
* ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
2422
* @vif: &struct ieee80211_vif pointer from the add_interface callback
2423
* @ra: receiver address of the BA session recipient.
2424
* @tid: the TID to BA on.
2426
* This function must be called by low level driver once it has
2427
* finished with preparations for the BA session. It can be called
2430
void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
2434
* ieee80211_stop_tx_ba_session - Stop a Block Ack session.
2435
* @sta: the station whose BA session to stop
2436
* @tid: the TID to stop BA.
2438
* Return: negative error if the TID is invalid, or no aggregation active
2440
* Although mac80211/low level driver/user space application can estimate
2441
* the need to stop aggregation on a certain RA/TID, the session level
2442
* will be managed by the mac80211.
2444
int ieee80211_stop_tx_ba_session(struct ieee80211_sta *sta, u16 tid);
2447
* ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
2448
* @vif: &struct ieee80211_vif pointer from the add_interface callback
2449
* @ra: receiver address of the BA session recipient.
2450
* @tid: the desired TID to BA on.
2452
* This function must be called by low level driver once it has
2453
* finished with preparations for the BA session tear down. It
2454
* can be called from any context.
2456
void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_vif *vif, const u8 *ra,
2460
* ieee80211_find_sta - find a station
2462
* @vif: virtual interface to look for station on
2463
* @addr: station's address
2465
* This function must be called under RCU lock and the
2466
* resulting pointer is only valid under RCU lock as well.
2468
struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_vif *vif,
2472
* ieee80211_find_sta_by_ifaddr - find a station on hardware
2474
* @hw: pointer as obtained from ieee80211_alloc_hw()
2475
* @addr: remote station's address
2476
* @localaddr: local address (vif->sdata->vif.addr). Use NULL for 'any'.
2478
* This function must be called under RCU lock and the
2479
* resulting pointer is only valid under RCU lock as well.
2481
* NOTE: You may pass NULL for localaddr, but then you will just get
2482
* the first STA that matches the remote address 'addr'.
2483
* We can have multiple STA associated with multiple
2484
* logical stations (e.g. consider a station connecting to another
2485
* BSSID on the same AP hardware without disconnecting first).
2486
* In this case, the result of this method with localaddr NULL
2489
* DO NOT USE THIS FUNCTION with localaddr NULL if at all possible.
2491
struct ieee80211_sta *ieee80211_find_sta_by_ifaddr(struct ieee80211_hw *hw,
2493
const u8 *localaddr);
2496
* ieee80211_sta_block_awake - block station from waking up
2498
* @pubsta: the station
2499
* @block: whether to block or unblock
2501
* Some devices require that all frames that are on the queues
2502
* for a specific station that went to sleep are flushed before
2503
* a poll response or frames after the station woke up can be
2504
* delivered to that it. Note that such frames must be rejected
2505
* by the driver as filtered, with the appropriate status flag.
2507
* This function allows implementing this mode in a race-free
2510
* To do this, a driver must keep track of the number of frames
2511
* still enqueued for a specific station. If this number is not
2512
* zero when the station goes to sleep, the driver must call
2513
* this function to force mac80211 to consider the station to
2514
* be asleep regardless of the station's actual state. Once the
2515
* number of outstanding frames reaches zero, the driver must
2516
* call this function again to unblock the station. That will
2517
* cause mac80211 to be able to send ps-poll responses, and if
2518
* the station queried in the meantime then frames will also
2519
* be sent out as a result of this. Additionally, the driver
2520
* will be notified that the station woke up some time after
2521
* it is unblocked, regardless of whether the station actually
2522
* woke up while blocked or not.
2524
void ieee80211_sta_block_awake(struct ieee80211_hw *hw,
2525
struct ieee80211_sta *pubsta, bool block);
2528
* ieee80211_beacon_loss - inform hardware does not receive beacons
2530
* @vif: &struct ieee80211_vif pointer from the add_interface callback.
2532
* When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER and
2533
* %IEEE80211_CONF_PS is set, the driver needs to inform whenever the
2534
* hardware is not receiving beacons with this function.
2536
void ieee80211_beacon_loss(struct ieee80211_vif *vif);
2539
* ieee80211_connection_loss - inform hardware has lost connection to the AP
2541
* @vif: &struct ieee80211_vif pointer from the add_interface callback.
2543
* When beacon filtering is enabled with %IEEE80211_HW_BEACON_FILTER, and
2544
* %IEEE80211_CONF_PS and %IEEE80211_HW_CONNECTION_MONITOR are set, the driver
2545
* needs to inform if the connection to the AP has been lost.
2547
* This function will cause immediate change to disassociated state,
2548
* without connection recovery attempts.
2550
void ieee80211_connection_loss(struct ieee80211_vif *vif);
2553
* ieee80211_disable_dyn_ps - force mac80211 to temporarily disable dynamic psm
2555
* @vif: &struct ieee80211_vif pointer from the add_interface callback.
2557
* Some hardware require full power save to manage simultaneous BT traffic
2558
* on the WLAN frequency. Full PSM is required periodically, whenever there are
2559
* burst of BT traffic. The hardware gets information of BT traffic via
2560
* hardware co-existence lines, and consequentially requests mac80211 to
2561
* (temporarily) enter full psm.
2562
* This function will only temporarily disable dynamic PS, not enable PSM if
2563
* it was not already enabled.
2564
* The driver must make sure to re-enable dynamic PS using
2565
* ieee80211_enable_dyn_ps() if the driver has disabled it.
2568
void ieee80211_disable_dyn_ps(struct ieee80211_vif *vif);
2571
* ieee80211_enable_dyn_ps - restore dynamic psm after being disabled
2573
* @vif: &struct ieee80211_vif pointer from the add_interface callback.
2575
* This function restores dynamic PS after being temporarily disabled via
2576
* ieee80211_disable_dyn_ps(). Each ieee80211_disable_dyn_ps() call must
2577
* be coupled with an eventual call to this function.
2580
void ieee80211_enable_dyn_ps(struct ieee80211_vif *vif);
2583
* ieee80211_cqm_rssi_notify - inform a configured connection quality monitoring
2584
* rssi threshold triggered
2586
* @vif: &struct ieee80211_vif pointer from the add_interface callback.
2587
* @rssi_event: the RSSI trigger event type
2588
* @gfp: context flags
2590
* When the %IEEE80211_HW_SUPPORTS_CQM_RSSI is set, and a connection quality
2591
* monitoring is configured with an rssi threshold, the driver will inform
2592
* whenever the rssi level reaches the threshold.
2594
void ieee80211_cqm_rssi_notify(struct ieee80211_vif *vif,
2595
enum nl80211_cqm_rssi_threshold_event rssi_event,
2599
* ieee80211_chswitch_done - Complete channel switch process
2600
* @vif: &struct ieee80211_vif pointer from the add_interface callback.
2601
* @success: make the channel switch successful or not
2603
* Complete the channel switch post-process: set the new operational channel
2604
* and wake up the suspended queues.
2606
void ieee80211_chswitch_done(struct ieee80211_vif *vif, bool success);
2609
* ieee80211_request_smps - request SM PS transition
2610
* @vif: &struct ieee80211_vif pointer from the add_interface callback.
2611
* @smps_mode: new SM PS mode
2613
* This allows the driver to request an SM PS transition in managed
2614
* mode. This is useful when the driver has more information than
2615
* the stack about possible interference, for example by bluetooth.
2617
void ieee80211_request_smps(struct ieee80211_vif *vif,
2618
enum ieee80211_smps_mode smps_mode);
2621
* ieee80211_key_removed - disable hw acceleration for key
2622
* @key_conf: The key hw acceleration should be disabled for
2624
* This allows drivers to indicate that the given key has been
2625
* removed from hardware acceleration, due to a new key that
2626
* was added. Don't use this if the key can continue to be used
2627
* for TX, if the key restriction is on RX only it is permitted
2628
* to keep the key for TX only and not call this function.
2630
* Due to locking constraints, it may only be called during
2631
* @set_key. This function must be allowed to sleep, and the
2632
* key it tries to disable may still be used until it returns.
2634
void ieee80211_key_removed(struct ieee80211_key_conf *key_conf);
2636
/* Rate control API */
2639
* enum rate_control_changed - flags to indicate which parameter changed
2641
* @IEEE80211_RC_HT_CHANGED: The HT parameters of the operating channel have
2642
* changed, rate control algorithm can update its internal state if needed.
2644
enum rate_control_changed {
2645
IEEE80211_RC_HT_CHANGED = BIT(0)
2649
* struct ieee80211_tx_rate_control - rate control information for/from RC algo
2651
* @hw: The hardware the algorithm is invoked for.
2652
* @sband: The band this frame is being transmitted on.
2653
* @bss_conf: the current BSS configuration
2654
* @reported_rate: The rate control algorithm can fill this in to indicate
2655
* which rate should be reported to userspace as the current rate and
2656
* used for rate calculations in the mesh network.
2657
* @rts: whether RTS will be used for this frame because it is longer than the
2659
* @short_preamble: whether mac80211 will request short-preamble transmission
2660
* if the selected rate supports it
2661
* @max_rate_idx: user-requested maximum rate (not MCS for now)
2662
* (deprecated; this will be removed once drivers get updated to use
2664
* @rate_idx_mask: user-requested rate mask (not MCS for now)
2665
* @skb: the skb that will be transmitted, the control information in it needs
2667
* @ap: whether this frame is sent out in AP mode
2669
struct ieee80211_tx_rate_control {
2670
struct ieee80211_hw *hw;
2671
struct ieee80211_supported_band *sband;
2672
struct ieee80211_bss_conf *bss_conf;
2673
struct sk_buff *skb;
2674
struct ieee80211_tx_rate reported_rate;
2675
bool rts, short_preamble;
2681
struct rate_control_ops {
2682
struct module *module;
2684
void *(*alloc)(struct ieee80211_hw *hw, struct dentry *debugfsdir);
2685
void (*free)(void *priv);
2687
void *(*alloc_sta)(void *priv, struct ieee80211_sta *sta, gfp_t gfp);
2688
void (*rate_init)(void *priv, struct ieee80211_supported_band *sband,
2689
struct ieee80211_sta *sta, void *priv_sta);
2690
void (*rate_update)(void *priv, struct ieee80211_supported_band *sband,
2691
struct ieee80211_sta *sta,
2692
void *priv_sta, u32 changed,
2693
enum nl80211_channel_type oper_chan_type);
2694
void (*free_sta)(void *priv, struct ieee80211_sta *sta,
2697
void (*tx_status)(void *priv, struct ieee80211_supported_band *sband,
2698
struct ieee80211_sta *sta, void *priv_sta,
2699
struct sk_buff *skb);
2700
void (*get_rate)(void *priv, struct ieee80211_sta *sta, void *priv_sta,
2701
struct ieee80211_tx_rate_control *txrc);
2703
void (*add_sta_debugfs)(void *priv, void *priv_sta,
2704
struct dentry *dir);
2705
void (*remove_sta_debugfs)(void *priv, void *priv_sta);
2708
static inline int rate_supported(struct ieee80211_sta *sta,
2709
enum ieee80211_band band,
2712
return (sta == NULL || sta->supp_rates[band] & BIT(index));
2716
* rate_control_send_low - helper for drivers for management/no-ack frames
2718
* Rate control algorithms that agree to use the lowest rate to
2719
* send management frames and NO_ACK data with the respective hw
2720
* retries should use this in the beginning of their mac80211 get_rate
2721
* callback. If true is returned the rate control can simply return.
2722
* If false is returned we guarantee that sta and sta and priv_sta is
2725
* Rate control algorithms wishing to do more intelligent selection of
2726
* rate for multicast/broadcast frames may choose to not use this.
2728
* @sta: &struct ieee80211_sta pointer to the target destination. Note
2729
* that this may be null.
2730
* @priv_sta: private rate control structure. This may be null.
2731
* @txrc: rate control information we sholud populate for mac80211.
2733
bool rate_control_send_low(struct ieee80211_sta *sta,
2735
struct ieee80211_tx_rate_control *txrc);
2739
rate_lowest_index(struct ieee80211_supported_band *sband,
2740
struct ieee80211_sta *sta)
2744
for (i = 0; i < sband->n_bitrates; i++)
2745
if (rate_supported(sta, sband->band, i))
2748
/* warn when we cannot find a rate. */
2755
bool rate_usable_index_exists(struct ieee80211_supported_band *sband,
2756
struct ieee80211_sta *sta)
2760
for (i = 0; i < sband->n_bitrates; i++)
2761
if (rate_supported(sta, sband->band, i))
2766
int ieee80211_rate_control_register(struct rate_control_ops *ops);
2767
void ieee80211_rate_control_unregister(struct rate_control_ops *ops);
2770
conf_is_ht20(struct ieee80211_conf *conf)
2772
return conf->channel_type == NL80211_CHAN_HT20;
2776
conf_is_ht40_minus(struct ieee80211_conf *conf)
2778
return conf->channel_type == NL80211_CHAN_HT40MINUS;
2782
conf_is_ht40_plus(struct ieee80211_conf *conf)
2784
return conf->channel_type == NL80211_CHAN_HT40PLUS;
2788
conf_is_ht40(struct ieee80211_conf *conf)
2790
return conf_is_ht40_minus(conf) || conf_is_ht40_plus(conf);
2794
conf_is_ht(struct ieee80211_conf *conf)
2796
return conf->channel_type != NL80211_CHAN_NO_HT;
2799
static inline enum nl80211_iftype
2800
ieee80211_iftype_p2p(enum nl80211_iftype type, bool p2p)
2804
case NL80211_IFTYPE_STATION:
2805
return NL80211_IFTYPE_P2P_CLIENT;
2806
case NL80211_IFTYPE_AP:
2807
return NL80211_IFTYPE_P2P_GO;
2815
static inline enum nl80211_iftype
2816
ieee80211_vif_type_p2p(struct ieee80211_vif *vif)
2818
return ieee80211_iftype_p2p(vif->type, vif->p2p);
2821
#endif /* MAC80211_H */
added
removed
updates/compat-wireless-2.6.37/include/net/mac80211.h
