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 * @flags: transmit info flags, defined above
306 * @antenna_sel_tx: TBD
307 * @control: union for control data
308 * @status: union for status data
309 * @driver_data: array of driver_data pointers
310 * @retry_count: number of retries
311 * @excessive_retries: set to 1 if the frame was retried many times
312 * but not acknowledged
313 * @ampdu_ack_len: number of aggregated frames.
314 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
315 * @ampdu_ack_map: block ack bit map for the aggregation.
316 * relevant only if IEEE80211_TX_STATUS_AMPDU was set.
317 * @ack_signal: signal strength of the ACK frame
319 struct ieee80211_tx_info {
320 /* common information */
330 struct ieee80211_vif *vif;
331 struct ieee80211_key_conf *hw_key;
332 unsigned long jiffies;
334 s8 rts_cts_rate_idx, alt_retry_rate_idx;
343 bool excessive_retries;
346 void *driver_data[IEEE80211_TX_INFO_DRIVER_DATA_PTRS];
350 static inline struct ieee80211_tx_info *IEEE80211_SKB_CB(struct sk_buff *skb)
352 return (struct ieee80211_tx_info *)skb->cb;
357 * enum mac80211_rx_flags - receive flags
359 * These flags are used with the @flag member of &struct ieee80211_rx_status.
360 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
361 * Use together with %RX_FLAG_MMIC_STRIPPED.
362 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
363 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
364 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
365 * verification has been done by the hardware.
366 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
367 * If this flag is set, the stack cannot do any replay detection
368 * hence the driver or hardware will have to do that.
369 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
371 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
373 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
374 * is valid. This is useful in monitor mode and necessary for beacon frames
375 * to enable IBSS merging.
376 * @RX_FLAG_SHORTPRE: Short preamble was used for this frame
378 enum mac80211_rx_flags {
379 RX_FLAG_MMIC_ERROR = 1<<0,
380 RX_FLAG_DECRYPTED = 1<<1,
381 RX_FLAG_RADIOTAP = 1<<2,
382 RX_FLAG_MMIC_STRIPPED = 1<<3,
383 RX_FLAG_IV_STRIPPED = 1<<4,
384 RX_FLAG_FAILED_FCS_CRC = 1<<5,
385 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
387 RX_FLAG_SHORTPRE = 1<<8
391 * struct ieee80211_rx_status - receive status
393 * The low-level driver should provide this information (the subset
394 * supported by hardware) to the 802.11 code with each received
397 * @mactime: value in microseconds of the 64-bit Time Synchronization Function
398 * (TSF) timer when the first data symbol (MPDU) arrived at the hardware.
399 * @band: the active band when this frame was received
400 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
401 * @signal: signal strength when receiving this frame, either in dBm, in dB or
402 * unspecified depending on the hardware capabilities flags
403 * @IEEE80211_HW_SIGNAL_*
404 * @noise: noise when receiving this frame, in dBm.
405 * @qual: overall signal quality indication, in percent (0-100).
406 * @antenna: antenna used
407 * @rate_idx: index of data rate into band's supported rates
410 struct ieee80211_rx_status {
412 enum ieee80211_band band;
423 * enum ieee80211_conf_flags - configuration flags
425 * Flags to define PHY configuration options
427 * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time
428 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
429 * @IEEE80211_CONF_SUPPORT_HT_MODE: use 802.11n HT capabilities (if supported)
430 * @IEEE80211_CONF_PS: Enable 802.11 power save mode
432 enum ieee80211_conf_flags {
434 * TODO: IEEE80211_CONF_SHORT_SLOT_TIME will be removed once drivers
435 * have been converted to use bss_info_changed() for slot time
438 IEEE80211_CONF_SHORT_SLOT_TIME = (1<<0),
439 IEEE80211_CONF_RADIOTAP = (1<<1),
440 IEEE80211_CONF_SUPPORT_HT_MODE = (1<<2),
441 IEEE80211_CONF_PS = (1<<3),
445 * struct ieee80211_conf - configuration of the device
447 * This struct indicates how the driver shall configure the hardware.
449 * @radio_enabled: when zero, driver is required to switch off the radio.
451 * @beacon_int: beacon interval (TODO make interface config)
452 * @listen_interval: listen interval in units of beacon interval
453 * @flags: configuration flags defined above
454 * @power_level: requested transmit power (in dBm)
455 * @max_antenna_gain: maximum antenna gain (in dBi)
456 * @antenna_sel_tx: transmit antenna selection, 0: default/diversity,
458 * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx
459 * @ht_conf: describes current self configuration of 802.11n HT capabilies
460 * @ht_bss_conf: describes current BSS configuration of 802.11n HT parameters
461 * @channel: the channel to tune to
463 struct ieee80211_conf {
470 int max_antenna_gain;
474 struct ieee80211_channel *channel;
476 struct ieee80211_ht_info ht_conf;
477 struct ieee80211_ht_bss_info ht_bss_conf;
481 * enum ieee80211_if_types - types of 802.11 network interfaces
483 * @IEEE80211_IF_TYPE_INVALID: invalid interface type, not used
485 * @IEEE80211_IF_TYPE_AP: interface in AP mode.
486 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap
487 * daemon. Drivers should never see this type.
488 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode.
489 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode.
490 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode.
491 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode.
492 * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers
493 * will never see this type.
494 * @IEEE80211_IF_TYPE_MESH_POINT: 802.11s mesh point
496 enum ieee80211_if_types {
497 IEEE80211_IF_TYPE_INVALID,
498 IEEE80211_IF_TYPE_AP,
499 IEEE80211_IF_TYPE_STA,
500 IEEE80211_IF_TYPE_IBSS,
501 IEEE80211_IF_TYPE_MESH_POINT,
502 IEEE80211_IF_TYPE_MNTR,
503 IEEE80211_IF_TYPE_WDS,
504 IEEE80211_IF_TYPE_VLAN,
508 * struct ieee80211_vif - per-interface data
510 * Data in this structure is continually present for driver
511 * use during the life of a virtual interface.
513 * @type: type of this virtual interface
514 * @drv_priv: data area for driver use, will always be aligned to
517 struct ieee80211_vif {
518 enum ieee80211_if_types type;
520 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
523 static inline bool ieee80211_vif_is_mesh(struct ieee80211_vif *vif)
525 #ifdef CONFIG_MAC80211_MESH
526 return vif->type == IEEE80211_IF_TYPE_MESH_POINT;
532 * struct ieee80211_if_init_conf - initial configuration of an interface
534 * @vif: pointer to a driver-use per-interface structure. The pointer
535 * itself is also used for various functions including
536 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
537 * @type: one of &enum ieee80211_if_types constants. Determines the type of
538 * added/removed interface.
539 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
540 * until the interface is removed (i.e. it cannot be used after
541 * remove_interface() callback was called for this interface).
543 * This structure is used in add_interface() and remove_interface()
544 * callbacks of &struct ieee80211_hw.
546 * When you allow multiple interfaces to be added to your PHY, take care
547 * that the hardware can actually handle multiple MAC addresses. However,
548 * also take care that when there's no interface left with mac_addr != %NULL
549 * you remove the MAC address from the device to avoid acknowledging packets
550 * in pure monitor mode.
552 struct ieee80211_if_init_conf {
553 enum ieee80211_if_types type;
554 struct ieee80211_vif *vif;
559 * enum ieee80211_if_conf_change - interface config change flags
561 * @IEEE80211_IFCC_BSSID: The BSSID changed.
562 * @IEEE80211_IFCC_SSID: The SSID changed.
563 * @IEEE80211_IFCC_BEACON: The beacon for this interface changed
564 * (currently AP and MESH only), use ieee80211_beacon_get().
566 enum ieee80211_if_conf_change {
567 IEEE80211_IFCC_BSSID = BIT(0),
568 IEEE80211_IFCC_SSID = BIT(1),
569 IEEE80211_IFCC_BEACON = BIT(2),
573 * struct ieee80211_if_conf - configuration of an interface
575 * @changed: parameters that have changed, see &enum ieee80211_if_conf_change.
576 * @bssid: BSSID of the network we are associated to/creating.
577 * @ssid: used (together with @ssid_len) by drivers for hardware that
578 * generate beacons independently. The pointer is valid only during the
579 * config_interface() call, so copy the value somewhere if you need
581 * @ssid_len: length of the @ssid field.
583 * This structure is passed to the config_interface() callback of
584 * &struct ieee80211_hw.
586 struct ieee80211_if_conf {
594 * enum ieee80211_key_alg - key algorithm
595 * @ALG_WEP: WEP40 or WEP104
597 * @ALG_CCMP: CCMP (AES)
599 enum ieee80211_key_alg {
606 * enum ieee80211_key_len - key length
607 * @LEN_WEP40: WEP 5-byte long key
608 * @LEN_WEP104: WEP 13-byte long key
610 enum ieee80211_key_len {
616 * enum ieee80211_key_flags - key flags
618 * These flags are used for communication about keys between the driver
619 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
621 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
622 * that the STA this key will be used with could be using QoS.
623 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
624 * driver to indicate that it requires IV generation for this
626 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
627 * the driver for a TKIP key if it requires Michael MIC
628 * generation in software.
629 * @IEEE80211_KEY_FLAG_PAIRWISE: Set by mac80211, this flag indicates
630 * that the key is pairwise rather then a shared key.
632 enum ieee80211_key_flags {
633 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
634 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
635 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
636 IEEE80211_KEY_FLAG_PAIRWISE = 1<<3,
640 * struct ieee80211_key_conf - key information
642 * This key information is given by mac80211 to the driver by
643 * the set_key() callback in &struct ieee80211_ops.
645 * @hw_key_idx: To be set by the driver, this is the key index the driver
646 * wants to be given when a frame is transmitted and needs to be
647 * encrypted in hardware.
648 * @alg: The key algorithm.
649 * @flags: key flags, see &enum ieee80211_key_flags.
650 * @keyidx: the key index (0-3)
651 * @keylen: key material length
652 * @key: key material. For ALG_TKIP the key is encoded as a 256-bit (32 byte)
654 * - Temporal Encryption Key (128 bits)
655 * - Temporal Authenticator Tx MIC Key (64 bits)
656 * - Temporal Authenticator Rx MIC Key (64 bits)
659 struct ieee80211_key_conf {
660 enum ieee80211_key_alg alg;
669 * enum set_key_cmd - key command
671 * Used with the set_key() callback in &struct ieee80211_ops, this
672 * indicates whether a key is being removed or added.
674 * @SET_KEY: a key is set
675 * @DISABLE_KEY: a key must be disabled
678 SET_KEY, DISABLE_KEY,
682 * enum sta_notify_cmd - sta notify command
684 * Used with the sta_notify() callback in &struct ieee80211_ops, this
685 * indicates addition and removal of a station to station table.
687 * @STA_NOTIFY_ADD: a station was added to the station table
688 * @STA_NOTIFY_REMOVE: a station being removed from the station table
690 enum sta_notify_cmd {
691 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE
695 * enum ieee80211_tkip_key_type - get tkip key
697 * Used by drivers which need to get a tkip key for skb. Some drivers need a
698 * phase 1 key, others need a phase 2 key. A single function allows the driver
699 * to get the key, this enum indicates what type of key is required.
701 * @IEEE80211_TKIP_P1_KEY: the driver needs a phase 1 key
702 * @IEEE80211_TKIP_P2_KEY: the driver needs a phase 2 key
704 enum ieee80211_tkip_key_type {
705 IEEE80211_TKIP_P1_KEY,
706 IEEE80211_TKIP_P2_KEY,
710 * enum ieee80211_hw_flags - hardware flags
712 * These flags are used to indicate hardware capabilities to
713 * the stack. Generally, flags here should have their meaning
714 * done in a way that the simplest hardware doesn't need setting
715 * any particular flags. There are some exceptions to this rule,
716 * however, so you are advised to review these flags carefully.
718 * @IEEE80211_HW_RX_INCLUDES_FCS:
719 * Indicates that received frames passed to the stack include
720 * the FCS at the end.
722 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
723 * Some wireless LAN chipsets buffer broadcast/multicast frames
724 * for power saving stations in the hardware/firmware and others
725 * rely on the host system for such buffering. This option is used
726 * to configure the IEEE 802.11 upper layer to buffer broadcast and
727 * multicast frames when there are power saving stations so that
728 * the driver can fetch them with ieee80211_get_buffered_bc().
730 * @IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE:
731 * Hardware is not capable of short slot operation on the 2.4 GHz band.
733 * @IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE:
734 * Hardware is not capable of receiving frames with short preamble on
737 * @IEEE80211_HW_SIGNAL_UNSPEC:
738 * Hardware can provide signal values but we don't know its units. We
739 * expect values between 0 and @max_signal.
740 * If possible please provide dB or dBm instead.
742 * @IEEE80211_HW_SIGNAL_DB:
743 * Hardware gives signal values in dB, decibel difference from an
744 * arbitrary, fixed reference. We expect values between 0 and @max_signal.
745 * If possible please provide dBm instead.
747 * @IEEE80211_HW_SIGNAL_DBM:
748 * Hardware gives signal values in dBm, decibel difference from
749 * one milliwatt. This is the preferred method since it is standardized
750 * between different devices. @max_signal does not need to be set.
752 * @IEEE80211_HW_NOISE_DBM:
753 * Hardware can provide noise (radio interference) values in units dBm,
754 * decibel difference from one milliwatt.
756 * @IEEE80211_HW_SPECTRUM_MGMT:
757 * Hardware supports spectrum management defined in 802.11h
758 * Measurement, Channel Switch, Quieting, TPC
760 enum ieee80211_hw_flags {
761 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
762 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
763 IEEE80211_HW_2GHZ_SHORT_SLOT_INCAPABLE = 1<<3,
764 IEEE80211_HW_2GHZ_SHORT_PREAMBLE_INCAPABLE = 1<<4,
765 IEEE80211_HW_SIGNAL_UNSPEC = 1<<5,
766 IEEE80211_HW_SIGNAL_DB = 1<<6,
767 IEEE80211_HW_SIGNAL_DBM = 1<<7,
768 IEEE80211_HW_NOISE_DBM = 1<<8,
769 IEEE80211_HW_SPECTRUM_MGMT = 1<<9,
773 * struct ieee80211_hw - hardware information and state
775 * This structure contains the configuration and hardware
776 * information for an 802.11 PHY.
778 * @wiphy: This points to the &struct wiphy allocated for this
779 * 802.11 PHY. You must fill in the @perm_addr and @dev
780 * members of this structure using SET_IEEE80211_DEV()
781 * and SET_IEEE80211_PERM_ADDR(). Additionally, all supported
782 * bands (with channels, bitrates) are registered here.
784 * @conf: &struct ieee80211_conf, device configuration, don't use.
786 * @workqueue: single threaded workqueue available for driver use,
787 * allocated by mac80211 on registration and flushed when an
788 * interface is removed.
789 * NOTICE: All work performed on this workqueue should NEVER
790 * acquire the RTNL lock (i.e. Don't use the function
791 * ieee80211_iterate_active_interfaces())
793 * @priv: pointer to private area that was allocated for driver use
794 * along with this structure.
796 * @flags: hardware flags, see &enum ieee80211_hw_flags.
798 * @extra_tx_headroom: headroom to reserve in each transmit skb
799 * for use by the driver (e.g. for transmit headers.)
801 * @channel_change_time: time (in microseconds) it takes to change channels.
803 * @max_signal: Maximum value for signal (rssi) in RX information, used
804 * only when @IEEE80211_HW_SIGNAL_UNSPEC or @IEEE80211_HW_SIGNAL_DB
806 * @max_listen_interval: max listen interval in units of beacon interval
809 * @queues: number of available hardware transmit queues for
810 * data packets. WMM/QoS requires at least four, these
811 * queues need to have configurable access parameters.
813 * @ampdu_queues: number of available hardware transmit queues
814 * for A-MPDU packets, these have no access parameters
815 * because they're used only for A-MPDU frames. Note that
816 * mac80211 will not currently use any of the regular queues
819 * @rate_control_algorithm: rate control algorithm for this hardware.
820 * If unset (NULL), the default algorithm will be used. Must be
821 * set before calling ieee80211_register_hw().
823 * @vif_data_size: size (in bytes) of the drv_priv data area
824 * within &struct ieee80211_vif.
826 struct ieee80211_hw {
827 struct ieee80211_conf conf;
829 struct workqueue_struct *workqueue;
830 const char *rate_control_algorithm;
833 unsigned int extra_tx_headroom;
834 int channel_change_time;
838 u16 max_listen_interval;
842 struct ieee80211_hw *wiphy_to_hw(struct wiphy *wiphy);
845 * SET_IEEE80211_DEV - set device for 802.11 hardware
847 * @hw: the &struct ieee80211_hw to set the device for
848 * @dev: the &struct device of this 802.11 device
850 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
852 set_wiphy_dev(hw->wiphy, dev);
856 * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware
858 * @hw: the &struct ieee80211_hw to set the MAC address for
859 * @addr: the address to set
861 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
863 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
866 static inline int ieee80211_num_regular_queues(struct ieee80211_hw *hw)
871 static inline int ieee80211_num_queues(struct ieee80211_hw *hw)
873 return hw->queues + hw->ampdu_queues;
876 static inline struct ieee80211_rate *
877 ieee80211_get_tx_rate(const struct ieee80211_hw *hw,
878 const struct ieee80211_tx_info *c)
880 if (WARN_ON(c->tx_rate_idx < 0))
882 return &hw->wiphy->bands[c->band]->bitrates[c->tx_rate_idx];
885 static inline struct ieee80211_rate *
886 ieee80211_get_rts_cts_rate(const struct ieee80211_hw *hw,
887 const struct ieee80211_tx_info *c)
889 if (c->control.rts_cts_rate_idx < 0)
891 return &hw->wiphy->bands[c->band]->bitrates[c->control.rts_cts_rate_idx];
894 static inline struct ieee80211_rate *
895 ieee80211_get_alt_retry_rate(const struct ieee80211_hw *hw,
896 const struct ieee80211_tx_info *c)
898 if (c->control.alt_retry_rate_idx < 0)
900 return &hw->wiphy->bands[c->band]->bitrates[c->control.alt_retry_rate_idx];
904 * DOC: Hardware crypto acceleration
906 * mac80211 is capable of taking advantage of many hardware
907 * acceleration designs for encryption and decryption operations.
909 * The set_key() callback in the &struct ieee80211_ops for a given
910 * device is called to enable hardware acceleration of encryption and
911 * decryption. The callback takes an @address parameter that will be
912 * the broadcast address for default keys, the other station's hardware
913 * address for individual keys or the zero address for keys that will
914 * be used only for transmission.
915 * Multiple transmission keys with the same key index may be used when
916 * VLANs are configured for an access point.
918 * The @local_address parameter will always be set to our own address,
919 * this is only relevant if you support multiple local addresses.
921 * When transmitting, the TX control data will use the @hw_key_idx
922 * selected by the driver by modifying the &struct ieee80211_key_conf
923 * pointed to by the @key parameter to the set_key() function.
925 * The set_key() call for the %SET_KEY command should return 0 if
926 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
927 * added; if you return 0 then hw_key_idx must be assigned to the
928 * hardware key index, you are free to use the full u8 range.
930 * When the cmd is %DISABLE_KEY then it must succeed.
932 * Note that it is permissible to not decrypt a frame even if a key
933 * for it has been uploaded to hardware, the stack will not make any
934 * decision based on whether a key has been uploaded or not but rather
935 * based on the receive flags.
937 * The &struct ieee80211_key_conf structure pointed to by the @key
938 * parameter is guaranteed to be valid until another call to set_key()
939 * removes it, but it can only be used as a cookie to differentiate
942 * In TKIP some HW need to be provided a phase 1 key, for RX decryption
943 * acceleration (i.e. iwlwifi). Those drivers should provide update_tkip_key
945 * The update_tkip_key() call updates the driver with the new phase 1 key.
946 * This happens everytime the iv16 wraps around (every 65536 packets). The
947 * set_key() call will happen only once for each key (unless the AP did
948 * rekeying), it will not include a valid phase 1 key. The valid phase 1 key is
949 * provided by udpate_tkip_key only. The trigger that makes mac80211 call this
950 * handler is software decryption with wrap around of iv16.
954 * DOC: Frame filtering
956 * mac80211 requires to see many management frames for proper
957 * operation, and users may want to see many more frames when
958 * in monitor mode. However, for best CPU usage and power consumption,
959 * having as few frames as possible percolate through the stack is
960 * desirable. Hence, the hardware should filter as much as possible.
962 * To achieve this, mac80211 uses filter flags (see below) to tell
963 * the driver's configure_filter() function which frames should be
964 * passed to mac80211 and which should be filtered out.
966 * The configure_filter() callback is invoked with the parameters
967 * @mc_count and @mc_list for the combined multicast address list
968 * of all virtual interfaces, @changed_flags telling which flags
969 * were changed and @total_flags with the new flag states.
971 * If your device has no multicast address filters your driver will
972 * need to check both the %FIF_ALLMULTI flag and the @mc_count
973 * parameter to see whether multicast frames should be accepted
976 * All unsupported flags in @total_flags must be cleared.
977 * Hardware does not support a flag if it is incapable of _passing_
978 * the frame to the stack. Otherwise the driver must ignore
979 * the flag, but not clear it.
980 * You must _only_ clear the flag (announce no support for the
981 * flag to mac80211) if you are not able to pass the packet type
982 * to the stack (so the hardware always filters it).
983 * So for example, you should clear @FIF_CONTROL, if your hardware
984 * always filters control frames. If your hardware always passes
985 * control frames to the kernel and is incapable of filtering them,
986 * you do _not_ clear the @FIF_CONTROL flag.
987 * This rule applies to all other FIF flags as well.
991 * enum ieee80211_filter_flags - hardware filter flags
993 * These flags determine what the filter in hardware should be
994 * programmed to let through and what should not be passed to the
995 * stack. It is always safe to pass more frames than requested,
996 * but this has negative impact on power consumption.
998 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
999 * think of the BSS as your network segment and then this corresponds
1000 * to the regular ethernet device promiscuous mode.
1002 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
1003 * by the user or if the hardware is not capable of filtering by
1004 * multicast address.
1006 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
1007 * %RX_FLAG_FAILED_FCS_CRC for them)
1009 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
1010 * the %RX_FLAG_FAILED_PLCP_CRC for them
1012 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
1013 * to the hardware that it should not filter beacons or probe responses
1014 * by BSSID. Filtering them can greatly reduce the amount of processing
1015 * mac80211 needs to do and the amount of CPU wakeups, so you should
1016 * honour this flag if possible.
1018 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
1019 * only those addressed to this station
1021 * @FIF_OTHER_BSS: pass frames destined to other BSSes
1023 enum ieee80211_filter_flags {
1024 FIF_PROMISC_IN_BSS = 1<<0,
1025 FIF_ALLMULTI = 1<<1,
1027 FIF_PLCPFAIL = 1<<3,
1028 FIF_BCN_PRBRESP_PROMISC = 1<<4,
1030 FIF_OTHER_BSS = 1<<6,
1034 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
1036 * These flags are used with the ampdu_action() callback in
1037 * &struct ieee80211_ops to indicate which action is needed.
1038 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
1039 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
1040 * @IEEE80211_AMPDU_TX_START: start Tx aggregation
1041 * @IEEE80211_AMPDU_TX_STOP: stop Tx aggregation
1043 enum ieee80211_ampdu_mlme_action {
1044 IEEE80211_AMPDU_RX_START,
1045 IEEE80211_AMPDU_RX_STOP,
1046 IEEE80211_AMPDU_TX_START,
1047 IEEE80211_AMPDU_TX_STOP,
1051 * struct ieee80211_ops - callbacks from mac80211 to the driver
1053 * This structure contains various callbacks that the driver may
1054 * handle or, in some cases, must handle, for example to configure
1055 * the hardware to a new channel or to transmit a frame.
1057 * @tx: Handler that 802.11 module calls for each transmitted frame.
1058 * skb contains the buffer starting from the IEEE 802.11 header.
1059 * The low-level driver should send the frame out based on
1060 * configuration in the TX control data. This handler should,
1061 * preferably, never fail and stop queues appropriately, more
1062 * importantly, however, it must never fail for A-MPDU-queues.
1063 * Must be implemented and atomic.
1065 * @start: Called before the first netdevice attached to the hardware
1066 * is enabled. This should turn on the hardware and must turn on
1067 * frame reception (for possibly enabled monitor interfaces.)
1068 * Returns negative error codes, these may be seen in userspace,
1070 * When the device is started it should not have a MAC address
1071 * to avoid acknowledging frames before a non-monitor device
1073 * Must be implemented.
1075 * @stop: Called after last netdevice attached to the hardware
1076 * is disabled. This should turn off the hardware (at least
1077 * it must turn off frame reception.)
1078 * May be called right after add_interface if that rejects
1080 * Must be implemented.
1082 * @add_interface: Called when a netdevice attached to the hardware is
1083 * enabled. Because it is not called for monitor mode devices, @open
1084 * and @stop must be implemented.
1085 * The driver should perform any initialization it needs before
1086 * the device can be enabled. The initial configuration for the
1087 * interface is given in the conf parameter.
1088 * The callback may refuse to add an interface by returning a
1089 * negative error code (which will be seen in userspace.)
1090 * Must be implemented.
1092 * @remove_interface: Notifies a driver that an interface is going down.
1093 * The @stop callback is called after this if it is the last interface
1094 * and no monitor interfaces are present.
1095 * When all interfaces are removed, the MAC address in the hardware
1096 * must be cleared so the device no longer acknowledges packets,
1097 * the mac_addr member of the conf structure is, however, set to the
1098 * MAC address of the device going away.
1099 * Hence, this callback must be implemented.
1101 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1102 * function to change hardware configuration, e.g., channel.
1104 * @config_interface: Handler for configuration requests related to interfaces
1105 * (e.g. BSSID changes.)
1107 * @bss_info_changed: Handler for configuration requests related to BSS
1108 * parameters that may vary during BSS's lifespan, and may affect low
1109 * level driver (e.g. assoc/disassoc status, erp parameters).
1110 * This function should not be used if no BSS has been set, unless
1111 * for association indication. The @changed parameter indicates which
1112 * of the bss parameters has changed when a call is made.
1114 * @configure_filter: Configure the device's RX filter.
1115 * See the section "Frame filtering" for more information.
1116 * This callback must be implemented and atomic.
1118 * @set_tim: Set TIM bit. mac80211 calls this function when a TIM bit
1119 * must be set or cleared for a given AID. Must be atomic.
1121 * @set_key: See the section "Hardware crypto acceleration"
1122 * This callback can sleep, and is only called between add_interface
1123 * and remove_interface calls, i.e. while the interface with the
1124 * given local_address is enabled.
1126 * @update_tkip_key: See the section "Hardware crypto acceleration"
1127 * This callback will be called in the context of Rx. Called for drivers
1128 * which set IEEE80211_KEY_FLAG_TKIP_REQ_RX_P1_KEY.
1130 * @hw_scan: Ask the hardware to service the scan request, no need to start
1131 * the scan state machine in stack. The scan must honour the channel
1132 * configuration done by the regulatory agent in the wiphy's registered
1133 * bands. When the scan finishes, ieee80211_scan_completed() must be
1134 * called; note that it also must be called when the scan cannot finish
1135 * because the hardware is turned off! Anything else is a bug!
1137 * @get_stats: return low-level statistics
1139 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1140 * callback should be provided to read the TKIP transmit IVs (both IV32
1141 * and IV16) for the given key from hardware.
1143 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1145 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if
1146 * the device does fragmentation by itself; if this method is assigned then
1147 * the stack will not do fragmentation.
1149 * @set_retry_limit: Configuration of retry limits (if device needs it)
1151 * @sta_notify: Notifies low level driver about addition or removal
1152 * of assocaited station or AP.
1154 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1155 * bursting) for a hardware TX queue.
1157 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1158 * to get number of currently queued packets (queue length), maximum queue
1159 * size (limit), and total number of packets sent using each TX queue
1160 * (count). The 'stats' pointer points to an array that has hw->queues +
1161 * hw->ampdu_queues items.
1163 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1164 * this is only used for IBSS mode debugging and, as such, is not a
1165 * required function. Must be atomic.
1167 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1168 * with other STAs in the IBSS. This is only used in IBSS mode. This
1169 * function is optional if the firmware/hardware takes full care of
1170 * TSF synchronization.
1172 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1173 * This is needed only for IBSS mode and the result of this function is
1174 * used to determine whether to reply to Probe Requests.
1176 * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic.
1178 * @ampdu_action: Perform a certain A-MPDU action
1179 * The RA/TID combination determines the destination and TID we want
1180 * the ampdu action to be performed for. The action is defined through
1181 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1182 * is the first frame we expect to perform the action on. notice
1183 * that TX/RX_STOP can pass NULL for this parameter.
1185 struct ieee80211_ops {
1186 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb);
1187 int (*start)(struct ieee80211_hw *hw);
1188 void (*stop)(struct ieee80211_hw *hw);
1189 int (*add_interface)(struct ieee80211_hw *hw,
1190 struct ieee80211_if_init_conf *conf);
1191 void (*remove_interface)(struct ieee80211_hw *hw,
1192 struct ieee80211_if_init_conf *conf);
1193 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
1194 int (*config_interface)(struct ieee80211_hw *hw,
1195 struct ieee80211_vif *vif,
1196 struct ieee80211_if_conf *conf);
1197 void (*bss_info_changed)(struct ieee80211_hw *hw,
1198 struct ieee80211_vif *vif,
1199 struct ieee80211_bss_conf *info,
1201 void (*configure_filter)(struct ieee80211_hw *hw,
1202 unsigned int changed_flags,
1203 unsigned int *total_flags,
1204 int mc_count, struct dev_addr_list *mc_list);
1205 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
1206 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1207 const u8 *local_address, const u8 *address,
1208 struct ieee80211_key_conf *key);
1209 void (*update_tkip_key)(struct ieee80211_hw *hw,
1210 struct ieee80211_key_conf *conf, const u8 *address,
1211 u32 iv32, u16 *phase1key);
1212 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
1213 int (*get_stats)(struct ieee80211_hw *hw,
1214 struct ieee80211_low_level_stats *stats);
1215 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1216 u32 *iv32, u16 *iv16);
1217 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1218 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
1219 int (*set_retry_limit)(struct ieee80211_hw *hw,
1220 u32 short_retry, u32 long_retr);
1221 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1222 enum sta_notify_cmd, const u8 *addr);
1223 int (*conf_tx)(struct ieee80211_hw *hw, u16 queue,
1224 const struct ieee80211_tx_queue_params *params);
1225 int (*get_tx_stats)(struct ieee80211_hw *hw,
1226 struct ieee80211_tx_queue_stats *stats);
1227 u64 (*get_tsf)(struct ieee80211_hw *hw);
1228 void (*reset_tsf)(struct ieee80211_hw *hw);
1229 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1230 int (*ampdu_action)(struct ieee80211_hw *hw,
1231 enum ieee80211_ampdu_mlme_action action,
1232 const u8 *addr, u16 tid, u16 *ssn);
1236 * ieee80211_alloc_hw - Allocate a new hardware device
1238 * This must be called once for each hardware device. The returned pointer
1239 * must be used to refer to this device when calling other functions.
1240 * mac80211 allocates a private data area for the driver pointed to by
1241 * @priv in &struct ieee80211_hw, the size of this area is given as
1244 * @priv_data_len: length of private data
1245 * @ops: callbacks for this device
1247 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1248 const struct ieee80211_ops *ops);
1251 * ieee80211_register_hw - Register hardware device
1253 * You must call this function before any other functions in
1254 * mac80211. Note that before a hardware can be registered, you
1255 * need to fill the contained wiphy's information.
1257 * @hw: the device to register as returned by ieee80211_alloc_hw()
1259 int ieee80211_register_hw(struct ieee80211_hw *hw);
1261 #ifdef CONFIG_MAC80211_LEDS
1262 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1263 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1264 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1265 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1268 * ieee80211_get_tx_led_name - get name of TX LED
1270 * mac80211 creates a transmit LED trigger for each wireless hardware
1271 * that can be used to drive LEDs if your driver registers a LED device.
1272 * This function returns the name (or %NULL if not configured for LEDs)
1273 * of the trigger so you can automatically link the LED device.
1275 * @hw: the hardware to get the LED trigger name for
1277 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1279 #ifdef CONFIG_MAC80211_LEDS
1280 return __ieee80211_get_tx_led_name(hw);
1287 * ieee80211_get_rx_led_name - get name of RX LED
1289 * mac80211 creates a receive LED trigger for each wireless hardware
1290 * that can be used to drive LEDs if your driver registers a LED device.
1291 * This function returns the name (or %NULL if not configured for LEDs)
1292 * of the trigger so you can automatically link the LED device.
1294 * @hw: the hardware to get the LED trigger name for
1296 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1298 #ifdef CONFIG_MAC80211_LEDS
1299 return __ieee80211_get_rx_led_name(hw);
1306 * ieee80211_get_assoc_led_name - get name of association LED
1308 * mac80211 creates a association LED trigger for each wireless hardware
1309 * that can be used to drive LEDs if your driver registers a LED device.
1310 * This function returns the name (or %NULL if not configured for LEDs)
1311 * of the trigger so you can automatically link the LED device.
1313 * @hw: the hardware to get the LED trigger name for
1315 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1317 #ifdef CONFIG_MAC80211_LEDS
1318 return __ieee80211_get_assoc_led_name(hw);
1325 * ieee80211_get_radio_led_name - get name of radio LED
1327 * mac80211 creates a radio change LED trigger for each wireless hardware
1328 * that can be used to drive LEDs if your driver registers a LED device.
1329 * This function returns the name (or %NULL if not configured for LEDs)
1330 * of the trigger so you can automatically link the LED device.
1332 * @hw: the hardware to get the LED trigger name for
1334 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1336 #ifdef CONFIG_MAC80211_LEDS
1337 return __ieee80211_get_radio_led_name(hw);
1344 * ieee80211_unregister_hw - Unregister a hardware device
1346 * This function instructs mac80211 to free allocated resources
1347 * and unregister netdevices from the networking subsystem.
1349 * @hw: the hardware to unregister
1351 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1354 * ieee80211_free_hw - free hardware descriptor
1356 * This function frees everything that was allocated, including the
1357 * private data for the driver. You must call ieee80211_unregister_hw()
1358 * before calling this function.
1360 * @hw: the hardware to free
1362 void ieee80211_free_hw(struct ieee80211_hw *hw);
1364 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1365 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1366 struct ieee80211_rx_status *status);
1369 * ieee80211_rx - receive frame
1371 * Use this function to hand received frames to mac80211. The receive
1372 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1373 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1375 * This function may not be called in IRQ context. Calls to this function
1376 * for a single hardware must be synchronized against each other. Calls
1377 * to this function and ieee80211_rx_irqsafe() may not be mixed for a
1380 * @hw: the hardware this frame came in on
1381 * @skb: the buffer to receive, owned by mac80211 after this call
1382 * @status: status of this frame; the status pointer need not be valid
1383 * after this function returns
1385 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1386 struct ieee80211_rx_status *status)
1388 __ieee80211_rx(hw, skb, status);
1392 * ieee80211_rx_irqsafe - receive frame
1394 * Like ieee80211_rx() but can be called in IRQ context
1395 * (internally defers to a tasklet.)
1397 * Calls to this function and ieee80211_rx() may not be mixed for a
1400 * @hw: the hardware this frame came in on
1401 * @skb: the buffer to receive, owned by mac80211 after this call
1402 * @status: status of this frame; the status pointer need not be valid
1403 * after this function returns and is not freed by mac80211,
1404 * it is recommended that it points to a stack area
1406 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1407 struct sk_buff *skb,
1408 struct ieee80211_rx_status *status);
1411 * ieee80211_tx_status - transmit status callback
1413 * Call this function for all transmitted frames after they have been
1414 * transmitted. It is permissible to not call this function for
1415 * multicast frames but this can affect statistics.
1417 * This function may not be called in IRQ context. Calls to this function
1418 * for a single hardware must be synchronized against each other. Calls
1419 * to this function and ieee80211_tx_status_irqsafe() may not be mixed
1420 * for a single hardware.
1422 * @hw: the hardware the frame was transmitted by
1423 * @skb: the frame that was transmitted, owned by mac80211 after this call
1425 void ieee80211_tx_status(struct ieee80211_hw *hw,
1426 struct sk_buff *skb);
1429 * ieee80211_tx_status_irqsafe - IRQ-safe transmit status callback
1431 * Like ieee80211_tx_status() but can be called in IRQ context
1432 * (internally defers to a tasklet.)
1434 * Calls to this function and ieee80211_tx_status() may not be mixed for a
1437 * @hw: the hardware the frame was transmitted by
1438 * @skb: the frame that was transmitted, owned by mac80211 after this call
1440 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1441 struct sk_buff *skb);
1444 * ieee80211_beacon_get - beacon generation function
1445 * @hw: pointer obtained from ieee80211_alloc_hw().
1446 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1447 * @control: will be filled with information needed to send this beacon.
1449 * If the beacon frames are generated by the host system (i.e., not in
1450 * hardware/firmware), the low-level driver uses this function to receive
1451 * the next beacon frame from the 802.11 code. The low-level is responsible
1452 * for calling this function before beacon data is needed (e.g., based on
1453 * hardware interrupt). Returned skb is used only once and low-level driver
1454 * is responsible of freeing it.
1456 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1457 struct ieee80211_vif *vif);
1460 * ieee80211_rts_get - RTS frame generation function
1461 * @hw: pointer obtained from ieee80211_alloc_hw().
1462 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1463 * @frame: pointer to the frame that is going to be protected by the RTS.
1464 * @frame_len: the frame length (in octets).
1465 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1466 * @rts: The buffer where to store the RTS frame.
1468 * If the RTS frames are generated by the host system (i.e., not in
1469 * hardware/firmware), the low-level driver uses this function to receive
1470 * the next RTS frame from the 802.11 code. The low-level is responsible
1471 * for calling this function before and RTS frame is needed.
1473 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1474 const void *frame, size_t frame_len,
1475 const struct ieee80211_tx_info *frame_txctl,
1476 struct ieee80211_rts *rts);
1479 * ieee80211_rts_duration - Get the duration field for an RTS frame
1480 * @hw: pointer obtained from ieee80211_alloc_hw().
1481 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1482 * @frame_len: the length of the frame that is going to be protected by the RTS.
1483 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1485 * If the RTS is generated in firmware, but the host system must provide
1486 * the duration field, the low-level driver uses this function to receive
1487 * the duration field value in little-endian byteorder.
1489 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1490 struct ieee80211_vif *vif, size_t frame_len,
1491 const struct ieee80211_tx_info *frame_txctl);
1494 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1495 * @hw: pointer obtained from ieee80211_alloc_hw().
1496 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1497 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1498 * @frame_len: the frame length (in octets).
1499 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1500 * @cts: The buffer where to store the CTS-to-self frame.
1502 * If the CTS-to-self frames are generated by the host system (i.e., not in
1503 * hardware/firmware), the low-level driver uses this function to receive
1504 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1505 * for calling this function before and CTS-to-self frame is needed.
1507 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1508 struct ieee80211_vif *vif,
1509 const void *frame, size_t frame_len,
1510 const struct ieee80211_tx_info *frame_txctl,
1511 struct ieee80211_cts *cts);
1514 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1515 * @hw: pointer obtained from ieee80211_alloc_hw().
1516 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1517 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1518 * @frame_txctl: &struct ieee80211_tx_info of the frame.
1520 * If the CTS-to-self is generated in firmware, but the host system must provide
1521 * the duration field, the low-level driver uses this function to receive
1522 * the duration field value in little-endian byteorder.
1524 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1525 struct ieee80211_vif *vif,
1527 const struct ieee80211_tx_info *frame_txctl);
1530 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1531 * @hw: pointer obtained from ieee80211_alloc_hw().
1532 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1533 * @frame_len: the length of the frame.
1534 * @rate: the rate at which the frame is going to be transmitted.
1536 * Calculate the duration field of some generic frame, given its
1537 * length and transmission rate (in 100kbps).
1539 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1540 struct ieee80211_vif *vif,
1542 struct ieee80211_rate *rate);
1545 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1546 * @hw: pointer as obtained from ieee80211_alloc_hw().
1547 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1548 * @control: will be filled with information needed to send returned frame.
1550 * Function for accessing buffered broadcast and multicast frames. If
1551 * hardware/firmware does not implement buffering of broadcast/multicast
1552 * frames when power saving is used, 802.11 code buffers them in the host
1553 * memory. The low-level driver uses this function to fetch next buffered
1554 * frame. In most cases, this is used when generating beacon frame. This
1555 * function returns a pointer to the next buffered skb or NULL if no more
1556 * buffered frames are available.
1558 * Note: buffered frames are returned only after DTIM beacon frame was
1559 * generated with ieee80211_beacon_get() and the low-level driver must thus
1560 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1561 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1562 * does not need to check for DTIM beacons separately and should be able to
1563 * use common code for all beacons.
1566 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif);
1569 * ieee80211_get_hdrlen_from_skb - get header length from data
1571 * Given an skb with a raw 802.11 header at the data pointer this function
1572 * returns the 802.11 header length in bytes (not including encryption
1573 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1574 * header the function returns 0.
1578 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1581 * ieee80211_hdrlen - get header length in bytes from frame control
1582 * @fc: frame control field in little-endian format
1584 unsigned int ieee80211_hdrlen(__le16 fc);
1587 * ieee80211_get_tkip_key - get a TKIP rc4 for skb
1589 * This function computes a TKIP rc4 key for an skb. It computes
1590 * a phase 1 key if needed (iv16 wraps around). This function is to
1591 * be used by drivers which can do HW encryption but need to compute
1592 * to phase 1/2 key in SW.
1594 * @keyconf: the parameter passed with the set key
1595 * @skb: the skb for which the key is needed
1596 * @rc4key: a buffer to which the key will be written
1600 void ieee80211_get_tkip_key(struct ieee80211_key_conf *keyconf,
1601 struct sk_buff *skb,
1602 enum ieee80211_tkip_key_type type, u8 *key);
1604 * ieee80211_wake_queue - wake specific queue
1605 * @hw: pointer as obtained from ieee80211_alloc_hw().
1606 * @queue: queue number (counted from zero).
1608 * Drivers should use this function instead of netif_wake_queue.
1610 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1613 * ieee80211_stop_queue - stop specific queue
1614 * @hw: pointer as obtained from ieee80211_alloc_hw().
1615 * @queue: queue number (counted from zero).
1617 * Drivers should use this function instead of netif_stop_queue.
1619 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1622 * ieee80211_queue_stopped - test status of the queue
1623 * @hw: pointer as obtained from ieee80211_alloc_hw().
1624 * @queue: queue number (counted from zero).
1626 * Drivers should use this function instead of netif_stop_queue.
1629 int ieee80211_queue_stopped(struct ieee80211_hw *hw, int queue);
1632 * ieee80211_stop_queues - stop all queues
1633 * @hw: pointer as obtained from ieee80211_alloc_hw().
1635 * Drivers should use this function instead of netif_stop_queue.
1637 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1640 * ieee80211_wake_queues - wake all queues
1641 * @hw: pointer as obtained from ieee80211_alloc_hw().
1643 * Drivers should use this function instead of netif_wake_queue.
1645 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1648 * ieee80211_scan_completed - completed hardware scan
1650 * When hardware scan offload is used (i.e. the hw_scan() callback is
1651 * assigned) this function needs to be called by the driver to notify
1652 * mac80211 that the scan finished.
1654 * @hw: the hardware that finished the scan
1656 void ieee80211_scan_completed(struct ieee80211_hw *hw);
1659 * ieee80211_iterate_active_interfaces - iterate active interfaces
1661 * This function iterates over the interfaces associated with a given
1662 * hardware that are currently active and calls the callback for them.
1663 * This function allows the iterator function to sleep, when the iterator
1664 * function is atomic @ieee80211_iterate_active_interfaces_atomic can
1667 * @hw: the hardware struct of which the interfaces should be iterated over
1668 * @iterator: the iterator function to call
1669 * @data: first argument of the iterator function
1671 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1672 void (*iterator)(void *data, u8 *mac,
1673 struct ieee80211_vif *vif),
1677 * ieee80211_iterate_active_interfaces_atomic - iterate active interfaces
1679 * This function iterates over the interfaces associated with a given
1680 * hardware that are currently active and calls the callback for them.
1681 * This function requires the iterator callback function to be atomic,
1682 * if that is not desired, use @ieee80211_iterate_active_interfaces instead.
1684 * @hw: the hardware struct of which the interfaces should be iterated over
1685 * @iterator: the iterator function to call, cannot sleep
1686 * @data: first argument of the iterator function
1688 void ieee80211_iterate_active_interfaces_atomic(struct ieee80211_hw *hw,
1689 void (*iterator)(void *data,
1691 struct ieee80211_vif *vif),
1695 * ieee80211_start_tx_ba_session - Start a tx Block Ack session.
1696 * @hw: pointer as obtained from ieee80211_alloc_hw().
1697 * @ra: receiver address of the BA session recipient
1698 * @tid: the TID to BA on.
1699 * @return: success if addBA request was sent, failure otherwise
1701 * Although mac80211/low level driver/user space application can estimate
1702 * the need to start aggregation on a certain RA/TID, the session level
1703 * will be managed by the mac80211.
1705 int ieee80211_start_tx_ba_session(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1708 * ieee80211_start_tx_ba_cb - low level driver ready to aggregate.
1709 * @hw: pointer as obtained from ieee80211_alloc_hw().
1710 * @ra: receiver address of the BA session recipient.
1711 * @tid: the TID to BA on.
1713 * This function must be called by low level driver once it has
1714 * finished with preparations for the BA session.
1716 void ieee80211_start_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u16 tid);
1719 * ieee80211_start_tx_ba_cb_irqsafe - low level driver ready to aggregate.
1720 * @hw: pointer as obtained from ieee80211_alloc_hw().
1721 * @ra: receiver address of the BA session recipient.
1722 * @tid: the TID to BA on.
1724 * This function must be called by low level driver once it has
1725 * finished with preparations for the BA session.
1726 * This version of the function is IRQ-safe.
1728 void ieee80211_start_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1732 * ieee80211_stop_tx_ba_session - Stop a Block Ack session.
1733 * @hw: pointer as obtained from ieee80211_alloc_hw().
1734 * @ra: receiver address of the BA session recipient
1735 * @tid: the TID to stop BA.
1736 * @initiator: if indicates initiator DELBA frame will be sent.
1737 * @return: error if no sta with matching da found, success otherwise
1739 * Although mac80211/low level driver/user space application can estimate
1740 * the need to stop aggregation on a certain RA/TID, the session level
1741 * will be managed by the mac80211.
1743 int ieee80211_stop_tx_ba_session(struct ieee80211_hw *hw,
1745 enum ieee80211_back_parties initiator);
1748 * ieee80211_stop_tx_ba_cb - low level driver ready to stop aggregate.
1749 * @hw: pointer as obtained from ieee80211_alloc_hw().
1750 * @ra: receiver address of the BA session recipient.
1751 * @tid: the desired TID to BA on.
1753 * This function must be called by low level driver once it has
1754 * finished with preparations for the BA session tear down.
1756 void ieee80211_stop_tx_ba_cb(struct ieee80211_hw *hw, u8 *ra, u8 tid);
1759 * ieee80211_stop_tx_ba_cb_irqsafe - low level driver ready to stop aggregate.
1760 * @hw: pointer as obtained from ieee80211_alloc_hw().
1761 * @ra: receiver address of the BA session recipient.
1762 * @tid: the desired TID to BA on.
1764 * This function must be called by low level driver once it has
1765 * finished with preparations for the BA session tear down.
1766 * This version of the function is IRQ-safe.
1768 void ieee80211_stop_tx_ba_cb_irqsafe(struct ieee80211_hw *hw, const u8 *ra,
1772 * ieee80211_notify_mac - low level driver notification
1773 * @hw: pointer as obtained from ieee80211_alloc_hw().
1774 * @notif_type: enum ieee80211_notification_types
1776 * This function must be called by low level driver to inform mac80211 of
1777 * low level driver status change or force mac80211 to re-assoc for low
1778 * level driver internal error that require re-assoc.
1780 void ieee80211_notify_mac(struct ieee80211_hw *hw,
1781 enum ieee80211_notification_types notif_type);
1782 #endif /* MAC80211_H */