1 /* ZD1211 USB-WLAN driver for Linux
3 * Copyright (C) 2005-2007 Ulrich Kunitz <kune@deine-taler.de>
4 * Copyright (C) 2006-2007 Daniel Drake <dsd@gentoo.org>
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.
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.
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
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>
32 #define ZD_USB_TX_HIGH 5
33 #define ZD_USB_TX_LOW 2
35 #define ZD_TX_TIMEOUT (HZ * 5)
36 #define ZD_TX_WATCHDOG_INTERVAL round_jiffies_relative(HZ)
37 #define ZD_RX_IDLE_INTERVAL round_jiffies_relative(30 * HZ)
54 USB_MAX_TRANSFER_SIZE = 4096, /* bytes */
55 /* FIXME: The original driver uses this value. We have to check,
56 * whether the MAX_TRANSFER_SIZE is sufficient and this needs only be
57 * used if one combined frame is split over two USB transactions.
59 USB_MAX_RX_SIZE = 4800, /* bytes */
60 USB_MAX_IOWRITE16_COUNT = 15,
61 USB_MAX_IOWRITE32_COUNT = USB_MAX_IOWRITE16_COUNT/2,
62 USB_MAX_IOREAD16_COUNT = 15,
63 USB_MAX_IOREAD32_COUNT = USB_MAX_IOREAD16_COUNT/2,
64 USB_MIN_RFWRITE_BIT_COUNT = 16,
65 USB_MAX_RFWRITE_BIT_COUNT = 28,
66 USB_MAX_EP_INT_BUFFER = 64,
67 USB_ZD1211B_BCD_DEVICE = 0x4810,
70 enum control_requests {
71 USB_REQ_WRITE_REGS = 0x21,
72 USB_REQ_READ_REGS = 0x22,
73 USB_REQ_WRITE_RF = 0x23,
74 USB_REQ_PROG_FLASH = 0x24,
75 USB_REQ_EEPROM_START = 0x0128, /* ? request is a byte */
76 USB_REQ_EEPROM_MID = 0x28,
77 USB_REQ_EEPROM_END = 0x0228, /* ? request is a byte */
78 USB_REQ_FIRMWARE_DOWNLOAD = 0x30,
79 USB_REQ_FIRMWARE_CONFIRM = 0x31,
80 USB_REQ_FIRMWARE_READ_DATA = 0x32,
83 struct usb_req_read_regs {
93 struct usb_req_write_regs {
95 struct reg_data reg_writes[0];
104 struct usb_req_rfwrite {
108 /* 2: other (default) */
111 __le16 bit_values[0];
112 /* (ZD_CR203 & ~(RF_IF_LE | RF_CLK | RF_DATA)) | (bit ? RF_DATA : 0) */
119 USB_INT_ID_REGS = 0x90,
120 USB_INT_ID_RETRY_FAILED = 0xa0,
124 USB_INT_READ_REGS_EN = 0x01,
127 struct usb_int_header {
128 u8 type; /* must always be 1 */
132 struct usb_int_regs {
133 struct usb_int_header hdr;
134 struct reg_data regs[0];
137 struct usb_int_retry_fail {
138 struct usb_int_header hdr;
145 struct read_regs_int {
146 struct completion completion;
147 /* Stores the USB int structure and contains the USB address of the
148 * first requested register before request.
150 u8 buffer[USB_MAX_EP_INT_BUFFER];
165 struct zd_usb_interrupt {
166 struct read_regs_int read_regs;
170 dma_addr_t buffer_dma;
172 u8 read_regs_enabled:1;
175 static inline struct usb_int_regs *get_read_regs(struct zd_usb_interrupt *intr)
177 return (struct usb_int_regs *)intr->read_regs.buffer;
180 #define RX_URBS_COUNT 5
184 struct mutex setup_mutex;
185 struct delayed_work idle_work;
186 u8 fragment[2 * USB_MAX_RX_SIZE];
187 unsigned int fragment_length;
188 unsigned int usb_packet_size;
194 * struct zd_usb_tx - structure used for transmitting frames
195 * @enabled: atomic enabled flag, indicates whether tx is enabled
196 * @lock: lock for transmission
197 * @submitted: anchor for URBs sent to device
198 * @submitted_urbs: atomic integer that counts the URBs having sent to the
199 * device, which haven't been completed
200 * @stopped: indicates whether higher level tx queues are stopped
205 struct delayed_work watchdog_work;
206 struct sk_buff_head submitted_skbs;
207 struct usb_anchor submitted;
209 u8 stopped:1, watchdog_enabled:1;
212 /* Contains the usb parts. The structure doesn't require a lock because intf
213 * will not be changed after initialization.
216 struct zd_usb_interrupt intr;
219 struct usb_interface *intf;
220 struct usb_anchor submitted_cmds;
221 struct urb *urb_async_waiting;
223 u8 req_buf[64]; /* zd_usb_iowrite16v needs 62 bytes */
224 u8 is_zd1211b:1, initialized:1, was_running:1, in_async:1;
227 #define zd_usb_dev(usb) (&usb->intf->dev)
229 static inline struct usb_device *zd_usb_to_usbdev(struct zd_usb *usb)
231 return interface_to_usbdev(usb->intf);
234 static inline struct ieee80211_hw *zd_intf_to_hw(struct usb_interface *intf)
236 return usb_get_intfdata(intf);
239 static inline struct ieee80211_hw *zd_usb_to_hw(struct zd_usb *usb)
241 return zd_intf_to_hw(usb->intf);
244 void zd_usb_init(struct zd_usb *usb, struct ieee80211_hw *hw,
245 struct usb_interface *intf);
246 int zd_usb_init_hw(struct zd_usb *usb);
247 void zd_usb_clear(struct zd_usb *usb);
249 int zd_usb_scnprint_id(struct zd_usb *usb, char *buffer, size_t size);
251 void zd_tx_watchdog_enable(struct zd_usb *usb);
252 void zd_tx_watchdog_disable(struct zd_usb *usb);
254 int zd_usb_enable_int(struct zd_usb *usb);
255 void zd_usb_disable_int(struct zd_usb *usb);
257 int zd_usb_enable_rx(struct zd_usb *usb);
258 void zd_usb_disable_rx(struct zd_usb *usb);
260 void zd_usb_reset_rx_idle_timer(struct zd_usb *usb);
262 void zd_usb_enable_tx(struct zd_usb *usb);
263 void zd_usb_disable_tx(struct zd_usb *usb);
265 int zd_usb_tx(struct zd_usb *usb, struct sk_buff *skb);
267 int zd_usb_ioread16v(struct zd_usb *usb, u16 *values,
268 const zd_addr_t *addresses, unsigned int count);
270 static inline int zd_usb_ioread16(struct zd_usb *usb, u16 *value,
271 const zd_addr_t addr)
273 return zd_usb_ioread16v(usb, value, (const zd_addr_t *)&addr, 1);
276 void zd_usb_iowrite16v_async_start(struct zd_usb *usb);
277 int zd_usb_iowrite16v_async_end(struct zd_usb *usb, unsigned int timeout);
278 int zd_usb_iowrite16v_async(struct zd_usb *usb, const struct zd_ioreq16 *ioreqs,
280 int zd_usb_iowrite16v(struct zd_usb *usb, const struct zd_ioreq16 *ioreqs,
283 int zd_usb_rfwrite(struct zd_usb *usb, u32 value, u8 bits);
285 int zd_usb_read_fw(struct zd_usb *usb, zd_addr_t addr, u8 *data, u16 len);
287 extern struct workqueue_struct *zd_workqueue;
289 #endif /* _ZD_USB_H */