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 function.
47 * If you're reading this document and not the header file itself, it will
48 * be incomplete because not all documentation has been converted yet.
54 * As a general rule, when frames are passed between mac80211 and the driver,
55 * they start with the IEEE 802.11 header and include the same octets that are
56 * sent over the air except for the FCS which should be calculated by the
59 * There are, however, various exceptions to this rule for advanced features:
61 * The first exception is for hardware encryption and decryption offload
62 * where the IV/ICV may or may not be generated in hardware.
64 * Secondly, when the hardware handles fragmentation, the frame handed to
65 * the driver from mac80211 is the MSDU, not the MPDU.
67 * Finally, for received frames, the driver is able to indicate that it has
68 * filled a radiotap header and put that in front of the frame; if it does
69 * not do so then mac80211 may add this under certain circumstances.
72 #define IEEE80211_CHAN_W_SCAN 0x00000001
73 #define IEEE80211_CHAN_W_ACTIVE_SCAN 0x00000002
74 #define IEEE80211_CHAN_W_IBSS 0x00000004
76 /* Channel information structure. Low-level driver is expected to fill in chan,
77 * freq, and val fields. Other fields will be filled in by 80211.o based on
78 * hostapd information and low-level driver does not need to use them. The
79 * limits for each channel will be provided in 'struct ieee80211_conf' when
80 * configuring the low-level driver with hw->config callback. If a device has
81 * a default regulatory domain, IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED
82 * can be set to let the driver configure all fields */
83 struct ieee80211_channel {
84 short chan; /* channel number (IEEE 802.11) */
85 short freq; /* frequency in MHz */
86 int val; /* hw specific value for the channel */
87 int flag; /* flag for hostapd use (IEEE80211_CHAN_*) */
88 unsigned char power_level;
89 unsigned char antenna_max;
92 #define IEEE80211_RATE_ERP 0x00000001
93 #define IEEE80211_RATE_BASIC 0x00000002
94 #define IEEE80211_RATE_PREAMBLE2 0x00000004
95 #define IEEE80211_RATE_SUPPORTED 0x00000010
96 #define IEEE80211_RATE_OFDM 0x00000020
97 #define IEEE80211_RATE_CCK 0x00000040
98 #define IEEE80211_RATE_MANDATORY 0x00000100
100 #define IEEE80211_RATE_CCK_2 (IEEE80211_RATE_CCK | IEEE80211_RATE_PREAMBLE2)
101 #define IEEE80211_RATE_MODULATION(f) \
102 (f & (IEEE80211_RATE_CCK | IEEE80211_RATE_OFDM))
104 /* Low-level driver should set PREAMBLE2, OFDM and CCK flags.
105 * BASIC, SUPPORTED, ERP, and MANDATORY flags are set in 80211.o based on the
107 struct ieee80211_rate {
108 int rate; /* rate in 100 kbps */
109 int val; /* hw specific value for the rate */
110 int flags; /* IEEE80211_RATE_ flags */
111 int val2; /* hw specific value for the rate when using short preamble
112 * (only when IEEE80211_RATE_PREAMBLE2 flag is set, i.e., for
113 * 2, 5.5, and 11 Mbps) */
114 signed char min_rssi_ack;
115 unsigned char min_rssi_ack_delta;
117 /* following fields are set by 80211.o and need not be filled by the
118 * low-level driver */
119 int rate_inv; /* inverse of the rate (LCM(all rates) / rate) for
120 * optimizing channel utilization estimates */
124 * enum ieee80211_phymode - PHY modes
126 * @MODE_IEEE80211A: 5GHz as defined by 802.11a/802.11h
127 * @MODE_IEEE80211B: 2.4 GHz as defined by 802.11b
128 * @MODE_IEEE80211G: 2.4 GHz as defined by 802.11g (with OFDM),
129 * backwards compatible with 11b mode
130 * @NUM_IEEE80211_MODES: internal
132 enum ieee80211_phymode {
142 * struct ieee80211_ht_info - describing STA's HT capabilities
144 * This structure describes most essential parameters needed
145 * to describe 802.11n HT capabilities for an STA.
147 * @ht_supported: is HT supported by STA, 0: no, 1: yes
148 * @cap: HT capabilities map as described in 802.11n spec
149 * @ampdu_factor: Maximum A-MPDU length factor
150 * @ampdu_density: Minimum A-MPDU spacing
151 * @supp_mcs_set: Supported MCS set as described in 802.11n spec
153 struct ieee80211_ht_info {
155 u16 cap; /* use IEEE80211_HT_CAP_ */
162 * struct ieee80211_ht_bss_info - describing BSS's HT characteristics
164 * This structure describes most essential parameters needed
165 * to describe 802.11n HT characteristics in a BSS
167 * @primary_channel: channel number of primery channel
168 * @bss_cap: 802.11n's general BSS capabilities (e.g. channel width)
169 * @bss_op_mode: 802.11n's BSS operation modes (e.g. HT protection)
171 struct ieee80211_ht_bss_info {
173 u8 bss_cap; /* use IEEE80211_HT_IE_CHA_ */
174 u8 bss_op_mode; /* use IEEE80211_HT_IE_ */
178 * struct ieee80211_hw_mode - PHY mode definition
180 * This structure describes the capabilities supported by the device
181 * in a single PHY mode.
184 * @channels: pointer to array of supported channels
185 * @rates: pointer to array of supported bitrates
186 * @mode: the PHY mode for this definition
187 * @num_channels: number of supported channels
188 * @num_rates: number of supported bitrates
189 * @ht_info: PHY's 802.11n HT abilities for this mode
191 struct ieee80211_hw_mode {
192 struct list_head list;
193 struct ieee80211_channel *channels;
194 struct ieee80211_rate *rates;
195 enum ieee80211_phymode mode;
198 struct ieee80211_ht_info ht_info;
202 * struct ieee80211_tx_queue_params - transmit queue configuration
204 * The information provided in this structure is required for QoS
205 * transmit queue configuration.
207 * @aifs: arbitration interface space [0..255, -1: use default]
208 * @cw_min: minimum contention window [will be a value of the form
209 * 2^n-1 in the range 1..1023; 0: use default]
210 * @cw_max: maximum contention window [like @cw_min]
211 * @burst_time: maximum burst time in units of 0.1ms, 0 meaning disabled
213 struct ieee80211_tx_queue_params {
221 * struct ieee80211_tx_queue_stats_data - transmit queue statistics
223 * @len: number of packets in queue
224 * @limit: queue length limit
225 * @count: number of frames sent
227 struct ieee80211_tx_queue_stats_data {
234 * enum ieee80211_tx_queue - transmit queue number
236 * These constants are used with some callbacks that take a
237 * queue number to set parameters for a queue.
239 * @IEEE80211_TX_QUEUE_DATA0: data queue 0
240 * @IEEE80211_TX_QUEUE_DATA1: data queue 1
241 * @IEEE80211_TX_QUEUE_DATA2: data queue 2
242 * @IEEE80211_TX_QUEUE_DATA3: data queue 3
243 * @IEEE80211_TX_QUEUE_DATA4: data queue 4
244 * @IEEE80211_TX_QUEUE_SVP: ??
245 * @NUM_TX_DATA_QUEUES: number of data queues
246 * @IEEE80211_TX_QUEUE_AFTER_BEACON: transmit queue for frames to be
247 * sent after a beacon
248 * @IEEE80211_TX_QUEUE_BEACON: transmit queue for beacon frames
250 enum ieee80211_tx_queue {
251 IEEE80211_TX_QUEUE_DATA0,
252 IEEE80211_TX_QUEUE_DATA1,
253 IEEE80211_TX_QUEUE_DATA2,
254 IEEE80211_TX_QUEUE_DATA3,
255 IEEE80211_TX_QUEUE_DATA4,
256 IEEE80211_TX_QUEUE_SVP,
260 /* due to stupidity in the sub-ioctl userspace interface, the items in
261 * this struct need to have fixed values. As soon as it is removed, we can
262 * fix these entries. */
263 IEEE80211_TX_QUEUE_AFTER_BEACON = 6,
264 IEEE80211_TX_QUEUE_BEACON = 7
267 struct ieee80211_tx_queue_stats {
268 struct ieee80211_tx_queue_stats_data data[NUM_TX_DATA_QUEUES];
271 struct ieee80211_low_level_stats {
272 unsigned int dot11ACKFailureCount;
273 unsigned int dot11RTSFailureCount;
274 unsigned int dot11FCSErrorCount;
275 unsigned int dot11RTSSuccessCount;
278 /* Transmit control fields. This data structure is passed to low-level driver
279 * with each TX frame. The low-level driver is responsible for configuring
280 * the hardware to use given values (depending on what is supported). */
282 struct ieee80211_tx_control {
283 struct ieee80211_vif *vif;
284 int tx_rate; /* Transmit rate, given as the hw specific value for the
285 * rate (from struct ieee80211_rate) */
286 int rts_cts_rate; /* Transmit rate for RTS/CTS frame, given as the hw
287 * specific value for the rate (from
288 * struct ieee80211_rate) */
290 #define IEEE80211_TXCTL_REQ_TX_STATUS (1<<0)/* request TX status callback for
292 #define IEEE80211_TXCTL_DO_NOT_ENCRYPT (1<<1) /* send this frame without
293 * encryption; e.g., for EAPOL
295 #define IEEE80211_TXCTL_USE_RTS_CTS (1<<2) /* use RTS-CTS before sending
297 #define IEEE80211_TXCTL_USE_CTS_PROTECT (1<<3) /* use CTS protection for the
298 * frame (e.g., for combined
299 * 802.11g / 802.11b networks) */
300 #define IEEE80211_TXCTL_NO_ACK (1<<4) /* tell the low level not to
302 #define IEEE80211_TXCTL_RATE_CTRL_PROBE (1<<5)
303 #define IEEE80211_TXCTL_CLEAR_DST_MASK (1<<6)
304 #define IEEE80211_TXCTL_REQUEUE (1<<7)
305 #define IEEE80211_TXCTL_FIRST_FRAGMENT (1<<8) /* this is a first fragment of
307 #define IEEE80211_TXCTL_LONG_RETRY_LIMIT (1<<10) /* this frame should be send
309 * set_retry_limit configured
310 * long retry value */
311 #define IEEE80211_TXCTL_EAPOL_FRAME (1<<11) /* internal to mac80211 */
312 #define IEEE80211_TXCTL_SEND_AFTER_DTIM (1<<12) /* send this frame after DTIM
314 u32 flags; /* tx control flags defined
316 u8 key_idx; /* keyidx from hw->set_key(), undefined if
317 * IEEE80211_TXCTL_DO_NOT_ENCRYPT is set */
318 u8 retry_limit; /* 1 = only first attempt, 2 = one retry, ..
319 * This could be used when set_retry_limit
320 * is not implemented by the driver */
321 u8 power_level; /* per-packet transmit power level, in dBm */
322 u8 antenna_sel_tx; /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */
323 u8 icv_len; /* length of the ICV/MIC field in octets */
324 u8 iv_len; /* length of the IV field in octets */
325 u8 queue; /* hardware queue to use for this frame;
326 * 0 = highest, hw->queues-1 = lowest */
327 struct ieee80211_rate *rate; /* internal 80211.o rate */
328 struct ieee80211_rate *rts_rate; /* internal 80211.o rate
330 int alt_retry_rate; /* retry rate for the last retries, given as the
331 * hw specific value for the rate (from
332 * struct ieee80211_rate). To be used to limit
333 * packet dropping when probing higher rates, if hw
334 * supports multiple retry rates. -1 = not used */
335 int type; /* internal */
340 * enum mac80211_rx_flags - receive flags
342 * These flags are used with the @flag member of &struct ieee80211_rx_status.
343 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
344 * Use together with %RX_FLAG_MMIC_STRIPPED.
345 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
346 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
347 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
348 * verification has been done by the hardware.
349 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
350 * If this flag is set, the stack cannot do any replay detection
351 * hence the driver or hardware will have to do that.
352 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
354 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
356 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
359 enum mac80211_rx_flags {
360 RX_FLAG_MMIC_ERROR = 1<<0,
361 RX_FLAG_DECRYPTED = 1<<1,
362 RX_FLAG_RADIOTAP = 1<<2,
363 RX_FLAG_MMIC_STRIPPED = 1<<3,
364 RX_FLAG_IV_STRIPPED = 1<<4,
365 RX_FLAG_FAILED_FCS_CRC = 1<<5,
366 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
371 * struct ieee80211_rx_status - receive status
373 * The low-level driver should provide this information (the subset
374 * supported by hardware) to the 802.11 code with each received
376 * @mactime: MAC timestamp as defined by 802.11
377 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
378 * @channel: channel the radio was tuned to
379 * @phymode: active PHY mode
380 * @ssi: signal strength when receiving this frame
381 * @signal: used as 'qual' in statistics reporting
382 * @noise: PHY noise when receiving this frame
383 * @antenna: antenna used
387 struct ieee80211_rx_status {
391 enum ieee80211_phymode phymode;
401 * enum ieee80211_tx_status_flags - transmit status flags
403 * Status flags to indicate various transmit conditions.
405 * @IEEE80211_TX_STATUS_TX_FILTERED: The frame was not transmitted
406 * because the destination STA was in powersave mode.
408 * @IEEE80211_TX_STATUS_ACK: Frame was acknowledged
410 enum ieee80211_tx_status_flags {
411 IEEE80211_TX_STATUS_TX_FILTERED = 1<<0,
412 IEEE80211_TX_STATUS_ACK = 1<<1,
416 * struct ieee80211_tx_status - transmit status
418 * As much information as possible should be provided for each transmitted
419 * frame with ieee80211_tx_status().
421 * @control: a copy of the &struct ieee80211_tx_control passed to the driver
422 * in the tx() callback.
424 * @flags: transmit status flags, defined above
426 * @ack_signal: signal strength of the ACK frame
428 * @excessive_retries: set to 1 if the frame was retried many times
429 * but not acknowledged
431 * @retry_count: number of retries
433 * @queue_length: ?? REMOVE
434 * @queue_number: ?? REMOVE
436 struct ieee80211_tx_status {
437 struct ieee80211_tx_control control;
439 bool excessive_retries;
447 * enum ieee80211_conf_flags - configuration flags
449 * Flags to define PHY configuration options
451 * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time
452 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
453 * @IEEE80211_CONF_SUPPORT_HT_MODE: use 802.11n HT capabilities (if supported)
455 enum ieee80211_conf_flags {
456 IEEE80211_CONF_SHORT_SLOT_TIME = (1<<0),
457 IEEE80211_CONF_RADIOTAP = (1<<1),
458 IEEE80211_CONF_SUPPORT_HT_MODE = (1<<2),
462 * struct ieee80211_conf - configuration of the device
464 * This struct indicates how the driver shall configure the hardware.
466 * @radio_enabled: when zero, driver is required to switch off the radio.
468 * @channel: IEEE 802.11 channel number
469 * @freq: frequency in MHz
470 * @channel_val: hardware specific channel value for the channel
471 * @phymode: PHY mode to activate (REMOVE)
472 * @chan: channel to switch to, pointer to the channel information
473 * @mode: pointer to mode definition
474 * @regulatory_domain: ??
475 * @beacon_int: beacon interval (TODO make interface config)
476 * @flags: configuration flags defined above
477 * @power_level: transmit power limit for current regulatory domain in dBm
478 * @antenna_max: maximum antenna gain
479 * @antenna_sel_tx: transmit antenna selection, 0: default/diversity,
481 * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx
482 * @ht_conf: describes current self configuration of 802.11n HT capabilies
483 * @ht_bss_conf: describes current BSS configuration of 802.11n HT parameters
485 struct ieee80211_conf {
486 int channel; /* IEEE 802.11 channel number */
488 int channel_val; /* hw specific value for the channel */
490 enum ieee80211_phymode phymode;
491 struct ieee80211_channel *chan;
492 struct ieee80211_hw_mode *mode;
493 unsigned int regulatory_domain;
503 struct ieee80211_ht_info ht_conf;
504 struct ieee80211_ht_bss_info ht_bss_conf;
508 * enum ieee80211_if_types - types of 802.11 network interfaces
510 * @IEEE80211_IF_TYPE_INVALID: invalid interface type, not used
512 * @IEEE80211_IF_TYPE_AP: interface in AP mode.
513 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap
514 * daemon. Drivers should never see this type.
515 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode.
516 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode.
517 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode.
518 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode.
519 * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers
520 * will never see this type.
522 enum ieee80211_if_types {
523 IEEE80211_IF_TYPE_INVALID,
524 IEEE80211_IF_TYPE_AP,
525 IEEE80211_IF_TYPE_STA,
526 IEEE80211_IF_TYPE_IBSS,
527 IEEE80211_IF_TYPE_MNTR,
528 IEEE80211_IF_TYPE_WDS,
529 IEEE80211_IF_TYPE_VLAN,
533 * struct ieee80211_vif - per-interface data
535 * Data in this structure is continually present for driver
536 * use during the life of a virtual interface.
538 * @drv_priv: data area for driver use, will always be aligned to
541 struct ieee80211_vif {
543 u8 drv_priv[0] __attribute__((__aligned__(sizeof(void *))));
547 * struct ieee80211_if_init_conf - initial configuration of an interface
549 * @vif: pointer to a driver-use per-interface structure. The pointer
550 * itself is also used for various functions including
551 * ieee80211_beacon_get() and ieee80211_get_buffered_bc().
552 * @type: one of &enum ieee80211_if_types constants. Determines the type of
553 * added/removed interface.
554 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
555 * until the interface is removed (i.e. it cannot be used after
556 * remove_interface() callback was called for this interface).
558 * This structure is used in add_interface() and remove_interface()
559 * callbacks of &struct ieee80211_hw.
561 * When you allow multiple interfaces to be added to your PHY, take care
562 * that the hardware can actually handle multiple MAC addresses. However,
563 * also take care that when there's no interface left with mac_addr != %NULL
564 * you remove the MAC address from the device to avoid acknowledging packets
565 * in pure monitor mode.
567 struct ieee80211_if_init_conf {
568 enum ieee80211_if_types type;
569 struct ieee80211_vif *vif;
574 * struct ieee80211_if_conf - configuration of an interface
576 * @type: type of the interface. This is always the same as was specified in
577 * &struct ieee80211_if_init_conf. The type of an interface never changes
578 * during the life of the interface; this field is present only for
580 * @bssid: BSSID of the network we are associated to/creating.
581 * @ssid: used (together with @ssid_len) by drivers for hardware that
582 * generate beacons independently. The pointer is valid only during the
583 * config_interface() call, so copy the value somewhere if you need
585 * @ssid_len: length of the @ssid field.
586 * @beacon: beacon template. Valid only if @host_gen_beacon_template in
587 * &struct ieee80211_hw is set. The driver is responsible of freeing
589 * @beacon_control: tx_control for the beacon template, this field is only
590 * valid when the @beacon field was set.
592 * This structure is passed to the config_interface() callback of
593 * &struct ieee80211_hw.
595 struct ieee80211_if_conf {
600 struct sk_buff *beacon;
601 struct ieee80211_tx_control *beacon_control;
605 * enum ieee80211_key_alg - key algorithm
606 * @ALG_WEP: WEP40 or WEP104
608 * @ALG_CCMP: CCMP (AES)
610 enum ieee80211_key_alg {
618 * enum ieee80211_key_flags - key flags
620 * These flags are used for communication about keys between the driver
621 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
623 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
624 * that the STA this key will be used with could be using QoS.
625 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
626 * driver to indicate that it requires IV generation for this
628 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
629 * the driver for a TKIP key if it requires Michael MIC
630 * generation in software.
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,
639 * struct ieee80211_key_conf - key information
641 * This key information is given by mac80211 to the driver by
642 * the set_key() callback in &struct ieee80211_ops.
644 * @hw_key_idx: To be set by the driver, this is the key index the driver
645 * wants to be given when a frame is transmitted and needs to be
646 * encrypted in hardware.
647 * @alg: The key algorithm.
648 * @flags: key flags, see &enum ieee80211_key_flags.
649 * @keyidx: the key index (0-3)
650 * @keylen: key material length
653 struct ieee80211_key_conf {
654 enum ieee80211_key_alg alg;
663 * enum set_key_cmd - key command
665 * Used with the set_key() callback in &struct ieee80211_ops, this
666 * indicates whether a key is being removed or added.
668 * @SET_KEY: a key is set
669 * @DISABLE_KEY: a key must be disabled
672 SET_KEY, DISABLE_KEY,
676 * enum sta_notify_cmd - sta notify command
678 * Used with the sta_notify() callback in &struct ieee80211_ops, this
679 * indicates addition and removal of a station to station table
681 * @STA_NOTIFY_ADD: a station was added to the station table
682 * @STA_NOTIFY_REMOVE: a station being removed from the station table
684 enum sta_notify_cmd {
685 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE
689 * enum ieee80211_hw_flags - hardware flags
691 * These flags are used to indicate hardware capabilities to
692 * the stack. Generally, flags here should have their meaning
693 * done in a way that the simplest hardware doesn't need setting
694 * any particular flags. There are some exceptions to this rule,
695 * however, so you are advised to review these flags carefully.
697 * @IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE:
698 * The device only needs to be supplied with a beacon template.
699 * If you need the host to generate each beacon then don't use
700 * this flag and call ieee80211_beacon_get() when you need the
701 * next beacon frame. Note that if you set this flag, you must
702 * implement the set_tim() callback for powersave mode to work
704 * This flag is only relevant for access-point mode.
706 * @IEEE80211_HW_RX_INCLUDES_FCS:
707 * Indicates that received frames passed to the stack include
708 * the FCS at the end.
710 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
711 * Some wireless LAN chipsets buffer broadcast/multicast frames
712 * for power saving stations in the hardware/firmware and others
713 * rely on the host system for such buffering. This option is used
714 * to configure the IEEE 802.11 upper layer to buffer broadcast and
715 * multicast frames when there are power saving stations so that
716 * the driver can fetch them with ieee80211_get_buffered_bc(). Note
717 * that not setting this flag works properly only when the
718 * %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is also not set because
719 * otherwise the stack will not know when the DTIM beacon was sent.
721 * @IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED:
722 * Channels are already configured to the default regulatory domain
723 * specified in the device's EEPROM
725 enum ieee80211_hw_flags {
726 IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE = 1<<0,
727 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
728 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
729 IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED = 1<<3,
733 * struct ieee80211_hw - hardware information and state
735 * This structure contains the configuration and hardware
736 * information for an 802.11 PHY.
738 * @wiphy: This points to the &struct wiphy allocated for this
739 * 802.11 PHY. You must fill in the @perm_addr and @dev
740 * members of this structure using SET_IEEE80211_DEV()
741 * and SET_IEEE80211_PERM_ADDR().
743 * @conf: &struct ieee80211_conf, device configuration, don't use.
745 * @workqueue: single threaded workqueue available for driver use,
746 * allocated by mac80211 on registration and flushed on
749 * @priv: pointer to private area that was allocated for driver use
750 * along with this structure.
752 * @flags: hardware flags, see &enum ieee80211_hw_flags.
754 * @extra_tx_headroom: headroom to reserve in each transmit skb
755 * for use by the driver (e.g. for transmit headers.)
757 * @channel_change_time: time (in microseconds) it takes to change channels.
759 * @max_rssi: Maximum value for ssi in RX information, use
760 * negative numbers for dBm and 0 to indicate no support.
762 * @max_signal: like @max_rssi, but for the signal value.
764 * @max_noise: like @max_rssi, but for the noise value.
766 * @queues: number of available hardware transmit queues for
767 * data packets. WMM/QoS requires at least four.
769 * @rate_control_algorithm: rate control algorithm for this hardware.
770 * If unset (NULL), the default algorithm will be used. Must be
771 * set before calling ieee80211_register_hw().
773 * @vif_data_size: size (in bytes) of the drv_priv data area
774 * within &struct ieee80211_vif.
776 struct ieee80211_hw {
777 struct ieee80211_conf conf;
779 struct workqueue_struct *workqueue;
780 const char *rate_control_algorithm;
783 unsigned int extra_tx_headroom;
784 int channel_change_time;
793 * SET_IEEE80211_DEV - set device for 802.11 hardware
795 * @hw: the &struct ieee80211_hw to set the device for
796 * @dev: the &struct device of this 802.11 device
798 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
800 set_wiphy_dev(hw->wiphy, dev);
804 * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware
806 * @hw: the &struct ieee80211_hw to set the MAC address for
807 * @addr: the address to set
809 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
811 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
815 * DOC: Hardware crypto acceleration
817 * mac80211 is capable of taking advantage of many hardware
818 * acceleration designs for encryption and decryption operations.
820 * The set_key() callback in the &struct ieee80211_ops for a given
821 * device is called to enable hardware acceleration of encryption and
822 * decryption. The callback takes an @address parameter that will be
823 * the broadcast address for default keys, the other station's hardware
824 * address for individual keys or the zero address for keys that will
825 * be used only for transmission.
826 * Multiple transmission keys with the same key index may be used when
827 * VLANs are configured for an access point.
829 * The @local_address parameter will always be set to our own address,
830 * this is only relevant if you support multiple local addresses.
832 * When transmitting, the TX control data will use the @hw_key_idx
833 * selected by the driver by modifying the &struct ieee80211_key_conf
834 * pointed to by the @key parameter to the set_key() function.
836 * The set_key() call for the %SET_KEY command should return 0 if
837 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
838 * added; if you return 0 then hw_key_idx must be assigned to the
839 * hardware key index, you are free to use the full u8 range.
841 * When the cmd is %DISABLE_KEY then it must succeed.
843 * Note that it is permissible to not decrypt a frame even if a key
844 * for it has been uploaded to hardware, the stack will not make any
845 * decision based on whether a key has been uploaded or not but rather
846 * based on the receive flags.
848 * The &struct ieee80211_key_conf structure pointed to by the @key
849 * parameter is guaranteed to be valid until another call to set_key()
850 * removes it, but it can only be used as a cookie to differentiate
855 * DOC: Frame filtering
857 * mac80211 requires to see many management frames for proper
858 * operation, and users may want to see many more frames when
859 * in monitor mode. However, for best CPU usage and power consumption,
860 * having as few frames as possible percolate through the stack is
861 * desirable. Hence, the hardware should filter as much as possible.
863 * To achieve this, mac80211 uses filter flags (see below) to tell
864 * the driver's configure_filter() function which frames should be
865 * passed to mac80211 and which should be filtered out.
867 * The configure_filter() callback is invoked with the parameters
868 * @mc_count and @mc_list for the combined multicast address list
869 * of all virtual interfaces, @changed_flags telling which flags
870 * were changed and @total_flags with the new flag states.
872 * If your device has no multicast address filters your driver will
873 * need to check both the %FIF_ALLMULTI flag and the @mc_count
874 * parameter to see whether multicast frames should be accepted
877 * All unsupported flags in @total_flags must be cleared, i.e. you
878 * should clear all bits except those you honoured.
882 * enum ieee80211_filter_flags - hardware filter flags
884 * These flags determine what the filter in hardware should be
885 * programmed to let through and what should not be passed to the
886 * stack. It is always safe to pass more frames than requested,
887 * but this has negative impact on power consumption.
889 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
890 * think of the BSS as your network segment and then this corresponds
891 * to the regular ethernet device promiscuous mode.
893 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
894 * by the user or if the hardware is not capable of filtering by
897 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
898 * %RX_FLAG_FAILED_FCS_CRC for them)
900 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
901 * the %RX_FLAG_FAILED_PLCP_CRC for them
903 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
904 * to the hardware that it should not filter beacons or probe responses
905 * by BSSID. Filtering them can greatly reduce the amount of processing
906 * mac80211 needs to do and the amount of CPU wakeups, so you should
907 * honour this flag if possible.
909 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
910 * only those addressed to this station
912 * @FIF_OTHER_BSS: pass frames destined to other BSSes
914 enum ieee80211_filter_flags {
915 FIF_PROMISC_IN_BSS = 1<<0,
919 FIF_BCN_PRBRESP_PROMISC = 1<<4,
921 FIF_OTHER_BSS = 1<<6,
925 * enum ieee80211_erp_change_flags - erp change flags
927 * These flags are used with the erp_ie_changed() callback in
928 * &struct ieee80211_ops to indicate which parameter(s) changed.
929 * @IEEE80211_ERP_CHANGE_PROTECTION: protection changed
930 * @IEEE80211_ERP_CHANGE_PREAMBLE: barker preamble mode changed
932 enum ieee80211_erp_change_flags {
933 IEEE80211_ERP_CHANGE_PROTECTION = 1<<0,
934 IEEE80211_ERP_CHANGE_PREAMBLE = 1<<1,
938 * enum ieee80211_ampdu_mlme_action - A-MPDU actions
940 * These flags are used with the ampdu_action() callback in
941 * &struct ieee80211_ops to indicate which action is needed.
942 * @IEEE80211_AMPDU_RX_START: start Rx aggregation
943 * @IEEE80211_AMPDU_RX_STOP: stop Rx aggregation
945 enum ieee80211_ampdu_mlme_action {
946 IEEE80211_AMPDU_RX_START,
947 IEEE80211_AMPDU_RX_STOP,
951 * struct ieee80211_ops - callbacks from mac80211 to the driver
953 * This structure contains various callbacks that the driver may
954 * handle or, in some cases, must handle, for example to configure
955 * the hardware to a new channel or to transmit a frame.
957 * @tx: Handler that 802.11 module calls for each transmitted frame.
958 * skb contains the buffer starting from the IEEE 802.11 header.
959 * The low-level driver should send the frame out based on
960 * configuration in the TX control data. Must be implemented and
963 * @start: Called before the first netdevice attached to the hardware
964 * is enabled. This should turn on the hardware and must turn on
965 * frame reception (for possibly enabled monitor interfaces.)
966 * Returns negative error codes, these may be seen in userspace,
968 * When the device is started it should not have a MAC address
969 * to avoid acknowledging frames before a non-monitor device
971 * Must be implemented.
973 * @stop: Called after last netdevice attached to the hardware
974 * is disabled. This should turn off the hardware (at least
975 * it must turn off frame reception.)
976 * May be called right after add_interface if that rejects
978 * Must be implemented.
980 * @add_interface: Called when a netdevice attached to the hardware is
981 * enabled. Because it is not called for monitor mode devices, @open
982 * and @stop must be implemented.
983 * The driver should perform any initialization it needs before
984 * the device can be enabled. The initial configuration for the
985 * interface is given in the conf parameter.
986 * The callback may refuse to add an interface by returning a
987 * negative error code (which will be seen in userspace.)
988 * Must be implemented.
990 * @remove_interface: Notifies a driver that an interface is going down.
991 * The @stop callback is called after this if it is the last interface
992 * and no monitor interfaces are present.
993 * When all interfaces are removed, the MAC address in the hardware
994 * must be cleared so the device no longer acknowledges packets,
995 * the mac_addr member of the conf structure is, however, set to the
996 * MAC address of the device going away.
997 * Hence, this callback must be implemented.
999 * @config: Handler for configuration requests. IEEE 802.11 code calls this
1000 * function to change hardware configuration, e.g., channel.
1002 * @config_interface: Handler for configuration requests related to interfaces
1003 * (e.g. BSSID changes.)
1005 * @configure_filter: Configure the device's RX filter.
1006 * See the section "Frame filtering" for more information.
1007 * This callback must be implemented and atomic.
1009 * @set_tim: Set TIM bit. If the hardware/firmware takes care of beacon
1010 * generation (that is, %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is set)
1011 * mac80211 calls this function when a TIM bit must be set or cleared
1012 * for a given AID. Must be atomic.
1014 * @set_key: See the section "Hardware crypto acceleration"
1015 * This callback can sleep, and is only called between add_interface
1016 * and remove_interface calls, i.e. while the interface with the
1017 * given local_address is enabled.
1019 * @hw_scan: Ask the hardware to service the scan request, no need to start
1020 * the scan state machine in stack.
1022 * @get_stats: return low-level statistics
1024 * @get_tkip_seq: If your device implements TKIP encryption in hardware this
1025 * callback should be provided to read the TKIP transmit IVs (both IV32
1026 * and IV16) for the given key from hardware.
1028 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1030 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if
1031 * the device does fragmentation by itself; if this method is assigned then
1032 * the stack will not do fragmentation.
1034 * @set_retry_limit: Configuration of retry limits (if device needs it)
1036 * @sta_notify: Notifies low level driver about addition or removal
1037 * of assocaited station or AP.
1039 * @erp_ie_changed: Handle ERP IE change notifications. Must be atomic.
1041 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1042 * bursting) for a hardware TX queue. The @queue parameter uses the
1043 * %IEEE80211_TX_QUEUE_* constants. Must be atomic.
1045 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1046 * to get number of currently queued packets (queue length), maximum queue
1047 * size (limit), and total number of packets sent using each TX queue
1048 * (count). This information is used for WMM to find out which TX
1049 * queues have room for more packets and by hostapd to provide
1050 * statistics about the current queueing state to external programs.
1052 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1053 * this is only used for IBSS mode debugging and, as such, is not a
1054 * required function. Must be atomic.
1056 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1057 * with other STAs in the IBSS. This is only used in IBSS mode. This
1058 * function is optional if the firmware/hardware takes full care of
1059 * TSF synchronization.
1061 * @beacon_update: Setup beacon data for IBSS beacons. Unlike access point,
1062 * IBSS uses a fixed beacon frame which is configured using this
1064 * If the driver returns success (0) from this callback, it owns
1065 * the skb. That means the driver is responsible to kfree_skb() it.
1066 * The control structure is not dynamically allocated. That means the
1067 * driver does not own the pointer and if it needs it somewhere
1068 * outside of the context of this function, it must copy it
1070 * This handler is required only for IBSS mode.
1072 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1073 * This is needed only for IBSS mode and the result of this function is
1074 * used to determine whether to reply to Probe Requests.
1076 * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic.
1078 * @ampdu_action: Perform a certain A-MPDU action
1079 * The RA/TID combination determines the destination and TID we want
1080 * the ampdu action to be performed for. The action is defined through
1081 * ieee80211_ampdu_mlme_action. Starting sequence number (@ssn)
1082 * is the first frame we expect to perform the action on.
1084 struct ieee80211_ops {
1085 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb,
1086 struct ieee80211_tx_control *control);
1087 int (*start)(struct ieee80211_hw *hw);
1088 void (*stop)(struct ieee80211_hw *hw);
1089 int (*add_interface)(struct ieee80211_hw *hw,
1090 struct ieee80211_if_init_conf *conf);
1091 void (*remove_interface)(struct ieee80211_hw *hw,
1092 struct ieee80211_if_init_conf *conf);
1093 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
1094 int (*config_interface)(struct ieee80211_hw *hw,
1095 struct ieee80211_vif *vif,
1096 struct ieee80211_if_conf *conf);
1097 void (*configure_filter)(struct ieee80211_hw *hw,
1098 unsigned int changed_flags,
1099 unsigned int *total_flags,
1100 int mc_count, struct dev_addr_list *mc_list);
1101 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
1102 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1103 const u8 *local_address, const u8 *address,
1104 struct ieee80211_key_conf *key);
1105 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
1106 int (*get_stats)(struct ieee80211_hw *hw,
1107 struct ieee80211_low_level_stats *stats);
1108 void (*get_tkip_seq)(struct ieee80211_hw *hw, u8 hw_key_idx,
1109 u32 *iv32, u16 *iv16);
1110 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1111 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
1112 int (*set_retry_limit)(struct ieee80211_hw *hw,
1113 u32 short_retry, u32 long_retr);
1114 void (*sta_notify)(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1115 enum sta_notify_cmd, const u8 *addr);
1116 void (*erp_ie_changed)(struct ieee80211_hw *hw, u8 changes,
1117 int cts_protection, int preamble);
1118 int (*conf_tx)(struct ieee80211_hw *hw, int queue,
1119 const struct ieee80211_tx_queue_params *params);
1120 int (*get_tx_stats)(struct ieee80211_hw *hw,
1121 struct ieee80211_tx_queue_stats *stats);
1122 u64 (*get_tsf)(struct ieee80211_hw *hw);
1123 void (*reset_tsf)(struct ieee80211_hw *hw);
1124 int (*beacon_update)(struct ieee80211_hw *hw,
1125 struct sk_buff *skb,
1126 struct ieee80211_tx_control *control);
1127 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1128 int (*conf_ht)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
1129 int (*ampdu_action)(struct ieee80211_hw *hw,
1130 enum ieee80211_ampdu_mlme_action action,
1131 const u8 *ra, u16 tid, u16 ssn);
1135 * ieee80211_alloc_hw - Allocate a new hardware device
1137 * This must be called once for each hardware device. The returned pointer
1138 * must be used to refer to this device when calling other functions.
1139 * mac80211 allocates a private data area for the driver pointed to by
1140 * @priv in &struct ieee80211_hw, the size of this area is given as
1143 * @priv_data_len: length of private data
1144 * @ops: callbacks for this device
1146 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1147 const struct ieee80211_ops *ops);
1150 * ieee80211_register_hw - Register hardware device
1152 * You must call this function before any other functions
1153 * except ieee80211_register_hwmode.
1155 * @hw: the device to register as returned by ieee80211_alloc_hw()
1157 int ieee80211_register_hw(struct ieee80211_hw *hw);
1159 #ifdef CONFIG_MAC80211_LEDS
1160 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1161 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1162 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1163 extern char *__ieee80211_get_radio_led_name(struct ieee80211_hw *hw);
1166 * ieee80211_get_tx_led_name - get name of TX LED
1168 * mac80211 creates a transmit LED trigger for each wireless hardware
1169 * that can be used to drive LEDs if your driver registers a LED device.
1170 * This function returns the name (or %NULL if not configured for LEDs)
1171 * of the trigger so you can automatically link the LED device.
1173 * @hw: the hardware to get the LED trigger name for
1175 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1177 #ifdef CONFIG_MAC80211_LEDS
1178 return __ieee80211_get_tx_led_name(hw);
1185 * ieee80211_get_rx_led_name - get name of RX LED
1187 * mac80211 creates a receive LED trigger for each wireless hardware
1188 * that can be used to drive LEDs if your driver registers a LED device.
1189 * This function returns the name (or %NULL if not configured for LEDs)
1190 * of the trigger so you can automatically link the LED device.
1192 * @hw: the hardware to get the LED trigger name for
1194 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1196 #ifdef CONFIG_MAC80211_LEDS
1197 return __ieee80211_get_rx_led_name(hw);
1204 * ieee80211_get_assoc_led_name - get name of association LED
1206 * mac80211 creates a association LED trigger for each wireless hardware
1207 * that can be used to drive LEDs if your driver registers a LED device.
1208 * This function returns the name (or %NULL if not configured for LEDs)
1209 * of the trigger so you can automatically link the LED device.
1211 * @hw: the hardware to get the LED trigger name for
1213 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1215 #ifdef CONFIG_MAC80211_LEDS
1216 return __ieee80211_get_assoc_led_name(hw);
1223 * ieee80211_get_radio_led_name - get name of radio LED
1225 * mac80211 creates a radio change LED trigger for each wireless hardware
1226 * that can be used to drive LEDs if your driver registers a LED device.
1227 * This function returns the name (or %NULL if not configured for LEDs)
1228 * of the trigger so you can automatically link the LED device.
1230 * @hw: the hardware to get the LED trigger name for
1232 static inline char *ieee80211_get_radio_led_name(struct ieee80211_hw *hw)
1234 #ifdef CONFIG_MAC80211_LEDS
1235 return __ieee80211_get_radio_led_name(hw);
1241 /* Register a new hardware PHYMODE capability to the stack. */
1242 int ieee80211_register_hwmode(struct ieee80211_hw *hw,
1243 struct ieee80211_hw_mode *mode);
1246 * ieee80211_unregister_hw - Unregister a hardware device
1248 * This function instructs mac80211 to free allocated resources
1249 * and unregister netdevices from the networking subsystem.
1251 * @hw: the hardware to unregister
1253 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1256 * ieee80211_free_hw - free hardware descriptor
1258 * This function frees everything that was allocated, including the
1259 * private data for the driver. You must call ieee80211_unregister_hw()
1260 * before calling this function
1262 * @hw: the hardware to free
1264 void ieee80211_free_hw(struct ieee80211_hw *hw);
1266 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1267 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1268 struct ieee80211_rx_status *status);
1271 * ieee80211_rx - receive frame
1273 * Use this function to hand received frames to mac80211. The receive
1274 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1275 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1277 * This function may not be called in IRQ context.
1279 * @hw: the hardware this frame came in on
1280 * @skb: the buffer to receive, owned by mac80211 after this call
1281 * @status: status of this frame; the status pointer need not be valid
1282 * after this function returns
1284 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1285 struct ieee80211_rx_status *status)
1287 __ieee80211_rx(hw, skb, status);
1291 * ieee80211_rx_irqsafe - receive frame
1293 * Like ieee80211_rx() but can be called in IRQ context
1294 * (internally defers to a workqueue.)
1296 * @hw: the hardware this frame came in on
1297 * @skb: the buffer to receive, owned by mac80211 after this call
1298 * @status: status of this frame; the status pointer need not be valid
1299 * after this function returns and is not freed by mac80211,
1300 * it is recommended that it points to a stack area
1302 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1303 struct sk_buff *skb,
1304 struct ieee80211_rx_status *status);
1307 * ieee80211_tx_status - transmit status callback
1309 * Call this function for all transmitted frames after they have been
1310 * transmitted. It is permissible to not call this function for
1311 * multicast frames but this can affect statistics.
1313 * @hw: the hardware the frame was transmitted by
1314 * @skb: the frame that was transmitted, owned by mac80211 after this call
1315 * @status: status information for this frame; the status pointer need not
1316 * be valid after this function returns and is not freed by mac80211,
1317 * it is recommended that it points to a stack area
1319 void ieee80211_tx_status(struct ieee80211_hw *hw,
1320 struct sk_buff *skb,
1321 struct ieee80211_tx_status *status);
1322 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1323 struct sk_buff *skb,
1324 struct ieee80211_tx_status *status);
1327 * ieee80211_beacon_get - beacon generation function
1328 * @hw: pointer obtained from ieee80211_alloc_hw().
1329 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1330 * @control: will be filled with information needed to send this beacon.
1332 * If the beacon frames are generated by the host system (i.e., not in
1333 * hardware/firmware), the low-level driver uses this function to receive
1334 * the next beacon frame from the 802.11 code. The low-level is responsible
1335 * for calling this function before beacon data is needed (e.g., based on
1336 * hardware interrupt). Returned skb is used only once and low-level driver
1337 * is responsible of freeing it.
1339 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1340 struct ieee80211_vif *vif,
1341 struct ieee80211_tx_control *control);
1344 * ieee80211_rts_get - RTS frame generation function
1345 * @hw: pointer obtained from ieee80211_alloc_hw().
1346 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1347 * @frame: pointer to the frame that is going to be protected by the RTS.
1348 * @frame_len: the frame length (in octets).
1349 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1350 * @rts: The buffer where to store the RTS frame.
1352 * If the RTS frames are generated by the host system (i.e., not in
1353 * hardware/firmware), the low-level driver uses this function to receive
1354 * the next RTS frame from the 802.11 code. The low-level is responsible
1355 * for calling this function before and RTS frame is needed.
1357 void ieee80211_rts_get(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1358 const void *frame, size_t frame_len,
1359 const struct ieee80211_tx_control *frame_txctl,
1360 struct ieee80211_rts *rts);
1363 * ieee80211_rts_duration - Get the duration field for an RTS frame
1364 * @hw: pointer obtained from ieee80211_alloc_hw().
1365 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1366 * @frame_len: the length of the frame that is going to be protected by the RTS.
1367 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1369 * If the RTS is generated in firmware, but the host system must provide
1370 * the duration field, the low-level driver uses this function to receive
1371 * the duration field value in little-endian byteorder.
1373 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw,
1374 struct ieee80211_vif *vif, size_t frame_len,
1375 const struct ieee80211_tx_control *frame_txctl);
1378 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1379 * @hw: pointer obtained from ieee80211_alloc_hw().
1380 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1381 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1382 * @frame_len: the frame length (in octets).
1383 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1384 * @cts: The buffer where to store the CTS-to-self frame.
1386 * If the CTS-to-self frames are generated by the host system (i.e., not in
1387 * hardware/firmware), the low-level driver uses this function to receive
1388 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1389 * for calling this function before and CTS-to-self frame is needed.
1391 void ieee80211_ctstoself_get(struct ieee80211_hw *hw,
1392 struct ieee80211_vif *vif,
1393 const void *frame, size_t frame_len,
1394 const struct ieee80211_tx_control *frame_txctl,
1395 struct ieee80211_cts *cts);
1398 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1399 * @hw: pointer obtained from ieee80211_alloc_hw().
1400 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1401 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1402 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1404 * If the CTS-to-self is generated in firmware, but the host system must provide
1405 * the duration field, the low-level driver uses this function to receive
1406 * the duration field value in little-endian byteorder.
1408 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw,
1409 struct ieee80211_vif *vif,
1411 const struct ieee80211_tx_control *frame_txctl);
1414 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1415 * @hw: pointer obtained from ieee80211_alloc_hw().
1416 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1417 * @frame_len: the length of the frame.
1418 * @rate: the rate (in 100kbps) at which the frame is going to be transmitted.
1420 * Calculate the duration field of some generic frame, given its
1421 * length and transmission rate (in 100kbps).
1423 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw,
1424 struct ieee80211_vif *vif,
1429 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1430 * @hw: pointer as obtained from ieee80211_alloc_hw().
1431 * @vif: &struct ieee80211_vif pointer from &struct ieee80211_if_init_conf.
1432 * @control: will be filled with information needed to send returned frame.
1434 * Function for accessing buffered broadcast and multicast frames. If
1435 * hardware/firmware does not implement buffering of broadcast/multicast
1436 * frames when power saving is used, 802.11 code buffers them in the host
1437 * memory. The low-level driver uses this function to fetch next buffered
1438 * frame. In most cases, this is used when generating beacon frame. This
1439 * function returns a pointer to the next buffered skb or NULL if no more
1440 * buffered frames are available.
1442 * Note: buffered frames are returned only after DTIM beacon frame was
1443 * generated with ieee80211_beacon_get() and the low-level driver must thus
1444 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1445 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1446 * does not need to check for DTIM beacons separately and should be able to
1447 * use common code for all beacons.
1450 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, struct ieee80211_vif *vif,
1451 struct ieee80211_tx_control *control);
1454 * ieee80211_get_hdrlen_from_skb - get header length from data
1456 * Given an skb with a raw 802.11 header at the data pointer this function
1457 * returns the 802.11 header length in bytes (not including encryption
1458 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1459 * header the function returns 0.
1463 int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1466 * ieee80211_get_hdrlen - get header length from frame control
1468 * This function returns the 802.11 header length in bytes (not including
1469 * encryption headers.)
1471 * @fc: the frame control field (in CPU endianness)
1473 int ieee80211_get_hdrlen(u16 fc);
1476 * ieee80211_wake_queue - wake specific queue
1477 * @hw: pointer as obtained from ieee80211_alloc_hw().
1478 * @queue: queue number (counted from zero).
1480 * Drivers should use this function instead of netif_wake_queue.
1482 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1485 * ieee80211_stop_queue - stop specific queue
1486 * @hw: pointer as obtained from ieee80211_alloc_hw().
1487 * @queue: queue number (counted from zero).
1489 * Drivers should use this function instead of netif_stop_queue.
1491 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1494 * ieee80211_start_queues - start all queues
1495 * @hw: pointer to as obtained from ieee80211_alloc_hw().
1497 * Drivers should use this function instead of netif_start_queue.
1499 void ieee80211_start_queues(struct ieee80211_hw *hw);
1502 * ieee80211_stop_queues - stop all queues
1503 * @hw: pointer as obtained from ieee80211_alloc_hw().
1505 * Drivers should use this function instead of netif_stop_queue.
1507 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1510 * ieee80211_wake_queues - wake all queues
1511 * @hw: pointer as obtained from ieee80211_alloc_hw().
1513 * Drivers should use this function instead of netif_wake_queue.
1515 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1518 * ieee80211_scan_completed - completed hardware scan
1520 * When hardware scan offload is used (i.e. the hw_scan() callback is
1521 * assigned) this function needs to be called by the driver to notify
1522 * mac80211 that the scan finished.
1524 * @hw: the hardware that finished the scan
1526 void ieee80211_scan_completed(struct ieee80211_hw *hw);
1529 * ieee80211_iterate_active_interfaces - iterate active interfaces
1531 * This function iterates over the interfaces associated with a given
1532 * hardware that are currently active and calls the callback for them.
1534 * @hw: the hardware struct of which the interfaces should be iterated over
1535 * @iterator: the iterator function to call, cannot sleep
1536 * @data: first argument of the iterator function
1538 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1539 void (*iterator)(void *data, u8 *mac,
1540 struct ieee80211_vif *vif),
1543 #endif /* MAC80211_H */