2 * Copyright (c) 2002,2003 Oliver Kurth
3 * (c) 2003,2004 Joerg Albert <joerg.albert@gmx.de>
4 * (c) 2007 Guido Guenther <agx@sigxcpu.org>
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation; either version 2 of
9 * the License, or (at your option) any later version.
11 * This driver was based on information from the Sourceforge driver
12 * released and maintained by Atmel:
14 * http://sourceforge.net/projects/atmelwlandriver/
16 * Although the code was completely re-written,
17 * it would have been impossible without Atmel's decision to
18 * release an Open Source driver (unfortunately the firmware was
19 * kept binary only). Thanks for that decision to Atmel!
27 BOARD_503_ISL3861 = 1,
28 BOARD_503_ISL3863 = 2,
37 #define CMD_STATUS_IDLE 0x00
38 #define CMD_STATUS_COMPLETE 0x01
39 #define CMD_STATUS_UNKNOWN 0x02
40 #define CMD_STATUS_INVALID_PARAMETER 0x03
41 #define CMD_STATUS_FUNCTION_NOT_SUPPORTED 0x04
42 #define CMD_STATUS_TIME_OUT 0x07
43 #define CMD_STATUS_IN_PROGRESS 0x08
44 #define CMD_STATUS_HOST_FAILURE 0xff
45 #define CMD_STATUS_SCAN_FAILED 0xf0
47 /* answers to get op mode */
48 #define OPMODE_NONE 0x00
49 #define OPMODE_NORMAL_NIC_WITH_FLASH 0x01
50 #define OPMODE_HW_CONFIG_MODE 0x02
51 #define OPMODE_DFU_MODE_WITH_FLASH 0x03
52 #define OPMODE_NORMAL_NIC_WITHOUT_FLASH 0x04
54 #define CMD_SET_MIB 0x01
55 #define CMD_GET_MIB 0x02
58 #define CMD_START_IBSS 0x05
59 #define CMD_RADIO_ON 0x06
60 #define CMD_RADIO_OFF 0x07
61 #define CMD_STARTUP 0x0B
63 #define MIB_LOCAL 0x01
64 #define MIB_MAC_ADDR 0x02
66 #define MIB_MAC_MGMT 0x05
67 #define MIB_MAC_WEP 0x06
68 #define MIB_MAC_ENCRYPTION 0x06
70 #define MIB_FW_VERSION 0x08
71 #define MIB_MDOMAIN 0x09
74 #define INFRASTRUCTURE_MODE 2
76 /* values for struct mib_local, field preamble_type */
77 #define PREAMBLE_TYPE_LONG 0
78 #define PREAMBLE_TYPE_SHORT 1
79 #define PREAMBLE_TYPE_AUTO 2
81 /* values for tx_rate */
82 #define TX_RATE_1MBIT 0
83 #define TX_RATE_2MBIT 1
84 #define TX_RATE_5_5MBIT 2
85 #define TX_RATE_11MBIT 3
86 #define TX_RATE_AUTO 4
88 /* power management modes */
91 #define AT76_PM_SMART 3
93 /* cipher values for encryption keys */
94 #define CIPHER_NONE 0 /* this value is only guessed */
95 #define CIPHER_WEP64 1
98 #define CIPHER_CCX 4 /* for consistency sake only */
99 #define CIPHER_WEP128 5
101 /* bit flags key types for encryption keys */
102 #define KEY_PAIRWISE 2
105 #define CIPHER_KEYS (4)
106 #define CIPHER_KEY_LEN (40)
118 u8 mac_addr[ETH_ALEN];
119 u8 regulatory_domain;
123 } __attribute__((packed));
130 u8 mac_addr[ETH_ALEN];
131 u8 regulatory_domain;
132 u8 low_power_values[14];
133 u8 normal_power_values[14];
135 } __attribute__((packed));
137 struct hwcfg_intersil {
138 u8 mac_addr[ETH_ALEN];
142 u8 regulatory_domain;
144 } __attribute__((packed));
147 struct hwcfg_intersil i;
148 struct hwcfg_rfmd r3;
149 struct hwcfg_r505 r5;
152 #define WEP_SMALL_KEY_LEN (40 / 8)
153 #define WEP_LARGE_KEY_LEN (104 / 8)
158 struct at76_card_config {
159 u8 exclude_unencrypted;
161 u8 short_retry_limit;
163 __le16 rts_threshold;
164 __le16 fragmentation_threshold; /* 256..2346 */
165 u8 basic_rate_set[4];
166 u8 auto_rate_fallback; /* 0,1 */
169 u8 wep_default_key_id; /* 0..3 */
171 u8 wep_default_key_value[4][WEP_LARGE_KEY_LEN];
174 __le16 beacon_period;
175 } __attribute__((packed));
177 struct at76_command {
182 } __attribute__((packed));
184 /* Length of Atmel-specific Rx header before 802.11 frame */
185 #define AT76_RX_HDRLEN offsetof(struct at76_rx_buffer, packet)
187 struct at76_rx_buffer {
196 u8 packet[IEEE80211_MAX_FRAG_THRESHOLD];
197 } __attribute__((packed));
199 /* Length of Atmel-specific Tx header before 802.11 frame */
200 #define AT76_TX_HDRLEN offsetof(struct at76_tx_buffer, packet)
202 struct at76_tx_buffer {
210 u8 packet[IEEE80211_MAX_FRAG_THRESHOLD];
211 } __attribute__((packed));
213 /* defines for scan_type below */
214 #define SCAN_TYPE_ACTIVE 0
215 #define SCAN_TYPE_PASSIVE 1
217 struct at76_req_scan {
223 __le16 min_channel_time;
224 __le16 max_channel_time;
226 u8 international_scan;
227 } __attribute__((packed));
229 struct at76_req_ibss {
236 } __attribute__((packed));
238 struct at76_req_join {
246 } __attribute__((packed));
248 struct set_mib_buffer {
257 u8 data[256]; /* we need more space for mib_mac_encryption */
259 } __attribute__((packed));
264 u8 txautorate_fallback;
271 } __attribute__((packed));
273 struct mib_mac_addr {
274 u8 mac_addr[ETH_ALEN];
276 u8 group_addr[4][ETH_ALEN];
277 u8 group_addr_status[4];
278 } __attribute__((packed));
281 __le32 max_tx_msdu_lifetime;
282 __le32 max_rx_lifetime;
283 __le16 frag_threshold;
284 __le16 rts_threshold;
289 u8 scan_type; /* active or passive */
291 __le16 probe_delay; /* delay before ProbeReq in active scan, RO */
292 __le16 min_channel_time;
293 __le16 max_channel_time;
294 __le16 listen_interval;
296 u8 desired_bssid[ETH_ALEN];
297 u8 desired_bsstype; /* ad-hoc or infrastructure */
299 } __attribute__((packed));
301 struct mib_mac_mgmt {
302 __le16 beacon_period;
303 __le16 CFP_max_duration;
304 __le16 medium_occupancy_limit;
305 __le16 station_id; /* assoc id */
308 u8 privacy_option_implemented;
311 u8 current_bssid[ETH_ALEN];
312 u8 current_essid[32];
318 u8 multi_domain_capability_implemented;
319 u8 multi_domain_capability_enabled;
320 u8 country_string[3];
322 } __attribute__((packed));
325 u8 privacy_invoked; /* 0 disable encr., 1 enable encr */
326 u8 wep_default_key_id;
327 u8 wep_key_mapping_len;
328 u8 exclude_unencrypted;
329 __le32 wep_icv_error_count;
330 __le32 wep_excluded_count;
331 u8 wep_default_keyvalue[WEP_KEYS][WEP_LARGE_KEY_LEN];
332 u8 encryption_level; /* 1 for 40bit, 2 for 104bit encryption */
333 } __attribute__((packed));
335 struct mib_mac_encryption {
336 u8 cipher_default_keyvalue[CIPHER_KEYS][CIPHER_KEY_LEN];
339 u8 cipher_default_key_id;
340 u8 cipher_default_group_key_id;
341 u8 exclude_unencrypted;
342 u8 wep_encryption_type;
343 u8 ckip_key_permutation; /* bool */
344 __le32 wep_icv_error_count;
345 __le32 wep_excluded_count;
346 u8 key_rsc[CIPHER_KEYS][8];
347 } __attribute__((packed));
354 __le16 preamble_length;
355 __le16 plcp_header_length;
356 __le16 mpdu_max_length;
357 __le16 cca_mode_supported;
359 u8 operation_rate_set[4];
363 u8 current_reg_domain;
364 } __attribute__((packed));
366 struct mib_fw_version {
371 } __attribute__((packed));
374 u8 tx_powerlevel[14];
375 u8 channel_list[14]; /* 0 for invalid channels */
376 } __attribute__((packed));
378 struct at76_fw_header {
379 __le32 crc; /* CRC32 of the whole image */
380 __le32 board_type; /* firmware compatibility code */
381 u8 build; /* firmware build number */
382 u8 patch; /* firmware patch level */
383 u8 minor; /* firmware minor version */
384 u8 major; /* firmware major version */
385 __le32 str_offset; /* offset of the copyright string */
386 __le32 int_fw_offset; /* internal firmware image offset */
387 __le32 int_fw_len; /* internal firmware image length */
388 __le32 ext_fw_offset; /* external firmware image offset */
389 __le32 ext_fw_len; /* external firmware image length */
390 } __attribute__((packed));
392 /* a description of a regulatory domain and the allowed channels */
396 u32 channel_map; /* if bit N is set, channel (N+1) is allowed */
399 /* Data for one loaded firmware file */
401 const char *const fwname;
402 const struct firmware *fw;
405 /* pointer to loaded firmware, no need to free */
406 u8 *extfw; /* external firmware, extfw_size bytes long */
407 u8 *intfw; /* internal firmware, intfw_size bytes long */
408 enum board_type board_type; /* board type */
409 struct mib_fw_version fw_version;
410 int loaded; /* Loaded and parsed successfully */
414 struct usb_device *udev; /* USB device pointer */
416 struct sk_buff *rx_skb; /* skbuff for receiving data */
417 struct sk_buff *tx_skb; /* skbuff for transmitting data */
418 void *bulk_out_buffer; /* buffer for sending data */
420 struct urb *tx_urb; /* URB for sending data */
421 struct urb *rx_urb; /* URB for receiving data */
423 unsigned int tx_pipe; /* bulk out pipe */
424 unsigned int rx_pipe; /* bulk in pipe */
426 struct mutex mtx; /* locks this structure */
429 struct work_struct work_set_promisc;
430 struct work_struct work_submit_rx;
431 struct delayed_work dwork_hw_scan;
433 struct tasklet_struct rx_tasklet;
436 int wep_enabled; /* 1 if WEP is enabled */
437 int wep_key_id; /* key id to be used */
438 u8 wep_keys[WEP_KEYS][WEP_LARGE_KEY_LEN]; /* WEP keys */
439 u8 wep_keys_len[WEP_KEYS]; /* length of WEP keys */
444 u8 essid[IW_ESSID_MAX_SIZE];
449 int preamble_type; /* 0 - long, 1 - short, 2 - auto */
450 int auth_mode; /* authentication type: 0 open, 1 shared key */
451 int txrate; /* 0,1,2,3 = 1,2,5.5,11 Mbps, 4 is auto */
452 int frag_threshold; /* threshold for fragmentation of tx packets */
453 int rts_threshold; /* threshold for RTS mechanism */
454 int short_retry_limit;
456 int scan_min_time; /* scan min channel time */
457 int scan_max_time; /* scan max channel time */
458 int scan_mode; /* SCAN_TYPE_ACTIVE, SCAN_TYPE_PASSIVE */
459 int scan_need_any; /* if set, need to scan for any ESSID */
461 u16 assoc_id; /* current association ID, if associated */
463 u8 pm_mode; /* power management mode */
464 u32 pm_period; /* power management period in microseconds */
466 struct reg_domain const *domain; /* reg domain description */
468 /* These fields contain HW config provided by the device (not all of
469 * these fields are used by all board types) */
470 u8 mac_addr[ETH_ALEN];
471 u8 regulatory_domain;
473 struct at76_card_config card_config;
475 enum board_type board_type;
476 struct mib_fw_version fw_version;
478 unsigned int device_unplugged:1;
479 unsigned int netdev_registered:1;
480 struct set_mib_buffer mib_buf; /* global buffer for set_mib calls */
482 int beacon_period; /* period of mgmt beacons, Kus */
484 struct ieee80211_hw *hw;
485 int mac80211_registered;
487 struct key_config keys[4]; /* installed key types */
488 u8 default_pairwise_key;
489 u8 default_group_key;
492 #define AT76_SUPPORTED_FILTERS FIF_PROMISC_IN_BSS
494 #define SCAN_POLL_INTERVAL (HZ / 4)
496 #define CMD_COMPLETION_TIMEOUT (5 * HZ)
498 #define DEF_RTS_THRESHOLD 1536
499 #define DEF_FRAG_THRESHOLD 1536
500 #define DEF_SHORT_RETRY_LIMIT 8
501 #define DEF_CHANNEL 10
502 #define DEF_SCAN_MIN_TIME 10
503 #define DEF_SCAN_MAX_TIME 120
505 /* the max padding size for tx in bytes (see calc_padding) */
506 #define MAX_PADDING_SIZE 53
508 #endif /* _AT76_USB_H */