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