drivers/net/wireless/at76c50x-usb.h

   1 /*
   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>
   5  *
   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.
  10  *
  11  * This driver was based on information from the Sourceforge driver
  12  * released and maintained by Atmel:
  13  *
  14  *  http://sourceforge.net/projects/atmelwlandriver/
  15  *
  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!
  20  */
  21
  22 #ifndef _AT76_USB_H
  23 #define _AT76_USB_H
  24
  25 /* Board types */
  26 enum board_type {
  27         BOARD_503_ISL3861 = 1,
  28         BOARD_503_ISL3863 = 2,
  29         BOARD_503 = 3,
  30         BOARD_503_ACC = 4,
  31         BOARD_505 = 5,
  32         BOARD_505_2958 = 6,
  33         BOARD_505A = 7,
  34         BOARD_505AMX = 8
  35 };
  36
  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
  46
  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
  53
  54 #define CMD_SET_MIB             0x01
  55 #define CMD_GET_MIB             0x02
  56 #define CMD_SCAN                0x03
  57 #define CMD_JOIN                0x04
  58 #define CMD_START_IBSS          0x05
  59 #define CMD_RADIO_ON            0x06
  60 #define CMD_RADIO_OFF           0x07
  61 #define CMD_STARTUP             0x0B
  62
  63 #define MIB_LOCAL               0x01
  64 #define MIB_MAC_ADDR            0x02
  65 #define MIB_MAC                 0x03
  66 #define MIB_MAC_MGMT            0x05
  67 #define MIB_MAC_WEP             0x06
  68 #define MIB_PHY                 0x07
  69 #define MIB_FW_VERSION          0x08
  70 #define MIB_MDOMAIN             0x09
  71
  72 #define ADHOC_MODE              1
  73 #define INFRASTRUCTURE_MODE     2
  74
  75 /* values for struct mib_local, field preamble_type */
  76 #define PREAMBLE_TYPE_LONG      0
  77 #define PREAMBLE_TYPE_SHORT     1
  78 #define PREAMBLE_TYPE_AUTO      2
  79
  80 /* values for tx_rate */
  81 #define TX_RATE_1MBIT           0
  82 #define TX_RATE_2MBIT           1
  83 #define TX_RATE_5_5MBIT         2
  84 #define TX_RATE_11MBIT          3
  85 #define TX_RATE_AUTO            4
  86
  87 /* power management modes */
  88 #define AT76_PM_OFF             1
  89 #define AT76_PM_ON              2
  90 #define AT76_PM_SMART           3
  91
  92 struct hwcfg_r505 {
  93         u8 cr39_values[14];
  94         u8 reserved1[14];
  95         u8 bb_cr[14];
  96         u8 pidvid[4];
  97         u8 mac_addr[ETH_ALEN];
  98         u8 regulatory_domain;
  99         u8 reserved2[14];
 100         u8 cr15_values[14];
 101         u8 reserved3[3];
 102 } __attribute__((packed));
 103
 104 struct hwcfg_rfmd {
 105         u8 cr20_values[14];
 106         u8 cr21_values[14];
 107         u8 bb_cr[14];
 108         u8 pidvid[4];
 109         u8 mac_addr[ETH_ALEN];
 110         u8 regulatory_domain;
 111         u8 low_power_values[14];
 112         u8 normal_power_values[14];
 113         u8 reserved1[3];
 114 } __attribute__((packed));
 115
 116 struct hwcfg_intersil {
 117         u8 mac_addr[ETH_ALEN];
 118         u8 cr31_values[14];
 119         u8 cr58_values[14];
 120         u8 pidvid[4];
 121         u8 regulatory_domain;
 122         u8 reserved[1];
 123 } __attribute__((packed));
 124
 125 union at76_hwcfg {
 126         struct hwcfg_intersil i;
 127         struct hwcfg_rfmd r3;
 128         struct hwcfg_r505 r5;
 129 };
 130
 131 #define WEP_SMALL_KEY_LEN       (40 / 8)
 132 #define WEP_LARGE_KEY_LEN       (104 / 8)
 133 #define WEP_KEYS                (4)
 134
 135 struct at76_card_config {
 136         u8 exclude_unencrypted;
 137         u8 promiscuous_mode;
 138         u8 short_retry_limit;
 139         u8 encryption_type;
 140         __le16 rts_threshold;
 141         __le16 fragmentation_threshold; /* 256..2346 */
 142         u8 basic_rate_set[4];
 143         u8 auto_rate_fallback;  /* 0,1 */
 144         u8 channel;
 145         u8 privacy_invoked;
 146         u8 wep_default_key_id;  /* 0..3 */
 147         u8 current_ssid[32];
 148         u8 wep_default_key_value[4][WEP_LARGE_KEY_LEN];
 149         u8 ssid_len;
 150         u8 short_preamble;
 151         __le16 beacon_period;
 152 } __attribute__((packed));
 153
 154 struct at76_command {
 155         u8 cmd;
 156         u8 reserved;
 157         __le16 size;
 158         u8 data[0];
 159 } __attribute__((packed));
 160
 161 /* Length of Atmel-specific Rx header before 802.11 frame */
 162 #define AT76_RX_HDRLEN offsetof(struct at76_rx_buffer, packet)
 163
 164 struct at76_rx_buffer {
 165         __le16 wlength;
 166         u8 rx_rate;
 167         u8 newbss;
 168         u8 fragmentation;
 169         u8 rssi;
 170         u8 link_quality;
 171         u8 noise_level;
 172         __le32 rx_time;
 173         u8 packet[IEEE80211_MAX_FRAG_THRESHOLD];
 174 } __attribute__((packed));
 175
 176 /* Length of Atmel-specific Tx header before 802.11 frame */
 177 #define AT76_TX_HDRLEN offsetof(struct at76_tx_buffer, packet)
 178
 179 struct at76_tx_buffer {
 180         __le16 wlength;
 181         u8 tx_rate;
 182         u8 padding;
 183         u8 reserved[4];
 184         u8 packet[IEEE80211_MAX_FRAG_THRESHOLD];
 185 } __attribute__((packed));
 186
 187 /* defines for scan_type below */
 188 #define SCAN_TYPE_ACTIVE        0
 189 #define SCAN_TYPE_PASSIVE       1
 190
 191 struct at76_req_scan {
 192         u8 bssid[ETH_ALEN];
 193         u8 essid[32];
 194         u8 scan_type;
 195         u8 channel;
 196         __le16 probe_delay;
 197         __le16 min_channel_time;
 198         __le16 max_channel_time;
 199         u8 essid_size;
 200         u8 international_scan;
 201 } __attribute__((packed));
 202
 203 struct at76_req_ibss {
 204         u8 bssid[ETH_ALEN];
 205         u8 essid[32];
 206         u8 bss_type;
 207         u8 channel;
 208         u8 essid_size;
 209         u8 reserved[3];
 210 } __attribute__((packed));
 211
 212 struct at76_req_join {
 213         u8 bssid[ETH_ALEN];
 214         u8 essid[32];
 215         u8 bss_type;
 216         u8 channel;
 217         __le16 timeout;
 218         u8 essid_size;
 219         u8 reserved;
 220 } __attribute__((packed));
 221
 222 struct set_mib_buffer {
 223         u8 type;
 224         u8 size;
 225         u8 index;
 226         u8 reserved;
 227         union {
 228                 u8 byte;
 229                 __le16 word;
 230                 u8 addr[ETH_ALEN];
 231         } data;
 232 } __attribute__((packed));
 233
 234 struct mib_local {
 235         u16 reserved0;
 236         u8 beacon_enable;
 237         u8 txautorate_fallback;
 238         u8 reserved1;
 239         u8 ssid_size;
 240         u8 promiscuous_mode;
 241         u16 reserved2;
 242         u8 preamble_type;
 243         u16 reserved3;
 244 } __attribute__((packed));
 245
 246 struct mib_mac_addr {
 247         u8 mac_addr[ETH_ALEN];
 248         u8 res[2];              /* ??? */
 249         u8 group_addr[4][ETH_ALEN];
 250         u8 group_addr_status[4];
 251 } __attribute__((packed));
 252
 253 struct mib_mac {
 254         __le32 max_tx_msdu_lifetime;
 255         __le32 max_rx_lifetime;
 256         __le16 frag_threshold;
 257         __le16 rts_threshold;
 258         __le16 cwmin;
 259         __le16 cwmax;
 260         u8 short_retry_time;
 261         u8 long_retry_time;
 262         u8 scan_type;           /* active or passive */
 263         u8 scan_channel;
 264         __le16 probe_delay;     /* delay before ProbeReq in active scan, RO */
 265         __le16 min_channel_time;
 266         __le16 max_channel_time;
 267         __le16 listen_interval;
 268         u8 desired_ssid[32];
 269         u8 desired_bssid[ETH_ALEN];
 270         u8 desired_bsstype;     /* ad-hoc or infrastructure */
 271         u8 reserved2;
 272 } __attribute__((packed));
 273
 274 struct mib_mac_mgmt {
 275         __le16 beacon_period;
 276         __le16 CFP_max_duration;
 277         __le16 medium_occupancy_limit;
 278         __le16 station_id;      /* assoc id */
 279         __le16 ATIM_window;
 280         u8 CFP_mode;
 281         u8 privacy_option_implemented;
 282         u8 DTIM_period;
 283         u8 CFP_period;
 284         u8 current_bssid[ETH_ALEN];
 285         u8 current_essid[32];
 286         u8 current_bss_type;
 287         u8 power_mgmt_mode;
 288         /* rfmd and 505 */
 289         u8 ibss_change;
 290         u8 res;
 291         u8 multi_domain_capability_implemented;
 292         u8 multi_domain_capability_enabled;
 293         u8 country_string[3];
 294         u8 reserved[3];
 295 } __attribute__((packed));
 296
 297 struct mib_mac_wep {
 298         u8 privacy_invoked;     /* 0 disable encr., 1 enable encr */
 299         u8 wep_default_key_id;
 300         u8 wep_key_mapping_len;
 301         u8 exclude_unencrypted;
 302         __le32 wep_icv_error_count;
 303         __le32 wep_excluded_count;
 304         u8 wep_default_keyvalue[WEP_KEYS][WEP_LARGE_KEY_LEN];
 305         u8 encryption_level;    /* 1 for 40bit, 2 for 104bit encryption */
 306 } __attribute__((packed));
 307
 308 struct mib_phy {
 309         __le32 ed_threshold;
 310
 311         __le16 slot_time;
 312         __le16 sifs_time;
 313         __le16 preamble_length;
 314         __le16 plcp_header_length;
 315         __le16 mpdu_max_length;
 316         __le16 cca_mode_supported;
 317
 318         u8 operation_rate_set[4];
 319         u8 channel_id;
 320         u8 current_cca_mode;
 321         u8 phy_type;
 322         u8 current_reg_domain;
 323 } __attribute__((packed));
 324
 325 struct mib_fw_version {
 326         u8 major;
 327         u8 minor;
 328         u8 patch;
 329         u8 build;
 330 } __attribute__((packed));
 331
 332 struct mib_mdomain {
 333         u8 tx_powerlevel[14];
 334         u8 channel_list[14];    /* 0 for invalid channels */
 335 } __attribute__((packed));
 336
 337 struct at76_fw_header {
 338         __le32 crc;             /* CRC32 of the whole image */
 339         __le32 board_type;      /* firmware compatibility code */
 340         u8 build;               /* firmware build number */
 341         u8 patch;               /* firmware patch level */
 342         u8 minor;               /* firmware minor version */
 343         u8 major;               /* firmware major version */
 344         __le32 str_offset;      /* offset of the copyright string */
 345         __le32 int_fw_offset;   /* internal firmware image offset */
 346         __le32 int_fw_len;      /* internal firmware image length */
 347         __le32 ext_fw_offset;   /* external firmware image offset */
 348         __le32 ext_fw_len;      /* external firmware image length */
 349 } __attribute__((packed));
 350
 351 /* a description of a regulatory domain and the allowed channels */
 352 struct reg_domain {
 353         u16 code;
 354         char const *name;
 355         u32 channel_map;        /* if bit N is set, channel (N+1) is allowed */
 356 };
 357
 358 /* Data for one loaded firmware file */
 359 struct fwentry {
 360         const char *const fwname;
 361         const struct firmware *fw;
 362         int extfw_size;
 363         int intfw_size;
 364         /* pointer to loaded firmware, no need to free */
 365         u8 *extfw;              /* external firmware, extfw_size bytes long */
 366         u8 *intfw;              /* internal firmware, intfw_size bytes long */
 367         enum board_type board_type;     /* board type */
 368         struct mib_fw_version fw_version;
 369         int loaded;             /* Loaded and parsed successfully */
 370 };
 371
 372 struct at76_priv {
 373         struct usb_device *udev;        /* USB device pointer */
 374
 375         struct sk_buff *rx_skb; /* skbuff for receiving data */
 376         struct sk_buff *tx_skb; /* skbuff for transmitting data */
 377         void *bulk_out_buffer;  /* buffer for sending data */
 378
 379         struct urb *tx_urb;     /* URB for sending data */
 380         struct urb *rx_urb;     /* URB for receiving data */
 381
 382         unsigned int tx_pipe;   /* bulk out pipe */
 383         unsigned int rx_pipe;   /* bulk in pipe */
 384
 385         struct mutex mtx;       /* locks this structure */
 386
 387         /* work queues */
 388         struct work_struct work_set_promisc;
 389         struct work_struct work_submit_rx;
 390         struct delayed_work dwork_hw_scan;
 391
 392         struct tasklet_struct rx_tasklet;
 393
 394         /* the WEP stuff */
 395         int wep_enabled;        /* 1 if WEP is enabled */
 396         int wep_key_id;         /* key id to be used */
 397         u8 wep_keys[WEP_KEYS][WEP_LARGE_KEY_LEN];       /* WEP keys */
 398         u8 wep_keys_len[WEP_KEYS];      /* length of WEP keys */
 399
 400         int channel;
 401         int iw_mode;
 402         u8 bssid[ETH_ALEN];
 403         u8 essid[IW_ESSID_MAX_SIZE];
 404         int essid_size;
 405         int radio_on;
 406         int promisc;
 407
 408         int preamble_type;      /* 0 - long, 1 - short, 2 - auto */
 409         int auth_mode;          /* authentication type: 0 open, 1 shared key */
 410         int txrate;             /* 0,1,2,3 = 1,2,5.5,11 Mbps, 4 is auto */
 411         int frag_threshold;     /* threshold for fragmentation of tx packets */
 412         int rts_threshold;      /* threshold for RTS mechanism */
 413         int short_retry_limit;
 414
 415         int scan_min_time;      /* scan min channel time */
 416         int scan_max_time;      /* scan max channel time */
 417         int scan_mode;          /* SCAN_TYPE_ACTIVE, SCAN_TYPE_PASSIVE */
 418         int scan_need_any;      /* if set, need to scan for any ESSID */
 419
 420         u16 assoc_id;           /* current association ID, if associated */
 421
 422         u8 pm_mode;             /* power management mode */
 423         u32 pm_period;          /* power management period in microseconds */
 424
 425         struct reg_domain const *domain;        /* reg domain description */
 426
 427         /* These fields contain HW config provided by the device (not all of
 428          * these fields are used by all board types) */
 429         u8 mac_addr[ETH_ALEN];
 430         u8 regulatory_domain;
 431
 432         struct at76_card_config card_config;
 433
 434         enum board_type board_type;
 435         struct mib_fw_version fw_version;
 436
 437         unsigned int device_unplugged:1;
 438         unsigned int netdev_registered:1;
 439         struct set_mib_buffer mib_buf;  /* global buffer for set_mib calls */
 440
 441         int beacon_period;      /* period of mgmt beacons, Kus */
 442
 443         struct ieee80211_hw *hw;
 444         int mac80211_registered;
 445 };
 446
 447 #define AT76_SUPPORTED_FILTERS FIF_PROMISC_IN_BSS
 448
 449 #define SCAN_POLL_INTERVAL      (HZ / 4)
 450
 451 #define CMD_COMPLETION_TIMEOUT  (5 * HZ)
 452
 453 #define DEF_RTS_THRESHOLD       1536
 454 #define DEF_FRAG_THRESHOLD      1536
 455 #define DEF_SHORT_RETRY_LIMIT   8
 456 #define DEF_CHANNEL             10
 457 #define DEF_SCAN_MIN_TIME       10
 458 #define DEF_SCAN_MAX_TIME       120
 459
 460 /* the max padding size for tx in bytes (see calc_padding) */
 461 #define MAX_PADDING_SIZE        53
 462
 463 #endif                          /* _AT76_USB_H */