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 int tx_rate; /* Transmit rate, given as the hw specific value for the
284 * rate (from struct ieee80211_rate) */
285 int rts_cts_rate; /* Transmit rate for RTS/CTS frame, given as the hw
286 * specific value for the rate (from
287 * struct ieee80211_rate) */
289 #define IEEE80211_TXCTL_REQ_TX_STATUS (1<<0)/* request TX status callback for
291 #define IEEE80211_TXCTL_DO_NOT_ENCRYPT (1<<1) /* send this frame without
292 * encryption; e.g., for EAPOL
294 #define IEEE80211_TXCTL_USE_RTS_CTS (1<<2) /* use RTS-CTS before sending
296 #define IEEE80211_TXCTL_USE_CTS_PROTECT (1<<3) /* use CTS protection for the
297 * frame (e.g., for combined
298 * 802.11g / 802.11b networks) */
299 #define IEEE80211_TXCTL_NO_ACK (1<<4) /* tell the low level not to
301 #define IEEE80211_TXCTL_RATE_CTRL_PROBE (1<<5)
302 #define IEEE80211_TXCTL_CLEAR_DST_MASK (1<<6)
303 #define IEEE80211_TXCTL_REQUEUE (1<<7)
304 #define IEEE80211_TXCTL_FIRST_FRAGMENT (1<<8) /* this is a first fragment of
306 #define IEEE80211_TXCTL_LONG_RETRY_LIMIT (1<<10) /* this frame should be send
308 * set_retry_limit configured
309 * long retry value */
310 #define IEEE80211_TXCTL_EAPOL_FRAME (1<<11) /* internal to mac80211 */
311 u32 flags; /* tx control flags defined
313 u8 key_idx; /* keyidx from hw->set_key(), undefined if
314 * IEEE80211_TXCTL_DO_NOT_ENCRYPT is set */
315 u8 retry_limit; /* 1 = only first attempt, 2 = one retry, ..
316 * This could be used when set_retry_limit
317 * is not implemented by the driver */
318 u8 power_level; /* per-packet transmit power level, in dBm */
319 u8 antenna_sel_tx; /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */
320 u8 icv_len; /* length of the ICV/MIC field in octets */
321 u8 iv_len; /* length of the IV field in octets */
322 u8 queue; /* hardware queue to use for this frame;
323 * 0 = highest, hw->queues-1 = lowest */
324 struct ieee80211_rate *rate; /* internal 80211.o rate */
325 struct ieee80211_rate *rts_rate; /* internal 80211.o rate
327 int alt_retry_rate; /* retry rate for the last retries, given as the
328 * hw specific value for the rate (from
329 * struct ieee80211_rate). To be used to limit
330 * packet dropping when probing higher rates, if hw
331 * supports multiple retry rates. -1 = not used */
332 int type; /* internal */
333 int ifindex; /* internal */
338 * enum mac80211_rx_flags - receive flags
340 * These flags are used with the @flag member of &struct ieee80211_rx_status.
341 * @RX_FLAG_MMIC_ERROR: Michael MIC error was reported on this frame.
342 * Use together with %RX_FLAG_MMIC_STRIPPED.
343 * @RX_FLAG_DECRYPTED: This frame was decrypted in hardware.
344 * @RX_FLAG_RADIOTAP: This frame starts with a radiotap header.
345 * @RX_FLAG_MMIC_STRIPPED: the Michael MIC is stripped off this frame,
346 * verification has been done by the hardware.
347 * @RX_FLAG_IV_STRIPPED: The IV/ICV are stripped from this frame.
348 * If this flag is set, the stack cannot do any replay detection
349 * hence the driver or hardware will have to do that.
350 * @RX_FLAG_FAILED_FCS_CRC: Set this flag if the FCS check failed on
352 * @RX_FLAG_FAILED_PLCP_CRC: Set this flag if the PCLP check failed on
354 * @RX_FLAG_TSFT: The timestamp passed in the RX status (@mactime field)
357 enum mac80211_rx_flags {
358 RX_FLAG_MMIC_ERROR = 1<<0,
359 RX_FLAG_DECRYPTED = 1<<1,
360 RX_FLAG_RADIOTAP = 1<<2,
361 RX_FLAG_MMIC_STRIPPED = 1<<3,
362 RX_FLAG_IV_STRIPPED = 1<<4,
363 RX_FLAG_FAILED_FCS_CRC = 1<<5,
364 RX_FLAG_FAILED_PLCP_CRC = 1<<6,
369 * struct ieee80211_rx_status - receive status
371 * The low-level driver should provide this information (the subset
372 * supported by hardware) to the 802.11 code with each received
374 * @mactime: MAC timestamp as defined by 802.11
375 * @freq: frequency the radio was tuned to when receiving this frame, in MHz
376 * @channel: channel the radio was tuned to
377 * @phymode: active PHY mode
378 * @ssi: signal strength when receiving this frame
379 * @signal: used as 'qual' in statistics reporting
380 * @noise: PHY noise when receiving this frame
381 * @antenna: antenna used
385 struct ieee80211_rx_status {
389 enum ieee80211_phymode phymode;
399 * enum ieee80211_tx_status_flags - transmit status flags
401 * Status flags to indicate various transmit conditions.
403 * @IEEE80211_TX_STATUS_TX_FILTERED: The frame was not transmitted
404 * because the destination STA was in powersave mode.
406 * @IEEE80211_TX_STATUS_ACK: Frame was acknowledged
408 enum ieee80211_tx_status_flags {
409 IEEE80211_TX_STATUS_TX_FILTERED = 1<<0,
410 IEEE80211_TX_STATUS_ACK = 1<<1,
414 * struct ieee80211_tx_status - transmit status
416 * As much information as possible should be provided for each transmitted
417 * frame with ieee80211_tx_status().
419 * @control: a copy of the &struct ieee80211_tx_control passed to the driver
420 * in the tx() callback.
422 * @flags: transmit status flags, defined above
424 * @ack_signal: signal strength of the ACK frame
426 * @excessive_retries: set to 1 if the frame was retried many times
427 * but not acknowledged
429 * @retry_count: number of retries
431 * @queue_length: ?? REMOVE
432 * @queue_number: ?? REMOVE
434 struct ieee80211_tx_status {
435 struct ieee80211_tx_control control;
437 bool excessive_retries;
445 * enum ieee80211_conf_flags - configuration flags
447 * Flags to define PHY configuration options
449 * @IEEE80211_CONF_SHORT_SLOT_TIME: use 802.11g short slot time
450 * @IEEE80211_CONF_RADIOTAP: add radiotap header at receive time (if supported)
451 * @IEEE80211_CONF_SUPPORT_HT_MODE: use 802.11n HT capabilities (if supported)
453 enum ieee80211_conf_flags {
454 IEEE80211_CONF_SHORT_SLOT_TIME = (1<<0),
455 IEEE80211_CONF_RADIOTAP = (1<<1),
456 IEEE80211_CONF_SUPPORT_HT_MODE = (1<<2),
460 * struct ieee80211_conf - configuration of the device
462 * This struct indicates how the driver shall configure the hardware.
464 * @radio_enabled: when zero, driver is required to switch off the radio.
466 * @channel: IEEE 802.11 channel number
467 * @freq: frequency in MHz
468 * @channel_val: hardware specific channel value for the channel
469 * @phymode: PHY mode to activate (REMOVE)
470 * @chan: channel to switch to, pointer to the channel information
471 * @mode: pointer to mode definition
472 * @regulatory_domain: ??
473 * @beacon_int: beacon interval (TODO make interface config)
474 * @flags: configuration flags defined above
475 * @power_level: transmit power limit for current regulatory domain in dBm
476 * @antenna_max: maximum antenna gain
477 * @antenna_sel_tx: transmit antenna selection, 0: default/diversity,
479 * @antenna_sel_rx: receive antenna selection, like @antenna_sel_tx
480 * @ht_conf: describes current self configuration of 802.11n HT capabilies
481 * @ht_bss_conf: describes current BSS configuration of 802.11n HT parameters
483 struct ieee80211_conf {
484 int channel; /* IEEE 802.11 channel number */
486 int channel_val; /* hw specific value for the channel */
488 enum ieee80211_phymode phymode;
489 struct ieee80211_channel *chan;
490 struct ieee80211_hw_mode *mode;
491 unsigned int regulatory_domain;
501 struct ieee80211_ht_info ht_conf;
502 struct ieee80211_ht_bss_info ht_bss_conf;
506 * enum ieee80211_if_types - types of 802.11 network interfaces
508 * @IEEE80211_IF_TYPE_INVALID: invalid interface type, not used
510 * @IEEE80211_IF_TYPE_AP: interface in AP mode.
511 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap
512 * daemon. Drivers should never see this type.
513 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode.
514 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode.
515 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode.
516 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode.
517 * @IEEE80211_IF_TYPE_VLAN: VLAN interface bound to an AP, drivers
518 * will never see this type.
520 enum ieee80211_if_types {
521 IEEE80211_IF_TYPE_INVALID,
522 IEEE80211_IF_TYPE_AP,
523 IEEE80211_IF_TYPE_STA,
524 IEEE80211_IF_TYPE_IBSS,
525 IEEE80211_IF_TYPE_MNTR,
526 IEEE80211_IF_TYPE_WDS,
527 IEEE80211_IF_TYPE_VLAN,
531 * struct ieee80211_if_init_conf - initial configuration of an interface
533 * @if_id: internal interface ID. This number has no particular meaning to
534 * drivers and the only allowed usage is to pass it to
535 * ieee80211_beacon_get() and ieee80211_get_buffered_bc() functions.
536 * This field is not valid for monitor interfaces
537 * (interfaces of %IEEE80211_IF_TYPE_MNTR type).
538 * @type: one of &enum ieee80211_if_types constants. Determines the type of
539 * added/removed interface.
540 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
541 * until the interface is removed (i.e. it cannot be used after
542 * remove_interface() callback was called for this interface).
544 * This structure is used in add_interface() and remove_interface()
545 * callbacks of &struct ieee80211_hw.
547 * When you allow multiple interfaces to be added to your PHY, take care
548 * that the hardware can actually handle multiple MAC addresses. However,
549 * also take care that when there's no interface left with mac_addr != %NULL
550 * you remove the MAC address from the device to avoid acknowledging packets
551 * in pure monitor mode.
553 struct ieee80211_if_init_conf {
555 enum ieee80211_if_types type;
560 * struct ieee80211_if_conf - configuration of an interface
562 * @type: type of the interface. This is always the same as was specified in
563 * &struct ieee80211_if_init_conf. The type of an interface never changes
564 * during the life of the interface; this field is present only for
566 * @bssid: BSSID of the network we are associated to/creating.
567 * @ssid: used (together with @ssid_len) by drivers for hardware that
568 * generate beacons independently. The pointer is valid only during the
569 * config_interface() call, so copy the value somewhere if you need
571 * @ssid_len: length of the @ssid field.
572 * @beacon: beacon template. Valid only if @host_gen_beacon_template in
573 * &struct ieee80211_hw is set. The driver is responsible of freeing
575 * @beacon_control: tx_control for the beacon template, this field is only
576 * valid when the @beacon field was set.
578 * This structure is passed to the config_interface() callback of
579 * &struct ieee80211_hw.
581 struct ieee80211_if_conf {
586 struct sk_buff *beacon;
587 struct ieee80211_tx_control *beacon_control;
591 * enum ieee80211_key_alg - key algorithm
592 * @ALG_WEP: WEP40 or WEP104
594 * @ALG_CCMP: CCMP (AES)
596 enum ieee80211_key_alg {
604 * enum ieee80211_key_flags - key flags
606 * These flags are used for communication about keys between the driver
607 * and mac80211, with the @flags parameter of &struct ieee80211_key_conf.
609 * @IEEE80211_KEY_FLAG_WMM_STA: Set by mac80211, this flag indicates
610 * that the STA this key will be used with could be using QoS.
611 * @IEEE80211_KEY_FLAG_GENERATE_IV: This flag should be set by the
612 * driver to indicate that it requires IV generation for this
614 * @IEEE80211_KEY_FLAG_GENERATE_MMIC: This flag should be set by
615 * the driver for a TKIP key if it requires Michael MIC
616 * generation in software.
618 enum ieee80211_key_flags {
619 IEEE80211_KEY_FLAG_WMM_STA = 1<<0,
620 IEEE80211_KEY_FLAG_GENERATE_IV = 1<<1,
621 IEEE80211_KEY_FLAG_GENERATE_MMIC= 1<<2,
625 * struct ieee80211_key_conf - key information
627 * This key information is given by mac80211 to the driver by
628 * the set_key() callback in &struct ieee80211_ops.
630 * @hw_key_idx: To be set by the driver, this is the key index the driver
631 * wants to be given when a frame is transmitted and needs to be
632 * encrypted in hardware.
633 * @alg: The key algorithm.
634 * @flags: key flags, see &enum ieee80211_key_flags.
635 * @keyidx: the key index (0-3)
636 * @keylen: key material length
639 struct ieee80211_key_conf {
640 enum ieee80211_key_alg alg;
648 #define IEEE80211_SEQ_COUNTER_RX 0
649 #define IEEE80211_SEQ_COUNTER_TX 1
652 * enum set_key_cmd - key command
654 * Used with the set_key() callback in &struct ieee80211_ops, this
655 * indicates whether a key is being removed or added.
657 * @SET_KEY: a key is set
658 * @DISABLE_KEY: a key must be disabled
661 SET_KEY, DISABLE_KEY,
665 * enum sta_notify_cmd - sta notify command
667 * Used with the sta_notify() callback in &struct ieee80211_ops, this
668 * indicates addition and removal of a station to station table
670 * @STA_NOTIFY_ADD: a station was added to the station table
671 * @STA_NOTIFY_REMOVE: a station being removed from the station table
673 enum sta_notify_cmd {
674 STA_NOTIFY_ADD, STA_NOTIFY_REMOVE
678 * enum ieee80211_hw_flags - hardware flags
680 * These flags are used to indicate hardware capabilities to
681 * the stack. Generally, flags here should have their meaning
682 * done in a way that the simplest hardware doesn't need setting
683 * any particular flags. There are some exceptions to this rule,
684 * however, so you are advised to review these flags carefully.
686 * @IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE:
687 * The device only needs to be supplied with a beacon template.
688 * If you need the host to generate each beacon then don't use
689 * this flag and call ieee80211_beacon_get() when you need the
690 * next beacon frame. Note that if you set this flag, you must
691 * implement the set_tim() callback for powersave mode to work
693 * This flag is only relevant for access-point mode.
695 * @IEEE80211_HW_RX_INCLUDES_FCS:
696 * Indicates that received frames passed to the stack include
697 * the FCS at the end.
699 * @IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING:
700 * Some wireless LAN chipsets buffer broadcast/multicast frames
701 * for power saving stations in the hardware/firmware and others
702 * rely on the host system for such buffering. This option is used
703 * to configure the IEEE 802.11 upper layer to buffer broadcast and
704 * multicast frames when there are power saving stations so that
705 * the driver can fetch them with ieee80211_get_buffered_bc(). Note
706 * that not setting this flag works properly only when the
707 * %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is also not set because
708 * otherwise the stack will not know when the DTIM beacon was sent.
710 * @IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED:
711 * Channels are already configured to the default regulatory domain
712 * specified in the device's EEPROM
714 enum ieee80211_hw_flags {
715 IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE = 1<<0,
716 IEEE80211_HW_RX_INCLUDES_FCS = 1<<1,
717 IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING = 1<<2,
718 IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED = 1<<3,
722 * struct ieee80211_hw - hardware information and state
724 * This structure contains the configuration and hardware
725 * information for an 802.11 PHY.
727 * @wiphy: This points to the &struct wiphy allocated for this
728 * 802.11 PHY. You must fill in the @perm_addr and @dev
729 * members of this structure using SET_IEEE80211_DEV()
730 * and SET_IEEE80211_PERM_ADDR().
732 * @conf: &struct ieee80211_conf, device configuration, don't use.
734 * @workqueue: single threaded workqueue available for driver use,
735 * allocated by mac80211 on registration and flushed on
738 * @priv: pointer to private area that was allocated for driver use
739 * along with this structure.
741 * @flags: hardware flags, see &enum ieee80211_hw_flags.
743 * @extra_tx_headroom: headroom to reserve in each transmit skb
744 * for use by the driver (e.g. for transmit headers.)
746 * @channel_change_time: time (in microseconds) it takes to change channels.
748 * @max_rssi: Maximum value for ssi in RX information, use
749 * negative numbers for dBm and 0 to indicate no support.
751 * @max_signal: like @max_rssi, but for the signal value.
753 * @max_noise: like @max_rssi, but for the noise value.
755 * @queues: number of available hardware transmit queues for
756 * data packets. WMM/QoS requires at least four.
758 * @rate_control_algorithm: rate control algorithm for this hardware.
759 * If unset (NULL), the default algorithm will be used. Must be
760 * set before calling ieee80211_register_hw().
762 struct ieee80211_hw {
763 struct ieee80211_conf conf;
765 struct workqueue_struct *workqueue;
766 const char *rate_control_algorithm;
769 unsigned int extra_tx_headroom;
770 int channel_change_time;
778 * SET_IEEE80211_DEV - set device for 802.11 hardware
780 * @hw: the &struct ieee80211_hw to set the device for
781 * @dev: the &struct device of this 802.11 device
783 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
785 set_wiphy_dev(hw->wiphy, dev);
789 * SET_IEEE80211_PERM_ADDR - set the permanenet MAC address for 802.11 hardware
791 * @hw: the &struct ieee80211_hw to set the MAC address for
792 * @addr: the address to set
794 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
796 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
800 * DOC: Hardware crypto acceleration
802 * mac80211 is capable of taking advantage of many hardware
803 * acceleration designs for encryption and decryption operations.
805 * The set_key() callback in the &struct ieee80211_ops for a given
806 * device is called to enable hardware acceleration of encryption and
807 * decryption. The callback takes an @address parameter that will be
808 * the broadcast address for default keys, the other station's hardware
809 * address for individual keys or the zero address for keys that will
810 * be used only for transmission.
811 * Multiple transmission keys with the same key index may be used when
812 * VLANs are configured for an access point.
814 * The @local_address parameter will always be set to our own address,
815 * this is only relevant if you support multiple local addresses.
817 * When transmitting, the TX control data will use the @hw_key_idx
818 * selected by the driver by modifying the &struct ieee80211_key_conf
819 * pointed to by the @key parameter to the set_key() function.
821 * The set_key() call for the %SET_KEY command should return 0 if
822 * the key is now in use, -%EOPNOTSUPP or -%ENOSPC if it couldn't be
823 * added; if you return 0 then hw_key_idx must be assigned to the
824 * hardware key index, you are free to use the full u8 range.
826 * When the cmd is %DISABLE_KEY then it must succeed.
828 * Note that it is permissible to not decrypt a frame even if a key
829 * for it has been uploaded to hardware, the stack will not make any
830 * decision based on whether a key has been uploaded or not but rather
831 * based on the receive flags.
833 * The &struct ieee80211_key_conf structure pointed to by the @key
834 * parameter is guaranteed to be valid until another call to set_key()
835 * removes it, but it can only be used as a cookie to differentiate
840 * DOC: Frame filtering
842 * mac80211 requires to see many management frames for proper
843 * operation, and users may want to see many more frames when
844 * in monitor mode. However, for best CPU usage and power consumption,
845 * having as few frames as possible percolate through the stack is
846 * desirable. Hence, the hardware should filter as much as possible.
848 * To achieve this, mac80211 uses filter flags (see below) to tell
849 * the driver's configure_filter() function which frames should be
850 * passed to mac80211 and which should be filtered out.
852 * The configure_filter() callback is invoked with the parameters
853 * @mc_count and @mc_list for the combined multicast address list
854 * of all virtual interfaces, @changed_flags telling which flags
855 * were changed and @total_flags with the new flag states.
857 * If your device has no multicast address filters your driver will
858 * need to check both the %FIF_ALLMULTI flag and the @mc_count
859 * parameter to see whether multicast frames should be accepted
862 * All unsupported flags in @total_flags must be cleared, i.e. you
863 * should clear all bits except those you honoured.
867 * enum ieee80211_filter_flags - hardware filter flags
869 * These flags determine what the filter in hardware should be
870 * programmed to let through and what should not be passed to the
871 * stack. It is always safe to pass more frames than requested,
872 * but this has negative impact on power consumption.
874 * @FIF_PROMISC_IN_BSS: promiscuous mode within your BSS,
875 * think of the BSS as your network segment and then this corresponds
876 * to the regular ethernet device promiscuous mode.
878 * @FIF_ALLMULTI: pass all multicast frames, this is used if requested
879 * by the user or if the hardware is not capable of filtering by
882 * @FIF_FCSFAIL: pass frames with failed FCS (but you need to set the
883 * %RX_FLAG_FAILED_FCS_CRC for them)
885 * @FIF_PLCPFAIL: pass frames with failed PLCP CRC (but you need to set
886 * the %RX_FLAG_FAILED_PLCP_CRC for them
888 * @FIF_BCN_PRBRESP_PROMISC: This flag is set during scanning to indicate
889 * to the hardware that it should not filter beacons or probe responses
890 * by BSSID. Filtering them can greatly reduce the amount of processing
891 * mac80211 needs to do and the amount of CPU wakeups, so you should
892 * honour this flag if possible.
894 * @FIF_CONTROL: pass control frames, if PROMISC_IN_BSS is not set then
895 * only those addressed to this station
897 * @FIF_OTHER_BSS: pass frames destined to other BSSes
899 enum ieee80211_filter_flags {
900 FIF_PROMISC_IN_BSS = 1<<0,
904 FIF_BCN_PRBRESP_PROMISC = 1<<4,
906 FIF_OTHER_BSS = 1<<6,
910 * enum ieee80211_erp_change_flags - erp change flags
912 * These flags are used with the erp_ie_changed() callback in
913 * &struct ieee80211_ops to indicate which parameter(s) changed.
914 * @IEEE80211_ERP_CHANGE_PROTECTION: protection changed
915 * @IEEE80211_ERP_CHANGE_PREAMBLE: barker preamble mode changed
917 enum ieee80211_erp_change_flags {
918 IEEE80211_ERP_CHANGE_PROTECTION = 1<<0,
919 IEEE80211_ERP_CHANGE_PREAMBLE = 1<<1,
924 * struct ieee80211_ops - callbacks from mac80211 to the driver
926 * This structure contains various callbacks that the driver may
927 * handle or, in some cases, must handle, for example to configure
928 * the hardware to a new channel or to transmit a frame.
930 * @tx: Handler that 802.11 module calls for each transmitted frame.
931 * skb contains the buffer starting from the IEEE 802.11 header.
932 * The low-level driver should send the frame out based on
933 * configuration in the TX control data. Must be implemented and
936 * @start: Called before the first netdevice attached to the hardware
937 * is enabled. This should turn on the hardware and must turn on
938 * frame reception (for possibly enabled monitor interfaces.)
939 * Returns negative error codes, these may be seen in userspace,
941 * When the device is started it should not have a MAC address
942 * to avoid acknowledging frames before a non-monitor device
944 * Must be implemented.
946 * @stop: Called after last netdevice attached to the hardware
947 * is disabled. This should turn off the hardware (at least
948 * it must turn off frame reception.)
949 * May be called right after add_interface if that rejects
951 * Must be implemented.
953 * @add_interface: Called when a netdevice attached to the hardware is
954 * enabled. Because it is not called for monitor mode devices, @open
955 * and @stop must be implemented.
956 * The driver should perform any initialization it needs before
957 * the device can be enabled. The initial configuration for the
958 * interface is given in the conf parameter.
959 * The callback may refuse to add an interface by returning a
960 * negative error code (which will be seen in userspace.)
961 * Must be implemented.
963 * @remove_interface: Notifies a driver that an interface is going down.
964 * The @stop callback is called after this if it is the last interface
965 * and no monitor interfaces are present.
966 * When all interfaces are removed, the MAC address in the hardware
967 * must be cleared so the device no longer acknowledges packets,
968 * the mac_addr member of the conf structure is, however, set to the
969 * MAC address of the device going away.
970 * Hence, this callback must be implemented.
972 * @config: Handler for configuration requests. IEEE 802.11 code calls this
973 * function to change hardware configuration, e.g., channel.
975 * @config_interface: Handler for configuration requests related to interfaces
976 * (e.g. BSSID changes.)
978 * @configure_filter: Configure the device's RX filter.
979 * See the section "Frame filtering" for more information.
980 * This callback must be implemented and atomic.
982 * @set_tim: Set TIM bit. If the hardware/firmware takes care of beacon
983 * generation (that is, %IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE is set)
984 * mac80211 calls this function when a TIM bit must be set or cleared
985 * for a given AID. Must be atomic.
987 * @set_key: See the section "Hardware crypto acceleration"
988 * This callback can sleep, and is only called between add_interface
989 * and remove_interface calls, i.e. while the interface with the
990 * given local_address is enabled.
992 * @hw_scan: Ask the hardware to service the scan request, no need to start
993 * the scan state machine in stack.
995 * @get_stats: return low-level statistics
997 * @get_sequence_counter: For devices that have internal sequence counters this
998 * callback allows mac80211 to access the current value of a counter.
999 * This callback seems not well-defined, tell us if you need it.
1001 * @set_rts_threshold: Configuration of RTS threshold (if device needs it)
1003 * @set_frag_threshold: Configuration of fragmentation threshold. Assign this if
1004 * the device does fragmentation by itself; if this method is assigned then
1005 * the stack will not do fragmentation.
1007 * @set_retry_limit: Configuration of retry limits (if device needs it)
1009 * @sta_notify: Notifies low level driver about addition or removal
1010 * of assocaited station or AP.
1012 * @erp_ie_changed: Handle ERP IE change notifications. Must be atomic.
1014 * @conf_tx: Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
1015 * bursting) for a hardware TX queue. The @queue parameter uses the
1016 * %IEEE80211_TX_QUEUE_* constants. Must be atomic.
1018 * @get_tx_stats: Get statistics of the current TX queue status. This is used
1019 * to get number of currently queued packets (queue length), maximum queue
1020 * size (limit), and total number of packets sent using each TX queue
1021 * (count). This information is used for WMM to find out which TX
1022 * queues have room for more packets and by hostapd to provide
1023 * statistics about the current queueing state to external programs.
1025 * @get_tsf: Get the current TSF timer value from firmware/hardware. Currently,
1026 * this is only used for IBSS mode debugging and, as such, is not a
1027 * required function. Must be atomic.
1029 * @reset_tsf: Reset the TSF timer and allow firmware/hardware to synchronize
1030 * with other STAs in the IBSS. This is only used in IBSS mode. This
1031 * function is optional if the firmware/hardware takes full care of
1032 * TSF synchronization.
1034 * @beacon_update: Setup beacon data for IBSS beacons. Unlike access point,
1035 * IBSS uses a fixed beacon frame which is configured using this
1037 * If the driver returns success (0) from this callback, it owns
1038 * the skb. That means the driver is responsible to kfree_skb() it.
1039 * The control structure is not dynamically allocated. That means the
1040 * driver does not own the pointer and if it needs it somewhere
1041 * outside of the context of this function, it must copy it
1043 * This handler is required only for IBSS mode.
1045 * @tx_last_beacon: Determine whether the last IBSS beacon was sent by us.
1046 * This is needed only for IBSS mode and the result of this function is
1047 * used to determine whether to reply to Probe Requests.
1049 * @conf_ht: Configures low level driver with 802.11n HT data. Must be atomic.
1051 struct ieee80211_ops {
1052 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb,
1053 struct ieee80211_tx_control *control);
1054 int (*start)(struct ieee80211_hw *hw);
1055 void (*stop)(struct ieee80211_hw *hw);
1056 int (*add_interface)(struct ieee80211_hw *hw,
1057 struct ieee80211_if_init_conf *conf);
1058 void (*remove_interface)(struct ieee80211_hw *hw,
1059 struct ieee80211_if_init_conf *conf);
1060 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
1061 int (*config_interface)(struct ieee80211_hw *hw,
1062 int if_id, struct ieee80211_if_conf *conf);
1063 void (*configure_filter)(struct ieee80211_hw *hw,
1064 unsigned int changed_flags,
1065 unsigned int *total_flags,
1066 int mc_count, struct dev_addr_list *mc_list);
1067 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
1068 int (*set_key)(struct ieee80211_hw *hw, enum set_key_cmd cmd,
1069 const u8 *local_address, const u8 *address,
1070 struct ieee80211_key_conf *key);
1071 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
1072 int (*get_stats)(struct ieee80211_hw *hw,
1073 struct ieee80211_low_level_stats *stats);
1074 int (*get_sequence_counter)(struct ieee80211_hw *hw,
1075 u8* addr, u8 keyidx, u8 txrx,
1076 u32* iv32, u16* iv16);
1077 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
1078 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
1079 int (*set_retry_limit)(struct ieee80211_hw *hw,
1080 u32 short_retry, u32 long_retr);
1081 void (*sta_notify)(struct ieee80211_hw *hw, int if_id,
1082 enum sta_notify_cmd, const u8 *addr);
1083 void (*erp_ie_changed)(struct ieee80211_hw *hw, u8 changes,
1084 int cts_protection, int preamble);
1085 int (*conf_tx)(struct ieee80211_hw *hw, int queue,
1086 const struct ieee80211_tx_queue_params *params);
1087 int (*get_tx_stats)(struct ieee80211_hw *hw,
1088 struct ieee80211_tx_queue_stats *stats);
1089 u64 (*get_tsf)(struct ieee80211_hw *hw);
1090 void (*reset_tsf)(struct ieee80211_hw *hw);
1091 int (*beacon_update)(struct ieee80211_hw *hw,
1092 struct sk_buff *skb,
1093 struct ieee80211_tx_control *control);
1094 int (*tx_last_beacon)(struct ieee80211_hw *hw);
1095 int (*conf_ht)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
1099 * ieee80211_alloc_hw - Allocate a new hardware device
1101 * This must be called once for each hardware device. The returned pointer
1102 * must be used to refer to this device when calling other functions.
1103 * mac80211 allocates a private data area for the driver pointed to by
1104 * @priv in &struct ieee80211_hw, the size of this area is given as
1107 * @priv_data_len: length of private data
1108 * @ops: callbacks for this device
1110 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
1111 const struct ieee80211_ops *ops);
1114 * ieee80211_register_hw - Register hardware device
1116 * You must call this function before any other functions
1117 * except ieee80211_register_hwmode.
1119 * @hw: the device to register as returned by ieee80211_alloc_hw()
1121 int ieee80211_register_hw(struct ieee80211_hw *hw);
1123 #ifdef CONFIG_MAC80211_LEDS
1124 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
1125 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
1126 extern char *__ieee80211_get_assoc_led_name(struct ieee80211_hw *hw);
1129 * ieee80211_get_tx_led_name - get name of TX LED
1131 * mac80211 creates a transmit LED trigger for each wireless hardware
1132 * that can be used to drive LEDs if your driver registers a LED device.
1133 * This function returns the name (or %NULL if not configured for LEDs)
1134 * of the trigger so you can automatically link the LED device.
1136 * @hw: the hardware to get the LED trigger name for
1138 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
1140 #ifdef CONFIG_MAC80211_LEDS
1141 return __ieee80211_get_tx_led_name(hw);
1148 * ieee80211_get_rx_led_name - get name of RX LED
1150 * mac80211 creates a receive LED trigger for each wireless hardware
1151 * that can be used to drive LEDs if your driver registers a LED device.
1152 * This function returns the name (or %NULL if not configured for LEDs)
1153 * of the trigger so you can automatically link the LED device.
1155 * @hw: the hardware to get the LED trigger name for
1157 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
1159 #ifdef CONFIG_MAC80211_LEDS
1160 return __ieee80211_get_rx_led_name(hw);
1166 static inline char *ieee80211_get_assoc_led_name(struct ieee80211_hw *hw)
1168 #ifdef CONFIG_MAC80211_LEDS
1169 return __ieee80211_get_assoc_led_name(hw);
1176 /* Register a new hardware PHYMODE capability to the stack. */
1177 int ieee80211_register_hwmode(struct ieee80211_hw *hw,
1178 struct ieee80211_hw_mode *mode);
1181 * ieee80211_unregister_hw - Unregister a hardware device
1183 * This function instructs mac80211 to free allocated resources
1184 * and unregister netdevices from the networking subsystem.
1186 * @hw: the hardware to unregister
1188 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
1191 * ieee80211_free_hw - free hardware descriptor
1193 * This function frees everything that was allocated, including the
1194 * private data for the driver. You must call ieee80211_unregister_hw()
1195 * before calling this function
1197 * @hw: the hardware to free
1199 void ieee80211_free_hw(struct ieee80211_hw *hw);
1201 /* trick to avoid symbol clashes with the ieee80211 subsystem */
1202 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1203 struct ieee80211_rx_status *status);
1206 * ieee80211_rx - receive frame
1208 * Use this function to hand received frames to mac80211. The receive
1209 * buffer in @skb must start with an IEEE 802.11 header or a radiotap
1210 * header if %RX_FLAG_RADIOTAP is set in the @status flags.
1212 * This function may not be called in IRQ context.
1214 * @hw: the hardware this frame came in on
1215 * @skb: the buffer to receive, owned by mac80211 after this call
1216 * @status: status of this frame; the status pointer need not be valid
1217 * after this function returns
1219 static inline void ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
1220 struct ieee80211_rx_status *status)
1222 __ieee80211_rx(hw, skb, status);
1226 * ieee80211_rx_irqsafe - receive frame
1228 * Like ieee80211_rx() but can be called in IRQ context
1229 * (internally defers to a workqueue.)
1231 * @hw: the hardware this frame came in on
1232 * @skb: the buffer to receive, owned by mac80211 after this call
1233 * @status: status of this frame; the status pointer need not be valid
1234 * after this function returns and is not freed by mac80211,
1235 * it is recommended that it points to a stack area
1237 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
1238 struct sk_buff *skb,
1239 struct ieee80211_rx_status *status);
1242 * ieee80211_tx_status - transmit status callback
1244 * Call this function for all transmitted frames after they have been
1245 * transmitted. It is permissible to not call this function for
1246 * multicast frames but this can affect statistics.
1248 * @hw: the hardware the frame was transmitted by
1249 * @skb: the frame that was transmitted, owned by mac80211 after this call
1250 * @status: status information for this frame; the status pointer need not
1251 * be valid after this function returns and is not freed by mac80211,
1252 * it is recommended that it points to a stack area
1254 void ieee80211_tx_status(struct ieee80211_hw *hw,
1255 struct sk_buff *skb,
1256 struct ieee80211_tx_status *status);
1257 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
1258 struct sk_buff *skb,
1259 struct ieee80211_tx_status *status);
1262 * ieee80211_beacon_get - beacon generation function
1263 * @hw: pointer obtained from ieee80211_alloc_hw().
1264 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1265 * @control: will be filled with information needed to send this beacon.
1267 * If the beacon frames are generated by the host system (i.e., not in
1268 * hardware/firmware), the low-level driver uses this function to receive
1269 * the next beacon frame from the 802.11 code. The low-level is responsible
1270 * for calling this function before beacon data is needed (e.g., based on
1271 * hardware interrupt). Returned skb is used only once and low-level driver
1272 * is responsible of freeing it.
1274 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
1276 struct ieee80211_tx_control *control);
1279 * ieee80211_rts_get - RTS frame generation function
1280 * @hw: pointer obtained from ieee80211_alloc_hw().
1281 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1282 * @frame: pointer to the frame that is going to be protected by the RTS.
1283 * @frame_len: the frame length (in octets).
1284 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1285 * @rts: The buffer where to store the RTS frame.
1287 * If the RTS frames are generated by the host system (i.e., not in
1288 * hardware/firmware), the low-level driver uses this function to receive
1289 * the next RTS frame from the 802.11 code. The low-level is responsible
1290 * for calling this function before and RTS frame is needed.
1292 void ieee80211_rts_get(struct ieee80211_hw *hw, int if_id,
1293 const void *frame, size_t frame_len,
1294 const struct ieee80211_tx_control *frame_txctl,
1295 struct ieee80211_rts *rts);
1298 * ieee80211_rts_duration - Get the duration field for an RTS frame
1299 * @hw: pointer obtained from ieee80211_alloc_hw().
1300 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1301 * @frame_len: the length of the frame that is going to be protected by the RTS.
1302 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1304 * If the RTS is generated in firmware, but the host system must provide
1305 * the duration field, the low-level driver uses this function to receive
1306 * the duration field value in little-endian byteorder.
1308 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw, int if_id,
1310 const struct ieee80211_tx_control *frame_txctl);
1313 * ieee80211_ctstoself_get - CTS-to-self frame generation function
1314 * @hw: pointer obtained from ieee80211_alloc_hw().
1315 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1316 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
1317 * @frame_len: the frame length (in octets).
1318 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1319 * @cts: The buffer where to store the CTS-to-self frame.
1321 * If the CTS-to-self frames are generated by the host system (i.e., not in
1322 * hardware/firmware), the low-level driver uses this function to receive
1323 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
1324 * for calling this function before and CTS-to-self frame is needed.
1326 void ieee80211_ctstoself_get(struct ieee80211_hw *hw, int if_id,
1327 const void *frame, size_t frame_len,
1328 const struct ieee80211_tx_control *frame_txctl,
1329 struct ieee80211_cts *cts);
1332 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
1333 * @hw: pointer obtained from ieee80211_alloc_hw().
1334 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1335 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
1336 * @frame_txctl: &struct ieee80211_tx_control of the frame.
1338 * If the CTS-to-self is generated in firmware, but the host system must provide
1339 * the duration field, the low-level driver uses this function to receive
1340 * the duration field value in little-endian byteorder.
1342 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, int if_id,
1344 const struct ieee80211_tx_control *frame_txctl);
1347 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
1348 * @hw: pointer obtained from ieee80211_alloc_hw().
1349 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1350 * @frame_len: the length of the frame.
1351 * @rate: the rate (in 100kbps) at which the frame is going to be transmitted.
1353 * Calculate the duration field of some generic frame, given its
1354 * length and transmission rate (in 100kbps).
1356 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, int if_id,
1361 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
1362 * @hw: pointer as obtained from ieee80211_alloc_hw().
1363 * @if_id: interface ID from &struct ieee80211_if_init_conf.
1364 * @control: will be filled with information needed to send returned frame.
1366 * Function for accessing buffered broadcast and multicast frames. If
1367 * hardware/firmware does not implement buffering of broadcast/multicast
1368 * frames when power saving is used, 802.11 code buffers them in the host
1369 * memory. The low-level driver uses this function to fetch next buffered
1370 * frame. In most cases, this is used when generating beacon frame. This
1371 * function returns a pointer to the next buffered skb or NULL if no more
1372 * buffered frames are available.
1374 * Note: buffered frames are returned only after DTIM beacon frame was
1375 * generated with ieee80211_beacon_get() and the low-level driver must thus
1376 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
1377 * NULL if the previous generated beacon was not DTIM, so the low-level driver
1378 * does not need to check for DTIM beacons separately and should be able to
1379 * use common code for all beacons.
1382 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, int if_id,
1383 struct ieee80211_tx_control *control);
1386 * ieee80211_get_hdrlen_from_skb - get header length from data
1388 * Given an skb with a raw 802.11 header at the data pointer this function
1389 * returns the 802.11 header length in bytes (not including encryption
1390 * headers). If the data in the sk_buff is too short to contain a valid 802.11
1391 * header the function returns 0.
1395 int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
1398 * ieee80211_get_hdrlen - get header length from frame control
1400 * This function returns the 802.11 header length in bytes (not including
1401 * encryption headers.)
1403 * @fc: the frame control field (in CPU endianness)
1405 int ieee80211_get_hdrlen(u16 fc);
1408 * ieee80211_wake_queue - wake specific queue
1409 * @hw: pointer as obtained from ieee80211_alloc_hw().
1410 * @queue: queue number (counted from zero).
1412 * Drivers should use this function instead of netif_wake_queue.
1414 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1417 * ieee80211_stop_queue - stop specific queue
1418 * @hw: pointer as obtained from ieee80211_alloc_hw().
1419 * @queue: queue number (counted from zero).
1421 * Drivers should use this function instead of netif_stop_queue.
1423 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1426 * ieee80211_start_queues - start all queues
1427 * @hw: pointer to as obtained from ieee80211_alloc_hw().
1429 * Drivers should use this function instead of netif_start_queue.
1431 void ieee80211_start_queues(struct ieee80211_hw *hw);
1434 * ieee80211_stop_queues - stop all queues
1435 * @hw: pointer as obtained from ieee80211_alloc_hw().
1437 * Drivers should use this function instead of netif_stop_queue.
1439 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1442 * ieee80211_wake_queues - wake all queues
1443 * @hw: pointer as obtained from ieee80211_alloc_hw().
1445 * Drivers should use this function instead of netif_wake_queue.
1447 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1450 * ieee80211_scan_completed - completed hardware scan
1452 * When hardware scan offload is used (i.e. the hw_scan() callback is
1453 * assigned) this function needs to be called by the driver to notify
1454 * mac80211 that the scan finished.
1456 * @hw: the hardware that finished the scan
1458 void ieee80211_scan_completed(struct ieee80211_hw *hw);
1461 * ieee80211_iterate_active_interfaces - iterate active interfaces
1463 * This function iterates over the interfaces associated with a given
1464 * hardware that are currently active and calls the callback for them.
1466 * @hw: the hardware struct of which the interfaces should be iterated over
1467 * @iterator: the iterator function to call, cannot sleep
1468 * @data: first argument of the iterator function
1470 void ieee80211_iterate_active_interfaces(struct ieee80211_hw *hw,
1471 void (*iterator)(void *data, u8 *mac,
1475 #endif /* MAC80211_H */