release/src-rt-6.x.4708/linux/linux-2.6.36/drivers/net/wireless/zd1211rw/zd_usb.h

   1 /* ZD1211 USB-WLAN driver for Linux
   2  *
   3  * Copyright (C) 2005-2007 Ulrich Kunitz <kune@deine-taler.de>
   4  * Copyright (C) 2006-2007 Daniel Drake <dsd@gentoo.org>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  19  */
  20
  21 #ifndef _ZD_USB_H
  22 #define _ZD_USB_H
  23
  24 #include <linux/completion.h>
  25 #include <linux/netdevice.h>
  26 #include <linux/spinlock.h>
  27 #include <linux/skbuff.h>
  28 #include <linux/usb.h>
  29
  30 #include "zd_def.h"
  31
  32 #define ZD_USB_TX_HIGH  5
  33 #define ZD_USB_TX_LOW   2
  34
  35 enum devicetype {
  36         DEVICE_ZD1211  = 0,
  37         DEVICE_ZD1211B = 1,
  38         DEVICE_INSTALLER = 2,
  39 };
  40
  41 enum endpoints {
  42         EP_CTRL     = 0,
  43         EP_DATA_OUT = 1,
  44         EP_DATA_IN  = 2,
  45         EP_INT_IN   = 3,
  46         EP_REGS_OUT = 4,
  47 };
  48
  49 enum {
  50         USB_MAX_TRANSFER_SIZE           = 4096, /* bytes */
  51         USB_MAX_RX_SIZE                 = 4800, /* bytes */
  52         USB_MAX_IOWRITE16_COUNT         = 15,
  53         USB_MAX_IOWRITE32_COUNT         = USB_MAX_IOWRITE16_COUNT/2,
  54         USB_MAX_IOREAD16_COUNT          = 15,
  55         USB_MAX_IOREAD32_COUNT          = USB_MAX_IOREAD16_COUNT/2,
  56         USB_MIN_RFWRITE_BIT_COUNT       = 16,
  57         USB_MAX_RFWRITE_BIT_COUNT       = 28,
  58         USB_MAX_EP_INT_BUFFER           = 64,
  59         USB_ZD1211B_BCD_DEVICE          = 0x4810,
  60 };
  61
  62 enum control_requests {
  63         USB_REQ_WRITE_REGS              = 0x21,
  64         USB_REQ_READ_REGS               = 0x22,
  65         USB_REQ_WRITE_RF                = 0x23,
  66         USB_REQ_PROG_FLASH              = 0x24,
  67         USB_REQ_EEPROM_START            = 0x0128, /* ? request is a byte */
  68         USB_REQ_EEPROM_MID              = 0x28,
  69         USB_REQ_EEPROM_END              = 0x0228, /* ? request is a byte */
  70         USB_REQ_FIRMWARE_DOWNLOAD       = 0x30,
  71         USB_REQ_FIRMWARE_CONFIRM        = 0x31,
  72         USB_REQ_FIRMWARE_READ_DATA      = 0x32,
  73 };
  74
  75 struct usb_req_read_regs {
  76         __le16 id;
  77         __le16 addr[0];
  78 } __packed;
  79
  80 struct reg_data {
  81         __le16 addr;
  82         __le16 value;
  83 } __packed;
  84
  85 struct usb_req_write_regs {
  86         __le16 id;
  87         struct reg_data reg_writes[0];
  88 } __packed;
  89
  90 enum {
  91         RF_IF_LE = 0x02,
  92         RF_CLK   = 0x04,
  93         RF_DATA  = 0x08,
  94 };
  95
  96 struct usb_req_rfwrite {
  97         __le16 id;
  98         __le16 value;
  99         /* 1: 3683a */
 100         /* 2: other (default) */
 101         __le16 bits;
 102         /* RF2595: 24 */
 103         __le16 bit_values[0];
 104         /* (CR203 & ~(RF_IF_LE | RF_CLK | RF_DATA)) | (bit ? RF_DATA : 0) */
 105 } __packed;
 106
 107 /* USB interrupt */
 108
 109 enum usb_int_id {
 110         USB_INT_TYPE                    = 0x01,
 111         USB_INT_ID_REGS                 = 0x90,
 112         USB_INT_ID_RETRY_FAILED         = 0xa0,
 113 };
 114
 115 enum usb_int_flags {
 116         USB_INT_READ_REGS_EN            = 0x01,
 117 };
 118
 119 struct usb_int_header {
 120         u8 type;        /* must always be 1 */
 121         u8 id;
 122 } __packed;
 123
 124 struct usb_int_regs {
 125         struct usb_int_header hdr;
 126         struct reg_data regs[0];
 127 } __packed;
 128
 129 struct usb_int_retry_fail {
 130         struct usb_int_header hdr;
 131         u8 new_rate;
 132         u8 _dummy;
 133         u8 addr[ETH_ALEN];
 134         u8 ibss_wakeup_dest;
 135 } __packed;
 136
 137 struct read_regs_int {
 138         struct completion completion;
 139         /* Stores the USB int structure and contains the USB address of the
 140          * first requested register before request.
 141          */
 142         u8 buffer[USB_MAX_EP_INT_BUFFER];
 143         int length;
 144         __le16 cr_int_addr;
 145 };
 146
 147 struct zd_ioreq16 {
 148         zd_addr_t addr;
 149         u16 value;
 150 };
 151
 152 struct zd_ioreq32 {
 153         zd_addr_t addr;
 154         u32 value;
 155 };
 156
 157 struct zd_usb_interrupt {
 158         struct read_regs_int read_regs;
 159         spinlock_t lock;
 160         struct urb *urb;
 161         int interval;
 162         u8 read_regs_enabled:1;
 163 };
 164
 165 static inline struct usb_int_regs *get_read_regs(struct zd_usb_interrupt *intr)
 166 {
 167         return (struct usb_int_regs *)intr->read_regs.buffer;
 168 }
 169
 170 #define RX_URBS_COUNT 5
 171
 172 struct zd_usb_rx {
 173         spinlock_t lock;
 174         u8 fragment[2*USB_MAX_RX_SIZE];
 175         unsigned int fragment_length;
 176         unsigned int usb_packet_size;
 177         struct urb **urbs;
 178         int urbs_count;
 179 };
 180
 181 /**
 182  * struct zd_usb_tx - structure used for transmitting frames
 183  * @lock: lock for transmission
 184  * @free_urb_list: list of free URBs, contains all the URBs, which can be used
 185  * @submitted_urbs: atomic integer that counts the URBs having sent to the
 186  *      device, which haven't been completed
 187  * @enabled: enabled flag, indicates whether tx is enabled
 188  * @stopped: indicates whether higher level tx queues are stopped
 189  */
 190 struct zd_usb_tx {
 191         spinlock_t lock;
 192         struct list_head free_urb_list;
 193         int submitted_urbs;
 194         int enabled;
 195         int stopped;
 196 };
 197
 198 /* Contains the usb parts. The structure doesn't require a lock because intf
 199  * will not be changed after initialization.
 200  */
 201 struct zd_usb {
 202         struct zd_usb_interrupt intr;
 203         struct zd_usb_rx rx;
 204         struct zd_usb_tx tx;
 205         struct usb_interface *intf;
 206         u8 is_zd1211b:1, initialized:1;
 207 };
 208
 209 #define zd_usb_dev(usb) (&usb->intf->dev)
 210
 211 static inline struct usb_device *zd_usb_to_usbdev(struct zd_usb *usb)
 212 {
 213         return interface_to_usbdev(usb->intf);
 214 }
 215
 216 static inline struct ieee80211_hw *zd_intf_to_hw(struct usb_interface *intf)
 217 {
 218         return usb_get_intfdata(intf);
 219 }
 220
 221 static inline struct ieee80211_hw *zd_usb_to_hw(struct zd_usb *usb)
 222 {
 223         return zd_intf_to_hw(usb->intf);
 224 }
 225
 226 void zd_usb_init(struct zd_usb *usb, struct ieee80211_hw *hw,
 227                  struct usb_interface *intf);
 228 int zd_usb_init_hw(struct zd_usb *usb);
 229 void zd_usb_clear(struct zd_usb *usb);
 230
 231 int zd_usb_scnprint_id(struct zd_usb *usb, char *buffer, size_t size);
 232
 233 int zd_usb_enable_int(struct zd_usb *usb);
 234 void zd_usb_disable_int(struct zd_usb *usb);
 235
 236 int zd_usb_enable_rx(struct zd_usb *usb);
 237 void zd_usb_disable_rx(struct zd_usb *usb);
 238
 239 void zd_usb_enable_tx(struct zd_usb *usb);
 240 void zd_usb_disable_tx(struct zd_usb *usb);
 241
 242 int zd_usb_tx(struct zd_usb *usb, struct sk_buff *skb);
 243
 244 int zd_usb_ioread16v(struct zd_usb *usb, u16 *values,
 245                  const zd_addr_t *addresses, unsigned int count);
 246
 247 static inline int zd_usb_ioread16(struct zd_usb *usb, u16 *value,
 248                               const zd_addr_t addr)
 249 {
 250         return zd_usb_ioread16v(usb, value, (const zd_addr_t *)&addr, 1);
 251 }
 252
 253 int zd_usb_iowrite16v(struct zd_usb *usb, const struct zd_ioreq16 *ioreqs,
 254                       unsigned int count);
 255
 256 int zd_usb_rfwrite(struct zd_usb *usb, u32 value, u8 bits);
 257
 258 int zd_usb_read_fw(struct zd_usb *usb, zd_addr_t addr, u8 *data, u16 len);
 259
 260 extern struct workqueue_struct *zd_workqueue;
 261
 262 #endif /* _ZD_USB_H */