2 * mac80211 <-> driver interface
4 * Copyright 2002-2005, Devicescape Software, Inc.
5 * Copyright 2006-2007 Jiri Benc <jbenc@suse.cz>
6 * Copyright 2007 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/wireless.h>
23 #include <net/cfg80211.h>
28 * mac80211 is the Linux stack for 802.11 hardware that implements
29 * only partial functionality in hard- or firmware. This document
30 * defines the interface between mac80211 and low-level hardware
35 * DOC: Calling mac80211 from interrupts
37 * Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
38 * called in hardware interrupt context. The low-level driver must not call any
39 * other functions in hardware interrupt context. If there is a need for such
40 * call, the low-level driver should first ACK the interrupt and perform the
41 * IEEE 802.11 code call after this, e.g. from a scheduled workqueue or even
44 * NOTE: If the driver opts to use the _irqsafe() functions, it may not also
45 * use the non-IRQ-safe functions!
51 * If you're reading this document and not the header file itself, it will
52 * be incomplete because not all documentation has been converted yet.
58 * As a general rule, when frames are passed between mac80211 and the driver,
59 * they start with the IEEE 802.11 header and include the same octets that are
60 * sent over the air except for the FCS which should be calculated by the
63 * There are, however, various exceptions to this rule for advanced features:
65 * The first exception is for hardware encryption and decryption offload
66 * where the IV/ICV may or may not be generated in hardware.
68 * Secondly, when the hardware handles fragmentation, the frame handed to
69 * the driver from mac80211 is the MSDU, not the MPDU.
71 * Finally, for received frames, the driver is able to indicate that it has
72 * filled a radiotap header and put that in front of the frame; if it does
73 * not do so then mac80211 may add this under certain circumstances.
77 * enum ieee80211_notification_type - Low level driver notification
78 * @IEEE80211_NOTIFY_RE_ASSOC: start the re-association sequence
80 enum ieee80211_notification_types {
81 IEEE80211_NOTIFY_RE_ASSOC,
85 * struct ieee80211_ht_bss_info - describing BSS's HT characteristics
87 * This structure describes most essential parameters needed
88 * to describe 802.11n HT characteristics in a BSS.
90 * @primary_channel: channel number of primery channel
91 * @bss_cap: 802.11n's general BSS capabilities (e.g. channel width)
92 * @bss_op_mode: 802.11n's BSS operation modes (e.g. HT protection)
94 struct ieee80211_ht_bss_info {
96 u8 bss_cap; /* use IEEE80211_HT_IE_CHA_ */
97 u8 bss_op_mode; /* use IEEE80211_HT_IE_ */
101 * enum ieee80211_max_queues - maximum number of queues
103 * @IEEE80211_MAX_QUEUES: Maximum number of regular device queues.
104 * @IEEE80211_MAX_AMPDU_QUEUES: Maximum number of queues usable
105 * for A-MPDU operation.
107 enum ieee80211_max_queues {
108 IEEE80211_MAX_QUEUES = 16,
109 IEEE80211_MAX_AMPDU_QUEUES = 16,
113 * struct ieee80211_tx_queue_params - transmit queue configuration
115 * The information provided in this structure is required for QoS
116 * transmit queue configuration. Cf. IEEE 802.11 7.3.2.29.
118 * @aifs: arbitration interface space [0..255]
119 * @cw_min: minimum contention window [a value of the form
120 * 2^n-1 in the range 1..32767]
121 * @cw_max: maximum contention window [like @cw_min]
122 * @txop: maximum burst time in units of 32 usecs, 0 meaning disabled
124 struct ieee80211_tx_queue_params {
132 * struct ieee80211_tx_queue_stats - transmit queue statistics
134 * @len: number of packets in queue
135 * @limit: queue length limit
136 * @count: number of frames sent
138 struct ieee80211_tx_queue_stats {
144 struct ieee80211_low_level_stats {
145 unsigned int dot11ACKFailureCount;
146 unsigned int dot11RTSFailureCount;
147 unsigned int dot11FCSErrorCount;
148 unsigned int dot11RTSSuccessCount;
152 * enum ieee80211_bss_change - BSS change notification flags
154 * These flags are used with the bss_info_changed() callback
155 * to indicate which BSS parameter changed.
157 * @BSS_CHANGED_ASSOC: association status changed (associated/disassociated),
158 * also implies a change in the AID.
159 * @BSS_CHANGED_ERP_CTS_PROT: CTS protection changed
160 * @BSS_CHANGED_ERP_PREAMBLE: preamble changed
161 * @BSS_CHANGED_ERP_SLOT: slot timing changed
162 * @BSS_CHANGED_HT: 802.11n parameters changed
163 * @BSS_CHANGED_BASIC_RATES: Basic rateset changed
165 enum ieee80211_bss_change {
166 BSS_CHANGED_ASSOC = 1<<0,
167 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
168 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
169 BSS_CHANGED_ERP_SLOT = 1<<3,
170 BSS_CHANGED_HT = 1<<4,
171 BSS_CHANGED_BASIC_RATES = 1<<5,
175 * struct ieee80211_bss_conf - holds the BSS's changing parameters
177 * This structure keeps information about a BSS (and an association
178 * to that BSS) that can change during the lifetime of the BSS.
180 * @assoc: association status
181 * @aid: association ID number, valid only when @assoc is true
182 * @use_cts_prot: use CTS protection
183 * @use_short_preamble: use 802.11b short preamble
184 * @use_short_slot: use short slot time (only relevant for ERP)
185 * @dtim_period: num of beacons before the next DTIM, for PSM
186 * @timestamp: beacon timestamp
187 * @beacon_int: beacon interval
188 * @assoc_capability: capabilities taken from assoc resp
189 * @assoc_ht: association in HT mode
190 * @ht_conf: ht capabilities
191 * @ht_bss_conf: ht extended capabilities
192 * @basic_rates: bitmap of basic rates, each bit stands for an
193 * index into the rate table configured by the driver in
196 struct ieee80211_bss_conf {
197 /* association related data */
200 /* erp related data */
202 bool use_short_preamble;
206 u16 assoc_capability;
209 /* ht related data */
211 struct ieee80211_ht_info *ht_conf;
212 struct ieee80211_ht_bss_info *ht_bss_conf;
216 * enum mac80211_tx_control_flags - flags to describe transmission information/status
218 * These flags are used with the @flags member of &ieee80211_tx_info.
220 * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame.
221 * @IEEE80211_TX_CTL_USE_RTS_CTS: use RTS-CTS before sending frame
222 * @IEEE80211_TX_CTL_USE_CTS_PROTECT: use CTS protection for the frame (e.g.,
223 * for combined 802.11g / 802.11b networks)
224 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
225 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE: TBD
226 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
228 * @IEEE80211_TX_CTL_REQUEUE: TBD
229 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
230 * @IEEE80211_TX_CTL_SHORT_PREAMBLE: TBD
231 * @IEEE80211_TX_CTL_LONG_RETRY_LIMIT: this frame should be send using the
232 * through set_retry_limit configured long retry value
233 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
234 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
235 * @IEEE80211_TX_CTL_OFDM_HT: this frame can be sent in HT OFDM rates. number
236 * of streams when this flag is on can be extracted from antenna_sel_tx,
237 * so if 1 antenna is marked use SISO, 2 antennas marked use MIMO, n
238 * antennas marked use MIMO_n.
239 * @IEEE80211_TX_CTL_GREEN_FIELD: use green field protection for this frame
240 * @IEEE80211_TX_CTL_40_MHZ_WIDTH: send this frame using 40 Mhz channel width
241 * @IEEE80211_TX_CTL_DUP_DATA: duplicate data frame on both 20 Mhz channels
242 * @IEEE80211_TX_CTL_SHORT_GI: send this frame using short guard interval
243 * @IEEE80211_TX_CTL_INJECTED: TBD
244 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
245 * because the destination STA was in powersave mode.
246 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
247 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
248 * is for the whole aggregation.
249 * @IEEE80211_TX_STAT_AMPDU_NO_BACK: no block ack was returned,
250 * so consider using block ack request (BAR).
251 * @IEEE80211_TX_CTL_ASSIGN_SEQ: The driver has to assign a sequence
252 * number to this frame, taking care of not overwriting the fragment
253 * number and increasing the sequence number only when the
254 * IEEE80211_TX_CTL_FIRST_FRAGMENT flags is set. mac80211 will properly
255 * assign sequence numbers to QoS-data frames but cannot do so correctly
256 * for non-QoS-data and management frames because beacons need them from
257 * that counter as well and mac80211 cannot guarantee proper sequencing.
258 * If this flag is set, the driver should instruct the hardware to
259 * assign a sequence number to the frame or assign one itself. Cf. IEEE
260 * 802.11-2007 7.1.3.4.1 paragraph 3. This flag will always be set for
261 * beacons always be clear for frames without a sequence number field.
263 enum mac80211_tx_control_flags {
264 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
265 IEEE80211_TX_CTL_USE_RTS_CTS = BIT(2),
266 IEEE80211_TX_CTL_USE_CTS_PROTECT = BIT(3),
267 IEEE80211_TX_CTL_NO_ACK = BIT(4),
268 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(5),
269 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(6),
270 IEEE80211_TX_CTL_REQUEUE = BIT(7),
271 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(8),
272 IEEE80211_TX_CTL_SHORT_PREAMBLE = BIT(9),
273 IEEE80211_TX_CTL_LONG_RETRY_LIMIT = BIT(10),
274 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(12),
275 IEEE80211_TX_CTL_AMPDU = BIT(13),
276 IEEE80211_TX_CTL_OFDM_HT = BIT(14),
277 IEEE80211_TX_CTL_GREEN_FIELD = BIT(15),
278 IEEE80211_TX_CTL_40_MHZ_WIDTH = BIT(16),
279 IEEE80211_TX_CTL_DUP_DATA = BIT(17),
280 IEEE80211_TX_CTL_SHORT_GI = BIT(18),
281 IEEE80211_TX_CTL_INJECTED = BIT(19),
282 IEEE80211_TX_STAT_TX_FILTERED = BIT(20),
283 IEEE80211_TX_STAT_ACK = BIT(21),
284 IEEE80211_TX_STAT_AMPDU = BIT(22),
285 IEEE80211_TX_STAT_AMPDU_NO_BACK = BIT(23),
286 IEEE80211_TX_CTL_ASSIGN_SEQ = BIT(24),
290 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE \
291 (sizeof(((struct sk_buff *)0)->cb) - 8)
292 #define IEEE80211_TX_INFO_DRIVER_DATA_PTRS \
293 (IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *))
296 * struct ieee80211_tx_info - skb transmit information
298 * This structure is placed in skb->cb for three uses:
299 * (1) mac80211 TX control - mac80211 tells the driver what to do
300 * (2) driver internal use (if applicable)
301 * (3) TX status information - driver tells mac80211 what happened
303 * The TX control's sta pointer is only valid during the ->tx call,
306 * @flags: transmit info flags, defined above
309 * @antenna_sel_tx: TBD
310 * @control: union for control data
311 * @status: union for status data
312 * @driver_data: array of driver_data pointers
313 * @retry_count: number of retries
314 * @excessive_retries: set to 1 if the frame was retried many times
315 * but not acknowledged
316 * @ampdu_ack_len: number of aggregated frames.
317 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
318 * @ampdu_ack_map: block ack bit map for the aggregation.
319 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
320 * @ack_signal: signal strength of the ACK frame
322 struct ieee80211_tx_info {
323 /* common information */
333 struct ieee80211_vif *vif;
334 struct ieee80211_key_conf *hw_key;
335 struct ieee80211_sta *sta;
336 unsigned long jiffies;
337 s8 rts_cts_rate_idx, alt_retry_rate_idx;
346 bool excessive_retries;
349 void *driver_data[IEEE80211_TX_INFO_DRIVER_DATA_PTRS];
353 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
355 return (struct ieee80211_tx_info *)skb->cb;
360 * enum mac80211_rx_flags - receive flags
362 * These flags are used with the @flag member of &struct ieee80211_rx_status.
363 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
364 * Use together with %RX_FLAG_MMIC_STRIPPED.
365 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
366 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
367 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
368 * verification has been done by the hardware.
369 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
370 * If this flag is set, the stack cannot do any replay detection
371 * hence the driver or hardware will have to do that.
372 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
374 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
376 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
377 * is valid. This is useful in monitor mode and necessary for beacon frames
378 * to enable IBSS merging.
379 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
381 enum mac80211_rx_flags {
382 RX_FLAG_MMIC_ERROR = 1<<0,
383 RX_FLAG_DECRYPTED = 1<<1,
384 RX_FLAG_RADIOTAP = 1<<2,
385 RX_FLAG_MMIC_STRIPPED = 1<<3,
386 RX_FLAG_IV_STRIPPED = 1<<4,
387 RX_FLAG_FAILED_FCS_CRC = 1<<5,
388 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
390 RX_FLAG_SHORTPRE = 1<<8
394 * struct ieee80211_rx_status - receive status
396 * The low-level driver should provide this information (the subset
397 * supported by hardware) to the 802.11 code with each received
400 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
401 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
402 * @band: the active band when this frame was received
403 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
404 * @signal: signal strength when receiving this frame, either in dBm, in dB or
405 * unspecified depending on the hardware capabilities flags
406 * @IEEE80211_HW_SIGNAL_*
407 * @noise: noise when receiving this frame, in dBm.
408 * @qual: overall signal quality indication, in percent (0-100).
409 * @antenna: antenna used
410 * @rate_idx: index of data rate into band's supported rates
413 struct ieee80211_rx_status {
415 enum ieee80211_band band;
426 * enum ieee80211_conf_flags - configuration flags
428 * Flags to define PHY configuration options
430 * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time
431 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
432 * @IEEE80211_CONF_SUPPORT_HT_MODE: use 802.11n HT capabilities (if supported)
433 * @IEEE80211_CONF_PS: Enable 802.11 power save mode
435 enum ieee80211_conf_flags {
437 * TODO: IEEE80211_CONF_SHORT_SLOT_TIME will be removed once drivers
438 * have been converted to use bss_info_changed() for slot time
441 IEEE80211_CONF_SHORT_SLOT_TIME = (1<<0),
442 IEEE80211_CONF_RADIOTAP = (1<<1),
443 IEEE80211_CONF_SUPPORT_HT_MODE = (1<<2),
444 IEEE80211_CONF_PS = (1<<3),
448 * struct ieee80211_conf - configuration of the device
450 * This struct indicates how the driver shall configure the hardware.
452 * @radio_enabled: when zero, driver is required to switch off the radio.
454 * @beacon_int: beacon interval (TODO make interface config)
455 * @listen_interval: listen interval in units of beacon interval
456 * @flags: configuration flags defined above
457 * @power_level: requested transmit power (in dBm)
458 * @max_antenna_gain: maximum antenna gain (in dBi)
459 * @antenna_sel_tx: transmit antenna selection, 0: default/diversity,
461 * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx
462 * @ht_conf: describes current self configuration of 802.11n HT capabilies
463 * @ht_bss_conf: describes current BSS configuration of 802.11n HT parameters
464 * @channel: the channel to tune to
466 struct ieee80211_conf {
473 int max_antenna_gain;
477 struct ieee80211_channel *channel;
479 struct ieee80211_ht_info ht_conf;
480 struct ieee80211_ht_bss_info ht_bss_conf;
484 * struct ieee80211_vif - per-interface data
486 * Data in this structure is continually present for driver
487 * use during the life of a virtual interface.
489 * @type: type of this virtual interface
490 * @drv_priv: data area for driver use, will always be aligned to
493 struct ieee80211_vif {
494 enum nl80211_iftype type;
496 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
499 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
501 #ifdef CONFIG_MAC80211_MESH
502 return vif->type == NL80211_IFTYPE_MESH_POINT;
508 * struct ieee80211_if_init_conf - initial configuration of an interface
510 * @vif: pointer to a driver-use per-interface structure. The pointer
511 * itself is also used for various functions including
512 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
513 * @type: one of &enum nl80211_iftype constants. Determines the type of
514 * added/removed interface.
515 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
516 * until the interface is removed (i.e. it cannot be used after
517 * remove_interface() callback was called for this interface).
519 * This structure is used in add_interface() and remove_interface()
520 * callbacks of &struct ieee80211_hw.
522 * When you allow multiple interfaces to be added to your PHY, take care
523 * that the hardware can actually handle multiple MAC addresses. However,
524 * also take care that when there's no interface left with mac_addr != %NULL
525 * you remove the MAC address from the device to avoid acknowledging packets
526 * in pure monitor mode.
528 struct ieee80211_if_init_conf {
529 enum nl80211_iftype type;
530 struct ieee80211_vif *vif;
535 * enum ieee80211_if_conf_change - interface config change flags
537 * @IEEE80211_IFCC_BSSID: The BSSID changed.
538 * @IEEE80211_IFCC_SSID: The SSID changed.
539 * @IEEE80211_IFCC_BEACON: The beacon for this interface changed
540 * (currently AP and MESH only), use ieee80211_beacon_get().
542 enum ieee80211_if_conf_change {
543 IEEE80211_IFCC_BSSID = BIT(0),
544 IEEE80211_IFCC_SSID = BIT(1),
545 IEEE80211_IFCC_BEACON = BIT(2),
549 * struct ieee80211_if_conf - configuration of an interface
551 * @changed: parameters that have changed, see &enum ieee80211_if_conf_change.
552 * @bssid: BSSID of the network we are associated to/creating.
553 * @ssid: used (together with @ssid_len) by drivers for hardware that
554 * generate beacons independently. The pointer is valid only during the
555 * config_interface() call, so copy the value somewhere if you need
557 * @ssid_len: length of the @ssid field.
559 * This structure is passed to the config_interface() callback of
560 * &struct ieee80211_hw.
562 struct ieee80211_if_conf {
570 * enum ieee80211_key_alg - key algorithm
571 * @ALG_WEP: WEP40 or WEP104
573 * @ALG_CCMP: CCMP (AES)
575 enum ieee80211_key_alg {
582 * enum ieee80211_key_len - key length
583 * @LEN_WEP40: WEP 5-byte long key
584 * @LEN_WEP104: WEP 13-byte long key
586 enum ieee80211_key_len {
592 * enum ieee80211_key_flags - key flags
594 * These flags are used for communication about keys between the driver
595 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
597 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
598 * that the STA this key will be used with could be using QoS.
599 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
600 * driver to indicate that it requires IV generation for this
602 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
603 * the driver for a TKIP key if it requires Michael MIC
604 * generation in software.
605 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
606 * that the key is pairwise rather then a shared key.
608 enum ieee80211_key_flags {
609 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
610 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
611 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
612 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
616 * struct ieee80211_key_conf - key information
618 * This key information is given by mac80211 to the driver by
619 * the set_key() callback in &struct ieee80211_ops.
621 * @hw_key_idx: To be set by the driver, this is the key index the driver
622 * wants to be given when a frame is transmitted and needs to be
623 * encrypted in hardware.
624 * @alg: The key algorithm.
625 * @flags: key flags, see &enum ieee80211_key_flags.
626 * @keyidx: the key index (0-3)
627 * @keylen: key material length
628 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
630 * - Temporal Encryption Key (128 bits)
631 * - Temporal Authenticator Tx MIC Key (64 bits)
632 * - Temporal Authenticator Rx MIC Key (64 bits)
635 struct ieee80211_key_conf {
636 enum ieee80211_key_alg alg;
645 * enum set_key_cmd - key command
647 * Used with the set_key() callback in &struct ieee80211_ops, this
648 * indicates whether a key is being removed or added.
650 * @SET_KEY: a key is set
651 * @DISABLE_KEY: a key must be disabled
654 SET_KEY, DISABLE_KEY,
658 * struct ieee80211_sta - station table entry
660 * A station table entry represents a station we are possibly
661 * communicating with. Since stations are RCU-managed in
662 * mac80211, any ieee80211_sta pointer you get access to must
663 * either be protected by rcu_read_lock() explicitly or implicitly,
664 * or you must take good care to not use such a pointer after a
665 * call to your sta_notify callback that removed it.
668 * @aid: AID we assigned to the station if we're an AP
669 * @supp_rates: Bitmap of supported rates (per band)
670 * @ht_info: HT capabilities of this STA
671 * @drv_priv: data area for driver use, will always be aligned to
672 * sizeof(void *), size is determined in hw information.
674 struct ieee80211_sta {
675 u64 supp_rates[IEEE80211_NUM_BANDS];
678 struct ieee80211_ht_info ht_info;
681 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
685 * enum sta_notify_cmd - sta notify command
687 * Used with the sta_notify() callback in &struct ieee80211_ops, this
688 * indicates addition and removal of a station to station table.
690 * @STA_NOTIFY_ADD: a station was added to the station table
691 * @STA_NOTIFY_REMOVE: a station being removed from the station table
693 enum sta_notify_cmd {
694 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE
698 * enum ieee80211_tkip_key_type - get tkip key
700 * Used by drivers which need to get a tkip key for skb. Some drivers need a
701 * phase 1 key, others need a phase 2 key. A single function allows the driver
702 * to get the key, this enum indicates what type of key is required.
704 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
705 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
707 enum ieee80211_tkip_key_type {
708 IEEE80211_TKIP_P1_KEY,
709 IEEE80211_TKIP_P2_KEY,
713 * enum ieee80211_hw_flags - hardware flags
715 * These flags are used to indicate hardware capabilities to
716 * the stack. Generally, flags here should have their meaning
717 * done in a way that the simplest hardware doesn't need setting
718 * any particular flags. There are some exceptions to this rule,
719 * however, so you are advised to review these flags carefully.
721 * @IEEE80211_HW_RX_INCLUDES_FCS:
722 * Indicates that received frames passed to the stack include
723 * the FCS at the end.
725 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
726 * Some wireless LAN chipsets buffer broadcast/multicast frames
727 * for power saving stations in the hardware/firmware and others
728 * rely on the host system for such buffering. This option is used
729 * to configure the IEEE 802.11 upper layer to buffer broadcast and
730 * multicast frames when there are power saving stations so that
731 * the driver can fetch them with ieee80211_get_buffered_bc().
733 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
734 * Hardware is not capable of short slot operation on the 2.4 GHz band.
736 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
737 * Hardware is not capable of receiving frames with short preamble on
740 * @IEEE80211_HW_SIGNAL_UNSPEC:
741 * Hardware can provide signal values but we don't know its units. We
742 * expect values between 0 and @max_signal.
743 * If possible please provide dB or dBm instead.
745 * @IEEE80211_HW_SIGNAL_DB:
746 * Hardware gives signal values in dB, decibel difference from an
747 * arbitrary, fixed reference. We expect values between 0 and @max_signal.
748 * If possible please provide dBm instead.
750 * @IEEE80211_HW_SIGNAL_DBM:
751 * Hardware gives signal values in dBm, decibel difference from
752 * one milliwatt. This is the preferred method since it is standardized
753 * between different devices. @max_signal does not need to be set.
755 * @IEEE80211_HW_NOISE_DBM:
756 * Hardware can provide noise (radio interference) values in units dBm,
757 * decibel difference from one milliwatt.
759 * @IEEE80211_HW_SPECTRUM_MGMT:
760 * Hardware supports spectrum management defined in 802.11h
761 * Measurement, Channel Switch, Quieting, TPC
763 enum ieee80211_hw_flags {
764 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
765 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
766 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
767 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
768 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
769 IEEE80211_HW_SIGNAL_DB = 1<<6,
770 IEEE80211_HW_SIGNAL_DBM = 1<<7,
771 IEEE80211_HW_NOISE_DBM = 1<<8,
772 IEEE80211_HW_SPECTRUM_MGMT = 1<<9,
776 * struct ieee80211_hw - hardware information and state
778 * This structure contains the configuration and hardware
779 * information for an 802.11 PHY.
781 * @wiphy: This points to the &struct wiphy allocated for this
782 * 802.11 PHY. You must fill in the @perm_addr and @dev
783 * members of this structure using SET_IEEE80211_DEV()
784 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
785 * bands (with channels, bitrates) are registered here.
787 * @conf: &struct ieee80211_conf, device configuration, don't use.
789 * @workqueue: single threaded workqueue available for driver use,
790 * allocated by mac80211 on registration and flushed when an
791 * interface is removed.
792 * NOTICE: All work performed on this workqueue should NEVER
793 * acquire the RTNL lock (i.e. Don't use the function
794 * ieee80211_iterate_active_interfaces())
796 * @priv: pointer to private area that was allocated for driver use
797 * along with this structure.
799 * @flags: hardware flags, see &enum ieee80211_hw_flags.
801 * @extra_tx_headroom: headroom to reserve in each transmit skb
802 * for use by the driver (e.g. for transmit headers.)
804 * @channel_change_time: time (in microseconds) it takes to change channels.
806 * @max_signal: Maximum value for signal (rssi) in RX information, used
807 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
809 * @max_listen_interval: max listen interval in units of beacon interval
812 * @queues: number of available hardware transmit queues for
813 * data packets. WMM/QoS requires at least four, these
814 * queues need to have configurable access parameters.
816 * @ampdu_queues: number of available hardware transmit queues
817 * for A-MPDU packets, these have no access parameters
818 * because they're used only for A-MPDU frames. Note that
819 * mac80211 will not currently use any of the regular queues
822 * @rate_control_algorithm: rate control algorithm for this hardware.
823 * If unset (NULL), the default algorithm will be used. Must be
824 * set before calling ieee80211_register_hw().
826 * @vif_data_size: size (in bytes) of the drv_priv data area
827 * within &struct ieee80211_vif.
828 * @sta_data_size: size (in bytes) of the drv_priv data area
829 * within &struct ieee80211_sta.
831 struct ieee80211_hw {
832 struct ieee80211_conf conf;
834 struct workqueue_struct *workqueue;
835 const char *rate_control_algorithm;
838 unsigned int extra_tx_headroom;
839 int channel_change_time;
844 u16 max_listen_interval;
848 struct ieee80211_hw *wiphy_to_hw(struct wiphy *wiphy);
851 * SET_IEEE80211_DEV - set device for 802.11 hardware
853 * @hw: the &struct ieee80211_hw to set the device for
854 * @dev: the &struct device of this 802.11 device
856 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
858 set_wiphy_dev(hw->wiphy, dev);
862 * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware
864 * @hw: the &struct ieee80211_hw to set the MAC address for
865 * @addr: the address to set
867 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
869 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
872 static inline int ieee80211_num_regular_queues(struct ieee80211_hw *hw)
877 static inline int ieee80211_num_queues(struct ieee80211_hw *hw)
879 return hw->queues + hw->ampdu_queues;
882 static inline struct ieee80211_rate *
883 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
884 const struct ieee80211_tx_info *c)
886 if (WARN_ON(c->tx_rate_idx < 0))
888 return &hw->wiphy->bands[c->band]->bitrates[c->tx_rate_idx];
891 static inline struct ieee80211_rate *
892 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
893 const struct ieee80211_tx_info *c)
895 if (c->control.rts_cts_rate_idx < 0)
897 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
900 static inline struct ieee80211_rate *
901 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
902 const struct ieee80211_tx_info *c)
904 if (c->control.alt_retry_rate_idx < 0)
906 return &hw->wiphy->bands[c->band]->bitrates[c->control.alt_retry_rate_idx];
910 * DOC: Hardware crypto acceleration
912 * mac80211 is capable of taking advantage of many hardware
913 * acceleration designs for encryption and decryption operations.
915 * The set_key() callback in the &struct ieee80211_ops for a given
916 * device is called to enable hardware acceleration of encryption and
917 * decryption. The callback takes an @address parameter that will be
918 * the broadcast address for default keys, the other station's hardware
919 * address for individual keys or the zero address for keys that will
920 * be used only for transmission.
921 * Multiple transmission keys with the same key index may be used when
922 * VLANs are configured for an access point.
924 * The @local_address parameter will always be set to our own address,
925 * this is only relevant if you support multiple local addresses.
927 * When transmitting, the TX control data will use the @hw_key_idx
928 * selected by the driver by modifying the &struct ieee80211_key_conf
929 * pointed to by the @key parameter to the set_key() function.
931 * The set_key() call for the %SET_KEY command should return 0 if
932 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
933 * added; if you return 0 then hw_key_idx must be assigned to the
934 * hardware key index, you are free to use the full u8 range.
936 * When the cmd is %DISABLE_KEY then it must succeed.
938 * Note that it is permissible to not decrypt a frame even if a key
939 * for it has been uploaded to hardware, the stack will not make any
940 * decision based on whether a key has been uploaded or not but rather
941 * based on the receive flags.
943 * The &struct ieee80211_key_conf structure pointed to by the @key
944 * parameter is guaranteed to be valid until another call to set_key()
945 * removes it, but it can only be used as a cookie to differentiate
948 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
949 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
951 * The update_tkip_key() call updates the driver with the new phase 1 key.
952 * This happens everytime the iv16 wraps around (every 65536 packets). The
953 * set_key() call will happen only once for each key (unless the AP did
954 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
955 * provided by udpate_tkip_key only. The trigger that makes mac80211 call this
956 * handler is software decryption with wrap around of iv16.
960 * DOC: Frame filtering
962 * mac80211 requires to see many management frames for proper
963 * operation, and users may want to see many more frames when
964 * in monitor mode. However, for best CPU usage and power consumption,
965 * having as few frames as possible percolate through the stack is
966 * desirable. Hence, the hardware should filter as much as possible.
968 * To achieve this, mac80211 uses filter flags (see below) to tell
969 * the driver's configure_filter() function which frames should be
970 * passed to mac80211 and which should be filtered out.
972 * The configure_filter() callback is invoked with the parameters
973 * @mc_count and @mc_list for the combined multicast address list
974 * of all virtual interfaces, @changed_flags telling which flags
975 * were changed and @total_flags with the new flag states.
977 * If your device has no multicast address filters your driver will
978 * need to check both the %FIF_ALLMULTI flag and the @mc_count
979 * parameter to see whether multicast frames should be accepted
982 * All unsupported flags in @total_flags must be cleared.
983 * Hardware does not support a flag if it is incapable of _passing_
984 * the frame to the stack. Otherwise the driver must ignore
985 * the flag, but not clear it.
986 * You must _only_ clear the flag (announce no support for the
987 * flag to mac80211) if you are not able to pass the packet type
988 * to the stack (so the hardware always filters it).
989 * So for example, you should clear @FIF_CONTROL, if your hardware
990 * always filters control frames. If your hardware always passes
991 * control frames to the kernel and is incapable of filtering them,
992 * you do _not_ clear the @FIF_CONTROL flag.
993 * This rule applies to all other FIF flags as well.
997 * enum ieee80211_filter_flags - hardware filter flags
999 * These flags determine what the filter in hardware should be
1000 * programmed to let through and what should not be passed to the
1001 * stack. It is always safe to pass more frames than requested,
1002 * but this has negative impact on power consumption.
1004 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
1005 * think of the BSS as your network segment and then this corresponds
1006 * to the regular ethernet device promiscuous mode.
1008 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1009 * by the user or if the hardware is not capable of filtering by
1010 * multicast address.
1012 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1013 * %RX_FLAG_FAILED_FCS_CRC for them)
1015 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1016 * the %RX_FLAG_FAILED_PLCP_CRC for them
1018 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1019 * to the hardware that it should not filter beacons or probe responses
1020 * by BSSID. Filtering them can greatly reduce the amount of processing
1021 * mac80211 needs to do and the amount of CPU wakeups, so you should
1022 * honour this flag if possible.
1024 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
1025 * only those addressed to this station
1027 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1029 enum ieee80211_filter_flags {
1030 FIF_PROMISC_IN_BSS = 1<<0,
1031 FIF_ALLMULTI = 1<<1,
1033 FIF_PLCPFAIL = 1<<3,
1034 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1036 FIF_OTHER_BSS = 1<<6,
1040 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1042 * These flags are used with the ampdu_action() callback in
1043 * &struct ieee80211_ops to indicate which action is needed.
1044 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1045 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1046 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1047 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1049 enum ieee80211_ampdu_mlme_action {
1050 IEEE80211_AMPDU_RX_START,
1051 IEEE80211_AMPDU_RX_STOP,
1052 IEEE80211_AMPDU_TX_START,
1053 IEEE80211_AMPDU_TX_STOP,
1057 * struct ieee80211_ops - callbacks from mac80211 to the driver
1059 * This structure contains various callbacks that the driver may
1060 * handle or, in some cases, must handle, for example to configure
1061 * the hardware to a new channel or to transmit a frame.
1063 * @tx: Handler that 802.11 module calls for each transmitted frame.
1064 * skb contains the buffer starting from the IEEE 802.11 header.
1065 * The low-level driver should send the frame out based on
1066 * configuration in the TX control data. This handler should,
1067 * preferably, never fail and stop queues appropriately, more
1068 * importantly, however, it must never fail for A-MPDU-queues.
1069 * Must be implemented and atomic.
1071 * @start: Called before the first netdevice attached to the hardware
1072 * is enabled. This should turn on the hardware and must turn on
1073 * frame reception (for possibly enabled monitor interfaces.)
1074 * Returns negative error codes, these may be seen in userspace,
1076 * When the device is started it should not have a MAC address
1077 * to avoid acknowledging frames before a non-monitor device
1079 * Must be implemented.
1081 * @stop: Called after last netdevice attached to the hardware
1082 * is disabled. This should turn off the hardware (at least
1083 * it must turn off frame reception.)
1084 * May be called right after add_interface if that rejects
1086 * Must be implemented.
1088 * @add_interface: Called when a netdevice attached to the hardware is
1089 * enabled. Because it is not called for monitor mode devices, @open
1090 * and @stop must be implemented.
1091 * The driver should perform any initialization it needs before
1092 * the device can be enabled. The initial configuration for the
1093 * interface is given in the conf parameter.
1094 * The callback may refuse to add an interface by returning a
1095 * negative error code (which will be seen in userspace.)
1096 * Must be implemented.
1098 * @remove_interface: Notifies a driver that an interface is going down.
1099 * The @stop callback is called after this if it is the last interface
1100 * and no monitor interfaces are present.
1101 * When all interfaces are removed, the MAC address in the hardware
1102 * must be cleared so the device no longer acknowledges packets,
1103 * the mac_addr member of the conf structure is, however, set to the
1104 * MAC address of the device going away.
1105 * Hence, this callback must be implemented.
1107 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1108 * function to change hardware configuration, e.g., channel.
1110 * @config_interface: Handler for configuration requests related to interfaces
1111 * (e.g. BSSID changes.)
1113 * @bss_info_changed: Handler for configuration requests related to BSS
1114 * parameters that may vary during BSS's lifespan, and may affect low
1115 * level driver (e.g. assoc/disassoc status, erp parameters).
1116 * This function should not be used if no BSS has been set, unless
1117 * for association indication. The @changed parameter indicates which
1118 * of the bss parameters has changed when a call is made.
1120 * @configure_filter: Configure the device's RX filter.
1121 * See the section "Frame filtering" for more information.
1122 * This callback must be implemented and atomic.
1124 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1125 * must be set or cleared for a given STA. Must be atomic.
1127 * @set_key: See the section "Hardware crypto acceleration"
1128 * This callback can sleep, and is only called between add_interface
1129 * and remove_interface calls, i.e. while the interface with the
1130 * given local_address is enabled.
1132 * @update_tkip_key: See the section "Hardware crypto acceleration"
1133 * This callback will be called in the context of Rx. Called for drivers
1134 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1136 * @hw_scan: Ask the hardware to service the scan request, no need to start
1137 * the scan state machine in stack. The scan must honour the channel
1138 * configuration done by the regulatory agent in the wiphy's registered
1139 * bands. When the scan finishes, ieee80211_scan_completed() must be
1140 * called; note that it also must be called when the scan cannot finish
1141 * because the hardware is turned off! Anything else is a bug!
1143 * @get_stats: return low-level statistics
1145 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1146 * callback should be provided to read the TKIP transmit IVs (both IV32
1147 * and IV16) for the given key from hardware.
1149 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1151 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if
1152 * the device does fragmentation by itself; if this method is assigned then
1153 * the stack will not do fragmentation.
1155 * @set_retry_limit: Configuration of retry limits (if device needs it)
1157 * @sta_notify: Notifies low level driver about addition or removal
1158 * of assocaited station or AP.
1160 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1161 * bursting) for a hardware TX queue.
1163 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1164 * to get number of currently queued packets (queue length), maximum queue
1165 * size (limit), and total number of packets sent using each TX queue
1166 * (count). The 'stats' pointer points to an array that has hw->queues +
1167 * hw->ampdu_queues items.
1169 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1170 * this is only used for IBSS mode debugging and, as such, is not a
1171 * required function. Must be atomic.
1173 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1174 * with other STAs in the IBSS. This is only used in IBSS mode. This
1175 * function is optional if the firmware/hardware takes full care of
1176 * TSF synchronization.
1178 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1179 * This is needed only for IBSS mode and the result of this function is
1180 * used to determine whether to reply to Probe Requests.
1182 * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic.
1184 * @ampdu_action: Perform a certain A-MPDU action
1185 * The RA/TID combination determines the destination and TID we want
1186 * the ampdu action to be performed for. The action is defined through
1187 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1188 * is the first frame we expect to perform the action on. notice
1189 * that TX/RX_STOP can pass NULL for this parameter.
1191 struct ieee80211_ops {
1192 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1193 int (*start)(struct ieee80211_hw *hw);
1194 void (*stop)(struct ieee80211_hw *hw);
1195 int (*add_interface)(struct ieee80211_hw *hw,
1196 struct ieee80211_if_init_conf *conf);
1197 void (*remove_interface)(struct ieee80211_hw *hw,
1198 struct ieee80211_if_init_conf *conf);
1199 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
1200 int (*config_interface)(struct ieee80211_hw *hw,
1201 struct ieee80211_vif *vif,
1202 struct ieee80211_if_conf *conf);
1203 void (*bss_info_changed)(struct ieee80211_hw *hw,
1204 struct ieee80211_vif *vif,
1205 struct ieee80211_bss_conf *info,
1207 void (*configure_filter)(struct ieee80211_hw *hw,
1208 unsigned int changed_flags,
1209 unsigned int *total_flags,
1210 int mc_count, struct dev_addr_list *mc_list);
1211 int (*set_tim)(struct ieee80211_hw *hw, struct ieee80211_sta *sta,
1213 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1214 const u8 *local_address, const u8 *address,
1215 struct ieee80211_key_conf *key);
1216 void (*update_tkip_key)(struct ieee80211_hw *hw,
1217 struct ieee80211_key_conf *conf, const u8 *address,
1218 u32 iv32, u16 *phase1key);
1219 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
1220 int (*get_stats)(struct ieee80211_hw *hw,
1221 struct ieee80211_low_level_stats *stats);
1222 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1223 u32 *iv32, u16 *iv16);
1224 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1225 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
1226 int (*set_retry_limit)(struct ieee80211_hw *hw,
1227 u32 short_retry, u32 long_retr);
1228 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1229 enum sta_notify_cmd, struct ieee80211_sta *sta);
1230 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
1231 const struct ieee80211_tx_queue_params *params);
1232 int (*get_tx_stats)(struct ieee80211_hw *hw,
1233 struct ieee80211_tx_queue_stats *stats);
1234 u64 (*get_tsf)(struct ieee80211_hw *hw);
1235 void (*reset_tsf)(struct ieee80211_hw *hw);
1236 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1237 int (*ampdu_action)(struct ieee80211_hw *hw,
1238 enum ieee80211_ampdu_mlme_action action,
1239 struct ieee80211_sta *sta, u16 tid, u16 *ssn);
1243 * ieee80211_alloc_hw - Allocate a new hardware device
1245 * This must be called once for each hardware device. The returned pointer
1246 * must be used to refer to this device when calling other functions.
1247 * mac80211 allocates a private data area for the driver pointed to by
1248 * @priv in &struct ieee80211_hw, the size of this area is given as
1251 * @priv_data_len: length of private data
1252 * @ops: callbacks for this device
1254 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1255 const struct ieee80211_ops *ops);
1258 * ieee80211_register_hw - Register hardware device
1260 * You must call this function before any other functions in
1261 * mac80211. Note that before a hardware can be registered, you
1262 * need to fill the contained wiphy's information.
1264 * @hw: the device to register as returned by ieee80211_alloc_hw()
1266 int ieee80211_register_hw(struct ieee80211_hw *hw);
1268 #ifdef CONFIG_MAC80211_LEDS
1269 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1270 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1271 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1272 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1275 * ieee80211_get_tx_led_name - get name of TX LED
1277 * mac80211 creates a transmit LED trigger for each wireless hardware
1278 * that can be used to drive LEDs if your driver registers a LED device.
1279 * This function returns the name (or %NULL if not configured for LEDs)
1280 * of the trigger so you can automatically link the LED device.
1282 * @hw: the hardware to get the LED trigger name for
1284 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1286 #ifdef CONFIG_MAC80211_LEDS
1287 return __ieee80211_get_tx_led_name(hw);
1294 * ieee80211_get_rx_led_name - get name of RX LED
1296 * mac80211 creates a receive LED trigger for each wireless hardware
1297 * that can be used to drive LEDs if your driver registers a LED device.
1298 * This function returns the name (or %NULL if not configured for LEDs)
1299 * of the trigger so you can automatically link the LED device.
1301 * @hw: the hardware to get the LED trigger name for
1303 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1305 #ifdef CONFIG_MAC80211_LEDS
1306 return __ieee80211_get_rx_led_name(hw);
1313 * ieee80211_get_assoc_led_name - get name of association LED
1315 * mac80211 creates a association LED trigger for each wireless hardware
1316 * that can be used to drive LEDs if your driver registers a LED device.
1317 * This function returns the name (or %NULL if not configured for LEDs)
1318 * of the trigger so you can automatically link the LED device.
1320 * @hw: the hardware to get the LED trigger name for
1322 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1324 #ifdef CONFIG_MAC80211_LEDS
1325 return __ieee80211_get_assoc_led_name(hw);
1332 * ieee80211_get_radio_led_name - get name of radio LED
1334 * mac80211 creates a radio change LED trigger for each wireless hardware
1335 * that can be used to drive LEDs if your driver registers a LED device.
1336 * This function returns the name (or %NULL if not configured for LEDs)
1337 * of the trigger so you can automatically link the LED device.
1339 * @hw: the hardware to get the LED trigger name for
1341 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1343 #ifdef CONFIG_MAC80211_LEDS
1344 return __ieee80211_get_radio_led_name(hw);
1351 * ieee80211_unregister_hw - Unregister a hardware device
1353 * This function instructs mac80211 to free allocated resources
1354 * and unregister netdevices from the networking subsystem.
1356 * @hw: the hardware to unregister
1358 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1361 * ieee80211_free_hw - free hardware descriptor
1363 * This function frees everything that was allocated, including the
1364 * private data for the driver. You must call ieee80211_unregister_hw()
1365 * before calling this function.
1367 * @hw: the hardware to free
1369 void ieee80211_free_hw(struct ieee80211_hw *hw);
1371 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1372 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1373 struct ieee80211_rx_status *status);
1376 * ieee80211_rx - receive frame
1378 * Use this function to hand received frames to mac80211. The receive
1379 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1380 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1382 * This function may not be called in IRQ context. Calls to this function
1383 * for a single hardware must be synchronized against each other. Calls
1384 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1387 * @hw: the hardware this frame came in on
1388 * @skb: the buffer to receive, owned by mac80211 after this call
1389 * @status: status of this frame; the status pointer need not be valid
1390 * after this function returns
1392 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1393 struct ieee80211_rx_status *status)
1395 __ieee80211_rx(hw, skb, status);
1399 * ieee80211_rx_irqsafe - receive frame
1401 * Like ieee80211_rx() but can be called in IRQ context
1402 * (internally defers to a tasklet.)
1404 * Calls to this function and ieee80211_rx() may not be mixed for a
1407 * @hw: the hardware this frame came in on
1408 * @skb: the buffer to receive, owned by mac80211 after this call
1409 * @status: status of this frame; the status pointer need not be valid
1410 * after this function returns and is not freed by mac80211,
1411 * it is recommended that it points to a stack area
1413 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1414 struct sk_buff *skb,
1415 struct ieee80211_rx_status *status);
1418 * ieee80211_tx_status - transmit status callback
1420 * Call this function for all transmitted frames after they have been
1421 * transmitted. It is permissible to not call this function for
1422 * multicast frames but this can affect statistics.
1424 * This function may not be called in IRQ context. Calls to this function
1425 * for a single hardware must be synchronized against each other. Calls
1426 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1427 * for a single hardware.
1429 * @hw: the hardware the frame was transmitted by
1430 * @skb: the frame that was transmitted, owned by mac80211 after this call
1432 void ieee80211_tx_status(struct ieee80211_hw *hw,
1433 struct sk_buff *skb);
1436 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
1438 * Like ieee80211_tx_status() but can be called in IRQ context
1439 * (internally defers to a tasklet.)
1441 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1444 * @hw: the hardware the frame was transmitted by
1445 * @skb: the frame that was transmitted, owned by mac80211 after this call
1447 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1448 struct sk_buff *skb);
1451 * ieee80211_beacon_get - beacon generation function
1452 * @hw: pointer obtained from ieee80211_alloc_hw().
1453 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1454 * @control: will be filled with information needed to send this beacon.
1456 * If the beacon frames are generated by the host system (i.e., not in
1457 * hardware/firmware), the low-level driver uses this function to receive
1458 * the next beacon frame from the 802.11 code. The low-level is responsible
1459 * for calling this function before beacon data is needed (e.g., based on
1460 * hardware interrupt). Returned skb is used only once and low-level driver
1461 * is responsible of freeing it.
1463 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1464 struct ieee80211_vif *vif);
1467 * ieee80211_rts_get - RTS frame generation function
1468 * @hw: pointer obtained from ieee80211_alloc_hw().
1469 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1470 * @frame: pointer to the frame that is going to be protected by the RTS.
1471 * @frame_len: the frame length (in octets).
1472 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1473 * @rts: The buffer where to store the RTS frame.
1475 * If the RTS frames are generated by the host system (i.e., not in
1476 * hardware/firmware), the low-level driver uses this function to receive
1477 * the next RTS frame from the 802.11 code. The low-level is responsible
1478 * for calling this function before and RTS frame is needed.
1480 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1481 const void *frame, size_t frame_len,
1482 const struct ieee80211_tx_info *frame_txctl,
1483 struct ieee80211_rts *rts);
1486 * ieee80211_rts_duration - Get the duration field for an RTS frame
1487 * @hw: pointer obtained from ieee80211_alloc_hw().
1488 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1489 * @frame_len: the length of the frame that is going to be protected by the RTS.
1490 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1492 * If the RTS is generated in firmware, but the host system must provide
1493 * the duration field, the low-level driver uses this function to receive
1494 * the duration field value in little-endian byteorder.
1496 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1497 struct ieee80211_vif *vif, size_t frame_len,
1498 const struct ieee80211_tx_info *frame_txctl);
1501 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1502 * @hw: pointer obtained from ieee80211_alloc_hw().
1503 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1504 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1505 * @frame_len: the frame length (in octets).
1506 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1507 * @cts: The buffer where to store the CTS-to-self frame.
1509 * If the CTS-to-self frames are generated by the host system (i.e., not in
1510 * hardware/firmware), the low-level driver uses this function to receive
1511 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1512 * for calling this function before and CTS-to-self frame is needed.
1514 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1515 struct ieee80211_vif *vif,
1516 const void *frame, size_t frame_len,
1517 const struct ieee80211_tx_info *frame_txctl,
1518 struct ieee80211_cts *cts);
1521 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1522 * @hw: pointer obtained from ieee80211_alloc_hw().
1523 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1524 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1525 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1527 * If the CTS-to-self is generated in firmware, but the host system must provide
1528 * the duration field, the low-level driver uses this function to receive
1529 * the duration field value in little-endian byteorder.
1531 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1532 struct ieee80211_vif *vif,
1534 const struct ieee80211_tx_info *frame_txctl);
1537 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1538 * @hw: pointer obtained from ieee80211_alloc_hw().
1539 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1540 * @frame_len: the length of the frame.
1541 * @rate: the rate at which the frame is going to be transmitted.
1543 * Calculate the duration field of some generic frame, given its
1544 * length and transmission rate (in 100kbps).
1546 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1547 struct ieee80211_vif *vif,
1549 struct ieee80211_rate *rate);
1552 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1553 * @hw: pointer as obtained from ieee80211_alloc_hw().
1554 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1555 * @control: will be filled with information needed to send returned frame.
1557 * Function for accessing buffered broadcast and multicast frames. If
1558 * hardware/firmware does not implement buffering of broadcast/multicast
1559 * frames when power saving is used, 802.11 code buffers them in the host
1560 * memory. The low-level driver uses this function to fetch next buffered
1561 * frame. In most cases, this is used when generating beacon frame. This
1562 * function returns a pointer to the next buffered skb or NULL if no more
1563 * buffered frames are available.
1565 * Note: buffered frames are returned only after DTIM beacon frame was
1566 * generated with ieee80211_beacon_get() and the low-level driver must thus
1567 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1568 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1569 * does not need to check for DTIM beacons separately and should be able to
1570 * use common code for all beacons.
1573 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
1576 * ieee80211_get_hdrlen_from_skb - get header length from data
1578 * Given an skb with a raw 802.11 header at the data pointer this function
1579 * returns the 802.11 header length in bytes (not including encryption
1580 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1581 * header the function returns 0.
1585 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1588 * ieee80211_hdrlen - get header length in bytes from frame control
1589 * @fc: frame control field in little-endian format
1591 unsigned int ieee80211_hdrlen(__le16 fc);
1594 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1596 * This function computes a TKIP rc4 key for an skb. It computes
1597 * a phase 1 key if needed (iv16 wraps around). This function is to
1598 * be used by drivers which can do HW encryption but need to compute
1599 * to phase 1/2 key in SW.
1601 * @keyconf: the parameter passed with the set key
1602 * @skb: the skb for which the key is needed
1603 * @rc4key: a buffer to which the key will be written
1607 void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1608 struct sk_buff *skb,
1609 enum ieee80211_tkip_key_type type, u8 *key);
1611 * ieee80211_wake_queue - wake specific queue
1612 * @hw: pointer as obtained from ieee80211_alloc_hw().
1613 * @queue: queue number (counted from zero).
1615 * Drivers should use this function instead of netif_wake_queue.
1617 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1620 * ieee80211_stop_queue - stop specific queue
1621 * @hw: pointer as obtained from ieee80211_alloc_hw().
1622 * @queue: queue number (counted from zero).
1624 * Drivers should use this function instead of netif_stop_queue.
1626 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1629 * ieee80211_queue_stopped - test status of the queue
1630 * @hw: pointer as obtained from ieee80211_alloc_hw().
1631 * @queue: queue number (counted from zero).
1633 * Drivers should use this function instead of netif_stop_queue.
1636 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
1639 * ieee80211_stop_queues - stop all queues
1640 * @hw: pointer as obtained from ieee80211_alloc_hw().
1642 * Drivers should use this function instead of netif_stop_queue.
1644 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1647 * ieee80211_wake_queues - wake all queues
1648 * @hw: pointer as obtained from ieee80211_alloc_hw().
1650 * Drivers should use this function instead of netif_wake_queue.
1652 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1655 * ieee80211_scan_completed - completed hardware scan
1657 * When hardware scan offload is used (i.e. the hw_scan() callback is
1658 * assigned) this function needs to be called by the driver to notify
1659 * mac80211 that the scan finished.
1661 * @hw: the hardware that finished the scan
1663 void ieee80211_scan_completed(struct ieee80211_hw *hw);
1666 * ieee80211_iterate_active_interfaces - iterate active interfaces
1668 * This function iterates over the interfaces associated with a given
1669 * hardware that are currently active and calls the callback for them.
1670 * This function allows the iterator function to sleep, when the iterator
1671 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
1674 * @hw: the hardware struct of which the interfaces should be iterated over
1675 * @iterator: the iterator function to call
1676 * @data: first argument of the iterator function
1678 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1679 void (*iterator)(void *data, u8 *mac,
1680 struct ieee80211_vif *vif),
1684 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
1686 * This function iterates over the interfaces associated with a given
1687 * hardware that are currently active and calls the callback for them.
1688 * This function requires the iterator callback function to be atomic,
1689 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
1691 * @hw: the hardware struct of which the interfaces should be iterated over
1692 * @iterator: the iterator function to call, cannot sleep
1693 * @data: first argument of the iterator function
1695 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
1696 void (*iterator)(void *data,
1698 struct ieee80211_vif *vif),
1702 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1703 * @hw: pointer as obtained from ieee80211_alloc_hw().
1704 * @ra: receiver address of the BA session recipient
1705 * @tid: the TID to BA on.
1706 * @return: success if addBA request was sent, failure otherwise
1708 * Although mac80211/low level driver/user space application can estimate
1709 * the need to start aggregation on a certain RA/TID, the session level
1710 * will be managed by the mac80211.
1712 int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1715 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1716 * @hw: pointer as obtained from ieee80211_alloc_hw().
1717 * @ra: receiver address of the BA session recipient.
1718 * @tid: the TID to BA on.
1720 * This function must be called by low level driver once it has
1721 * finished with preparations for the BA session.
1723 void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1726 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1727 * @hw: pointer as obtained from ieee80211_alloc_hw().
1728 * @ra: receiver address of the BA session recipient.
1729 * @tid: the TID to BA on.
1731 * This function must be called by low level driver once it has
1732 * finished with preparations for the BA session.
1733 * This version of the function is IRQ-safe.
1735 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1739 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1740 * @hw: pointer as obtained from ieee80211_alloc_hw().
1741 * @ra: receiver address of the BA session recipient
1742 * @tid: the TID to stop BA.
1743 * @initiator: if indicates initiator DELBA frame will be sent.
1744 * @return: error if no sta with matching da found, success otherwise
1746 * Although mac80211/low level driver/user space application can estimate
1747 * the need to stop aggregation on a certain RA/TID, the session level
1748 * will be managed by the mac80211.
1750 int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1752 enum ieee80211_back_parties initiator);
1755 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1756 * @hw: pointer as obtained from ieee80211_alloc_hw().
1757 * @ra: receiver address of the BA session recipient.
1758 * @tid: the desired TID to BA on.
1760 * This function must be called by low level driver once it has
1761 * finished with preparations for the BA session tear down.
1763 void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1766 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1767 * @hw: pointer as obtained from ieee80211_alloc_hw().
1768 * @ra: receiver address of the BA session recipient.
1769 * @tid: the desired TID to BA on.
1771 * This function must be called by low level driver once it has
1772 * finished with preparations for the BA session tear down.
1773 * This version of the function is IRQ-safe.
1775 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1779 * ieee80211_notify_mac - low level driver notification
1780 * @hw: pointer as obtained from ieee80211_alloc_hw().
1781 * @notif_type: enum ieee80211_notification_types
1783 * This function must be called by low level driver to inform mac80211 of
1784 * low level driver status change or force mac80211 to re-assoc for low
1785 * level driver internal error that require re-assoc.
1787 void ieee80211_notify_mac(struct ieee80211_hw *hw,
1788 enum ieee80211_notification_types notif_type);
1791 * ieee80211_find_sta - find a station
1793 * @hw: pointer as obtained from ieee80211_alloc_hw()
1794 * @addr: station's address
1796 * This function must be called under RCU lock and the
1797 * resulting pointer is only valid under RCU lock as well.
1799 struct ieee80211_sta *ieee80211_find_sta(struct ieee80211_hw *hw,
1802 #endif /* MAC80211_H */