1 /* zd_usb.h: Header for USB interface implemented by ZD1211 chip
3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #include <linux/completion.h>
22 #include <linux/netdevice.h>
23 #include <linux/spinlock.h>
24 #include <linux/skbuff.h>
25 #include <linux/usb.h>
45 USB_MAX_TRANSFER_SIZE = 4096, /* bytes */
46 /* FIXME: The original driver uses this value. We have to check,
47 * whether the MAX_TRANSFER_SIZE is sufficient and this needs only be
48 * used if one combined frame is split over two USB transactions.
50 USB_MAX_RX_SIZE = 4800, /* bytes */
51 USB_MAX_IOWRITE16_COUNT = 15,
52 USB_MAX_IOWRITE32_COUNT = USB_MAX_IOWRITE16_COUNT/2,
53 USB_MAX_IOREAD16_COUNT = 15,
54 USB_MAX_IOREAD32_COUNT = USB_MAX_IOREAD16_COUNT/2,
55 USB_MIN_RFWRITE_BIT_COUNT = 16,
56 USB_MAX_RFWRITE_BIT_COUNT = 28,
57 USB_MAX_EP_INT_BUFFER = 64,
58 USB_ZD1211B_BCD_DEVICE = 0x4810,
61 enum control_requests {
62 USB_REQ_WRITE_REGS = 0x21,
63 USB_REQ_READ_REGS = 0x22,
64 USB_REQ_WRITE_RF = 0x23,
65 USB_REQ_PROG_FLASH = 0x24,
66 USB_REQ_EEPROM_START = 0x0128, /* ? request is a byte */
67 USB_REQ_EEPROM_MID = 0x28,
68 USB_REQ_EEPROM_END = 0x0228, /* ? request is a byte */
69 USB_REQ_FIRMWARE_DOWNLOAD = 0x30,
70 USB_REQ_FIRMWARE_CONFIRM = 0x31,
71 USB_REQ_FIRMWARE_READ_DATA = 0x32,
74 struct usb_req_read_regs {
84 struct usb_req_write_regs {
86 struct reg_data reg_writes[0];
95 struct usb_req_rfwrite {
99 /* 2: other (default) */
102 __le16 bit_values[0];
103 /* (CR203 & ~(RF_IF_LE | RF_CLK | RF_DATA)) | (bit ? RF_DATA : 0) */
110 USB_INT_ID_REGS = 0x90,
111 USB_INT_ID_RETRY_FAILED = 0xa0,
115 USB_INT_READ_REGS_EN = 0x01,
118 struct usb_int_header {
119 u8 type; /* must always be 1 */
123 struct usb_int_regs {
124 struct usb_int_header hdr;
125 struct reg_data regs[0];
128 struct usb_int_retry_fail {
129 struct usb_int_header hdr;
136 struct read_regs_int {
137 struct completion completion;
138 /* Stores the USB int structure and contains the USB address of the
139 * first requested register before request.
141 u8 buffer[USB_MAX_EP_INT_BUFFER];
156 struct zd_usb_interrupt {
157 struct read_regs_int read_regs;
161 u8 read_regs_enabled:1;
164 static inline struct usb_int_regs *get_read_regs(struct zd_usb_interrupt *intr)
166 return (struct usb_int_regs *)intr->read_regs.buffer;
173 u8 fragment[2*USB_MAX_RX_SIZE];
174 unsigned int fragment_length;
175 unsigned int usb_packet_size;
184 /* Contains the usb parts. The structure doesn't require a lock, because intf
185 * and fw_base_offset, will not be changed after initialization.
188 struct zd_usb_interrupt intr;
191 struct usb_interface *intf;
195 #define zd_usb_dev(usb) (&usb->intf->dev)
197 static inline struct usb_device *zd_usb_to_usbdev(struct zd_usb *usb)
199 return interface_to_usbdev(usb->intf);
202 static inline struct net_device *zd_intf_to_netdev(struct usb_interface *intf)
204 return usb_get_intfdata(intf);
207 static inline struct net_device *zd_usb_to_netdev(struct zd_usb *usb)
209 return zd_intf_to_netdev(usb->intf);
212 void zd_usb_init(struct zd_usb *usb, struct net_device *netdev,
213 struct usb_interface *intf);
214 int zd_usb_init_hw(struct zd_usb *usb);
215 void zd_usb_clear(struct zd_usb *usb);
217 int zd_usb_scnprint_id(struct zd_usb *usb, char *buffer, size_t size);
219 int zd_usb_enable_int(struct zd_usb *usb);
220 void zd_usb_disable_int(struct zd_usb *usb);
222 int zd_usb_enable_rx(struct zd_usb *usb);
223 void zd_usb_disable_rx(struct zd_usb *usb);
225 int zd_usb_tx(struct zd_usb *usb, const u8 *frame, unsigned int length);
227 int zd_usb_ioread16v(struct zd_usb *usb, u16 *values,
228 const zd_addr_t *addresses, unsigned int count);
230 static inline int zd_usb_ioread16(struct zd_usb *usb, u16 *value,
231 const zd_addr_t addr)
233 return zd_usb_ioread16v(usb, value, (const zd_addr_t *)&addr, 1);
236 int zd_usb_iowrite16v(struct zd_usb *usb, const struct zd_ioreq16 *ioreqs,
239 int zd_usb_rfwrite(struct zd_usb *usb, u32 value, u8 bits);
241 #endif /* _ZD_USB_H */