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>
25 /* Note! Only ieee80211_tx_status_irqsafe() and ieee80211_rx_irqsafe() can be
26 * called in hardware interrupt context. The low-level driver must not call any
27 * other functions in hardware interrupt context. If there is a need for such
28 * call, the low-level driver should first ACK the interrupt and perform the
29 * IEEE 802.11 code call after this, e.g., from a scheduled tasklet (in
30 * software interrupt context).
34 * Frame format used when passing frame between low-level hardware drivers
35 * and IEEE 802.11 driver the same as used in the wireless media, i.e.,
36 * buffers start with IEEE 802.11 header and include the same octets that
39 * If hardware uses IEEE 802.3 headers (and perform 802.3 <-> 802.11
40 * conversion in firmware), upper layer 802.11 code needs to be changed to
43 * If the receive frame format is not the same as the real frame sent
44 * on the wireless media (e.g., due to padding etc.), upper layer 802.11 code
45 * could be updated to provide support for such format assuming this would
46 * optimize the performance, e.g., by removing need to re-allocation and
47 * copying of the data.
50 #define IEEE80211_CHAN_W_SCAN 0x00000001
51 #define IEEE80211_CHAN_W_ACTIVE_SCAN 0x00000002
52 #define IEEE80211_CHAN_W_IBSS 0x00000004
54 /* Channel information structure. Low-level driver is expected to fill in chan,
55 * freq, and val fields. Other fields will be filled in by 80211.o based on
56 * hostapd information and low-level driver does not need to use them. The
57 * limits for each channel will be provided in 'struct ieee80211_conf' when
58 * configuring the low-level driver with hw->config callback. If a device has
59 * a default regulatory domain, IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED
60 * can be set to let the driver configure all fields */
61 struct ieee80211_channel {
62 short chan; /* channel number (IEEE 802.11) */
63 short freq; /* frequency in MHz */
64 int val; /* hw specific value for the channel */
65 int flag; /* flag for hostapd use (IEEE80211_CHAN_*) */
66 unsigned char power_level;
67 unsigned char antenna_max;
70 #define IEEE80211_RATE_ERP 0x00000001
71 #define IEEE80211_RATE_BASIC 0x00000002
72 #define IEEE80211_RATE_PREAMBLE2 0x00000004
73 #define IEEE80211_RATE_SUPPORTED 0x00000010
74 #define IEEE80211_RATE_OFDM 0x00000020
75 #define IEEE80211_RATE_CCK 0x00000040
76 #define IEEE80211_RATE_MANDATORY 0x00000100
78 #define IEEE80211_RATE_CCK_2 (IEEE80211_RATE_CCK | IEEE80211_RATE_PREAMBLE2)
79 #define IEEE80211_RATE_MODULATION(f) \
80 (f & (IEEE80211_RATE_CCK | IEEE80211_RATE_OFDM))
82 /* Low-level driver should set PREAMBLE2, OFDM and CCK flags.
83 * BASIC, SUPPORTED, ERP, and MANDATORY flags are set in 80211.o based on the
85 struct ieee80211_rate {
86 int rate; /* rate in 100 kbps */
87 int val; /* hw specific value for the rate */
88 int flags; /* IEEE80211_RATE_ flags */
89 int val2; /* hw specific value for the rate when using short preamble
90 * (only when IEEE80211_RATE_PREAMBLE2 flag is set, i.e., for
91 * 2, 5.5, and 11 Mbps) */
92 signed char min_rssi_ack;
93 unsigned char min_rssi_ack_delta;
95 /* following fields are set by 80211.o and need not be filled by the
97 int rate_inv; /* inverse of the rate (LCM(all rates) / rate) for
98 * optimizing channel utilization estimates */
101 /* 802.11g is backwards-compatible with 802.11b, so a wlan card can
102 * actually be both in 11b and 11g modes at the same time. */
103 enum ieee80211_phymode {
104 MODE_IEEE80211A, /* IEEE 802.11a */
105 MODE_IEEE80211B, /* IEEE 802.11b only */
106 MODE_IEEE80211G, /* IEEE 802.11g (and 802.11b compatibility) */
112 struct ieee80211_hw_mode {
113 int mode; /* MODE_IEEE80211... */
114 int num_channels; /* Number of channels (below) */
115 struct ieee80211_channel *channels; /* Array of supported channels */
116 int num_rates; /* Number of rates (below) */
117 struct ieee80211_rate *rates; /* Array of supported rates */
119 struct list_head list; /* Internal, don't touch */
122 struct ieee80211_tx_queue_params {
123 int aifs; /* 0 .. 255; -1 = use default */
124 int cw_min; /* 2^n-1: 1, 3, 7, .. , 1023; 0 = use default */
125 int cw_max; /* 2^n-1: 1, 3, 7, .. , 1023; 0 = use default */
126 int burst_time; /* maximum burst time in 0.1 ms (i.e., 10 = 1 ms);
130 struct ieee80211_tx_queue_stats_data {
131 unsigned int len; /* num packets in queue */
132 unsigned int limit; /* queue len (soft) limit */
133 unsigned int count; /* total num frames sent */
137 IEEE80211_TX_QUEUE_DATA0,
138 IEEE80211_TX_QUEUE_DATA1,
139 IEEE80211_TX_QUEUE_DATA2,
140 IEEE80211_TX_QUEUE_DATA3,
141 IEEE80211_TX_QUEUE_DATA4,
142 IEEE80211_TX_QUEUE_SVP,
146 /* due to stupidity in the sub-ioctl userspace interface, the items in
147 * this struct need to have fixed values. As soon as it is removed, we can
148 * fix these entries. */
149 IEEE80211_TX_QUEUE_AFTER_BEACON = 6,
150 IEEE80211_TX_QUEUE_BEACON = 7
153 struct ieee80211_tx_queue_stats {
154 struct ieee80211_tx_queue_stats_data data[NUM_TX_DATA_QUEUES];
157 struct ieee80211_low_level_stats {
158 unsigned int dot11ACKFailureCount;
159 unsigned int dot11RTSFailureCount;
160 unsigned int dot11FCSErrorCount;
161 unsigned int dot11RTSSuccessCount;
164 /* Transmit control fields. This data structure is passed to low-level driver
165 * with each TX frame. The low-level driver is responsible for configuring
166 * the hardware to use given values (depending on what is supported). */
167 #define HW_KEY_IDX_INVALID -1
169 struct ieee80211_tx_control {
170 int tx_rate; /* Transmit rate, given as the hw specific value for the
171 * rate (from struct ieee80211_rate) */
172 int rts_cts_rate; /* Transmit rate for RTS/CTS frame, given as the hw
173 * specific value for the rate (from
174 * struct ieee80211_rate) */
176 #define IEEE80211_TXCTL_REQ_TX_STATUS (1<<0)/* request TX status callback for
178 #define IEEE80211_TXCTL_DO_NOT_ENCRYPT (1<<1) /* send this frame without
179 * encryption; e.g., for EAPOL
181 #define IEEE80211_TXCTL_USE_RTS_CTS (1<<2) /* use RTS-CTS before sending
183 #define IEEE80211_TXCTL_USE_CTS_PROTECT (1<<3) /* use CTS protection for the
184 * frame (e.g., for combined
185 * 802.11g / 802.11b networks) */
186 #define IEEE80211_TXCTL_NO_ACK (1<<4) /* tell the low level not to
188 #define IEEE80211_TXCTL_RATE_CTRL_PROBE (1<<5)
189 #define IEEE80211_TXCTL_CLEAR_DST_MASK (1<<6)
190 #define IEEE80211_TXCTL_REQUEUE (1<<7)
191 #define IEEE80211_TXCTL_FIRST_FRAGMENT (1<<8) /* this is a first fragment of
193 #define IEEE80211_TXCTL_TKIP_NEW_PHASE1_KEY (1<<9)
194 #define IEEE80211_TXCTL_LONG_RETRY_LIMIT (1<<10) /* this frame should be send
196 * set_retry_limit configured
197 * long retry value */
198 u32 flags; /* tx control flags defined
200 u8 retry_limit; /* 1 = only first attempt, 2 = one retry, ..
201 * This could be used when set_retry_limit
202 * is not implemented by the driver */
203 u8 power_level; /* per-packet transmit power level, in dBm */
204 u8 antenna_sel_tx; /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */
205 s8 key_idx; /* HW_KEY_IDX_INVALID = do not encrypt,
206 * other values: keyidx from hw->set_key() */
207 u8 icv_len; /* length of the ICV/MIC field in octets */
208 u8 iv_len; /* length of the IV field in octets */
209 u8 tkip_key[16]; /* generated phase2/phase1 key for hw TKIP */
210 u8 queue; /* hardware queue to use for this frame;
211 * 0 = highest, hw->queues-1 = lowest */
212 u8 sw_retry_attempt; /* number of times hw has tried to
213 * transmit frame (not incl. hw retries) */
215 struct ieee80211_rate *rate; /* internal 80211.o rate */
216 struct ieee80211_rate *rts_rate; /* internal 80211.o rate
218 int alt_retry_rate; /* retry rate for the last retries, given as the
219 * hw specific value for the rate (from
220 * struct ieee80211_rate). To be used to limit
221 * packet dropping when probing higher rates, if hw
222 * supports multiple retry rates. -1 = not used */
223 int type; /* internal */
224 int ifindex; /* internal */
227 /* Receive status. The low-level driver should provide this information
228 * (the subset supported by hardware) to the 802.11 code with each received
230 struct ieee80211_rx_status {
232 int freq; /* receive frequency in Mhz */
236 int signal; /* used as qual in statistics reporting */
240 #define RX_FLAG_MMIC_ERROR (1<<0)
241 #define RX_FLAG_DECRYPTED (1<<1)
242 #define RX_FLAG_RADIOTAP (1<<2)
246 /* Transmit status. The low-level driver should provide this information
247 * (the subset supported by hardware) to the 802.11 code for each transmit
249 struct ieee80211_tx_status {
250 /* copied ieee80211_tx_control structure */
251 struct ieee80211_tx_control control;
253 #define IEEE80211_TX_STATUS_TX_FILTERED (1<<0)
254 #define IEEE80211_TX_STATUS_ACK (1<<1) /* whether the TX frame was ACKed */
255 u32 flags; /* tx staus flags defined above */
257 int ack_signal; /* measured signal strength of the ACK frame */
258 int excessive_retries;
261 int queue_length; /* information about TX queue */
267 * struct ieee80211_conf - configuration of the device
269 * This struct indicates how the driver shall configure the hardware.
271 * @radio_enabled: when zero, driver is required to switch off the radio.
273 struct ieee80211_conf {
274 int channel; /* IEEE 802.11 channel number */
276 int channel_val; /* hw specific value for the channel */
278 int phymode; /* MODE_IEEE80211A, .. */
279 struct ieee80211_channel *chan;
280 struct ieee80211_hw_mode *mode;
281 unsigned int regulatory_domain;
286 #define IEEE80211_CONF_SHORT_SLOT_TIME (1<<0) /* use IEEE 802.11g Short Slot
288 #define IEEE80211_CONF_SSID_HIDDEN (1<<1) /* do not broadcast the ssid */
289 #define IEEE80211_CONF_RADIOTAP (1<<2) /* use radiotap if supported
290 check this bit at RX time */
291 u32 flags; /* configuration flags defined above */
293 u8 power_level; /* transmit power limit for current
294 * regulatory domain; in dBm */
295 u8 antenna_max; /* maximum antenna gain */
297 /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */
303 * enum ieee80211_if_types - types of 802.11 network interfaces
305 * @IEEE80211_IF_TYPE_AP: interface in AP mode.
306 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap
307 * daemon. Drivers should never see this type.
308 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode.
309 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode.
310 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode.
311 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode.
312 * @IEEE80211_IF_TYPE_VLAN: not used.
314 enum ieee80211_if_types {
315 IEEE80211_IF_TYPE_AP = 0x00000000,
316 IEEE80211_IF_TYPE_MGMT = 0x00000001,
317 IEEE80211_IF_TYPE_STA = 0x00000002,
318 IEEE80211_IF_TYPE_IBSS = 0x00000003,
319 IEEE80211_IF_TYPE_MNTR = 0x00000004,
320 IEEE80211_IF_TYPE_WDS = 0x5A580211,
321 IEEE80211_IF_TYPE_VLAN = 0x00080211,
325 * struct ieee80211_if_init_conf - initial configuration of an interface
327 * @if_id: internal interface ID. This number has no particular meaning to
328 * drivers and the only allowed usage is to pass it to
329 * ieee80211_beacon_get() and ieee80211_get_buffered_bc() functions.
330 * This field is not valid for monitor interfaces
331 * (interfaces of %IEEE80211_IF_TYPE_MNTR type).
332 * @type: one of &enum ieee80211_if_types constants. Determines the type of
333 * added/removed interface.
334 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
335 * until the interface is removed (i.e. it cannot be used after
336 * remove_interface() callback was called for this interface).
337 * This pointer will be %NULL for monitor interfaces, be careful.
339 * This structure is used in add_interface() and remove_interface()
340 * callbacks of &struct ieee80211_hw.
342 * When you allow multiple interfaces to be added to your PHY, take care
343 * that the hardware can actually handle multiple MAC addresses. However,
344 * also take care that when there's no interface left with mac_addr != %NULL
345 * you remove the MAC address from the device to avoid acknowledging packets
346 * in pure monitor mode.
348 struct ieee80211_if_init_conf {
355 * struct ieee80211_if_conf - configuration of an interface
357 * @type: type of the interface. This is always the same as was specified in
358 * &struct ieee80211_if_init_conf. The type of an interface never changes
359 * during the life of the interface; this field is present only for
361 * @bssid: BSSID of the network we are associated to/creating.
362 * @ssid: used (together with @ssid_len) by drivers for hardware that
363 * generate beacons independently. The pointer is valid only during the
364 * config_interface() call, so copy the value somewhere if you need
366 * @ssid_len: length of the @ssid field.
367 * @generic_elem: used (together with @generic_elem_len) by drivers for
368 * hardware that generate beacons independently. The pointer is valid
369 * only during the config_interface() call, so copy the value somewhere
371 * @generic_elem_len: length of the generic element.
372 * @beacon: beacon template. Valid only if @host_gen_beacon_template in
373 * &struct ieee80211_hw is set. The driver is responsible of freeing
375 * @beacon_control: tx_control for the beacon template, this field is only
376 * valid when the @beacon field was set.
378 * This structure is passed to the config_interface() callback of
379 * &struct ieee80211_hw.
381 struct ieee80211_if_conf {
387 size_t generic_elem_len;
388 struct sk_buff *beacon;
389 struct ieee80211_tx_control *beacon_control;
400 * This flag indiciates that the station this key is being
401 * configured for may use QoS. If your hardware cannot handle
402 * that situation it should reject that key.
404 #define IEEE80211_KEY_FLAG_WMM_STA (1<<0)
406 struct ieee80211_key_conf {
408 * To be set by the driver to the key index it would like to
409 * get in the ieee80211_tx_control.key_idx which defaults
410 * to HW_KEY_IDX_INVALID so that shouldn't be used.
414 /* key algorithm, ALG_NONE should never be seen by the driver */
415 ieee80211_key_alg alg;
417 /* key flags, see above */
423 /* length of key material */
426 /* the key material */
430 #define IEEE80211_SEQ_COUNTER_RX 0
431 #define IEEE80211_SEQ_COUNTER_TX 1
434 SET_KEY, DISABLE_KEY,
437 /* This is driver-visible part of the per-hw state the stack keeps. */
438 struct ieee80211_hw {
439 /* points to the cfg80211 wiphy for this piece. Note
440 * that you must fill in the perm_addr and dev fields
441 * of this structure, use the macros provided below. */
444 /* assigned by mac80211, don't write */
445 struct ieee80211_conf conf;
447 /* Single thread workqueue available for driver use
448 * Allocated by mac80211 on registration */
449 struct workqueue_struct *workqueue;
451 /* Pointer to the private area that was
452 * allocated with this struct for you. */
455 /* The rest is information about your hardware */
457 /* TODO: frame_type 802.11/802.3, sw_encryption requirements */
462 * The device only needs to be supplied with a beacon template.
463 * If you need the host to generate each beacon then don't use
464 * this flag and use ieee80211_beacon_get().
466 #define IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE (1<<1)
469 * Some devices handle decryption internally and do not
470 * indicate whether the frame was encrypted (unencrypted frames
471 * will be dropped by the hardware, unless specifically allowed
473 * It is permissible to not handle all encrypted frames and fall
474 * back to software encryption; however, if this flag is set
475 * unencrypted frames must be dropped unless the driver is told
476 * otherwise via the set_ieee8021x() callback.
478 #define IEEE80211_HW_DEVICE_HIDES_WEP (1<<2)
480 /* Whether RX frames passed to ieee80211_rx() include FCS in the end */
481 #define IEEE80211_HW_RX_INCLUDES_FCS (1<<3)
483 /* Some wireless LAN chipsets buffer broadcast/multicast frames for
484 * power saving stations in the hardware/firmware and others rely on
485 * the host system for such buffering. This option is used to
486 * configure the IEEE 802.11 upper layer to buffer broadcast/multicast
487 * frames when there are power saving stations so that low-level driver
488 * can fetch them with ieee80211_get_buffered_bc(). */
489 #define IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING (1<<4)
492 * This flag is only relevant if hardware encryption is used.
493 * If set, it has two meanings:
494 * 1) the IV and ICV are present in received frames that have
495 * been decrypted (unless IEEE80211_HW_DEVICE_HIDES_WEP is
497 * 2) on transmission, the IV should be generated in software.
499 * Please let us know if you *don't* use this flag, the stack would
500 * really like to be able to get the IV to keep key statistics
503 #define IEEE80211_HW_WEP_INCLUDE_IV (1<<5)
510 * Some devices handle Michael MIC internally and do not include MIC in
511 * the received packets passed up. This flag must be set for such
512 * devices. The 'encryption' frame control bit is expected to be still
513 * set in the IEEE 802.11 header with this option unlike with the
514 * IEEE80211_HW_DEVICE_HIDES_WEP flag.
516 #define IEEE80211_HW_DEVICE_STRIPS_MIC (1<<8)
518 /* Device is capable of performing full monitor mode even during
519 * normal operation. */
520 #define IEEE80211_HW_MONITOR_DURING_OPER (1<<9)
522 /* Device does not need BSSID filter set to broadcast in order to
523 * receive all probe responses while scanning */
524 #define IEEE80211_HW_NO_PROBE_FILTERING (1<<10)
526 /* Channels are already configured to the default regulatory domain
527 * specified in the device's EEPROM */
528 #define IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED (1<<11)
530 /* calculate Michael MIC for an MSDU when doing hwcrypto */
531 #define IEEE80211_HW_TKIP_INCLUDE_MMIC (1<<12)
532 /* Do TKIP phase1 key mixing in stack to support cards only do
533 * phase2 key mixing when doing hwcrypto */
534 #define IEEE80211_HW_TKIP_REQ_PHASE1_KEY (1<<13)
535 /* Do TKIP phase1 and phase2 key mixing in stack and send the generated
536 * per-packet RC4 key with each TX frame when doing hwcrypto */
537 #define IEEE80211_HW_TKIP_REQ_PHASE2_KEY (1<<14)
539 u32 flags; /* hardware flags defined above */
541 /* Set to the size of a needed device specific skb headroom for TX skbs. */
542 unsigned int extra_tx_headroom;
544 /* This is the time in us to change channels
546 int channel_change_time;
547 /* Maximum values for various statistics.
548 * Leave at 0 to indicate no support. Use negative numbers for dBm. */
553 /* Number of available hardware TX queues for data packets.
554 * WMM requires at least four queues. */
558 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
560 set_wiphy_dev(hw->wiphy, dev);
563 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
565 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
568 /* Configuration block used by the low-level driver to tell the 802.11 code
569 * about supported hardware features and to pass function pointers to callback
571 struct ieee80211_ops {
572 /* Handler that 802.11 module calls for each transmitted frame.
573 * skb contains the buffer starting from the IEEE 802.11 header.
574 * The low-level driver should send the frame out based on
575 * configuration in the TX control data.
577 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb,
578 struct ieee80211_tx_control *control);
580 /* Handler that is called when any netdevice attached to the hardware
581 * device is set UP for the first time. This can be used, e.g., to
582 * enable interrupts and beacon sending. */
583 int (*open)(struct ieee80211_hw *hw);
585 /* Handler that is called when the last netdevice attached to the
586 * hardware device is set DOWN. This can be used, e.g., to disable
587 * interrupts and beacon sending. */
588 int (*stop)(struct ieee80211_hw *hw);
590 /* Handler for asking a driver if a new interface can be added (or,
591 * more exactly, set UP). If the handler returns zero, the interface
592 * is added. Driver should perform any initialization it needs prior
593 * to returning zero. By returning non-zero addition of the interface
594 * is inhibited. Unless monitor_during_oper is set, it is guaranteed
595 * that monitor interfaces and normal interfaces are mutually
596 * exclusive. If assigned, the open() handler is called after
597 * add_interface() if this is the first device added. The
598 * add_interface() callback has to be assigned because it is the only
599 * way to obtain the requested MAC address for any interface.
601 int (*add_interface)(struct ieee80211_hw *hw,
602 struct ieee80211_if_init_conf *conf);
604 /* Notify a driver that an interface is going down. The stop() handler
605 * is called prior to this if this is a last interface. */
606 void (*remove_interface)(struct ieee80211_hw *hw,
607 struct ieee80211_if_init_conf *conf);
609 /* Handler for configuration requests. IEEE 802.11 code calls this
610 * function to change hardware configuration, e.g., channel. */
611 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
613 /* Handler for configuration requests related to interfaces (e.g.
615 int (*config_interface)(struct ieee80211_hw *hw,
616 int if_id, struct ieee80211_if_conf *conf);
618 /* ieee80211 drivers do not have access to the &struct net_device
619 * that is (are) connected with their device. Hence (and because
620 * we need to combine the multicast lists and flags for multiple
621 * virtual interfaces), they cannot assign set_multicast_list.
622 * The parameters here replace dev->flags and dev->mc_count,
623 * dev->mc_list is replaced by calling ieee80211_get_mc_list_item.
625 void (*set_multicast_list)(struct ieee80211_hw *hw,
626 unsigned short flags, int mc_count);
628 /* Set TIM bit handler. If the hardware/firmware takes care of beacon
629 * generation, IEEE 802.11 code uses this function to tell the
630 * low-level to set (or clear if set==0) TIM bit for the given aid. If
631 * host system is used to generate beacons, this handler is not used
632 * and low-level driver should set it to NULL.
634 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
637 * Set encryption key.
639 * This is called to enable hardware acceleration of encryption and
640 * decryption. The address will be the broadcast address for default
641 * keys, the other station's hardware address for individual keys or
642 * the zero address for keys that will be used only for transmission.
644 * The local_address parameter will always be set to our own address,
645 * this is only relevant if you support multiple local addresses.
647 * When transmitting, the TX control data will use the hw_key_idx
648 * selected by the low-level driver.
650 * Return 0 if the key is now in use, -EOPNOTSUPP or -ENOSPC if it
651 * couldn't be added; if you return 0 then hw_key_idx must be
652 * assigned to something other than HW_KEY_IDX_INVALID. When the cmd
653 * is DISABLE_KEY then it must succeed.
655 * This callback can sleep, and is only called between add_interface
656 * and remove_interface calls, i.e. while the interface with the
657 * given local_address is enabled.
659 * The ieee80211_key_conf structure pointed to by the key parameter
660 * is guaranteed to be valid until another call to set_key removes
661 * it, but it can only be used as a cookie to differentiate keys.
663 int (*set_key)(struct ieee80211_hw *hw, set_key_cmd cmd,
664 const u8 *local_address, const u8 *address,
665 struct ieee80211_key_conf *key);
668 * Set TX key index for default/broadcast keys. This is needed in cases
669 * where wlan card is doing full WEP/TKIP encapsulation (wep_include_iv
670 * is not set), in other cases, this function pointer can be set to
671 * NULL since the IEEE 802.11 module takes care of selecting the key
672 * index for each TX frame.
674 * TODO: If you use this callback in your driver tell us if you need
675 * any other information from it to make it easier, like the
678 int (*set_key_idx)(struct ieee80211_hw *hw, int idx);
680 /* Enable/disable IEEE 802.1X. This item requests wlan card to pass
681 * unencrypted EAPOL-Key frames even when encryption is configured.
682 * If the wlan card does not require such a configuration, this
683 * function pointer can be set to NULL. */
684 int (*set_ieee8021x)(struct ieee80211_hw *hw, int use_ieee8021x);
686 /* Set port authorization state (IEEE 802.1X PAE) to be authorized
687 * (authorized=1) or unauthorized (authorized=0). This function can be
688 * used if the wlan hardware or low-level driver implements PAE.
689 * 80211.o module will anyway filter frames based on authorization
690 * state, so this function pointer can be NULL if low-level driver does
691 * not require event notification about port state changes.
692 * Currently unused. */
693 int (*set_port_auth)(struct ieee80211_hw *hw, u8 *addr,
696 /* Ask the hardware to service the scan request, no need to start
697 * the scan state machine in stack. */
698 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
700 /* return low-level statistics */
701 int (*get_stats)(struct ieee80211_hw *hw,
702 struct ieee80211_low_level_stats *stats);
704 /* For devices that generate their own beacons and probe response
705 * or association responses this updates the state of privacy_invoked
706 * returns 0 for success or an error number */
707 int (*set_privacy_invoked)(struct ieee80211_hw *hw,
708 int privacy_invoked);
710 /* For devices that have internal sequence counters, allow 802.11
711 * code to access the current value of a counter */
712 int (*get_sequence_counter)(struct ieee80211_hw *hw,
713 u8* addr, u8 keyidx, u8 txrx,
714 u32* iv32, u16* iv16);
716 /* Configuration of RTS threshold (if device needs it) */
717 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
719 /* Configuration of fragmentation threshold.
720 * Assign this if the device does fragmentation by itself,
721 * if this method is assigned then the stack will not do
723 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
725 /* Configuration of retry limits (if device needs it) */
726 int (*set_retry_limit)(struct ieee80211_hw *hw,
727 u32 short_retry, u32 long_retr);
729 /* Number of STAs in STA table notification (NULL = disabled).
731 void (*sta_table_notification)(struct ieee80211_hw *hw,
734 /* Handle ERP IE change notifications. Must be atomic. */
735 void (*erp_ie_changed)(struct ieee80211_hw *hw, u8 changes,
736 int cts_protection, int preamble);
738 /* Flags for the erp_ie_changed changes parameter */
739 #define IEEE80211_ERP_CHANGE_PROTECTION (1<<0) /* protection flag changed */
740 #define IEEE80211_ERP_CHANGE_PREAMBLE (1<<1) /* barker preamble mode changed */
742 /* Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
743 * bursting) for a hardware TX queue.
744 * queue = IEEE80211_TX_QUEUE_*.
746 int (*conf_tx)(struct ieee80211_hw *hw, int queue,
747 const struct ieee80211_tx_queue_params *params);
749 /* Get statistics of the current TX queue status. This is used to get
750 * number of currently queued packets (queue length), maximum queue
751 * size (limit), and total number of packets sent using each TX queue
753 * Currently unused. */
754 int (*get_tx_stats)(struct ieee80211_hw *hw,
755 struct ieee80211_tx_queue_stats *stats);
757 /* Get the current TSF timer value from firmware/hardware. Currently,
758 * this is only used for IBSS mode debugging and, as such, is not a
761 u64 (*get_tsf)(struct ieee80211_hw *hw);
763 /* Reset the TSF timer and allow firmware/hardware to synchronize with
764 * other STAs in the IBSS. This is only used in IBSS mode. This
765 * function is optional if the firmware/hardware takes full care of
766 * TSF synchronization. */
767 void (*reset_tsf)(struct ieee80211_hw *hw);
769 /* Setup beacon data for IBSS beacons. Unlike access point (Master),
770 * IBSS uses a fixed beacon frame which is configured using this
771 * function. This handler is required only for IBSS mode. */
772 int (*beacon_update)(struct ieee80211_hw *hw,
774 struct ieee80211_tx_control *control);
776 /* Determine whether the last IBSS beacon was sent by us. This is
777 * needed only for IBSS mode and the result of this function is used to
778 * determine whether to reply to Probe Requests. */
779 int (*tx_last_beacon)(struct ieee80211_hw *hw);
782 /* Allocate a new hardware device. This must be called once for each
783 * hardware device. The returned pointer must be used to refer to this
784 * device when calling other functions. 802.11 code allocates a private data
785 * area for the low-level driver. The size of this area is given as
788 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
789 const struct ieee80211_ops *ops);
791 /* Register hardware device to the IEEE 802.11 code and kernel. Low-level
792 * drivers must call this function before using any other IEEE 802.11
793 * function except ieee80211_register_hwmode. */
794 int ieee80211_register_hw(struct ieee80211_hw *hw);
796 /* driver can use this and ieee80211_get_rx_led_name to get the
797 * name of the registered LEDs after ieee80211_register_hw
799 * This is useful to set the default trigger on the LED class
800 * device that your driver should export for each LED the device
801 * has, that way the default behaviour will be as expected but
802 * the user can still change it/turn off the LED etc.
804 #ifdef CONFIG_MAC80211_LEDS
805 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
806 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
808 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
810 #ifdef CONFIG_MAC80211_LEDS
811 return __ieee80211_get_tx_led_name(hw);
817 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
819 #ifdef CONFIG_MAC80211_LEDS
820 return __ieee80211_get_rx_led_name(hw);
826 /* Register a new hardware PHYMODE capability to the stack. */
827 int ieee80211_register_hwmode(struct ieee80211_hw *hw,
828 struct ieee80211_hw_mode *mode);
830 /* Unregister a hardware device. This function instructs 802.11 code to free
831 * allocated resources and unregister netdevices from the kernel. */
832 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
834 /* Free everything that was allocated including private data of a driver. */
835 void ieee80211_free_hw(struct ieee80211_hw *hw);
837 /* Receive frame callback function. The low-level driver uses this function to
838 * send received frames to the IEEE 802.11 code. Receive buffer (skb) must
839 * start with IEEE 802.11 header. */
840 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
841 struct ieee80211_rx_status *status);
842 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
844 struct ieee80211_rx_status *status);
846 /* Transmit status callback function. The low-level driver must call this
847 * function to report transmit status for all the TX frames that had
848 * req_tx_status set in the transmit control fields. In addition, this should
849 * be called at least for all unicast frames to provide information for TX rate
850 * control algorithm. In order to maintain all statistics, this function is
851 * recommended to be called after each frame, including multicast/broadcast, is
853 void ieee80211_tx_status(struct ieee80211_hw *hw,
855 struct ieee80211_tx_status *status);
856 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
858 struct ieee80211_tx_status *status);
861 * ieee80211_beacon_get - beacon generation function
862 * @hw: pointer obtained from ieee80211_alloc_hw().
863 * @if_id: interface ID from &struct ieee80211_if_init_conf.
864 * @control: will be filled with information needed to send this beacon.
866 * If the beacon frames are generated by the host system (i.e., not in
867 * hardware/firmware), the low-level driver uses this function to receive
868 * the next beacon frame from the 802.11 code. The low-level is responsible
869 * for calling this function before beacon data is needed (e.g., based on
870 * hardware interrupt). Returned skb is used only once and low-level driver
871 * is responsible of freeing it.
873 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
875 struct ieee80211_tx_control *control);
878 * ieee80211_rts_get - RTS frame generation function
879 * @hw: pointer obtained from ieee80211_alloc_hw().
880 * @if_id: interface ID from &struct ieee80211_if_init_conf.
881 * @frame: pointer to the frame that is going to be protected by the RTS.
882 * @frame_len: the frame length (in octets).
883 * @frame_txctl: &struct ieee80211_tx_control of the frame.
884 * @rts: The buffer where to store the RTS frame.
886 * If the RTS frames are generated by the host system (i.e., not in
887 * hardware/firmware), the low-level driver uses this function to receive
888 * the next RTS frame from the 802.11 code. The low-level is responsible
889 * for calling this function before and RTS frame is needed.
891 void ieee80211_rts_get(struct ieee80211_hw *hw, int if_id,
892 const void *frame, size_t frame_len,
893 const struct ieee80211_tx_control *frame_txctl,
894 struct ieee80211_rts *rts);
897 * ieee80211_rts_duration - Get the duration field for an RTS frame
898 * @hw: pointer obtained from ieee80211_alloc_hw().
899 * @if_id: interface ID from &struct ieee80211_if_init_conf.
900 * @frame_len: the length of the frame that is going to be protected by the RTS.
901 * @frame_txctl: &struct ieee80211_tx_control of the frame.
903 * If the RTS is generated in firmware, but the host system must provide
904 * the duration field, the low-level driver uses this function to receive
905 * the duration field value in little-endian byteorder.
907 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw, int if_id,
909 const struct ieee80211_tx_control *frame_txctl);
912 * ieee80211_ctstoself_get - CTS-to-self frame generation function
913 * @hw: pointer obtained from ieee80211_alloc_hw().
914 * @if_id: interface ID from &struct ieee80211_if_init_conf.
915 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
916 * @frame_len: the frame length (in octets).
917 * @frame_txctl: &struct ieee80211_tx_control of the frame.
918 * @cts: The buffer where to store the CTS-to-self frame.
920 * If the CTS-to-self frames are generated by the host system (i.e., not in
921 * hardware/firmware), the low-level driver uses this function to receive
922 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
923 * for calling this function before and CTS-to-self frame is needed.
925 void ieee80211_ctstoself_get(struct ieee80211_hw *hw, int if_id,
926 const void *frame, size_t frame_len,
927 const struct ieee80211_tx_control *frame_txctl,
928 struct ieee80211_cts *cts);
931 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
932 * @hw: pointer obtained from ieee80211_alloc_hw().
933 * @if_id: interface ID from &struct ieee80211_if_init_conf.
934 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
935 * @frame_txctl: &struct ieee80211_tx_control of the frame.
937 * If the CTS-to-self is generated in firmware, but the host system must provide
938 * the duration field, the low-level driver uses this function to receive
939 * the duration field value in little-endian byteorder.
941 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, int if_id,
943 const struct ieee80211_tx_control *frame_txctl);
946 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
947 * @hw: pointer obtained from ieee80211_alloc_hw().
948 * @if_id: interface ID from &struct ieee80211_if_init_conf.
949 * @frame_len: the length of the frame.
950 * @rate: the rate (in 100kbps) at which the frame is going to be transmitted.
952 * Calculate the duration field of some generic frame, given its
953 * length and transmission rate (in 100kbps).
955 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, int if_id,
960 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
961 * @hw: pointer as obtained from ieee80211_alloc_hw().
962 * @if_id: interface ID from &struct ieee80211_if_init_conf.
963 * @control: will be filled with information needed to send returned frame.
965 * Function for accessing buffered broadcast and multicast frames. If
966 * hardware/firmware does not implement buffering of broadcast/multicast
967 * frames when power saving is used, 802.11 code buffers them in the host
968 * memory. The low-level driver uses this function to fetch next buffered
969 * frame. In most cases, this is used when generating beacon frame. This
970 * function returns a pointer to the next buffered skb or NULL if no more
971 * buffered frames are available.
973 * Note: buffered frames are returned only after DTIM beacon frame was
974 * generated with ieee80211_beacon_get() and the low-level driver must thus
975 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
976 * NULL if the previous generated beacon was not DTIM, so the low-level driver
977 * does not need to check for DTIM beacons separately and should be able to
978 * use common code for all beacons.
981 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, int if_id,
982 struct ieee80211_tx_control *control);
984 /* Given an sk_buff with a raw 802.11 header at the data pointer this function
985 * returns the 802.11 header length in bytes (not including encryption
986 * headers). If the data in the sk_buff is too short to contain a valid 802.11
987 * header the function returns 0.
989 int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
991 /* Like ieee80211_get_hdrlen_from_skb() but takes a FC in CPU order. */
992 int ieee80211_get_hdrlen(u16 fc);
995 * ieee80211_wake_queue - wake specific queue
996 * @hw: pointer as obtained from ieee80211_alloc_hw().
997 * @queue: queue number (counted from zero).
999 * Drivers should use this function instead of netif_wake_queue.
1001 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
1004 * ieee80211_stop_queue - stop specific queue
1005 * @hw: pointer as obtained from ieee80211_alloc_hw().
1006 * @queue: queue number (counted from zero).
1008 * Drivers should use this function instead of netif_stop_queue.
1010 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
1013 * ieee80211_start_queues - start all queues
1014 * @hw: pointer to as obtained from ieee80211_alloc_hw().
1016 * Drivers should use this function instead of netif_start_queue.
1018 void ieee80211_start_queues(struct ieee80211_hw *hw);
1021 * ieee80211_stop_queues - stop all queues
1022 * @hw: pointer as obtained from ieee80211_alloc_hw().
1024 * Drivers should use this function instead of netif_stop_queue.
1026 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1029 * ieee80211_wake_queues - wake all queues
1030 * @hw: pointer as obtained from ieee80211_alloc_hw().
1032 * Drivers should use this function instead of netif_wake_queue.
1034 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1037 * ieee80211_get_mc_list_item - iteration over items in multicast list
1038 * @hw: pointer as obtained from ieee80211_alloc_hw().
1039 * @prev: value returned by previous call to ieee80211_get_mc_list_item() or
1040 * NULL to start a new iteration.
1041 * @ptr: pointer to buffer of void * type for internal usage of
1042 * ieee80211_get_mc_list_item().
1044 * Iterates over items in multicast list of given device. To get the first
1045 * item, pass NULL in @prev and in *@ptr. In subsequent calls, pass the
1046 * value returned by previous call in @prev. Don't alter *@ptr during
1047 * iteration. When there are no more items, NULL is returned.
1049 struct dev_mc_list *
1050 ieee80211_get_mc_list_item(struct ieee80211_hw *hw,
1051 struct dev_mc_list *prev,
1054 /* called by driver to notify scan status completed */
1055 void ieee80211_scan_completed(struct ieee80211_hw *hw);
1057 /* return a pointer to the source address (SA) */
1058 static inline u8 *ieee80211_get_SA(struct ieee80211_hdr *hdr)
1060 u8 *raw = (u8 *) hdr;
1061 u8 tofrom = (*(raw+1)) & 3; /* get the TODS and FROMDS bits */
1072 /* return a pointer to the destination address (DA) */
1073 static inline u8 *ieee80211_get_DA(struct ieee80211_hdr *hdr)
1075 u8 *raw = (u8 *) hdr;
1076 u8 to_ds = (*(raw+1)) & 1; /* get the TODS bit */
1083 static inline int ieee80211_get_morefrag(struct ieee80211_hdr *hdr)
1085 return (le16_to_cpu(hdr->frame_control) &
1086 IEEE80211_FCTL_MOREFRAGS) != 0;
1089 #define MAC_FMT "%02x:%02x:%02x:%02x:%02x:%02x"
1090 #define MAC_ARG(x) ((u8*)(x))[0], ((u8*)(x))[1], ((u8*)(x))[2], \
1091 ((u8*)(x))[3], ((u8*)(x))[4], ((u8*)(x))[5]
1093 #endif /* MAC80211_H */