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_TURBO 0x00000080
77 #define IEEE80211_RATE_MANDATORY 0x00000100
79 #define IEEE80211_RATE_CCK_2 (IEEE80211_RATE_CCK | IEEE80211_RATE_PREAMBLE2)
80 #define IEEE80211_RATE_MODULATION(f) \
81 (f & (IEEE80211_RATE_CCK | IEEE80211_RATE_OFDM))
83 /* Low-level driver should set PREAMBLE2, OFDM, CCK, and TURBO flags.
84 * BASIC, SUPPORTED, ERP, and MANDATORY flags are set in 80211.o based on the
86 struct ieee80211_rate {
87 int rate; /* rate in 100 kbps */
88 int val; /* hw specific value for the rate */
89 int flags; /* IEEE80211_RATE_ flags */
90 int val2; /* hw specific value for the rate when using short preamble
91 * (only when IEEE80211_RATE_PREAMBLE2 flag is set, i.e., for
92 * 2, 5.5, and 11 Mbps) */
93 signed char min_rssi_ack;
94 unsigned char min_rssi_ack_delta;
96 /* following fields are set by 80211.o and need not be filled by the
98 int rate_inv; /* inverse of the rate (LCM(all rates) / rate) for
99 * optimizing channel utilization estimates */
102 /* 802.11g is backwards-compatible with 802.11b, so a wlan card can
103 * actually be both in 11b and 11g modes at the same time. */
105 MODE_IEEE80211A, /* IEEE 802.11a */
106 MODE_IEEE80211B, /* IEEE 802.11b only */
107 MODE_ATHEROS_TURBO, /* Atheros Turbo mode (2x.11a at 5 GHz) */
108 MODE_IEEE80211G, /* IEEE 802.11g (and 802.11b compatibility) */
109 MODE_ATHEROS_TURBOG, /* Atheros Turbo mode (2x.11g at 2.4 GHz) */
115 struct ieee80211_hw_mode {
116 int mode; /* MODE_IEEE80211... */
117 int num_channels; /* Number of channels (below) */
118 struct ieee80211_channel *channels; /* Array of supported channels */
119 int num_rates; /* Number of rates (below) */
120 struct ieee80211_rate *rates; /* Array of supported rates */
122 struct list_head list; /* Internal, don't touch */
125 struct ieee80211_tx_queue_params {
126 int aifs; /* 0 .. 255; -1 = use default */
127 int cw_min; /* 2^n-1: 1, 3, 7, .. , 1023; 0 = use default */
128 int cw_max; /* 2^n-1: 1, 3, 7, .. , 1023; 0 = use default */
129 int burst_time; /* maximum burst time in 0.1 ms (i.e., 10 = 1 ms);
133 struct ieee80211_tx_queue_stats_data {
134 unsigned int len; /* num packets in queue */
135 unsigned int limit; /* queue len (soft) limit */
136 unsigned int count; /* total num frames sent */
140 IEEE80211_TX_QUEUE_DATA0,
141 IEEE80211_TX_QUEUE_DATA1,
142 IEEE80211_TX_QUEUE_DATA2,
143 IEEE80211_TX_QUEUE_DATA3,
144 IEEE80211_TX_QUEUE_DATA4,
145 IEEE80211_TX_QUEUE_SVP,
149 /* due to stupidity in the sub-ioctl userspace interface, the items in
150 * this struct need to have fixed values. As soon as it is removed, we can
151 * fix these entries. */
152 IEEE80211_TX_QUEUE_AFTER_BEACON = 6,
153 IEEE80211_TX_QUEUE_BEACON = 7
156 struct ieee80211_tx_queue_stats {
157 struct ieee80211_tx_queue_stats_data data[NUM_TX_DATA_QUEUES];
160 struct ieee80211_low_level_stats {
161 unsigned int dot11ACKFailureCount;
162 unsigned int dot11RTSFailureCount;
163 unsigned int dot11FCSErrorCount;
164 unsigned int dot11RTSSuccessCount;
167 /* Transmit control fields. This data structure is passed to low-level driver
168 * with each TX frame. The low-level driver is responsible for configuring
169 * the hardware to use given values (depending on what is supported). */
170 #define HW_KEY_IDX_INVALID -1
172 struct ieee80211_tx_control {
173 int tx_rate; /* Transmit rate, given as the hw specific value for the
174 * rate (from struct ieee80211_rate) */
175 int rts_cts_rate; /* Transmit rate for RTS/CTS frame, given as the hw
176 * specific value for the rate (from
177 * struct ieee80211_rate) */
179 #define IEEE80211_TXCTL_REQ_TX_STATUS (1<<0)/* request TX status callback for
181 #define IEEE80211_TXCTL_DO_NOT_ENCRYPT (1<<1) /* send this frame without
182 * encryption; e.g., for EAPOL
184 #define IEEE80211_TXCTL_USE_RTS_CTS (1<<2) /* use RTS-CTS before sending
186 #define IEEE80211_TXCTL_USE_CTS_PROTECT (1<<3) /* use CTS protection for the
187 * frame (e.g., for combined
188 * 802.11g / 802.11b networks) */
189 #define IEEE80211_TXCTL_NO_ACK (1<<4) /* tell the low level not to
191 #define IEEE80211_TXCTL_RATE_CTRL_PROBE (1<<5)
192 #define IEEE80211_TXCTL_CLEAR_DST_MASK (1<<6)
193 #define IEEE80211_TXCTL_REQUEUE (1<<7)
194 #define IEEE80211_TXCTL_FIRST_FRAGMENT (1<<8) /* this is a first fragment of
196 #define IEEE80211_TXCTL_TKIP_NEW_PHASE1_KEY (1<<9)
197 #define IEEE80211_TXCTL_LONG_RETRY_LIMIT (1<<10) /* this frame should be send
199 * set_retry_limit configured
200 * long retry value */
201 u32 flags; /* tx control flags defined
203 u8 retry_limit; /* 1 = only first attempt, 2 = one retry, ..
204 * This could be used when set_retry_limit
205 * is not implemented by the driver */
206 u8 power_level; /* per-packet transmit power level, in dBm */
207 u8 antenna_sel_tx; /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */
208 s8 key_idx; /* -1 = do not encrypt, >= 0 keyidx from
210 u8 icv_len; /* length of the ICV/MIC field in octets */
211 u8 iv_len; /* length of the IV field in octets */
212 u8 tkip_key[16]; /* generated phase2/phase1 key for hw TKIP */
213 u8 queue; /* hardware queue to use for this frame;
214 * 0 = highest, hw->queues-1 = lowest */
215 u8 sw_retry_attempt; /* number of times hw has tried to
216 * transmit frame (not incl. hw retries) */
218 struct ieee80211_rate *rate; /* internal 80211.o rate */
219 struct ieee80211_rate *rts_rate; /* internal 80211.o rate
221 int alt_retry_rate; /* retry rate for the last retries, given as the
222 * hw specific value for the rate (from
223 * struct ieee80211_rate). To be used to limit
224 * packet dropping when probing higher rates, if hw
225 * supports multiple retry rates. -1 = not used */
226 int type; /* internal */
227 int ifindex; /* internal */
230 /* Receive status. The low-level driver should provide this information
231 * (the subset supported by hardware) to the 802.11 code with each received
233 struct ieee80211_rx_status {
235 int freq; /* receive frequency in Mhz */
239 int signal; /* used as qual in statistics reporting */
243 #define RX_FLAG_MMIC_ERROR (1<<0)
244 #define RX_FLAG_DECRYPTED (1<<1)
245 #define RX_FLAG_RADIOTAP (1<<2)
249 /* Transmit status. The low-level driver should provide this information
250 * (the subset supported by hardware) to the 802.11 code for each transmit
252 struct ieee80211_tx_status {
253 /* copied ieee80211_tx_control structure */
254 struct ieee80211_tx_control control;
256 #define IEEE80211_TX_STATUS_TX_FILTERED (1<<0)
257 #define IEEE80211_TX_STATUS_ACK (1<<1) /* whether the TX frame was ACKed */
258 u32 flags; /* tx staus flags defined above */
260 int ack_signal; /* measured signal strength of the ACK frame */
261 int excessive_retries;
264 int queue_length; /* information about TX queue */
270 * struct ieee80211_conf - configuration of the device
272 * This struct indicates how the driver shall configure the hardware.
274 * @radio_enabled: when zero, driver is required to switch off the radio.
276 struct ieee80211_conf {
277 int channel; /* IEEE 802.11 channel number */
279 int channel_val; /* hw specific value for the channel */
281 int phymode; /* MODE_IEEE80211A, .. */
282 struct ieee80211_channel *chan;
283 struct ieee80211_hw_mode *mode;
284 unsigned int regulatory_domain;
289 #define IEEE80211_CONF_SHORT_SLOT_TIME (1<<0) /* use IEEE 802.11g Short Slot
291 #define IEEE80211_CONF_SSID_HIDDEN (1<<1) /* do not broadcast the ssid */
292 #define IEEE80211_CONF_RADIOTAP (1<<2) /* use radiotap if supported
293 check this bit at RX time */
294 u32 flags; /* configuration flags defined above */
296 u8 power_level; /* transmit power limit for current
297 * regulatory domain; in dBm */
298 u8 antenna_max; /* maximum antenna gain */
299 short tx_power_reduction; /* in 0.1 dBm */
301 /* 0 = default/diversity, 1 = Ant0, 2 = Ant1 */
305 /* Following five fields are used for IEEE 802.11H */
306 unsigned int radar_detect;
307 unsigned int spect_mgmt;
308 /* All following fields are currently unused. */
309 unsigned int quiet_duration; /* duration of quiet period */
310 unsigned int quiet_offset; /* how far into the beacon is the quiet
312 unsigned int quiet_period;
313 u8 radar_firpwr_threshold;
314 u8 radar_rssi_threshold;
315 u8 pulse_height_threshold;
316 u8 pulse_rssi_threshold;
317 u8 pulse_inband_threshold;
321 * enum ieee80211_if_types - types of 802.11 network interfaces
323 * @IEEE80211_IF_TYPE_AP: interface in AP mode.
324 * @IEEE80211_IF_TYPE_MGMT: special interface for communication with hostap
325 * daemon. Drivers should never see this type.
326 * @IEEE80211_IF_TYPE_STA: interface in STA (client) mode.
327 * @IEEE80211_IF_TYPE_IBSS: interface in IBSS (ad-hoc) mode.
328 * @IEEE80211_IF_TYPE_MNTR: interface in monitor (rfmon) mode.
329 * @IEEE80211_IF_TYPE_WDS: interface in WDS mode.
330 * @IEEE80211_IF_TYPE_VLAN: not used.
332 enum ieee80211_if_types {
333 IEEE80211_IF_TYPE_AP = 0x00000000,
334 IEEE80211_IF_TYPE_MGMT = 0x00000001,
335 IEEE80211_IF_TYPE_STA = 0x00000002,
336 IEEE80211_IF_TYPE_IBSS = 0x00000003,
337 IEEE80211_IF_TYPE_MNTR = 0x00000004,
338 IEEE80211_IF_TYPE_WDS = 0x5A580211,
339 IEEE80211_IF_TYPE_VLAN = 0x00080211,
343 * struct ieee80211_if_init_conf - initial configuration of an interface
345 * @if_id: internal interface ID. This number has no particular meaning to
346 * drivers and the only allowed usage is to pass it to
347 * ieee80211_beacon_get() and ieee80211_get_buffered_bc() functions.
348 * This field is not valid for monitor interfaces
349 * (interfaces of %IEEE80211_IF_TYPE_MNTR type).
350 * @type: one of &enum ieee80211_if_types constants. Determines the type of
351 * added/removed interface.
352 * @mac_addr: pointer to MAC address of the interface. This pointer is valid
353 * until the interface is removed (i.e. it cannot be used after
354 * remove_interface() callback was called for this interface).
355 * This pointer will be %NULL for monitor interfaces, be careful.
357 * This structure is used in add_interface() and remove_interface()
358 * callbacks of &struct ieee80211_hw.
360 * When you allow multiple interfaces to be added to your PHY, take care
361 * that the hardware can actually handle multiple MAC addresses. However,
362 * also take care that when there's no interface left with mac_addr != %NULL
363 * you remove the MAC address from the device to avoid acknowledging packets
364 * in pure monitor mode.
366 struct ieee80211_if_init_conf {
373 * struct ieee80211_if_conf - configuration of an interface
375 * @type: type of the interface. This is always the same as was specified in
376 * &struct ieee80211_if_init_conf. The type of an interface never changes
377 * during the life of the interface; this field is present only for
379 * @bssid: BSSID of the network we are associated to/creating.
380 * @ssid: used (together with @ssid_len) by drivers for hardware that
381 * generate beacons independently. The pointer is valid only during the
382 * config_interface() call, so copy the value somewhere if you need
384 * @ssid_len: length of the @ssid field.
385 * @generic_elem: used (together with @generic_elem_len) by drivers for
386 * hardware that generate beacons independently. The pointer is valid
387 * only during the config_interface() call, so copy the value somewhere
389 * @generic_elem_len: length of the generic element.
390 * @beacon: beacon template. Valid only if @host_gen_beacon_template in
391 * &struct ieee80211_hw is set. The driver is responsible of freeing
393 * @beacon_control: tx_control for the beacon template, this field is only
394 * valid when the @beacon field was set.
396 * This structure is passed to the config_interface() callback of
397 * &struct ieee80211_hw.
399 struct ieee80211_if_conf {
405 size_t generic_elem_len;
406 struct sk_buff *beacon;
407 struct ieee80211_tx_control *beacon_control;
410 typedef enum { ALG_NONE, ALG_WEP, ALG_TKIP, ALG_CCMP, ALG_NULL }
414 struct ieee80211_key_conf {
416 int hw_key_idx; /* filled + used by low-level driver */
417 ieee80211_key_alg alg;
420 #define IEEE80211_KEY_FORCE_SW_ENCRYPT (1<<0) /* to be cleared by low-level
422 #define IEEE80211_KEY_DEFAULT_TX_KEY (1<<1) /* This key is the new default TX
423 key (used only for broadcast
425 #define IEEE80211_KEY_DEFAULT_WEP_ONLY (1<<2) /* static WEP is the only
426 configured security policy;
427 this allows some low-level
428 drivers to determine when
429 hwaccel can be used */
430 u32 flags; /* key configuration flags defined above */
432 s8 keyidx; /* WEP key index */
436 #define IEEE80211_SEQ_COUNTER_RX 0
437 #define IEEE80211_SEQ_COUNTER_TX 1
440 SET_KEY, DISABLE_KEY, REMOVE_ALL_KEYS,
443 /* This is driver-visible part of the per-hw state the stack keeps. */
444 struct ieee80211_hw {
445 /* points to the cfg80211 wiphy for this piece. Note
446 * that you must fill in the perm_addr and dev fields
447 * of this structure, use the macros provided below. */
450 /* assigned by mac80211, don't write */
451 struct ieee80211_conf conf;
453 /* Single thread workqueue available for driver use
454 * Allocated by mac80211 on registration */
455 struct workqueue_struct *workqueue;
457 /* Pointer to the private area that was
458 * allocated with this struct for you. */
461 /* The rest is information about your hardware */
463 /* TODO: frame_type 802.11/802.3, sw_encryption requirements */
468 * The device only needs to be supplied with a beacon template.
469 * If you need the host to generate each beacon then don't use
470 * this flag and use ieee80211_beacon_get().
472 #define IEEE80211_HW_HOST_GEN_BEACON_TEMPLATE (1<<1)
475 * Some devices handle decryption internally and do not
476 * indicate whether the frame was encrypted (unencrypted frames
477 * will be dropped by the hardware, unless specifically allowed
479 * It is permissible to not handle all encrypted frames and fall
480 * back to software encryption; however, if this flag is set
481 * unencrypted frames must be dropped unless the driver is told
482 * otherwise via the set_ieee8021x() callback.
484 #define IEEE80211_HW_DEVICE_HIDES_WEP (1<<2)
486 /* Whether RX frames passed to ieee80211_rx() include FCS in the end */
487 #define IEEE80211_HW_RX_INCLUDES_FCS (1<<3)
489 /* Some wireless LAN chipsets buffer broadcast/multicast frames for
490 * power saving stations in the hardware/firmware and others rely on
491 * the host system for such buffering. This option is used to
492 * configure the IEEE 802.11 upper layer to buffer broadcast/multicast
493 * frames when there are power saving stations so that low-level driver
494 * can fetch them with ieee80211_get_buffered_bc(). */
495 #define IEEE80211_HW_HOST_BROADCAST_PS_BUFFERING (1<<4)
498 * This flag is only relevant if hardware encryption is used.
499 * If set, it has two meanings:
500 * 1) the IV and ICV are present in received frames that have
501 * been decrypted (unless IEEE80211_HW_DEVICE_HIDES_WEP is
503 * 2) on transmission, the IV should be generated in software.
505 * Please let us know if you *don't* use this flag, the stack would
506 * really like to be able to get the IV to keep key statistics
509 #define IEEE80211_HW_WEP_INCLUDE_IV (1<<5)
513 /* Force software encryption for TKIP packets if WMM is enabled. */
514 #define IEEE80211_HW_NO_TKIP_WMM_HWACCEL (1<<7)
517 * Some devices handle Michael MIC internally and do not include MIC in
518 * the received packets passed up. This flag must be set for such
519 * devices. The 'encryption' frame control bit is expected to be still
520 * set in the IEEE 802.11 header with this option unlike with the
521 * IEEE80211_HW_DEVICE_HIDES_WEP flag.
523 #define IEEE80211_HW_DEVICE_STRIPS_MIC (1<<8)
525 /* Device is capable of performing full monitor mode even during
526 * normal operation. */
527 #define IEEE80211_HW_MONITOR_DURING_OPER (1<<9)
529 /* Device does not need BSSID filter set to broadcast in order to
530 * receive all probe responses while scanning */
531 #define IEEE80211_HW_NO_PROBE_FILTERING (1<<10)
533 /* Channels are already configured to the default regulatory domain
534 * specified in the device's EEPROM */
535 #define IEEE80211_HW_DEFAULT_REG_DOMAIN_CONFIGURED (1<<11)
537 /* calculate Michael MIC for an MSDU when doing hwcrypto */
538 #define IEEE80211_HW_TKIP_INCLUDE_MMIC (1<<12)
539 /* Do TKIP phase1 key mixing in stack to support cards only do
540 * phase2 key mixing when doing hwcrypto */
541 #define IEEE80211_HW_TKIP_REQ_PHASE1_KEY (1<<13)
542 /* Do TKIP phase1 and phase2 key mixing in stack and send the generated
543 * per-packet RC4 key with each TX frame when doing hwcrypto */
544 #define IEEE80211_HW_TKIP_REQ_PHASE2_KEY (1<<14)
546 u32 flags; /* hardware flags defined above */
548 /* Set to the size of a needed device specific skb headroom for TX skbs. */
549 unsigned int extra_tx_headroom;
551 /* This is the time in us to change channels
553 int channel_change_time;
554 /* Maximum values for various statistics.
555 * Leave at 0 to indicate no support. Use negative numbers for dBm. */
560 /* Number of available hardware TX queues for data packets.
561 * WMM requires at least four queues. */
565 static inline void SET_IEEE80211_DEV(struct ieee80211_hw *hw, struct device *dev)
567 set_wiphy_dev(hw->wiphy, dev);
570 static inline void SET_IEEE80211_PERM_ADDR(struct ieee80211_hw *hw, u8 *addr)
572 memcpy(hw->wiphy->perm_addr, addr, ETH_ALEN);
575 /* Configuration block used by the low-level driver to tell the 802.11 code
576 * about supported hardware features and to pass function pointers to callback
578 struct ieee80211_ops {
579 /* Handler that 802.11 module calls for each transmitted frame.
580 * skb contains the buffer starting from the IEEE 802.11 header.
581 * The low-level driver should send the frame out based on
582 * configuration in the TX control data.
584 int (*tx)(struct ieee80211_hw *hw, struct sk_buff *skb,
585 struct ieee80211_tx_control *control);
587 /* Handler that is called when any netdevice attached to the hardware
588 * device is set UP for the first time. This can be used, e.g., to
589 * enable interrupts and beacon sending. */
590 int (*open)(struct ieee80211_hw *hw);
592 /* Handler that is called when the last netdevice attached to the
593 * hardware device is set DOWN. This can be used, e.g., to disable
594 * interrupts and beacon sending. */
595 int (*stop)(struct ieee80211_hw *hw);
597 /* Handler for asking a driver if a new interface can be added (or,
598 * more exactly, set UP). If the handler returns zero, the interface
599 * is added. Driver should perform any initialization it needs prior
600 * to returning zero. By returning non-zero addition of the interface
601 * is inhibited. Unless monitor_during_oper is set, it is guaranteed
602 * that monitor interfaces and normal interfaces are mutually
603 * exclusive. If assigned, the open() handler is called after
604 * add_interface() if this is the first device added. The
605 * add_interface() callback has to be assigned because it is the only
606 * way to obtain the requested MAC address for any interface.
608 int (*add_interface)(struct ieee80211_hw *hw,
609 struct ieee80211_if_init_conf *conf);
611 /* Notify a driver that an interface is going down. The stop() handler
612 * is called prior to this if this is a last interface. */
613 void (*remove_interface)(struct ieee80211_hw *hw,
614 struct ieee80211_if_init_conf *conf);
616 /* Handler for configuration requests. IEEE 802.11 code calls this
617 * function to change hardware configuration, e.g., channel. */
618 int (*config)(struct ieee80211_hw *hw, struct ieee80211_conf *conf);
620 /* Handler for configuration requests related to interfaces (e.g.
622 int (*config_interface)(struct ieee80211_hw *hw,
623 int if_id, struct ieee80211_if_conf *conf);
625 /* ieee80211 drivers do not have access to the &struct net_device
626 * that is (are) connected with their device. Hence (and because
627 * we need to combine the multicast lists and flags for multiple
628 * virtual interfaces), they cannot assign set_multicast_list.
629 * The parameters here replace dev->flags and dev->mc_count,
630 * dev->mc_list is replaced by calling ieee80211_get_mc_list_item.
632 void (*set_multicast_list)(struct ieee80211_hw *hw,
633 unsigned short flags, int mc_count);
635 /* Set TIM bit handler. If the hardware/firmware takes care of beacon
636 * generation, IEEE 802.11 code uses this function to tell the
637 * low-level to set (or clear if set==0) TIM bit for the given aid. If
638 * host system is used to generate beacons, this handler is not used
639 * and low-level driver should set it to NULL.
641 int (*set_tim)(struct ieee80211_hw *hw, int aid, int set);
643 /* Set encryption key. IEEE 802.11 module calls this function to set
644 * encryption keys. addr is ff:ff:ff:ff:ff:ff for default keys and
645 * station hwaddr for individual keys. aid of the station is given
646 * to help low-level driver in selecting which key->hw_key_idx to use
647 * for this key. TX control data will use the hw_key_idx selected by
648 * the low-level driver. */
649 int (*set_key)(struct ieee80211_hw *hw, set_key_cmd cmd,
650 u8 *addr, struct ieee80211_key_conf *key, int aid);
652 /* Set TX key index for default/broadcast keys. This is needed in cases
653 * where wlan card is doing full WEP/TKIP encapsulation (wep_include_iv
654 * is not set), in other cases, this function pointer can be set to
655 * NULL since the IEEE 802. 11 module takes care of selecting the key
656 * index for each TX frame. */
657 int (*set_key_idx)(struct ieee80211_hw *hw, int idx);
659 /* Enable/disable IEEE 802.1X. This item requests wlan card to pass
660 * unencrypted EAPOL-Key frames even when encryption is configured.
661 * If the wlan card does not require such a configuration, this
662 * function pointer can be set to NULL. */
663 int (*set_ieee8021x)(struct ieee80211_hw *hw, int use_ieee8021x);
665 /* Set port authorization state (IEEE 802.1X PAE) to be authorized
666 * (authorized=1) or unauthorized (authorized=0). This function can be
667 * used if the wlan hardware or low-level driver implements PAE.
668 * 80211.o module will anyway filter frames based on authorization
669 * state, so this function pointer can be NULL if low-level driver does
670 * not require event notification about port state changes.
671 * Currently unused. */
672 int (*set_port_auth)(struct ieee80211_hw *hw, u8 *addr,
675 /* Ask the hardware to service the scan request, no need to start
676 * the scan state machine in stack. */
677 int (*hw_scan)(struct ieee80211_hw *hw, u8 *ssid, size_t len);
679 /* return low-level statistics */
680 int (*get_stats)(struct ieee80211_hw *hw,
681 struct ieee80211_low_level_stats *stats);
683 /* For devices that generate their own beacons and probe response
684 * or association responses this updates the state of privacy_invoked
685 * returns 0 for success or an error number */
686 int (*set_privacy_invoked)(struct ieee80211_hw *hw,
687 int privacy_invoked);
689 /* For devices that have internal sequence counters, allow 802.11
690 * code to access the current value of a counter */
691 int (*get_sequence_counter)(struct ieee80211_hw *hw,
692 u8* addr, u8 keyidx, u8 txrx,
693 u32* iv32, u16* iv16);
695 /* Configuration of RTS threshold (if device needs it) */
696 int (*set_rts_threshold)(struct ieee80211_hw *hw, u32 value);
698 /* Configuration of fragmentation threshold.
699 * Assign this if the device does fragmentation by itself,
700 * if this method is assigned then the stack will not do
702 int (*set_frag_threshold)(struct ieee80211_hw *hw, u32 value);
704 /* Configuration of retry limits (if device needs it) */
705 int (*set_retry_limit)(struct ieee80211_hw *hw,
706 u32 short_retry, u32 long_retr);
708 /* Number of STAs in STA table notification (NULL = disabled).
710 void (*sta_table_notification)(struct ieee80211_hw *hw,
713 /* Handle ERP IE change notifications. Must be atomic. */
714 void (*erp_ie_changed)(struct ieee80211_hw *hw, u8 changes,
715 int cts_protection, int preamble);
717 /* Flags for the erp_ie_changed changes parameter */
718 #define IEEE80211_ERP_CHANGE_PROTECTION (1<<0) /* protection flag changed */
719 #define IEEE80211_ERP_CHANGE_PREAMBLE (1<<1) /* barker preamble mode changed */
721 /* Configure TX queue parameters (EDCF (aifs, cw_min, cw_max),
722 * bursting) for a hardware TX queue.
723 * queue = IEEE80211_TX_QUEUE_*.
725 int (*conf_tx)(struct ieee80211_hw *hw, int queue,
726 const struct ieee80211_tx_queue_params *params);
728 /* Get statistics of the current TX queue status. This is used to get
729 * number of currently queued packets (queue length), maximum queue
730 * size (limit), and total number of packets sent using each TX queue
732 * Currently unused. */
733 int (*get_tx_stats)(struct ieee80211_hw *hw,
734 struct ieee80211_tx_queue_stats *stats);
736 /* Get the current TSF timer value from firmware/hardware. Currently,
737 * this is only used for IBSS mode debugging and, as such, is not a
740 u64 (*get_tsf)(struct ieee80211_hw *hw);
742 /* Reset the TSF timer and allow firmware/hardware to synchronize with
743 * other STAs in the IBSS. This is only used in IBSS mode. This
744 * function is optional if the firmware/hardware takes full care of
745 * TSF synchronization. */
746 void (*reset_tsf)(struct ieee80211_hw *hw);
748 /* Setup beacon data for IBSS beacons. Unlike access point (Master),
749 * IBSS uses a fixed beacon frame which is configured using this
750 * function. This handler is required only for IBSS mode. */
751 int (*beacon_update)(struct ieee80211_hw *hw,
753 struct ieee80211_tx_control *control);
755 /* Determine whether the last IBSS beacon was sent by us. This is
756 * needed only for IBSS mode and the result of this function is used to
757 * determine whether to reply to Probe Requests. */
758 int (*tx_last_beacon)(struct ieee80211_hw *hw);
761 /* Allocate a new hardware device. This must be called once for each
762 * hardware device. The returned pointer must be used to refer to this
763 * device when calling other functions. 802.11 code allocates a private data
764 * area for the low-level driver. The size of this area is given as
767 struct ieee80211_hw *ieee80211_alloc_hw(size_t priv_data_len,
768 const struct ieee80211_ops *ops);
770 /* Register hardware device to the IEEE 802.11 code and kernel. Low-level
771 * drivers must call this function before using any other IEEE 802.11
772 * function except ieee80211_register_hwmode. */
773 int ieee80211_register_hw(struct ieee80211_hw *hw);
775 /* driver can use this and ieee80211_get_rx_led_name to get the
776 * name of the registered LEDs after ieee80211_register_hw
778 * This is useful to set the default trigger on the LED class
779 * device that your driver should export for each LED the device
780 * has, that way the default behaviour will be as expected but
781 * the user can still change it/turn off the LED etc.
783 #ifdef CONFIG_MAC80211_LEDS
784 extern char *__ieee80211_get_tx_led_name(struct ieee80211_hw *hw);
785 extern char *__ieee80211_get_rx_led_name(struct ieee80211_hw *hw);
787 static inline char *ieee80211_get_tx_led_name(struct ieee80211_hw *hw)
789 #ifdef CONFIG_MAC80211_LEDS
790 return __ieee80211_get_tx_led_name(hw);
796 static inline char *ieee80211_get_rx_led_name(struct ieee80211_hw *hw)
798 #ifdef CONFIG_MAC80211_LEDS
799 return __ieee80211_get_rx_led_name(hw);
805 /* Register a new hardware PHYMODE capability to the stack. */
806 int ieee80211_register_hwmode(struct ieee80211_hw *hw,
807 struct ieee80211_hw_mode *mode);
809 /* Unregister a hardware device. This function instructs 802.11 code to free
810 * allocated resources and unregister netdevices from the kernel. */
811 void ieee80211_unregister_hw(struct ieee80211_hw *hw);
813 /* Free everything that was allocated including private data of a driver. */
814 void ieee80211_free_hw(struct ieee80211_hw *hw);
816 /* Receive frame callback function. The low-level driver uses this function to
817 * send received frames to the IEEE 802.11 code. Receive buffer (skb) must
818 * start with IEEE 802.11 header. */
819 void __ieee80211_rx(struct ieee80211_hw *hw, struct sk_buff *skb,
820 struct ieee80211_rx_status *status);
821 void ieee80211_rx_irqsafe(struct ieee80211_hw *hw,
823 struct ieee80211_rx_status *status);
825 /* Transmit status callback function. The low-level driver must call this
826 * function to report transmit status for all the TX frames that had
827 * req_tx_status set in the transmit control fields. In addition, this should
828 * be called at least for all unicast frames to provide information for TX rate
829 * control algorithm. In order to maintain all statistics, this function is
830 * recommended to be called after each frame, including multicast/broadcast, is
832 void ieee80211_tx_status(struct ieee80211_hw *hw,
834 struct ieee80211_tx_status *status);
835 void ieee80211_tx_status_irqsafe(struct ieee80211_hw *hw,
837 struct ieee80211_tx_status *status);
840 * ieee80211_beacon_get - beacon generation function
841 * @hw: pointer obtained from ieee80211_alloc_hw().
842 * @if_id: interface ID from &struct ieee80211_if_init_conf.
843 * @control: will be filled with information needed to send this beacon.
845 * If the beacon frames are generated by the host system (i.e., not in
846 * hardware/firmware), the low-level driver uses this function to receive
847 * the next beacon frame from the 802.11 code. The low-level is responsible
848 * for calling this function before beacon data is needed (e.g., based on
849 * hardware interrupt). Returned skb is used only once and low-level driver
850 * is responsible of freeing it.
852 struct sk_buff *ieee80211_beacon_get(struct ieee80211_hw *hw,
854 struct ieee80211_tx_control *control);
857 * ieee80211_rts_get - RTS frame generation function
858 * @hw: pointer obtained from ieee80211_alloc_hw().
859 * @if_id: interface ID from &struct ieee80211_if_init_conf.
860 * @frame: pointer to the frame that is going to be protected by the RTS.
861 * @frame_len: the frame length (in octets).
862 * @frame_txctl: &struct ieee80211_tx_control of the frame.
863 * @rts: The buffer where to store the RTS frame.
865 * If the RTS frames are generated by the host system (i.e., not in
866 * hardware/firmware), the low-level driver uses this function to receive
867 * the next RTS frame from the 802.11 code. The low-level is responsible
868 * for calling this function before and RTS frame is needed.
870 void ieee80211_rts_get(struct ieee80211_hw *hw, int if_id,
871 const void *frame, size_t frame_len,
872 const struct ieee80211_tx_control *frame_txctl,
873 struct ieee80211_rts *rts);
876 * ieee80211_rts_duration - Get the duration field for an RTS frame
877 * @hw: pointer obtained from ieee80211_alloc_hw().
878 * @if_id: interface ID from &struct ieee80211_if_init_conf.
879 * @frame_len: the length of the frame that is going to be protected by the RTS.
880 * @frame_txctl: &struct ieee80211_tx_control of the frame.
882 * If the RTS is generated in firmware, but the host system must provide
883 * the duration field, the low-level driver uses this function to receive
884 * the duration field value in little-endian byteorder.
886 __le16 ieee80211_rts_duration(struct ieee80211_hw *hw, int if_id,
888 const struct ieee80211_tx_control *frame_txctl);
891 * ieee80211_ctstoself_get - CTS-to-self frame generation function
892 * @hw: pointer obtained from ieee80211_alloc_hw().
893 * @if_id: interface ID from &struct ieee80211_if_init_conf.
894 * @frame: pointer to the frame that is going to be protected by the CTS-to-self.
895 * @frame_len: the frame length (in octets).
896 * @frame_txctl: &struct ieee80211_tx_control of the frame.
897 * @cts: The buffer where to store the CTS-to-self frame.
899 * If the CTS-to-self frames are generated by the host system (i.e., not in
900 * hardware/firmware), the low-level driver uses this function to receive
901 * the next CTS-to-self frame from the 802.11 code. The low-level is responsible
902 * for calling this function before and CTS-to-self frame is needed.
904 void ieee80211_ctstoself_get(struct ieee80211_hw *hw, int if_id,
905 const void *frame, size_t frame_len,
906 const struct ieee80211_tx_control *frame_txctl,
907 struct ieee80211_cts *cts);
910 * ieee80211_ctstoself_duration - Get the duration field for a CTS-to-self frame
911 * @hw: pointer obtained from ieee80211_alloc_hw().
912 * @if_id: interface ID from &struct ieee80211_if_init_conf.
913 * @frame_len: the length of the frame that is going to be protected by the CTS-to-self.
914 * @frame_txctl: &struct ieee80211_tx_control of the frame.
916 * If the CTS-to-self is generated in firmware, but the host system must provide
917 * the duration field, the low-level driver uses this function to receive
918 * the duration field value in little-endian byteorder.
920 __le16 ieee80211_ctstoself_duration(struct ieee80211_hw *hw, int if_id,
922 const struct ieee80211_tx_control *frame_txctl);
925 * ieee80211_generic_frame_duration - Calculate the duration field for a frame
926 * @hw: pointer obtained from ieee80211_alloc_hw().
927 * @if_id: interface ID from &struct ieee80211_if_init_conf.
928 * @frame_len: the length of the frame.
929 * @rate: the rate (in 100kbps) at which the frame is going to be transmitted.
931 * Calculate the duration field of some generic frame, given its
932 * length and transmission rate (in 100kbps).
934 __le16 ieee80211_generic_frame_duration(struct ieee80211_hw *hw, int if_id,
939 * ieee80211_get_buffered_bc - accessing buffered broadcast and multicast frames
940 * @hw: pointer as obtained from ieee80211_alloc_hw().
941 * @if_id: interface ID from &struct ieee80211_if_init_conf.
942 * @control: will be filled with information needed to send returned frame.
944 * Function for accessing buffered broadcast and multicast frames. If
945 * hardware/firmware does not implement buffering of broadcast/multicast
946 * frames when power saving is used, 802.11 code buffers them in the host
947 * memory. The low-level driver uses this function to fetch next buffered
948 * frame. In most cases, this is used when generating beacon frame. This
949 * function returns a pointer to the next buffered skb or NULL if no more
950 * buffered frames are available.
952 * Note: buffered frames are returned only after DTIM beacon frame was
953 * generated with ieee80211_beacon_get() and the low-level driver must thus
954 * call ieee80211_beacon_get() first. ieee80211_get_buffered_bc() returns
955 * NULL if the previous generated beacon was not DTIM, so the low-level driver
956 * does not need to check for DTIM beacons separately and should be able to
957 * use common code for all beacons.
960 ieee80211_get_buffered_bc(struct ieee80211_hw *hw, int if_id,
961 struct ieee80211_tx_control *control);
963 /* Given an sk_buff with a raw 802.11 header at the data pointer this function
964 * returns the 802.11 header length in bytes (not including encryption
965 * headers). If the data in the sk_buff is too short to contain a valid 802.11
966 * header the function returns 0.
968 int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
970 /* Like ieee80211_get_hdrlen_from_skb() but takes a FC in CPU order. */
971 int ieee80211_get_hdrlen(u16 fc);
974 * ieee80211_wake_queue - wake specific queue
975 * @hw: pointer as obtained from ieee80211_alloc_hw().
976 * @queue: queue number (counted from zero).
978 * Drivers should use this function instead of netif_wake_queue.
980 void ieee80211_wake_queue(struct ieee80211_hw *hw, int queue);
983 * ieee80211_stop_queue - stop specific queue
984 * @hw: pointer as obtained from ieee80211_alloc_hw().
985 * @queue: queue number (counted from zero).
987 * Drivers should use this function instead of netif_stop_queue.
989 void ieee80211_stop_queue(struct ieee80211_hw *hw, int queue);
992 * ieee80211_start_queues - start all queues
993 * @hw: pointer to as obtained from ieee80211_alloc_hw().
995 * Drivers should use this function instead of netif_start_queue.
997 void ieee80211_start_queues(struct ieee80211_hw *hw);
1000 * ieee80211_stop_queues - stop all queues
1001 * @hw: pointer as obtained from ieee80211_alloc_hw().
1003 * Drivers should use this function instead of netif_stop_queue.
1005 void ieee80211_stop_queues(struct ieee80211_hw *hw);
1008 * ieee80211_wake_queues - wake all queues
1009 * @hw: pointer as obtained from ieee80211_alloc_hw().
1011 * Drivers should use this function instead of netif_wake_queue.
1013 void ieee80211_wake_queues(struct ieee80211_hw *hw);
1016 * ieee80211_get_mc_list_item - iteration over items in multicast list
1017 * @hw: pointer as obtained from ieee80211_alloc_hw().
1018 * @prev: value returned by previous call to ieee80211_get_mc_list_item() or
1019 * NULL to start a new iteration.
1020 * @ptr: pointer to buffer of void * type for internal usage of
1021 * ieee80211_get_mc_list_item().
1023 * Iterates over items in multicast list of given device. To get the first
1024 * item, pass NULL in @prev and in *@ptr. In subsequent calls, pass the
1025 * value returned by previous call in @prev. Don't alter *@ptr during
1026 * iteration. When there are no more items, NULL is returned.
1028 struct dev_mc_list *
1029 ieee80211_get_mc_list_item(struct ieee80211_hw *hw,
1030 struct dev_mc_list *prev,
1033 /* called by driver to notify scan status completed */
1034 void ieee80211_scan_completed(struct ieee80211_hw *hw);
1036 /* return a pointer to the source address (SA) */
1037 static inline u8 *ieee80211_get_SA(struct ieee80211_hdr *hdr)
1039 u8 *raw = (u8 *) hdr;
1040 u8 tofrom = (*(raw+1)) & 3; /* get the TODS and FROMDS bits */
1051 /* return a pointer to the destination address (DA) */
1052 static inline u8 *ieee80211_get_DA(struct ieee80211_hdr *hdr)
1054 u8 *raw = (u8 *) hdr;
1055 u8 to_ds = (*(raw+1)) & 1; /* get the TODS bit */
1062 static inline int ieee80211_get_morefrag(struct ieee80211_hdr *hdr)
1064 return (le16_to_cpu(hdr->frame_control) &
1065 IEEE80211_FCTL_MOREFRAGS) != 0;
1068 #define MAC_FMT "%02x:%02x:%02x:%02x:%02x:%02x"
1069 #define MAC_ARG(x) ((u8*)(x))[0], ((u8*)(x))[1], ((u8*)(x))[2], \
1070 ((u8*)(x))[3], ((u8*)(x))[4], ((u8*)(x))[5]
1072 #endif /* MAC80211_H */