[PATCH] zd1211rw: Add ID for ZyXEL G220F
[pandora-kernel.git] / drivers / net / wireless / zd1211rw / zd_usb.c
1 /* zd_usb.c
2  *
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.
7  *
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.
12  *
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
16  */
17
18 #include <asm/unaligned.h>
19 #include <linux/kernel.h>
20 #include <linux/init.h>
21 #include <linux/module.h>
22 #include <linux/firmware.h>
23 #include <linux/device.h>
24 #include <linux/errno.h>
25 #include <linux/skbuff.h>
26 #include <linux/usb.h>
27 #include <net/ieee80211.h>
28
29 #include "zd_def.h"
30 #include "zd_netdev.h"
31 #include "zd_mac.h"
32 #include "zd_usb.h"
33 #include "zd_util.h"
34
35 static struct usb_device_id usb_ids[] = {
36         /* ZD1211 */
37         { USB_DEVICE(0x0ace, 0x1211), .driver_info = DEVICE_ZD1211 },
38         { USB_DEVICE(0x07b8, 0x6001), .driver_info = DEVICE_ZD1211 },
39         { USB_DEVICE(0x126f, 0xa006), .driver_info = DEVICE_ZD1211 },
40         { USB_DEVICE(0x6891, 0xa727), .driver_info = DEVICE_ZD1211 },
41         { USB_DEVICE(0x0df6, 0x9071), .driver_info = DEVICE_ZD1211 },
42         { USB_DEVICE(0x157e, 0x300b), .driver_info = DEVICE_ZD1211 },
43         { USB_DEVICE(0x079b, 0x004a), .driver_info = DEVICE_ZD1211 },
44         { USB_DEVICE(0x1740, 0x2000), .driver_info = DEVICE_ZD1211 },
45         { USB_DEVICE(0x157e, 0x3204), .driver_info = DEVICE_ZD1211 },
46         { USB_DEVICE(0x0586, 0x3402), .driver_info = DEVICE_ZD1211 },
47         /* ZD1211B */
48         { USB_DEVICE(0x0ace, 0x1215), .driver_info = DEVICE_ZD1211B },
49         { USB_DEVICE(0x157e, 0x300d), .driver_info = DEVICE_ZD1211B },
50         { USB_DEVICE(0x079b, 0x0062), .driver_info = DEVICE_ZD1211B },
51         {}
52 };
53
54 MODULE_LICENSE("GPL");
55 MODULE_DESCRIPTION("USB driver for devices with the ZD1211 chip.");
56 MODULE_AUTHOR("Ulrich Kunitz");
57 MODULE_AUTHOR("Daniel Drake");
58 MODULE_VERSION("1.0");
59 MODULE_DEVICE_TABLE(usb, usb_ids);
60
61 #define FW_ZD1211_PREFIX        "zd1211/zd1211_"
62 #define FW_ZD1211B_PREFIX       "zd1211/zd1211b_"
63
64 /* register address handling */
65
66 #ifdef DEBUG
67 static int check_addr(struct zd_usb *usb, zd_addr_t addr)
68 {
69         u32 base = ZD_ADDR_BASE(addr);
70         u32 offset = ZD_OFFSET(addr);
71
72         if ((u32)addr & ADDR_ZERO_MASK)
73                 goto invalid_address;
74         switch (base) {
75         case USB_BASE:
76                 break;
77         case CR_BASE:
78                 if (offset > CR_MAX_OFFSET) {
79                         dev_dbg(zd_usb_dev(usb),
80                                 "CR offset %#010x larger than"
81                                 " CR_MAX_OFFSET %#10x\n",
82                                 offset, CR_MAX_OFFSET);
83                         goto invalid_address;
84                 }
85                 if (offset & 1) {
86                         dev_dbg(zd_usb_dev(usb),
87                                 "CR offset %#010x is not a multiple of 2\n",
88                                 offset);
89                         goto invalid_address;
90                 }
91                 break;
92         case E2P_BASE:
93                 if (offset > E2P_MAX_OFFSET) {
94                         dev_dbg(zd_usb_dev(usb),
95                                 "E2P offset %#010x larger than"
96                                 " E2P_MAX_OFFSET %#010x\n",
97                                 offset, E2P_MAX_OFFSET);
98                         goto invalid_address;
99                 }
100                 break;
101         case FW_BASE:
102                 if (!usb->fw_base_offset) {
103                         dev_dbg(zd_usb_dev(usb),
104                                "ERROR: fw base offset has not been set\n");
105                         return -EAGAIN;
106                 }
107                 if (offset > FW_MAX_OFFSET) {
108                         dev_dbg(zd_usb_dev(usb),
109                                 "FW offset %#10x is larger than"
110                                 " FW_MAX_OFFSET %#010x\n",
111                                 offset, FW_MAX_OFFSET);
112                         goto invalid_address;
113                 }
114                 break;
115         default:
116                 dev_dbg(zd_usb_dev(usb),
117                         "address has unsupported base %#010x\n", addr);
118                 goto invalid_address;
119         }
120
121         return 0;
122 invalid_address:
123         dev_dbg(zd_usb_dev(usb),
124                 "ERROR: invalid address: %#010x\n", addr);
125         return -EINVAL;
126 }
127 #endif /* DEBUG */
128
129 static u16 usb_addr(struct zd_usb *usb, zd_addr_t addr)
130 {
131         u32 base;
132         u16 offset;
133
134         base = ZD_ADDR_BASE(addr);
135         offset = ZD_OFFSET(addr);
136
137         ZD_ASSERT(check_addr(usb, addr) == 0);
138
139         switch (base) {
140         case CR_BASE:
141                 offset += CR_BASE_OFFSET;
142                 break;
143         case E2P_BASE:
144                 offset += E2P_BASE_OFFSET;
145                 break;
146         case FW_BASE:
147                 offset += usb->fw_base_offset;
148                 break;
149         }
150
151         return offset;
152 }
153
154 /* USB device initialization */
155
156 static int request_fw_file(
157         const struct firmware **fw, const char *name, struct device *device)
158 {
159         int r;
160
161         dev_dbg_f(device, "fw name %s\n", name);
162
163         r = request_firmware(fw, name, device);
164         if (r)
165                 dev_err(device,
166                        "Could not load firmware file %s. Error number %d\n",
167                        name, r);
168         return r;
169 }
170
171 static inline u16 get_bcdDevice(const struct usb_device *udev)
172 {
173         return le16_to_cpu(udev->descriptor.bcdDevice);
174 }
175
176 enum upload_code_flags {
177         REBOOT = 1,
178 };
179
180 /* Ensures that MAX_TRANSFER_SIZE is even. */
181 #define MAX_TRANSFER_SIZE (USB_MAX_TRANSFER_SIZE & ~1)
182
183 static int upload_code(struct usb_device *udev,
184         const u8 *data, size_t size, u16 code_offset, int flags)
185 {
186         u8 *p;
187         int r;
188
189         /* USB request blocks need "kmalloced" buffers.
190          */
191         p = kmalloc(MAX_TRANSFER_SIZE, GFP_KERNEL);
192         if (!p) {
193                 dev_err(&udev->dev, "out of memory\n");
194                 r = -ENOMEM;
195                 goto error;
196         }
197
198         size &= ~1;
199         while (size > 0) {
200                 size_t transfer_size = size <= MAX_TRANSFER_SIZE ?
201                         size : MAX_TRANSFER_SIZE;
202
203                 dev_dbg_f(&udev->dev, "transfer size %zu\n", transfer_size);
204
205                 memcpy(p, data, transfer_size);
206                 r = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
207                         USB_REQ_FIRMWARE_DOWNLOAD,
208                         USB_DIR_OUT | USB_TYPE_VENDOR,
209                         code_offset, 0, p, transfer_size, 1000 /* ms */);
210                 if (r < 0) {
211                         dev_err(&udev->dev,
212                                "USB control request for firmware upload"
213                                " failed. Error number %d\n", r);
214                         goto error;
215                 }
216                 transfer_size = r & ~1;
217
218                 size -= transfer_size;
219                 data += transfer_size;
220                 code_offset += transfer_size/sizeof(u16);
221         }
222
223         if (flags & REBOOT) {
224                 u8 ret;
225
226                 r = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
227                         USB_REQ_FIRMWARE_CONFIRM,
228                         USB_DIR_IN | USB_TYPE_VENDOR,
229                         0, 0, &ret, sizeof(ret), 5000 /* ms */);
230                 if (r != sizeof(ret)) {
231                         dev_err(&udev->dev,
232                                 "control request firmeware confirmation failed."
233                                 " Return value %d\n", r);
234                         if (r >= 0)
235                                 r = -ENODEV;
236                         goto error;
237                 }
238                 if (ret & 0x80) {
239                         dev_err(&udev->dev,
240                                 "Internal error while downloading."
241                                 " Firmware confirm return value %#04x\n",
242                                 (unsigned int)ret);
243                         r = -ENODEV;
244                         goto error;
245                 }
246                 dev_dbg_f(&udev->dev, "firmware confirm return value %#04x\n",
247                         (unsigned int)ret);
248         }
249
250         r = 0;
251 error:
252         kfree(p);
253         return r;
254 }
255
256 static u16 get_word(const void *data, u16 offset)
257 {
258         const __le16 *p = data;
259         return le16_to_cpu(p[offset]);
260 }
261
262 static char *get_fw_name(char *buffer, size_t size, u8 device_type,
263                        const char* postfix)
264 {
265         scnprintf(buffer, size, "%s%s",
266                 device_type == DEVICE_ZD1211B ?
267                         FW_ZD1211B_PREFIX : FW_ZD1211_PREFIX,
268                 postfix);
269         return buffer;
270 }
271
272 static int handle_version_mismatch(struct usb_device *udev, u8 device_type,
273         const struct firmware *ub_fw)
274 {
275         const struct firmware *ur_fw = NULL;
276         int offset;
277         int r = 0;
278         char fw_name[128];
279
280         r = request_fw_file(&ur_fw,
281                 get_fw_name(fw_name, sizeof(fw_name), device_type, "ur"),
282                 &udev->dev);
283         if (r)
284                 goto error;
285
286         r = upload_code(udev, ur_fw->data, ur_fw->size, FW_START_OFFSET,
287                 REBOOT);
288         if (r)
289                 goto error;
290
291         offset = ((EEPROM_REGS_OFFSET + EEPROM_REGS_SIZE) * sizeof(u16));
292         r = upload_code(udev, ub_fw->data + offset, ub_fw->size - offset,
293                 E2P_BASE_OFFSET + EEPROM_REGS_SIZE, REBOOT);
294
295         /* At this point, the vendor driver downloads the whole firmware
296          * image, hacks around with version IDs, and uploads it again,
297          * completely overwriting the boot code. We do not do this here as
298          * it is not required on any tested devices, and it is suspected to
299          * cause problems. */
300 error:
301         release_firmware(ur_fw);
302         return r;
303 }
304
305 static int upload_firmware(struct usb_device *udev, u8 device_type)
306 {
307         int r;
308         u16 fw_bcdDevice;
309         u16 bcdDevice;
310         const struct firmware *ub_fw = NULL;
311         const struct firmware *uph_fw = NULL;
312         char fw_name[128];
313
314         bcdDevice = get_bcdDevice(udev);
315
316         r = request_fw_file(&ub_fw,
317                 get_fw_name(fw_name, sizeof(fw_name), device_type,  "ub"),
318                 &udev->dev);
319         if (r)
320                 goto error;
321
322         fw_bcdDevice = get_word(ub_fw->data, EEPROM_REGS_OFFSET);
323
324         if (fw_bcdDevice != bcdDevice) {
325                 dev_info(&udev->dev,
326                         "firmware version %#06x and device bootcode version "
327                         "%#06x differ\n", fw_bcdDevice, bcdDevice);
328                 if (bcdDevice <= 0x4313)
329                         dev_warn(&udev->dev, "device has old bootcode, please "
330                                 "report success or failure\n");
331
332                 r = handle_version_mismatch(udev, device_type, ub_fw);
333                 if (r)
334                         goto error;
335         } else {
336                 dev_dbg_f(&udev->dev,
337                         "firmware device id %#06x is equal to the "
338                         "actual device id\n", fw_bcdDevice);
339         }
340
341
342         r = request_fw_file(&uph_fw,
343                 get_fw_name(fw_name, sizeof(fw_name), device_type, "uphr"),
344                 &udev->dev);
345         if (r)
346                 goto error;
347
348         r = upload_code(udev, uph_fw->data, uph_fw->size, FW_START_OFFSET,
349                         REBOOT);
350         if (r) {
351                 dev_err(&udev->dev,
352                         "Could not upload firmware code uph. Error number %d\n",
353                         r);
354         }
355
356         /* FALL-THROUGH */
357 error:
358         release_firmware(ub_fw);
359         release_firmware(uph_fw);
360         return r;
361 }
362
363 static void disable_read_regs_int(struct zd_usb *usb)
364 {
365         struct zd_usb_interrupt *intr = &usb->intr;
366
367         spin_lock(&intr->lock);
368         intr->read_regs_enabled = 0;
369         spin_unlock(&intr->lock);
370 }
371
372 #define urb_dev(urb) (&(urb)->dev->dev)
373
374 static inline void handle_regs_int(struct urb *urb)
375 {
376         struct zd_usb *usb = urb->context;
377         struct zd_usb_interrupt *intr = &usb->intr;
378         int len;
379
380         ZD_ASSERT(in_interrupt());
381         spin_lock(&intr->lock);
382
383         if (intr->read_regs_enabled) {
384                 intr->read_regs.length = len = urb->actual_length;
385
386                 if (len > sizeof(intr->read_regs.buffer))
387                         len = sizeof(intr->read_regs.buffer);
388                 memcpy(intr->read_regs.buffer, urb->transfer_buffer, len);
389                 intr->read_regs_enabled = 0;
390                 complete(&intr->read_regs.completion);
391                 goto out;
392         }
393
394         dev_dbg_f(urb_dev(urb), "regs interrupt ignored\n");
395 out:
396         spin_unlock(&intr->lock);
397 }
398
399 static inline void handle_retry_failed_int(struct urb *urb)
400 {
401         dev_dbg_f(urb_dev(urb), "retry failed interrupt\n");
402 }
403
404
405 static void int_urb_complete(struct urb *urb, struct pt_regs *pt_regs)
406 {
407         int r;
408         struct usb_int_header *hdr;
409
410         switch (urb->status) {
411         case 0:
412                 break;
413         case -ESHUTDOWN:
414         case -EINVAL:
415         case -ENODEV:
416         case -ENOENT:
417         case -ECONNRESET:
418         case -EPIPE:
419                 goto kfree;
420         default:
421                 goto resubmit;
422         }
423
424         if (urb->actual_length < sizeof(hdr)) {
425                 dev_dbg_f(urb_dev(urb), "error: urb %p to small\n", urb);
426                 goto resubmit;
427         }
428
429         hdr = urb->transfer_buffer;
430         if (hdr->type != USB_INT_TYPE) {
431                 dev_dbg_f(urb_dev(urb), "error: urb %p wrong type\n", urb);
432                 goto resubmit;
433         }
434
435         switch (hdr->id) {
436         case USB_INT_ID_REGS:
437                 handle_regs_int(urb);
438                 break;
439         case USB_INT_ID_RETRY_FAILED:
440                 handle_retry_failed_int(urb);
441                 break;
442         default:
443                 dev_dbg_f(urb_dev(urb), "error: urb %p unknown id %x\n", urb,
444                         (unsigned int)hdr->id);
445                 goto resubmit;
446         }
447
448 resubmit:
449         r = usb_submit_urb(urb, GFP_ATOMIC);
450         if (r) {
451                 dev_dbg_f(urb_dev(urb), "resubmit urb %p\n", urb);
452                 goto kfree;
453         }
454         return;
455 kfree:
456         kfree(urb->transfer_buffer);
457 }
458
459 static inline int int_urb_interval(struct usb_device *udev)
460 {
461         switch (udev->speed) {
462         case USB_SPEED_HIGH:
463                 return 4;
464         case USB_SPEED_LOW:
465                 return 10;
466         case USB_SPEED_FULL:
467         default:
468                 return 1;
469         }
470 }
471
472 static inline int usb_int_enabled(struct zd_usb *usb)
473 {
474         unsigned long flags;
475         struct zd_usb_interrupt *intr = &usb->intr;
476         struct urb *urb;
477
478         spin_lock_irqsave(&intr->lock, flags);
479         urb = intr->urb;
480         spin_unlock_irqrestore(&intr->lock, flags);
481         return urb != NULL;
482 }
483
484 int zd_usb_enable_int(struct zd_usb *usb)
485 {
486         int r;
487         struct usb_device *udev;
488         struct zd_usb_interrupt *intr = &usb->intr;
489         void *transfer_buffer = NULL;
490         struct urb *urb;
491
492         dev_dbg_f(zd_usb_dev(usb), "\n");
493
494         urb = usb_alloc_urb(0, GFP_NOFS);
495         if (!urb) {
496                 r = -ENOMEM;
497                 goto out;
498         }
499
500         ZD_ASSERT(!irqs_disabled());
501         spin_lock_irq(&intr->lock);
502         if (intr->urb) {
503                 spin_unlock_irq(&intr->lock);
504                 r = 0;
505                 goto error_free_urb;
506         }
507         intr->urb = urb;
508         spin_unlock_irq(&intr->lock);
509
510         /* TODO: make it a DMA buffer */
511         r = -ENOMEM;
512         transfer_buffer = kmalloc(USB_MAX_EP_INT_BUFFER, GFP_NOFS);
513         if (!transfer_buffer) {
514                 dev_dbg_f(zd_usb_dev(usb),
515                         "couldn't allocate transfer_buffer\n");
516                 goto error_set_urb_null;
517         }
518
519         udev = zd_usb_to_usbdev(usb);
520         usb_fill_int_urb(urb, udev, usb_rcvintpipe(udev, EP_INT_IN),
521                          transfer_buffer, USB_MAX_EP_INT_BUFFER,
522                          int_urb_complete, usb,
523                          intr->interval);
524
525         dev_dbg_f(zd_usb_dev(usb), "submit urb %p\n", intr->urb);
526         r = usb_submit_urb(urb, GFP_NOFS);
527         if (r) {
528                 dev_dbg_f(zd_usb_dev(usb),
529                          "Couldn't submit urb. Error number %d\n", r);
530                 goto error;
531         }
532
533         return 0;
534 error:
535         kfree(transfer_buffer);
536 error_set_urb_null:
537         spin_lock_irq(&intr->lock);
538         intr->urb = NULL;
539         spin_unlock_irq(&intr->lock);
540 error_free_urb:
541         usb_free_urb(urb);
542 out:
543         return r;
544 }
545
546 void zd_usb_disable_int(struct zd_usb *usb)
547 {
548         unsigned long flags;
549         struct zd_usb_interrupt *intr = &usb->intr;
550         struct urb *urb;
551
552         spin_lock_irqsave(&intr->lock, flags);
553         urb = intr->urb;
554         if (!urb) {
555                 spin_unlock_irqrestore(&intr->lock, flags);
556                 return;
557         }
558         intr->urb = NULL;
559         spin_unlock_irqrestore(&intr->lock, flags);
560
561         usb_kill_urb(urb);
562         dev_dbg_f(zd_usb_dev(usb), "urb %p killed\n", urb);
563         usb_free_urb(urb);
564 }
565
566 static void handle_rx_packet(struct zd_usb *usb, const u8 *buffer,
567                              unsigned int length)
568 {
569         int i;
570         struct zd_mac *mac = zd_usb_to_mac(usb);
571         const struct rx_length_info *length_info;
572
573         if (length < sizeof(struct rx_length_info)) {
574                 /* It's not a complete packet anyhow. */
575                 return;
576         }
577         length_info = (struct rx_length_info *)
578                 (buffer + length - sizeof(struct rx_length_info));
579
580         /* It might be that three frames are merged into a single URB
581          * transaction. We have to check for the length info tag.
582          *
583          * While testing we discovered that length_info might be unaligned,
584          * because if USB transactions are merged, the last packet will not
585          * be padded. Unaligned access might also happen if the length_info
586          * structure is not present.
587          */
588         if (get_unaligned(&length_info->tag) == cpu_to_le16(RX_LENGTH_INFO_TAG))
589         {
590                 unsigned int l, k, n;
591                 for (i = 0, l = 0;; i++) {
592                         k = le16_to_cpu(get_unaligned(&length_info->length[i]));
593                         n = l+k;
594                         if (n > length)
595                                 return;
596                         zd_mac_rx(mac, buffer+l, k);
597                         if (i >= 2)
598                                 return;
599                         l = (n+3) & ~3;
600                 }
601         } else {
602                 zd_mac_rx(mac, buffer, length);
603         }
604 }
605
606 static void rx_urb_complete(struct urb *urb, struct pt_regs *pt_regs)
607 {
608         struct zd_usb *usb;
609         struct zd_usb_rx *rx;
610         const u8 *buffer;
611         unsigned int length;
612
613         switch (urb->status) {
614         case 0:
615                 break;
616         case -ESHUTDOWN:
617         case -EINVAL:
618         case -ENODEV:
619         case -ENOENT:
620         case -ECONNRESET:
621         case -EPIPE:
622                 return;
623         default:
624                 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
625                 goto resubmit;
626         }
627
628         buffer = urb->transfer_buffer;
629         length = urb->actual_length;
630         usb = urb->context;
631         rx = &usb->rx;
632
633         if (length%rx->usb_packet_size > rx->usb_packet_size-4) {
634                 /* If there is an old first fragment, we don't care. */
635                 dev_dbg_f(urb_dev(urb), "*** first fragment ***\n");
636                 ZD_ASSERT(length <= ARRAY_SIZE(rx->fragment));
637                 spin_lock(&rx->lock);
638                 memcpy(rx->fragment, buffer, length);
639                 rx->fragment_length = length;
640                 spin_unlock(&rx->lock);
641                 goto resubmit;
642         }
643
644         spin_lock(&rx->lock);
645         if (rx->fragment_length > 0) {
646                 /* We are on a second fragment, we believe */
647                 ZD_ASSERT(length + rx->fragment_length <=
648                           ARRAY_SIZE(rx->fragment));
649                 dev_dbg_f(urb_dev(urb), "*** second fragment ***\n");
650                 memcpy(rx->fragment+rx->fragment_length, buffer, length);
651                 handle_rx_packet(usb, rx->fragment,
652                                  rx->fragment_length + length);
653                 rx->fragment_length = 0;
654                 spin_unlock(&rx->lock);
655         } else {
656                 spin_unlock(&rx->lock);
657                 handle_rx_packet(usb, buffer, length);
658         }
659
660 resubmit:
661         usb_submit_urb(urb, GFP_ATOMIC);
662 }
663
664 struct urb *alloc_urb(struct zd_usb *usb)
665 {
666         struct usb_device *udev = zd_usb_to_usbdev(usb);
667         struct urb *urb;
668         void *buffer;
669
670         urb = usb_alloc_urb(0, GFP_NOFS);
671         if (!urb)
672                 return NULL;
673         buffer = usb_buffer_alloc(udev, USB_MAX_RX_SIZE, GFP_NOFS,
674                                   &urb->transfer_dma);
675         if (!buffer) {
676                 usb_free_urb(urb);
677                 return NULL;
678         }
679
680         usb_fill_bulk_urb(urb, udev, usb_rcvbulkpipe(udev, EP_DATA_IN),
681                           buffer, USB_MAX_RX_SIZE,
682                           rx_urb_complete, usb);
683         urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
684
685         return urb;
686 }
687
688 void free_urb(struct urb *urb)
689 {
690         if (!urb)
691                 return;
692         usb_buffer_free(urb->dev, urb->transfer_buffer_length,
693                         urb->transfer_buffer, urb->transfer_dma);
694         usb_free_urb(urb);
695 }
696
697 int zd_usb_enable_rx(struct zd_usb *usb)
698 {
699         int i, r;
700         struct zd_usb_rx *rx = &usb->rx;
701         struct urb **urbs;
702
703         dev_dbg_f(zd_usb_dev(usb), "\n");
704
705         r = -ENOMEM;
706         urbs = kcalloc(URBS_COUNT, sizeof(struct urb *), GFP_NOFS);
707         if (!urbs)
708                 goto error;
709         for (i = 0; i < URBS_COUNT; i++) {
710                 urbs[i] = alloc_urb(usb);
711                 if (!urbs[i])
712                         goto error;
713         }
714
715         ZD_ASSERT(!irqs_disabled());
716         spin_lock_irq(&rx->lock);
717         if (rx->urbs) {
718                 spin_unlock_irq(&rx->lock);
719                 r = 0;
720                 goto error;
721         }
722         rx->urbs = urbs;
723         rx->urbs_count = URBS_COUNT;
724         spin_unlock_irq(&rx->lock);
725
726         for (i = 0; i < URBS_COUNT; i++) {
727                 r = usb_submit_urb(urbs[i], GFP_NOFS);
728                 if (r)
729                         goto error_submit;
730         }
731
732         return 0;
733 error_submit:
734         for (i = 0; i < URBS_COUNT; i++) {
735                 usb_kill_urb(urbs[i]);
736         }
737         spin_lock_irq(&rx->lock);
738         rx->urbs = NULL;
739         rx->urbs_count = 0;
740         spin_unlock_irq(&rx->lock);
741 error:
742         if (urbs) {
743                 for (i = 0; i < URBS_COUNT; i++)
744                         free_urb(urbs[i]);
745         }
746         return r;
747 }
748
749 void zd_usb_disable_rx(struct zd_usb *usb)
750 {
751         int i;
752         unsigned long flags;
753         struct urb **urbs;
754         unsigned int count;
755         struct zd_usb_rx *rx = &usb->rx;
756
757         spin_lock_irqsave(&rx->lock, flags);
758         urbs = rx->urbs;
759         count = rx->urbs_count;
760         spin_unlock_irqrestore(&rx->lock, flags);
761         if (!urbs)
762                 return;
763
764         for (i = 0; i < count; i++) {
765                 usb_kill_urb(urbs[i]);
766                 free_urb(urbs[i]);
767         }
768         kfree(urbs);
769
770         spin_lock_irqsave(&rx->lock, flags);
771         rx->urbs = NULL;
772         rx->urbs_count = 0;
773         spin_unlock_irqrestore(&rx->lock, flags);
774 }
775
776 static void tx_urb_complete(struct urb *urb, struct pt_regs *pt_regs)
777 {
778         int r;
779
780         switch (urb->status) {
781         case 0:
782                 break;
783         case -ESHUTDOWN:
784         case -EINVAL:
785         case -ENODEV:
786         case -ENOENT:
787         case -ECONNRESET:
788         case -EPIPE:
789                 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
790                 break;
791         default:
792                 dev_dbg_f(urb_dev(urb), "urb %p error %d\n", urb, urb->status);
793                 goto resubmit;
794         }
795 free_urb:
796         usb_buffer_free(urb->dev, urb->transfer_buffer_length,
797                         urb->transfer_buffer, urb->transfer_dma);
798         usb_free_urb(urb);
799         return;
800 resubmit:
801         r = usb_submit_urb(urb, GFP_ATOMIC);
802         if (r) {
803                 dev_dbg_f(urb_dev(urb), "error resubmit urb %p %d\n", urb, r);
804                 goto free_urb;
805         }
806 }
807
808 /* Puts the frame on the USB endpoint. It doesn't wait for
809  * completion. The frame must contain the control set.
810  */
811 int zd_usb_tx(struct zd_usb *usb, const u8 *frame, unsigned int length)
812 {
813         int r;
814         struct usb_device *udev = zd_usb_to_usbdev(usb);
815         struct urb *urb;
816         void *buffer;
817
818         urb = usb_alloc_urb(0, GFP_ATOMIC);
819         if (!urb) {
820                 r = -ENOMEM;
821                 goto out;
822         }
823
824         buffer = usb_buffer_alloc(zd_usb_to_usbdev(usb), length, GFP_ATOMIC,
825                                   &urb->transfer_dma);
826         if (!buffer) {
827                 r = -ENOMEM;
828                 goto error_free_urb;
829         }
830         memcpy(buffer, frame, length);
831
832         usb_fill_bulk_urb(urb, udev, usb_sndbulkpipe(udev, EP_DATA_OUT),
833                           buffer, length, tx_urb_complete, NULL);
834         urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
835
836         r = usb_submit_urb(urb, GFP_ATOMIC);
837         if (r)
838                 goto error;
839         return 0;
840 error:
841         usb_buffer_free(zd_usb_to_usbdev(usb), length, buffer,
842                         urb->transfer_dma);
843 error_free_urb:
844         usb_free_urb(urb);
845 out:
846         return r;
847 }
848
849 static inline void init_usb_interrupt(struct zd_usb *usb)
850 {
851         struct zd_usb_interrupt *intr = &usb->intr;
852
853         spin_lock_init(&intr->lock);
854         intr->interval = int_urb_interval(zd_usb_to_usbdev(usb));
855         init_completion(&intr->read_regs.completion);
856         intr->read_regs.cr_int_addr = cpu_to_le16(usb_addr(usb, CR_INTERRUPT));
857 }
858
859 static inline void init_usb_rx(struct zd_usb *usb)
860 {
861         struct zd_usb_rx *rx = &usb->rx;
862         spin_lock_init(&rx->lock);
863         if (interface_to_usbdev(usb->intf)->speed == USB_SPEED_HIGH) {
864                 rx->usb_packet_size = 512;
865         } else {
866                 rx->usb_packet_size = 64;
867         }
868         ZD_ASSERT(rx->fragment_length == 0);
869 }
870
871 static inline void init_usb_tx(struct zd_usb *usb)
872 {
873         /* FIXME: at this point we will allocate a fixed number of urb's for
874          * use in a cyclic scheme */
875 }
876
877 void zd_usb_init(struct zd_usb *usb, struct net_device *netdev,
878                  struct usb_interface *intf)
879 {
880         memset(usb, 0, sizeof(*usb));
881         usb->intf = usb_get_intf(intf);
882         usb_set_intfdata(usb->intf, netdev);
883         init_usb_interrupt(usb);
884         init_usb_tx(usb);
885         init_usb_rx(usb);
886 }
887
888 int zd_usb_init_hw(struct zd_usb *usb)
889 {
890         int r;
891         struct zd_chip *chip = zd_usb_to_chip(usb);
892
893         ZD_ASSERT(mutex_is_locked(&chip->mutex));
894         r = zd_ioread16_locked(chip, &usb->fw_base_offset,
895                         USB_REG((u16)FW_BASE_ADDR_OFFSET));
896         if (r)
897                 return r;
898         dev_dbg_f(zd_usb_dev(usb), "fw_base_offset: %#06hx\n",
899                  usb->fw_base_offset);
900
901         return 0;
902 }
903
904 void zd_usb_clear(struct zd_usb *usb)
905 {
906         usb_set_intfdata(usb->intf, NULL);
907         usb_put_intf(usb->intf);
908         memset(usb, 0, sizeof(*usb));
909         /* FIXME: usb_interrupt, usb_tx, usb_rx? */
910 }
911
912 static const char *speed(enum usb_device_speed speed)
913 {
914         switch (speed) {
915         case USB_SPEED_LOW:
916                 return "low";
917         case USB_SPEED_FULL:
918                 return "full";
919         case USB_SPEED_HIGH:
920                 return "high";
921         default:
922                 return "unknown speed";
923         }
924 }
925
926 static int scnprint_id(struct usb_device *udev, char *buffer, size_t size)
927 {
928         return scnprintf(buffer, size, "%04hx:%04hx v%04hx %s",
929                 le16_to_cpu(udev->descriptor.idVendor),
930                 le16_to_cpu(udev->descriptor.idProduct),
931                 get_bcdDevice(udev),
932                 speed(udev->speed));
933 }
934
935 int zd_usb_scnprint_id(struct zd_usb *usb, char *buffer, size_t size)
936 {
937         struct usb_device *udev = interface_to_usbdev(usb->intf);
938         return scnprint_id(udev, buffer, size);
939 }
940
941 #ifdef DEBUG
942 static void print_id(struct usb_device *udev)
943 {
944         char buffer[40];
945
946         scnprint_id(udev, buffer, sizeof(buffer));
947         buffer[sizeof(buffer)-1] = 0;
948         dev_dbg_f(&udev->dev, "%s\n", buffer);
949 }
950 #else
951 #define print_id(udev) do { } while (0)
952 #endif
953
954 static int probe(struct usb_interface *intf, const struct usb_device_id *id)
955 {
956         int r;
957         struct usb_device *udev = interface_to_usbdev(intf);
958         struct net_device *netdev = NULL;
959
960         print_id(udev);
961
962         switch (udev->speed) {
963         case USB_SPEED_LOW:
964         case USB_SPEED_FULL:
965         case USB_SPEED_HIGH:
966                 break;
967         default:
968                 dev_dbg_f(&intf->dev, "Unknown USB speed\n");
969                 r = -ENODEV;
970                 goto error;
971         }
972
973         netdev = zd_netdev_alloc(intf);
974         if (netdev == NULL) {
975                 r = -ENOMEM;
976                 goto error;
977         }
978
979         r = upload_firmware(udev, id->driver_info);
980         if (r) {
981                 dev_err(&intf->dev,
982                        "couldn't load firmware. Error number %d\n", r);
983                 goto error;
984         }
985
986         r = usb_reset_configuration(udev);
987         if (r) {
988                 dev_dbg_f(&intf->dev,
989                         "couldn't reset configuration. Error number %d\n", r);
990                 goto error;
991         }
992
993         /* At this point the interrupt endpoint is not generally enabled. We
994          * save the USB bandwidth until the network device is opened. But
995          * notify that the initialization of the MAC will require the
996          * interrupts to be temporary enabled.
997          */
998         r = zd_mac_init_hw(zd_netdev_mac(netdev), id->driver_info);
999         if (r) {
1000                 dev_dbg_f(&intf->dev,
1001                          "couldn't initialize mac. Error number %d\n", r);
1002                 goto error;
1003         }
1004
1005         r = register_netdev(netdev);
1006         if (r) {
1007                 dev_dbg_f(&intf->dev,
1008                          "couldn't register netdev. Error number %d\n", r);
1009                 goto error;
1010         }
1011
1012         dev_dbg_f(&intf->dev, "successful\n");
1013         dev_info(&intf->dev,"%s\n", netdev->name);
1014         return 0;
1015 error:
1016         usb_reset_device(interface_to_usbdev(intf));
1017         zd_netdev_free(netdev);
1018         return r;
1019 }
1020
1021 static void disconnect(struct usb_interface *intf)
1022 {
1023         struct net_device *netdev = zd_intf_to_netdev(intf);
1024         struct zd_mac *mac = zd_netdev_mac(netdev);
1025         struct zd_usb *usb = &mac->chip.usb;
1026
1027         dev_dbg_f(zd_usb_dev(usb), "\n");
1028
1029         zd_netdev_disconnect(netdev);
1030
1031         /* Just in case something has gone wrong! */
1032         zd_usb_disable_rx(usb);
1033         zd_usb_disable_int(usb);
1034
1035         /* If the disconnect has been caused by a removal of the
1036          * driver module, the reset allows reloading of the driver. If the
1037          * reset will not be executed here, the upload of the firmware in the
1038          * probe function caused by the reloading of the driver will fail.
1039          */
1040         usb_reset_device(interface_to_usbdev(intf));
1041
1042         /* If somebody still waits on this lock now, this is an error. */
1043         zd_netdev_free(netdev);
1044         dev_dbg(&intf->dev, "disconnected\n");
1045 }
1046
1047 static struct usb_driver driver = {
1048         .name           = "zd1211rw",
1049         .id_table       = usb_ids,
1050         .probe          = probe,
1051         .disconnect     = disconnect,
1052 };
1053
1054 static int __init usb_init(void)
1055 {
1056         int r;
1057
1058         pr_debug("usb_init()\n");
1059
1060         r = usb_register(&driver);
1061         if (r) {
1062                 printk(KERN_ERR "usb_register() failed. Error number %d\n", r);
1063                 return r;
1064         }
1065
1066         pr_debug("zd1211rw initialized\n");
1067         return 0;
1068 }
1069
1070 static void __exit usb_exit(void)
1071 {
1072         pr_debug("usb_exit()\n");
1073         usb_deregister(&driver);
1074 }
1075
1076 module_init(usb_init);
1077 module_exit(usb_exit);
1078
1079 static int usb_int_regs_length(unsigned int count)
1080 {
1081         return sizeof(struct usb_int_regs) + count * sizeof(struct reg_data);
1082 }
1083
1084 static void prepare_read_regs_int(struct zd_usb *usb)
1085 {
1086         struct zd_usb_interrupt *intr = &usb->intr;
1087
1088         spin_lock(&intr->lock);
1089         intr->read_regs_enabled = 1;
1090         INIT_COMPLETION(intr->read_regs.completion);
1091         spin_unlock(&intr->lock);
1092 }
1093
1094 static int get_results(struct zd_usb *usb, u16 *values,
1095                        struct usb_req_read_regs *req, unsigned int count)
1096 {
1097         int r;
1098         int i;
1099         struct zd_usb_interrupt *intr = &usb->intr;
1100         struct read_regs_int *rr = &intr->read_regs;
1101         struct usb_int_regs *regs = (struct usb_int_regs *)rr->buffer;
1102
1103         spin_lock(&intr->lock);
1104
1105         r = -EIO;
1106         /* The created block size seems to be larger than expected.
1107          * However results appear to be correct.
1108          */
1109         if (rr->length < usb_int_regs_length(count)) {
1110                 dev_dbg_f(zd_usb_dev(usb),
1111                          "error: actual length %d less than expected %d\n",
1112                          rr->length, usb_int_regs_length(count));
1113                 goto error_unlock;
1114         }
1115         if (rr->length > sizeof(rr->buffer)) {
1116                 dev_dbg_f(zd_usb_dev(usb),
1117                          "error: actual length %d exceeds buffer size %zu\n",
1118                          rr->length, sizeof(rr->buffer));
1119                 goto error_unlock;
1120         }
1121
1122         for (i = 0; i < count; i++) {
1123                 struct reg_data *rd = &regs->regs[i];
1124                 if (rd->addr != req->addr[i]) {
1125                         dev_dbg_f(zd_usb_dev(usb),
1126                                  "rd[%d] addr %#06hx expected %#06hx\n", i,
1127                                  le16_to_cpu(rd->addr),
1128                                  le16_to_cpu(req->addr[i]));
1129                         goto error_unlock;
1130                 }
1131                 values[i] = le16_to_cpu(rd->value);
1132         }
1133
1134         r = 0;
1135 error_unlock:
1136         spin_unlock(&intr->lock);
1137         return r;
1138 }
1139
1140 int zd_usb_ioread16v(struct zd_usb *usb, u16 *values,
1141                      const zd_addr_t *addresses, unsigned int count)
1142 {
1143         int r;
1144         int i, req_len, actual_req_len;
1145         struct usb_device *udev;
1146         struct usb_req_read_regs *req = NULL;
1147         unsigned long timeout;
1148
1149         if (count < 1) {
1150                 dev_dbg_f(zd_usb_dev(usb), "error: count is zero\n");
1151                 return -EINVAL;
1152         }
1153         if (count > USB_MAX_IOREAD16_COUNT) {
1154                 dev_dbg_f(zd_usb_dev(usb),
1155                          "error: count %u exceeds possible max %u\n",
1156                          count, USB_MAX_IOREAD16_COUNT);
1157                 return -EINVAL;
1158         }
1159         if (in_atomic()) {
1160                 dev_dbg_f(zd_usb_dev(usb),
1161                          "error: io in atomic context not supported\n");
1162                 return -EWOULDBLOCK;
1163         }
1164         if (!usb_int_enabled(usb)) {
1165                  dev_dbg_f(zd_usb_dev(usb),
1166                           "error: usb interrupt not enabled\n");
1167                 return -EWOULDBLOCK;
1168         }
1169
1170         req_len = sizeof(struct usb_req_read_regs) + count * sizeof(__le16);
1171         req = kmalloc(req_len, GFP_NOFS);
1172         if (!req)
1173                 return -ENOMEM;
1174         req->id = cpu_to_le16(USB_REQ_READ_REGS);
1175         for (i = 0; i < count; i++)
1176                 req->addr[i] = cpu_to_le16(usb_addr(usb, addresses[i]));
1177
1178         udev = zd_usb_to_usbdev(usb);
1179         prepare_read_regs_int(usb);
1180         r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1181                          req, req_len, &actual_req_len, 1000 /* ms */);
1182         if (r) {
1183                 dev_dbg_f(zd_usb_dev(usb),
1184                         "error in usb_bulk_msg(). Error number %d\n", r);
1185                 goto error;
1186         }
1187         if (req_len != actual_req_len) {
1188                 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()\n"
1189                         " req_len %d != actual_req_len %d\n",
1190                         req_len, actual_req_len);
1191                 r = -EIO;
1192                 goto error;
1193         }
1194
1195         timeout = wait_for_completion_timeout(&usb->intr.read_regs.completion,
1196                                               msecs_to_jiffies(1000));
1197         if (!timeout) {
1198                 disable_read_regs_int(usb);
1199                 dev_dbg_f(zd_usb_dev(usb), "read timed out\n");
1200                 r = -ETIMEDOUT;
1201                 goto error;
1202         }
1203
1204         r = get_results(usb, values, req, count);
1205 error:
1206         kfree(req);
1207         return r;
1208 }
1209
1210 int zd_usb_iowrite16v(struct zd_usb *usb, const struct zd_ioreq16 *ioreqs,
1211                       unsigned int count)
1212 {
1213         int r;
1214         struct usb_device *udev;
1215         struct usb_req_write_regs *req = NULL;
1216         int i, req_len, actual_req_len;
1217
1218         if (count == 0)
1219                 return 0;
1220         if (count > USB_MAX_IOWRITE16_COUNT) {
1221                 dev_dbg_f(zd_usb_dev(usb),
1222                         "error: count %u exceeds possible max %u\n",
1223                         count, USB_MAX_IOWRITE16_COUNT);
1224                 return -EINVAL;
1225         }
1226         if (in_atomic()) {
1227                 dev_dbg_f(zd_usb_dev(usb),
1228                         "error: io in atomic context not supported\n");
1229                 return -EWOULDBLOCK;
1230         }
1231
1232         req_len = sizeof(struct usb_req_write_regs) +
1233                   count * sizeof(struct reg_data);
1234         req = kmalloc(req_len, GFP_NOFS);
1235         if (!req)
1236                 return -ENOMEM;
1237
1238         req->id = cpu_to_le16(USB_REQ_WRITE_REGS);
1239         for (i = 0; i < count; i++) {
1240                 struct reg_data *rw  = &req->reg_writes[i];
1241                 rw->addr = cpu_to_le16(usb_addr(usb, ioreqs[i].addr));
1242                 rw->value = cpu_to_le16(ioreqs[i].value);
1243         }
1244
1245         udev = zd_usb_to_usbdev(usb);
1246         r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1247                          req, req_len, &actual_req_len, 1000 /* ms */);
1248         if (r) {
1249                 dev_dbg_f(zd_usb_dev(usb),
1250                         "error in usb_bulk_msg(). Error number %d\n", r);
1251                 goto error;
1252         }
1253         if (req_len != actual_req_len) {
1254                 dev_dbg_f(zd_usb_dev(usb),
1255                         "error in usb_bulk_msg()"
1256                         " req_len %d != actual_req_len %d\n",
1257                         req_len, actual_req_len);
1258                 r = -EIO;
1259                 goto error;
1260         }
1261
1262         /* FALL-THROUGH with r == 0 */
1263 error:
1264         kfree(req);
1265         return r;
1266 }
1267
1268 int zd_usb_rfwrite(struct zd_usb *usb, u32 value, u8 bits)
1269 {
1270         int r;
1271         struct usb_device *udev;
1272         struct usb_req_rfwrite *req = NULL;
1273         int i, req_len, actual_req_len;
1274         u16 bit_value_template;
1275
1276         if (in_atomic()) {
1277                 dev_dbg_f(zd_usb_dev(usb),
1278                         "error: io in atomic context not supported\n");
1279                 return -EWOULDBLOCK;
1280         }
1281         if (bits < USB_MIN_RFWRITE_BIT_COUNT) {
1282                 dev_dbg_f(zd_usb_dev(usb),
1283                         "error: bits %d are smaller than"
1284                         " USB_MIN_RFWRITE_BIT_COUNT %d\n",
1285                         bits, USB_MIN_RFWRITE_BIT_COUNT);
1286                 return -EINVAL;
1287         }
1288         if (bits > USB_MAX_RFWRITE_BIT_COUNT) {
1289                 dev_dbg_f(zd_usb_dev(usb),
1290                         "error: bits %d exceed USB_MAX_RFWRITE_BIT_COUNT %d\n",
1291                         bits, USB_MAX_RFWRITE_BIT_COUNT);
1292                 return -EINVAL;
1293         }
1294 #ifdef DEBUG
1295         if (value & (~0UL << bits)) {
1296                 dev_dbg_f(zd_usb_dev(usb),
1297                         "error: value %#09x has bits >= %d set\n",
1298                         value, bits);
1299                 return -EINVAL;
1300         }
1301 #endif /* DEBUG */
1302
1303         dev_dbg_f(zd_usb_dev(usb), "value %#09x bits %d\n", value, bits);
1304
1305         r = zd_usb_ioread16(usb, &bit_value_template, CR203);
1306         if (r) {
1307                 dev_dbg_f(zd_usb_dev(usb),
1308                         "error %d: Couldn't read CR203\n", r);
1309                 goto out;
1310         }
1311         bit_value_template &= ~(RF_IF_LE|RF_CLK|RF_DATA);
1312
1313         req_len = sizeof(struct usb_req_rfwrite) + bits * sizeof(__le16);
1314         req = kmalloc(req_len, GFP_NOFS);
1315         if (!req)
1316                 return -ENOMEM;
1317
1318         req->id = cpu_to_le16(USB_REQ_WRITE_RF);
1319         /* 1: 3683a, but not used in ZYDAS driver */
1320         req->value = cpu_to_le16(2);
1321         req->bits = cpu_to_le16(bits);
1322
1323         for (i = 0; i < bits; i++) {
1324                 u16 bv = bit_value_template;
1325                 if (value & (1 << (bits-1-i)))
1326                         bv |= RF_DATA;
1327                 req->bit_values[i] = cpu_to_le16(bv);
1328         }
1329
1330         udev = zd_usb_to_usbdev(usb);
1331         r = usb_bulk_msg(udev, usb_sndbulkpipe(udev, EP_REGS_OUT),
1332                          req, req_len, &actual_req_len, 1000 /* ms */);
1333         if (r) {
1334                 dev_dbg_f(zd_usb_dev(usb),
1335                         "error in usb_bulk_msg(). Error number %d\n", r);
1336                 goto out;
1337         }
1338         if (req_len != actual_req_len) {
1339                 dev_dbg_f(zd_usb_dev(usb), "error in usb_bulk_msg()"
1340                         " req_len %d != actual_req_len %d\n",
1341                         req_len, actual_req_len);
1342                 r = -EIO;
1343                 goto out;
1344         }
1345
1346         /* FALL-THROUGH with r == 0 */
1347 out:
1348         kfree(req);
1349         return r;
1350 }