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-irqsafe 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, -1: use default]
119 * @cw_min: minimum contention window [will be a value of the form
120 * 2^n-1 in the range 1..1023; 0: use default]
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_HT: 802.11n parameters changed
163 enum ieee80211_bss_change {
164 BSS_CHANGED_ASSOC = 1<<0,
165 BSS_CHANGED_ERP_CTS_PROT = 1<<1,
166 BSS_CHANGED_ERP_PREAMBLE = 1<<2,
167 BSS_CHANGED_HT = 1<<4,
171 * struct ieee80211_bss_conf - holds the BSS's changing parameters
173 * This structure keeps information about a BSS (and an association
174 * to that BSS) that can change during the lifetime of the BSS.
176 * @assoc: association status
177 * @aid: association ID number, valid only when @assoc is true
178 * @use_cts_prot: use CTS protection
179 * @use_short_preamble: use 802.11b short preamble
180 * @timestamp: beacon timestamp
181 * @beacon_int: beacon interval
182 * @assoc_capability: capabbilities taken from assoc resp
183 * @assoc_ht: association in HT mode
184 * @ht_conf: ht capabilities
185 * @ht_bss_conf: ht extended capabilities
187 struct ieee80211_bss_conf {
188 /* association related data */
191 /* erp related data */
193 bool use_short_preamble;
195 u16 assoc_capability;
197 /* ht related data */
199 struct ieee80211_ht_info *ht_conf;
200 struct ieee80211_ht_bss_info *ht_bss_conf;
204 * enum mac80211_tx_flags - flags to transmission information/status
206 * These flags are used with the @flags member of &ieee80211_tx_info
208 * @IEEE80211_TX_CTL_REQ_TX_STATUS: request TX status callback for this frame.
209 * @IEEE80211_TX_CTL_DO_NOT_ENCRYPT: send this frame without encryption;
210 * e.g., for EAPOL frame
211 * @IEEE80211_TX_CTL_USE_RTS_CTS: use RTS-CTS before sending frame
212 * @IEEE80211_TX_CTL_USE_CTS_PROTECT: use CTS protection for the frame (e.g.,
213 * for combined 802.11g / 802.11b networks)
214 * @IEEE80211_TX_CTL_NO_ACK: tell the low level not to wait for an ack
215 * @IEEE80211_TX_CTL_RATE_CTRL_PROBE
216 * @IEEE80211_TX_CTL_CLEAR_PS_FILT: clear powersave filter for destination
218 * @IEEE80211_TX_CTL_REQUEUE:
219 * @IEEE80211_TX_CTL_FIRST_FRAGMENT: this is a first fragment of the frame
220 * @IEEE80211_TX_CTL_LONG_RETRY_LIMIT: this frame should be send using the
221 * through set_retry_limit configured long retry value
222 * @IEEE80211_TX_CTL_EAPOL_FRAME: internal to mac80211
223 * @IEEE80211_TX_CTL_SEND_AFTER_DTIM: send this frame after DTIM beacon
224 * @IEEE80211_TX_CTL_AMPDU: this frame should be sent as part of an A-MPDU
225 * @IEEE80211_TX_CTL_OFDM_HT: this frame can be sent in HT OFDM rates. number
226 * of streams when this flag is on can be extracted from antenna_sel_tx,
227 * so if 1 antenna is marked use SISO, 2 antennas marked use MIMO, n
228 * antennas marked use MIMO_n.
229 * @IEEE80211_TX_CTL_GREEN_FIELD: use green field protection for this frame
230 * @IEEE80211_TX_CTL_40_MHZ_WIDTH: send this frame using 40 Mhz channel width
231 * @IEEE80211_TX_CTL_DUP_DATA: duplicate data frame on both 20 Mhz channels
232 * @IEEE80211_TX_CTL_SHORT_GI: send this frame using short guard interval
233 * @IEEE80211_TX_STAT_TX_FILTERED: The frame was not transmitted
234 * because the destination STA was in powersave mode.
235 * @IEEE80211_TX_STAT_ACK: Frame was acknowledged
236 * @IEEE80211_TX_STAT_AMPDU: The frame was aggregated, so status
237 * is for the whole aggregation.
239 enum mac80211_tx_control_flags {
240 IEEE80211_TX_CTL_REQ_TX_STATUS = BIT(0),
241 IEEE80211_TX_CTL_DO_NOT_ENCRYPT = BIT(1),
242 IEEE80211_TX_CTL_USE_RTS_CTS = BIT(2),
243 IEEE80211_TX_CTL_USE_CTS_PROTECT = BIT(3),
244 IEEE80211_TX_CTL_NO_ACK = BIT(4),
245 IEEE80211_TX_CTL_RATE_CTRL_PROBE = BIT(5),
246 IEEE80211_TX_CTL_CLEAR_PS_FILT = BIT(6),
247 IEEE80211_TX_CTL_REQUEUE = BIT(7),
248 IEEE80211_TX_CTL_FIRST_FRAGMENT = BIT(8),
249 IEEE80211_TX_CTL_SHORT_PREAMBLE = BIT(9),
250 IEEE80211_TX_CTL_LONG_RETRY_LIMIT = BIT(10),
251 IEEE80211_TX_CTL_EAPOL_FRAME = BIT(11),
252 IEEE80211_TX_CTL_SEND_AFTER_DTIM = BIT(12),
253 IEEE80211_TX_CTL_AMPDU = BIT(13),
254 IEEE80211_TX_CTL_OFDM_HT = BIT(14),
255 IEEE80211_TX_CTL_GREEN_FIELD = BIT(15),
256 IEEE80211_TX_CTL_40_MHZ_WIDTH = BIT(16),
257 IEEE80211_TX_CTL_DUP_DATA = BIT(17),
258 IEEE80211_TX_CTL_SHORT_GI = BIT(18),
259 IEEE80211_TX_CTL_INJECTED = BIT(19),
260 IEEE80211_TX_STAT_TX_FILTERED = BIT(20),
261 IEEE80211_TX_STAT_ACK = BIT(21),
262 IEEE80211_TX_STAT_AMPDU = BIT(22),
266 #define IEEE80211_TX_INFO_DRIVER_DATA_SIZE \
267 (sizeof(((struct sk_buff *)0)->cb) - 8)
268 #define IEEE80211_TX_INFO_DRIVER_DATA_PTRS \
269 (IEEE80211_TX_INFO_DRIVER_DATA_SIZE / sizeof(void *))
272 * struct ieee80211_tx_info - skb transmit information
274 * This structure is placed in skb->cb for three uses:
275 * (1) mac80211 TX control - mac80211 tells the driver what to do
276 * (2) driver internal use (if applicable)
277 * (3) TX status information - driver tells mac80211 what happened
279 * @flags: transmit info flags, defined above
280 * @retry_count: number of retries
281 * @excessive_retries: set to 1 if the frame was retried many times
282 * but not acknowledged
283 * @ampdu_ack_len: number of aggregated frames.
284 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
285 * @ampdu_ack_map: block ack bit map for the aggregation.
286 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
287 * @ack_signal: signal strength of the ACK frame
289 struct ieee80211_tx_info {
290 /* common information */
300 struct ieee80211_vif *vif;
301 struct ieee80211_key_conf *hw_key;
302 unsigned long jiffies;
305 s8 rts_cts_rate_idx, alt_retry_rate_idx;
314 bool excessive_retries;
317 void *driver_data[IEEE80211_TX_INFO_DRIVER_DATA_PTRS];
321 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
323 return (struct ieee80211_tx_info *)skb->cb;
328 * enum mac80211_rx_flags - receive flags
330 * These flags are used with the @flag member of &struct ieee80211_rx_status.
331 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
332 * Use together with %RX_FLAG_MMIC_STRIPPED.
333 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
334 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
335 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
336 * verification has been done by the hardware.
337 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
338 * If this flag is set, the stack cannot do any replay detection
339 * hence the driver or hardware will have to do that.
340 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
342 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
344 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
345 * is valid. This is useful in monitor mode and necessary for beacon frames
346 * to enable IBSS merging.
348 enum mac80211_rx_flags {
349 RX_FLAG_MMIC_ERROR = 1<<0,
350 RX_FLAG_DECRYPTED = 1<<1,
351 RX_FLAG_RADIOTAP = 1<<2,
352 RX_FLAG_MMIC_STRIPPED = 1<<3,
353 RX_FLAG_IV_STRIPPED = 1<<4,
354 RX_FLAG_FAILED_FCS_CRC = 1<<5,
355 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
360 * struct ieee80211_rx_status - receive status
362 * The low-level driver should provide this information (the subset
363 * supported by hardware) to the 802.11 code with each received
366 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
367 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
368 * @band: the active band when this frame was received
369 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
370 * @signal: signal strength when receiving this frame, either in dBm, in dB or
371 * unspecified depending on the hardware capabilities flags
372 * @IEEE80211_HW_SIGNAL_*
373 * @noise: noise when receiving this frame, in dBm.
374 * @qual: overall signal quality indication, in percent (0-100).
375 * @antenna: antenna used
376 * @rate_idx: index of data rate into band's supported rates
379 struct ieee80211_rx_status {
381 enum ieee80211_band band;
392 * enum ieee80211_conf_flags - configuration flags
394 * Flags to define PHY configuration options
396 * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time
397 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
398 * @IEEE80211_CONF_SUPPORT_HT_MODE: use 802.11n HT capabilities (if supported)
400 enum ieee80211_conf_flags {
401 IEEE80211_CONF_SHORT_SLOT_TIME = (1<<0),
402 IEEE80211_CONF_RADIOTAP = (1<<1),
403 IEEE80211_CONF_SUPPORT_HT_MODE = (1<<2),
407 * struct ieee80211_conf - configuration of the device
409 * This struct indicates how the driver shall configure the hardware.
411 * @radio_enabled: when zero, driver is required to switch off the radio.
413 * @beacon_int: beacon interval (TODO make interface config)
414 * @flags: configuration flags defined above
415 * @power_level: requested transmit power (in dBm)
416 * @max_antenna_gain: maximum antenna gain (in dBi)
417 * @antenna_sel_tx: transmit antenna selection, 0: default/diversity,
419 * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx
420 * @ht_conf: describes current self configuration of 802.11n HT capabilies
421 * @ht_bss_conf: describes current BSS configuration of 802.11n HT parameters
422 * @channel: the channel to tune to
424 struct ieee80211_conf {
430 int max_antenna_gain;
434 struct ieee80211_channel *channel;
436 struct ieee80211_ht_info ht_conf;
437 struct ieee80211_ht_bss_info ht_bss_conf;
441 * enum ieee80211_if_types - types of 802.11 network interfaces
443 * @IEEE80211_IF_TYPE_INVALID: invalid interface type, not used
445 * @IEEE80211_IF_TYPE_AP: interface in AP mode.
446 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap
447 * daemon. Drivers should never see this type.
448 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode.
449 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode.
450 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode.
451 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode.
452 * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers
453 * will never see this type.
454 * @IEEE80211_IF_TYPE_MESH_POINT: 802.11s mesh point
456 enum ieee80211_if_types {
457 IEEE80211_IF_TYPE_INVALID,
458 IEEE80211_IF_TYPE_AP,
459 IEEE80211_IF_TYPE_STA,
460 IEEE80211_IF_TYPE_IBSS,
461 IEEE80211_IF_TYPE_MESH_POINT,
462 IEEE80211_IF_TYPE_MNTR,
463 IEEE80211_IF_TYPE_WDS,
464 IEEE80211_IF_TYPE_VLAN,
468 * struct ieee80211_vif - per-interface data
470 * Data in this structure is continually present for driver
471 * use during the life of a virtual interface.
473 * @type: type of this virtual interface
474 * @drv_priv: data area for driver use, will always be aligned to
477 struct ieee80211_vif {
478 enum ieee80211_if_types type;
480 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
483 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
485 #ifdef CONFIG_MAC80211_MESH
486 return vif->type == IEEE80211_IF_TYPE_MESH_POINT;
492 * struct ieee80211_if_init_conf - initial configuration of an interface
494 * @vif: pointer to a driver-use per-interface structure. The pointer
495 * itself is also used for various functions including
496 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
497 * @type: one of &enum ieee80211_if_types constants. Determines the type of
498 * added/removed interface.
499 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
500 * until the interface is removed (i.e. it cannot be used after
501 * remove_interface() callback was called for this interface).
503 * This structure is used in add_interface() and remove_interface()
504 * callbacks of &struct ieee80211_hw.
506 * When you allow multiple interfaces to be added to your PHY, take care
507 * that the hardware can actually handle multiple MAC addresses. However,
508 * also take care that when there's no interface left with mac_addr != %NULL
509 * you remove the MAC address from the device to avoid acknowledging packets
510 * in pure monitor mode.
512 struct ieee80211_if_init_conf {
513 enum ieee80211_if_types type;
514 struct ieee80211_vif *vif;
519 * struct ieee80211_if_conf - configuration of an interface
521 * @type: type of the interface. This is always the same as was specified in
522 * &struct ieee80211_if_init_conf. The type of an interface never changes
523 * during the life of the interface; this field is present only for
525 * @bssid: BSSID of the network we are associated to/creating.
526 * @ssid: used (together with @ssid_len) by drivers for hardware that
527 * generate beacons independently. The pointer is valid only during the
528 * config_interface() call, so copy the value somewhere if you need
530 * @ssid_len: length of the @ssid field.
531 * @beacon: beacon template. Valid only if @host_gen_beacon_template in
532 * &struct ieee80211_hw is set. The driver is responsible of freeing
534 * @beacon_control: tx_control for the beacon template, this field is only
535 * valid when the @beacon field was set.
537 * This structure is passed to the config_interface() callback of
538 * &struct ieee80211_hw.
540 struct ieee80211_if_conf {
545 struct sk_buff *beacon;
549 * enum ieee80211_key_alg - key algorithm
550 * @ALG_WEP: WEP40 or WEP104
552 * @ALG_CCMP: CCMP (AES)
554 enum ieee80211_key_alg {
562 * enum ieee80211_key_flags - key flags
564 * These flags are used for communication about keys between the driver
565 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
567 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
568 * that the STA this key will be used with could be using QoS.
569 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
570 * driver to indicate that it requires IV generation for this
572 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
573 * the driver for a TKIP key if it requires Michael MIC
574 * generation in software.
575 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
576 * that the key is pairwise rather then a shared key.
578 enum ieee80211_key_flags {
579 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
580 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
581 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
582 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
586 * struct ieee80211_key_conf - key information
588 * This key information is given by mac80211 to the driver by
589 * the set_key() callback in &struct ieee80211_ops.
591 * @hw_key_idx: To be set by the driver, this is the key index the driver
592 * wants to be given when a frame is transmitted and needs to be
593 * encrypted in hardware.
594 * @alg: The key algorithm.
595 * @flags: key flags, see &enum ieee80211_key_flags.
596 * @keyidx: the key index (0-3)
597 * @keylen: key material length
598 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
600 * - Temporal Encryption Key (128 bits)
601 * - Temporal Authenticator Tx MIC Key (64 bits)
602 * - Temporal Authenticator Rx MIC Key (64 bits)
605 struct ieee80211_key_conf {
606 enum ieee80211_key_alg alg;
615 * enum set_key_cmd - key command
617 * Used with the set_key() callback in &struct ieee80211_ops, this
618 * indicates whether a key is being removed or added.
620 * @SET_KEY: a key is set
621 * @DISABLE_KEY: a key must be disabled
624 SET_KEY, DISABLE_KEY,
628 * enum sta_notify_cmd - sta notify command
630 * Used with the sta_notify() callback in &struct ieee80211_ops, this
631 * indicates addition and removal of a station to station table
633 * @STA_NOTIFY_ADD: a station was added to the station table
634 * @STA_NOTIFY_REMOVE: a station being removed from the station table
636 enum sta_notify_cmd {
637 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE
641 * enum ieee80211_tkip_key_type - get tkip key
643 * Used by drivers which need to get a tkip key for skb. Some drivers need a
644 * phase 1 key, others need a phase 2 key. A single function allows the driver
645 * to get the key, this enum indicates what type of key is required.
647 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
648 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
650 enum ieee80211_tkip_key_type {
651 IEEE80211_TKIP_P1_KEY,
652 IEEE80211_TKIP_P2_KEY,
656 * enum ieee80211_hw_flags - hardware flags
658 * These flags are used to indicate hardware capabilities to
659 * the stack. Generally, flags here should have their meaning
660 * done in a way that the simplest hardware doesn't need setting
661 * any particular flags. There are some exceptions to this rule,
662 * however, so you are advised to review these flags carefully.
664 * @IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE:
665 * The device only needs to be supplied with a beacon template.
666 * If you need the host to generate each beacon then don't use
667 * this flag and call ieee80211_beacon_get() when you need the
668 * next beacon frame. Note that if you set this flag, you must
669 * implement the set_tim() callback for powersave mode to work
671 * This flag is only relevant for access-point mode.
673 * @IEEE80211_HW_RX_INCLUDES_FCS:
674 * Indicates that received frames passed to the stack include
675 * the FCS at the end.
677 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
678 * Some wireless LAN chipsets buffer broadcast/multicast frames
679 * for power saving stations in the hardware/firmware and others
680 * rely on the host system for such buffering. This option is used
681 * to configure the IEEE 802.11 upper layer to buffer broadcast and
682 * multicast frames when there are power saving stations so that
683 * the driver can fetch them with ieee80211_get_buffered_bc(). Note
684 * that not setting this flag works properly only when the
685 * %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is also not set because
686 * otherwise the stack will not know when the DTIM beacon was sent.
688 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
689 * Hardware is not capable of short slot operation on the 2.4 GHz band.
691 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
692 * Hardware is not capable of receiving frames with short preamble on
695 * @IEEE80211_HW_SIGNAL_UNSPEC:
696 * Hardware can provide signal values but we don't know its units. We
697 * expect values between 0 and @max_signal.
698 * If possible please provide dB or dBm instead.
700 * @IEEE80211_HW_SIGNAL_DB:
701 * Hardware gives signal values in dB, decibel difference from an
702 * arbitrary, fixed reference. We expect values between 0 and @max_signal.
703 * If possible please provide dBm instead.
705 * @IEEE80211_HW_SIGNAL_DBM:
706 * Hardware gives signal values in dBm, decibel difference from
707 * one milliwatt. This is the preferred method since it is standardized
708 * between different devices. @max_signal does not need to be set.
710 * @IEEE80211_HW_NOISE_DBM:
711 * Hardware can provide noise (radio interference) values in units dBm,
712 * decibel difference from one milliwatt.
714 enum ieee80211_hw_flags {
715 IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE = 1<<0,
716 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
717 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
718 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
719 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
720 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
721 IEEE80211_HW_SIGNAL_DB = 1<<6,
722 IEEE80211_HW_SIGNAL_DBM = 1<<7,
723 IEEE80211_HW_NOISE_DBM = 1<<8,
727 * struct ieee80211_hw - hardware information and state
729 * This structure contains the configuration and hardware
730 * information for an 802.11 PHY.
732 * @wiphy: This points to the &struct wiphy allocated for this
733 * 802.11 PHY. You must fill in the @perm_addr and @dev
734 * members of this structure using SET_IEEE80211_DEV()
735 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
736 * bands (with channels, bitrates) are registered here.
738 * @conf: &struct ieee80211_conf, device configuration, don't use.
740 * @workqueue: single threaded workqueue available for driver use,
741 * allocated by mac80211 on registration and flushed when an
742 * interface is removed.
743 * NOTICE: All work performed on this workqueue should NEVER
744 * acquire the RTNL lock (i.e. Don't use the function
745 * ieee80211_iterate_active_interfaces())
747 * @priv: pointer to private area that was allocated for driver use
748 * along with this structure.
750 * @flags: hardware flags, see &enum ieee80211_hw_flags.
752 * @extra_tx_headroom: headroom to reserve in each transmit skb
753 * for use by the driver (e.g. for transmit headers.)
755 * @channel_change_time: time (in microseconds) it takes to change channels.
757 * @max_signal: Maximum value for signal (rssi) in RX information, used
758 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
760 * @queues: number of available hardware transmit queues for
761 * data packets. WMM/QoS requires at least four, these
762 * queues need to have configurable access parameters.
764 * @ampdu_queues: number of available hardware transmit queues
765 * for A-MPDU packets, these have no access parameters
766 * because they're used only for A-MPDU frames. Note that
767 * mac80211 will not currently use any of the regular queues
770 * @rate_control_algorithm: rate control algorithm for this hardware.
771 * If unset (NULL), the default algorithm will be used. Must be
772 * set before calling ieee80211_register_hw().
774 * @vif_data_size: size (in bytes) of the drv_priv data area
775 * within &struct ieee80211_vif.
777 struct ieee80211_hw {
778 struct ieee80211_conf conf;
780 struct workqueue_struct *workqueue;
781 const char *rate_control_algorithm;
784 unsigned int extra_tx_headroom;
785 int channel_change_time;
787 u16 queues, ampdu_queues;
792 * SET_IEEE80211_DEV - set device for 802.11 hardware
794 * @hw: the &struct ieee80211_hw to set the device for
795 * @dev: the &struct device of this 802.11 device
797 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
799 set_wiphy_dev(hw->wiphy, dev);
803 * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware
805 * @hw: the &struct ieee80211_hw to set the MAC address for
806 * @addr: the address to set
808 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
810 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
813 static inline int ieee80211_num_regular_queues(struct ieee80211_hw *hw)
815 #ifdef CONFIG_MAC80211_QOS
822 static inline int ieee80211_num_queues(struct ieee80211_hw *hw)
824 #ifdef CONFIG_MAC80211_QOS
825 return hw->queues + hw->ampdu_queues;
831 static inline struct ieee80211_rate *
832 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
833 const struct ieee80211_tx_info *c)
835 if (WARN_ON(c->tx_rate_idx < 0))
837 return &hw->wiphy->bands[c->band]->bitrates[c->tx_rate_idx];
840 static inline struct ieee80211_rate *
841 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
842 const struct ieee80211_tx_info *c)
844 if (c->control.rts_cts_rate_idx < 0)
846 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
849 static inline struct ieee80211_rate *
850 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
851 const struct ieee80211_tx_info *c)
853 if (c->control.alt_retry_rate_idx < 0)
855 return &hw->wiphy->bands[c->band]->bitrates[c->control.alt_retry_rate_idx];
859 * DOC: Hardware crypto acceleration
861 * mac80211 is capable of taking advantage of many hardware
862 * acceleration designs for encryption and decryption operations.
864 * The set_key() callback in the &struct ieee80211_ops for a given
865 * device is called to enable hardware acceleration of encryption and
866 * decryption. The callback takes an @address parameter that will be
867 * the broadcast address for default keys, the other station's hardware
868 * address for individual keys or the zero address for keys that will
869 * be used only for transmission.
870 * Multiple transmission keys with the same key index may be used when
871 * VLANs are configured for an access point.
873 * The @local_address parameter will always be set to our own address,
874 * this is only relevant if you support multiple local addresses.
876 * When transmitting, the TX control data will use the @hw_key_idx
877 * selected by the driver by modifying the &struct ieee80211_key_conf
878 * pointed to by the @key parameter to the set_key() function.
880 * The set_key() call for the %SET_KEY command should return 0 if
881 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
882 * added; if you return 0 then hw_key_idx must be assigned to the
883 * hardware key index, you are free to use the full u8 range.
885 * When the cmd is %DISABLE_KEY then it must succeed.
887 * Note that it is permissible to not decrypt a frame even if a key
888 * for it has been uploaded to hardware, the stack will not make any
889 * decision based on whether a key has been uploaded or not but rather
890 * based on the receive flags.
892 * The &struct ieee80211_key_conf structure pointed to by the @key
893 * parameter is guaranteed to be valid until another call to set_key()
894 * removes it, but it can only be used as a cookie to differentiate
897 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
898 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
900 * The update_tkip_key() call updates the driver with the new phase 1 key.
901 * This happens everytime the iv16 wraps around (every 65536 packets). The
902 * set_key() call will happen only once for each key (unless the AP did
903 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
904 * provided by udpate_tkip_key only. The trigger that makes mac80211 call this
905 * handler is software decryption with wrap around of iv16.
909 * DOC: Frame filtering
911 * mac80211 requires to see many management frames for proper
912 * operation, and users may want to see many more frames when
913 * in monitor mode. However, for best CPU usage and power consumption,
914 * having as few frames as possible percolate through the stack is
915 * desirable. Hence, the hardware should filter as much as possible.
917 * To achieve this, mac80211 uses filter flags (see below) to tell
918 * the driver's configure_filter() function which frames should be
919 * passed to mac80211 and which should be filtered out.
921 * The configure_filter() callback is invoked with the parameters
922 * @mc_count and @mc_list for the combined multicast address list
923 * of all virtual interfaces, @changed_flags telling which flags
924 * were changed and @total_flags with the new flag states.
926 * If your device has no multicast address filters your driver will
927 * need to check both the %FIF_ALLMULTI flag and the @mc_count
928 * parameter to see whether multicast frames should be accepted
931 * All unsupported flags in @total_flags must be cleared.
932 * Hardware does not support a flag if it is incapable of _passing_
933 * the frame to the stack. Otherwise the driver must ignore
934 * the flag, but not clear it.
935 * You must _only_ clear the flag (announce no support for the
936 * flag to mac80211) if you are not able to pass the packet type
937 * to the stack (so the hardware always filters it).
938 * So for example, you should clear @FIF_CONTROL, if your hardware
939 * always filters control frames. If your hardware always passes
940 * control frames to the kernel and is incapable of filtering them,
941 * you do _not_ clear the @FIF_CONTROL flag.
942 * This rule applies to all other FIF flags as well.
946 * enum ieee80211_filter_flags - hardware filter flags
948 * These flags determine what the filter in hardware should be
949 * programmed to let through and what should not be passed to the
950 * stack. It is always safe to pass more frames than requested,
951 * but this has negative impact on power consumption.
953 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
954 * think of the BSS as your network segment and then this corresponds
955 * to the regular ethernet device promiscuous mode.
957 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
958 * by the user or if the hardware is not capable of filtering by
961 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
962 * %RX_FLAG_FAILED_FCS_CRC for them)
964 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
965 * the %RX_FLAG_FAILED_PLCP_CRC for them
967 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
968 * to the hardware that it should not filter beacons or probe responses
969 * by BSSID. Filtering them can greatly reduce the amount of processing
970 * mac80211 needs to do and the amount of CPU wakeups, so you should
971 * honour this flag if possible.
973 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
974 * only those addressed to this station
976 * @FIF_OTHER_BSS: pass frames destined to other BSSes
978 enum ieee80211_filter_flags {
979 FIF_PROMISC_IN_BSS = 1<<0,
983 FIF_BCN_PRBRESP_PROMISC = 1<<4,
985 FIF_OTHER_BSS = 1<<6,
989 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
991 * These flags are used with the ampdu_action() callback in
992 * &struct ieee80211_ops to indicate which action is needed.
993 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
994 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
995 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
996 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
998 enum ieee80211_ampdu_mlme_action {
999 IEEE80211_AMPDU_RX_START,
1000 IEEE80211_AMPDU_RX_STOP,
1001 IEEE80211_AMPDU_TX_START,
1002 IEEE80211_AMPDU_TX_STOP,
1006 * struct ieee80211_ops - callbacks from mac80211 to the driver
1008 * This structure contains various callbacks that the driver may
1009 * handle or, in some cases, must handle, for example to configure
1010 * the hardware to a new channel or to transmit a frame.
1012 * @tx: Handler that 802.11 module calls for each transmitted frame.
1013 * skb contains the buffer starting from the IEEE 802.11 header.
1014 * The low-level driver should send the frame out based on
1015 * configuration in the TX control data. This handler should,
1016 * preferably, never fail and stop queues appropriately, more
1017 * importantly, however, it must never fail for A-MPDU-queues.
1018 * Must be implemented and atomic.
1020 * @start: Called before the first netdevice attached to the hardware
1021 * is enabled. This should turn on the hardware and must turn on
1022 * frame reception (for possibly enabled monitor interfaces.)
1023 * Returns negative error codes, these may be seen in userspace,
1025 * When the device is started it should not have a MAC address
1026 * to avoid acknowledging frames before a non-monitor device
1028 * Must be implemented.
1030 * @stop: Called after last netdevice attached to the hardware
1031 * is disabled. This should turn off the hardware (at least
1032 * it must turn off frame reception.)
1033 * May be called right after add_interface if that rejects
1035 * Must be implemented.
1037 * @add_interface: Called when a netdevice attached to the hardware is
1038 * enabled. Because it is not called for monitor mode devices, @open
1039 * and @stop must be implemented.
1040 * The driver should perform any initialization it needs before
1041 * the device can be enabled. The initial configuration for the
1042 * interface is given in the conf parameter.
1043 * The callback may refuse to add an interface by returning a
1044 * negative error code (which will be seen in userspace.)
1045 * Must be implemented.
1047 * @remove_interface: Notifies a driver that an interface is going down.
1048 * The @stop callback is called after this if it is the last interface
1049 * and no monitor interfaces are present.
1050 * When all interfaces are removed, the MAC address in the hardware
1051 * must be cleared so the device no longer acknowledges packets,
1052 * the mac_addr member of the conf structure is, however, set to the
1053 * MAC address of the device going away.
1054 * Hence, this callback must be implemented.
1056 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1057 * function to change hardware configuration, e.g., channel.
1059 * @config_interface: Handler for configuration requests related to interfaces
1060 * (e.g. BSSID changes.)
1062 * @bss_info_changed: Handler for configuration requests related to BSS
1063 * parameters that may vary during BSS's lifespan, and may affect low
1064 * level driver (e.g. assoc/disassoc status, erp parameters).
1065 * This function should not be used if no BSS has been set, unless
1066 * for association indication. The @changed parameter indicates which
1067 * of the bss parameters has changed when a call is made.
1069 * @configure_filter: Configure the device's RX filter.
1070 * See the section "Frame filtering" for more information.
1071 * This callback must be implemented and atomic.
1073 * @set_tim: Set TIM bit. If the hardware/firmware takes care of beacon
1074 * generation (that is, %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is set)
1075 * mac80211 calls this function when a TIM bit must be set or cleared
1076 * for a given AID. Must be atomic.
1078 * @set_key: See the section "Hardware crypto acceleration"
1079 * This callback can sleep, and is only called between add_interface
1080 * and remove_interface calls, i.e. while the interface with the
1081 * given local_address is enabled.
1083 * @update_tkip_key: See the section "Hardware crypto acceleration"
1084 * This callback will be called in the context of Rx. Called for drivers
1085 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1087 * @hw_scan: Ask the hardware to service the scan request, no need to start
1088 * the scan state machine in stack. The scan must honour the channel
1089 * configuration done by the regulatory agent in the wiphy's registered
1092 * @get_stats: return low-level statistics
1094 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1095 * callback should be provided to read the TKIP transmit IVs (both IV32
1096 * and IV16) for the given key from hardware.
1098 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1100 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if
1101 * the device does fragmentation by itself; if this method is assigned then
1102 * the stack will not do fragmentation.
1104 * @set_retry_limit: Configuration of retry limits (if device needs it)
1106 * @sta_notify: Notifies low level driver about addition or removal
1107 * of assocaited station or AP.
1109 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1110 * bursting) for a hardware TX queue. Must be atomic.
1112 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1113 * to get number of currently queued packets (queue length), maximum queue
1114 * size (limit), and total number of packets sent using each TX queue
1115 * (count). The 'stats' pointer points to an array that has hw->queues +
1116 * hw->ampdu_queues items.
1118 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1119 * this is only used for IBSS mode debugging and, as such, is not a
1120 * required function. Must be atomic.
1122 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1123 * with other STAs in the IBSS. This is only used in IBSS mode. This
1124 * function is optional if the firmware/hardware takes full care of
1125 * TSF synchronization.
1127 * @beacon_update: Setup beacon data for IBSS beacons. Unlike access point,
1128 * IBSS uses a fixed beacon frame which is configured using this
1130 * If the driver returns success (0) from this callback, it owns
1131 * the skb. That means the driver is responsible to kfree_skb() it.
1132 * The control structure is not dynamically allocated. That means the
1133 * driver does not own the pointer and if it needs it somewhere
1134 * outside of the context of this function, it must copy it
1136 * This handler is required only for IBSS mode.
1138 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1139 * This is needed only for IBSS mode and the result of this function is
1140 * used to determine whether to reply to Probe Requests.
1142 * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic.
1144 * @ampdu_action: Perform a certain A-MPDU action
1145 * The RA/TID combination determines the destination and TID we want
1146 * the ampdu action to be performed for. The action is defined through
1147 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1148 * is the first frame we expect to perform the action on. notice
1149 * that TX/RX_STOP can pass NULL for this parameter.
1151 struct ieee80211_ops {
1152 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1153 int (*start)(struct ieee80211_hw *hw);
1154 void (*stop)(struct ieee80211_hw *hw);
1155 int (*add_interface)(struct ieee80211_hw *hw,
1156 struct ieee80211_if_init_conf *conf);
1157 void (*remove_interface)(struct ieee80211_hw *hw,
1158 struct ieee80211_if_init_conf *conf);
1159 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
1160 int (*config_interface)(struct ieee80211_hw *hw,
1161 struct ieee80211_vif *vif,
1162 struct ieee80211_if_conf *conf);
1163 void (*bss_info_changed)(struct ieee80211_hw *hw,
1164 struct ieee80211_vif *vif,
1165 struct ieee80211_bss_conf *info,
1167 void (*configure_filter)(struct ieee80211_hw *hw,
1168 unsigned int changed_flags,
1169 unsigned int *total_flags,
1170 int mc_count, struct dev_addr_list *mc_list);
1171 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
1172 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1173 const u8 *local_address, const u8 *address,
1174 struct ieee80211_key_conf *key);
1175 void (*update_tkip_key)(struct ieee80211_hw *hw,
1176 struct ieee80211_key_conf *conf, const u8 *address,
1177 u32 iv32, u16 *phase1key);
1178 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
1179 int (*get_stats)(struct ieee80211_hw *hw,
1180 struct ieee80211_low_level_stats *stats);
1181 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1182 u32 *iv32, u16 *iv16);
1183 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1184 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
1185 int (*set_retry_limit)(struct ieee80211_hw *hw,
1186 u32 short_retry, u32 long_retr);
1187 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1188 enum sta_notify_cmd, const u8 *addr);
1189 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
1190 const struct ieee80211_tx_queue_params *params);
1191 int (*get_tx_stats)(struct ieee80211_hw *hw,
1192 struct ieee80211_tx_queue_stats *stats);
1193 u64 (*get_tsf)(struct ieee80211_hw *hw);
1194 void (*reset_tsf)(struct ieee80211_hw *hw);
1195 int (*beacon_update)(struct ieee80211_hw *hw,
1196 struct sk_buff *skb);
1197 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1198 int (*ampdu_action)(struct ieee80211_hw *hw,
1199 enum ieee80211_ampdu_mlme_action action,
1200 const u8 *addr, u16 tid, u16 *ssn);
1204 * ieee80211_alloc_hw - Allocate a new hardware device
1206 * This must be called once for each hardware device. The returned pointer
1207 * must be used to refer to this device when calling other functions.
1208 * mac80211 allocates a private data area for the driver pointed to by
1209 * @priv in &struct ieee80211_hw, the size of this area is given as
1212 * @priv_data_len: length of private data
1213 * @ops: callbacks for this device
1215 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1216 const struct ieee80211_ops *ops);
1219 * ieee80211_register_hw - Register hardware device
1221 * You must call this function before any other functions in
1222 * mac80211. Note that before a hardware can be registered, you
1223 * need to fill the contained wiphy's information.
1225 * @hw: the device to register as returned by ieee80211_alloc_hw()
1227 int ieee80211_register_hw(struct ieee80211_hw *hw);
1229 #ifdef CONFIG_MAC80211_LEDS
1230 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1231 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1232 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1233 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1236 * ieee80211_get_tx_led_name - get name of TX LED
1238 * mac80211 creates a transmit LED trigger for each wireless hardware
1239 * that can be used to drive LEDs if your driver registers a LED device.
1240 * This function returns the name (or %NULL if not configured for LEDs)
1241 * of the trigger so you can automatically link the LED device.
1243 * @hw: the hardware to get the LED trigger name for
1245 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1247 #ifdef CONFIG_MAC80211_LEDS
1248 return __ieee80211_get_tx_led_name(hw);
1255 * ieee80211_get_rx_led_name - get name of RX LED
1257 * mac80211 creates a receive LED trigger for each wireless hardware
1258 * that can be used to drive LEDs if your driver registers a LED device.
1259 * This function returns the name (or %NULL if not configured for LEDs)
1260 * of the trigger so you can automatically link the LED device.
1262 * @hw: the hardware to get the LED trigger name for
1264 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1266 #ifdef CONFIG_MAC80211_LEDS
1267 return __ieee80211_get_rx_led_name(hw);
1274 * ieee80211_get_assoc_led_name - get name of association LED
1276 * mac80211 creates a association LED trigger for each wireless hardware
1277 * that can be used to drive LEDs if your driver registers a LED device.
1278 * This function returns the name (or %NULL if not configured for LEDs)
1279 * of the trigger so you can automatically link the LED device.
1281 * @hw: the hardware to get the LED trigger name for
1283 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1285 #ifdef CONFIG_MAC80211_LEDS
1286 return __ieee80211_get_assoc_led_name(hw);
1293 * ieee80211_get_radio_led_name - get name of radio LED
1295 * mac80211 creates a radio change LED trigger for each wireless hardware
1296 * that can be used to drive LEDs if your driver registers a LED device.
1297 * This function returns the name (or %NULL if not configured for LEDs)
1298 * of the trigger so you can automatically link the LED device.
1300 * @hw: the hardware to get the LED trigger name for
1302 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1304 #ifdef CONFIG_MAC80211_LEDS
1305 return __ieee80211_get_radio_led_name(hw);
1312 * ieee80211_unregister_hw - Unregister a hardware device
1314 * This function instructs mac80211 to free allocated resources
1315 * and unregister netdevices from the networking subsystem.
1317 * @hw: the hardware to unregister
1319 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1322 * ieee80211_free_hw - free hardware descriptor
1324 * This function frees everything that was allocated, including the
1325 * private data for the driver. You must call ieee80211_unregister_hw()
1326 * before calling this function
1328 * @hw: the hardware to free
1330 void ieee80211_free_hw(struct ieee80211_hw *hw);
1332 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1333 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1334 struct ieee80211_rx_status *status);
1337 * ieee80211_rx - receive frame
1339 * Use this function to hand received frames to mac80211. The receive
1340 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1341 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1343 * This function may not be called in IRQ context. Calls to this function
1344 * for a single hardware must be synchronized against each other. Calls
1345 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1348 * @hw: the hardware this frame came in on
1349 * @skb: the buffer to receive, owned by mac80211 after this call
1350 * @status: status of this frame; the status pointer need not be valid
1351 * after this function returns
1353 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1354 struct ieee80211_rx_status *status)
1356 __ieee80211_rx(hw, skb, status);
1360 * ieee80211_rx_irqsafe - receive frame
1362 * Like ieee80211_rx() but can be called in IRQ context
1363 * (internally defers to a tasklet.)
1365 * Calls to this function and ieee80211_rx() may not be mixed for a
1368 * @hw: the hardware this frame came in on
1369 * @skb: the buffer to receive, owned by mac80211 after this call
1370 * @status: status of this frame; the status pointer need not be valid
1371 * after this function returns and is not freed by mac80211,
1372 * it is recommended that it points to a stack area
1374 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1375 struct sk_buff *skb,
1376 struct ieee80211_rx_status *status);
1379 * ieee80211_tx_status - transmit status callback
1381 * Call this function for all transmitted frames after they have been
1382 * transmitted. It is permissible to not call this function for
1383 * multicast frames but this can affect statistics.
1385 * This function may not be called in IRQ context. Calls to this function
1386 * for a single hardware must be synchronized against each other. Calls
1387 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1388 * for a single hardware.
1390 * @hw: the hardware the frame was transmitted by
1391 * @skb: the frame that was transmitted, owned by mac80211 after this call
1393 void ieee80211_tx_status(struct ieee80211_hw *hw,
1394 struct sk_buff *skb);
1397 * ieee80211_tx_status_irqsafe - irq-safe transmit status callback
1399 * Like ieee80211_tx_status() but can be called in IRQ context
1400 * (internally defers to a tasklet.)
1402 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1405 * @hw: the hardware the frame was transmitted by
1406 * @skb: the frame that was transmitted, owned by mac80211 after this call
1408 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1409 struct sk_buff *skb);
1412 * ieee80211_beacon_get - beacon generation function
1413 * @hw: pointer obtained from ieee80211_alloc_hw().
1414 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1415 * @control: will be filled with information needed to send this beacon.
1417 * If the beacon frames are generated by the host system (i.e., not in
1418 * hardware/firmware), the low-level driver uses this function to receive
1419 * the next beacon frame from the 802.11 code. The low-level is responsible
1420 * for calling this function before beacon data is needed (e.g., based on
1421 * hardware interrupt). Returned skb is used only once and low-level driver
1422 * is responsible of freeing it.
1424 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1425 struct ieee80211_vif *vif);
1428 * ieee80211_rts_get - RTS frame generation function
1429 * @hw: pointer obtained from ieee80211_alloc_hw().
1430 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1431 * @frame: pointer to the frame that is going to be protected by the RTS.
1432 * @frame_len: the frame length (in octets).
1433 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1434 * @rts: The buffer where to store the RTS frame.
1436 * If the RTS frames are generated by the host system (i.e., not in
1437 * hardware/firmware), the low-level driver uses this function to receive
1438 * the next RTS frame from the 802.11 code. The low-level is responsible
1439 * for calling this function before and RTS frame is needed.
1441 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1442 const void *frame, size_t frame_len,
1443 const struct ieee80211_tx_info *frame_txctl,
1444 struct ieee80211_rts *rts);
1447 * ieee80211_rts_duration - Get the duration field for an RTS frame
1448 * @hw: pointer obtained from ieee80211_alloc_hw().
1449 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1450 * @frame_len: the length of the frame that is going to be protected by the RTS.
1451 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1453 * If the RTS is generated in firmware, but the host system must provide
1454 * the duration field, the low-level driver uses this function to receive
1455 * the duration field value in little-endian byteorder.
1457 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1458 struct ieee80211_vif *vif, size_t frame_len,
1459 const struct ieee80211_tx_info *frame_txctl);
1462 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1463 * @hw: pointer obtained from ieee80211_alloc_hw().
1464 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1465 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1466 * @frame_len: the frame length (in octets).
1467 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1468 * @cts: The buffer where to store the CTS-to-self frame.
1470 * If the CTS-to-self frames are generated by the host system (i.e., not in
1471 * hardware/firmware), the low-level driver uses this function to receive
1472 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1473 * for calling this function before and CTS-to-self frame is needed.
1475 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1476 struct ieee80211_vif *vif,
1477 const void *frame, size_t frame_len,
1478 const struct ieee80211_tx_info *frame_txctl,
1479 struct ieee80211_cts *cts);
1482 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1483 * @hw: pointer obtained from ieee80211_alloc_hw().
1484 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1485 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1486 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1488 * If the CTS-to-self is generated in firmware, but the host system must provide
1489 * the duration field, the low-level driver uses this function to receive
1490 * the duration field value in little-endian byteorder.
1492 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1493 struct ieee80211_vif *vif,
1495 const struct ieee80211_tx_info *frame_txctl);
1498 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1499 * @hw: pointer obtained from ieee80211_alloc_hw().
1500 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1501 * @frame_len: the length of the frame.
1502 * @rate: the rate at which the frame is going to be transmitted.
1504 * Calculate the duration field of some generic frame, given its
1505 * length and transmission rate (in 100kbps).
1507 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1508 struct ieee80211_vif *vif,
1510 struct ieee80211_rate *rate);
1513 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1514 * @hw: pointer as obtained from ieee80211_alloc_hw().
1515 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1516 * @control: will be filled with information needed to send returned frame.
1518 * Function for accessing buffered broadcast and multicast frames. If
1519 * hardware/firmware does not implement buffering of broadcast/multicast
1520 * frames when power saving is used, 802.11 code buffers them in the host
1521 * memory. The low-level driver uses this function to fetch next buffered
1522 * frame. In most cases, this is used when generating beacon frame. This
1523 * function returns a pointer to the next buffered skb or NULL if no more
1524 * buffered frames are available.
1526 * Note: buffered frames are returned only after DTIM beacon frame was
1527 * generated with ieee80211_beacon_get() and the low-level driver must thus
1528 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1529 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1530 * does not need to check for DTIM beacons separately and should be able to
1531 * use common code for all beacons.
1534 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
1537 * ieee80211_get_hdrlen_from_skb - get header length from data
1539 * Given an skb with a raw 802.11 header at the data pointer this function
1540 * returns the 802.11 header length in bytes (not including encryption
1541 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1542 * header the function returns 0.
1546 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1549 * ieee80211_get_hdrlen - get header length from frame control
1551 * This function returns the 802.11 header length in bytes (not including
1552 * encryption headers.)
1554 * @fc: the frame control field (in CPU endianness)
1556 int ieee80211_get_hdrlen(u16 fc);
1559 * ieee80211_hdrlen - get header length in bytes from frame control
1560 * @fc: frame control field in little-endian format
1562 unsigned int ieee80211_hdrlen(__le16 fc);
1565 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1567 * This function computes a TKIP rc4 key for an skb. It computes
1568 * a phase 1 key if needed (iv16 wraps around). This function is to
1569 * be used by drivers which can do HW encryption but need to compute
1570 * to phase 1/2 key in SW.
1572 * @keyconf: the parameter passed with the set key
1573 * @skb: the skb for which the key is needed
1574 * @rc4key: a buffer to which the key will be written
1576 void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1577 struct sk_buff *skb,
1578 enum ieee80211_tkip_key_type type, u8 *key);
1580 * ieee80211_wake_queue - wake specific queue
1581 * @hw: pointer as obtained from ieee80211_alloc_hw().
1582 * @queue: queue number (counted from zero).
1584 * Drivers should use this function instead of netif_wake_queue.
1586 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1589 * ieee80211_stop_queue - stop specific queue
1590 * @hw: pointer as obtained from ieee80211_alloc_hw().
1591 * @queue: queue number (counted from zero).
1593 * Drivers should use this function instead of netif_stop_queue.
1595 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1598 * ieee80211_stop_queues - stop all queues
1599 * @hw: pointer as obtained from ieee80211_alloc_hw().
1601 * Drivers should use this function instead of netif_stop_queue.
1603 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1606 * ieee80211_wake_queues - wake all queues
1607 * @hw: pointer as obtained from ieee80211_alloc_hw().
1609 * Drivers should use this function instead of netif_wake_queue.
1611 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1614 * ieee80211_scan_completed - completed hardware scan
1616 * When hardware scan offload is used (i.e. the hw_scan() callback is
1617 * assigned) this function needs to be called by the driver to notify
1618 * mac80211 that the scan finished.
1620 * @hw: the hardware that finished the scan
1622 void ieee80211_scan_completed(struct ieee80211_hw *hw);
1625 * ieee80211_iterate_active_interfaces- iterate active interfaces
1627 * This function iterates over the interfaces associated with a given
1628 * hardware that are currently active and calls the callback for them.
1629 * This function allows the iterator function to sleep, when the iterator
1630 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
1633 * @hw: the hardware struct of which the interfaces should be iterated over
1634 * @iterator: the iterator function to call
1635 * @data: first argument of the iterator function
1637 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1638 void (*iterator)(void *data, u8 *mac,
1639 struct ieee80211_vif *vif),
1643 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
1645 * This function iterates over the interfaces associated with a given
1646 * hardware that are currently active and calls the callback for them.
1647 * This function requires the iterator callback function to be atomic,
1648 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
1650 * @hw: the hardware struct of which the interfaces should be iterated over
1651 * @iterator: the iterator function to call, cannot sleep
1652 * @data: first argument of the iterator function
1654 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
1655 void (*iterator)(void *data,
1657 struct ieee80211_vif *vif),
1661 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1662 * @hw: pointer as obtained from ieee80211_alloc_hw().
1663 * @ra: receiver address of the BA session recipient
1664 * @tid: the TID to BA on.
1665 * @return: success if addBA request was sent, failure otherwise
1667 * Although mac80211/low level driver/user space application can estimate
1668 * the need to start aggregation on a certain RA/TID, the session level
1669 * will be managed by the mac80211.
1671 int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1674 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1675 * @hw: pointer as obtained from ieee80211_alloc_hw().
1676 * @ra: receiver address of the BA session recipient.
1677 * @tid: the TID to BA on.
1679 * This function must be called by low level driver once it has
1680 * finished with preparations for the BA session.
1682 void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1685 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1686 * @hw: pointer as obtained from ieee80211_alloc_hw().
1687 * @ra: receiver address of the BA session recipient.
1688 * @tid: the TID to BA on.
1690 * This function must be called by low level driver once it has
1691 * finished with preparations for the BA session.
1692 * This version of the function is irq safe.
1694 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1698 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1699 * @hw: pointer as obtained from ieee80211_alloc_hw().
1700 * @ra: receiver address of the BA session recipient
1701 * @tid: the TID to stop BA.
1702 * @initiator: if indicates initiator DELBA frame will be sent.
1703 * @return: error if no sta with matching da found, success otherwise
1705 * Although mac80211/low level driver/user space application can estimate
1706 * the need to stop aggregation on a certain RA/TID, the session level
1707 * will be managed by the mac80211.
1709 int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1711 enum ieee80211_back_parties initiator);
1714 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1715 * @hw: pointer as obtained from ieee80211_alloc_hw().
1716 * @ra: receiver address of the BA session recipient.
1717 * @tid: the desired TID to BA on.
1719 * This function must be called by low level driver once it has
1720 * finished with preparations for the BA session tear down.
1722 void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1725 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1726 * @hw: pointer as obtained from ieee80211_alloc_hw().
1727 * @ra: receiver address of the BA session recipient.
1728 * @tid: the desired TID to BA on.
1730 * This function must be called by low level driver once it has
1731 * finished with preparations for the BA session tear down.
1732 * This version of the function is irq safe.
1734 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1738 * ieee80211_notify_mac - low level driver notification
1739 * @hw: pointer as obtained from ieee80211_alloc_hw().
1740 * @notification_types: enum ieee80211_notification_types
1742 * This function must be called by low level driver to inform mac80211 of
1743 * low level driver status change or force mac80211 to re-assoc for low
1744 * level driver internal error that require re-assoc.
1746 void ieee80211_notify_mac(struct ieee80211_hw *hw,
1747 enum ieee80211_notification_types notif_type);
1748 #endif /* MAC80211_H */