package/rt2x00/src/rt2x00usb.c

   1 /*
   2         Copyright (C) 2004 - 2007 rt2x00 SourceForge Project
   3         <http://rt2x00.serialmonkey.com>
   4
   5         This program is free software; you can redistribute it and/or modify
   6         it under the terms of the GNU General Public License as published by
   7         the Free Software Foundation; either version 2 of the License, or
   8         (at your option) any later version.
   9
  10         This program is distributed in the hope that it will be useful,
  11         but WITHOUT ANY WARRANTY; without even the implied warranty of
  12         MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13         GNU General Public License for more details.
  14
  15         You should have received a copy of the GNU General Public License
  16         along with this program; if not, write to the
  17         Free Software Foundation, Inc.,
  18         59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19  */
  20
  21 /*
  22         Module: rt2x00usb
  23         Abstract: rt2x00 generic usb device routines.
  24  */
  25
  26 /*
  27  * Set enviroment defines for rt2x00.h
  28  */
  29 #define DRV_NAME "rt2x00usb"
  30
  31 #include <linux/kernel.h>
  32 #include <linux/module.h>
  33 #include <linux/usb.h>
  34
  35 #include "rt2x00.h"
  36 #include "rt2x00usb.h"
  37
  38 /*
  39  * Interfacing with the HW.
  40  */
  41 int rt2x00usb_vendor_request(const struct rt2x00_dev *rt2x00dev,
  42                              const u8 request, const u8 requesttype,
  43                              const u16 offset, const u16 value,
  44                              void *buffer, const u16 buffer_length,
  45                              const int timeout)
  46 {
  47         struct usb_device *usb_dev =
  48             interface_to_usbdev(rt2x00dev_usb(rt2x00dev));
  49         int status;
  50         unsigned int i;
  51         unsigned int pipe =
  52             (requesttype == USB_VENDOR_REQUEST_IN) ?
  53             usb_rcvctrlpipe(usb_dev, 0) : usb_sndctrlpipe(usb_dev, 0);
  54
  55         for (i = 0; i < REGISTER_BUSY_COUNT; i++) {
  56                 status = usb_control_msg(usb_dev, pipe, request, requesttype,
  57                                          value, offset, buffer, buffer_length,
  58                                          timeout);
  59                 if (status >= 0)
  60                         return 0;
  61
  62                 /*
  63                  * Check for errors
  64                  * -ENODEV: Device has disappeared, no point continuing.
  65                  * All other errors: Try again.
  66                  */
  67                 else if (status == -ENODEV)
  68                         break;
  69         }
  70
  71         ERROR(rt2x00dev,
  72               "Vendor Request 0x%02x failed for offset 0x%04x with error %d.\n",
  73               request, offset, status);
  74
  75         return status;
  76 }
  77 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request);
  78
  79 int rt2x00usb_vendor_request_buff(const struct rt2x00_dev *rt2x00dev,
  80                                   const u8 request, const u8 requesttype,
  81                                   const u16 offset, void *buffer,
  82                                   const u16 buffer_length, const int timeout)
  83 {
  84         int status;
  85
  86         /*
  87          * Check for Cache availability.
  88          */
  89         if (unlikely(!rt2x00dev->csr_cache || buffer_length > CSR_CACHE_SIZE)) {
  90                 ERROR(rt2x00dev, "CSR cache not available.\n");
  91                 return -ENOMEM;
  92         }
  93
  94         if (requesttype == USB_VENDOR_REQUEST_OUT)
  95                 memcpy(rt2x00dev->csr_cache, buffer, buffer_length);
  96
  97         status = rt2x00usb_vendor_request(rt2x00dev, request, requesttype,
  98                                           offset, 0, rt2x00dev->csr_cache,
  99                                           buffer_length, timeout);
 100
 101         if (!status && requesttype == USB_VENDOR_REQUEST_IN)
 102                 memcpy(buffer, rt2x00dev->csr_cache, buffer_length);
 103
 104         return status;
 105 }
 106 EXPORT_SYMBOL_GPL(rt2x00usb_vendor_request_buff);
 107
 108 /*
 109  * TX data handlers.
 110  */
 111 static void rt2x00usb_interrupt_txdone(struct urb *urb)
 112 {
 113         struct data_entry *entry = (struct data_entry *)urb->context;
 114         struct data_ring *ring = entry->ring;
 115         struct rt2x00_dev *rt2x00dev = ring->rt2x00dev;
 116         struct data_desc *txd = (struct data_desc *)entry->skb->data;
 117         u32 word;
 118         int tx_status;
 119
 120         if (!test_bit(DEVICE_ENABLED_RADIO, &rt2x00dev->flags) ||
 121             !__test_and_clear_bit(ENTRY_OWNER_NIC, &entry->flags))
 122                 return;
 123
 124         rt2x00_desc_read(txd, 0, &word);
 125
 126         /*
 127          * Remove the descriptor data from the buffer.
 128          */
 129         skb_pull(entry->skb, ring->desc_size);
 130
 131         /*
 132          * Obtain the status about this packet.
 133          */
 134         tx_status = !urb->status ? TX_SUCCESS : TX_FAIL_RETRY;
 135
 136         rt2x00lib_txdone(entry, tx_status, 0);
 137
 138         /*
 139          * Make this entry available for reuse.
 140          */
 141         entry->flags = 0;
 142         rt2x00_ring_index_done_inc(entry->ring);
 143
 144         /*
 145          * If the data ring was full before the txdone handler
 146          * we must make sure the packet queue in the mac80211 stack
 147          * is reenabled when the txdone handler has finished.
 148          */
 149         if (!rt2x00_ring_full(ring))
 150                 ieee80211_wake_queue(rt2x00dev->hw,
 151                                      entry->tx_status.control.queue);
 152 }
 153
 154 int rt2x00usb_write_tx_data(struct rt2x00_dev *rt2x00dev,
 155                             struct data_ring *ring, struct sk_buff *skb,
 156                             struct ieee80211_tx_control *control)
 157 {
 158         struct usb_device *usb_dev =
 159             interface_to_usbdev(rt2x00dev_usb(rt2x00dev));
 160         struct data_entry *entry = rt2x00_get_data_entry(ring);
 161         int pipe = usb_sndbulkpipe(usb_dev, 1);
 162         u32 length;
 163
 164         if (rt2x00_ring_full(ring)) {
 165                 ieee80211_stop_queue(rt2x00dev->hw, control->queue);
 166                 return -EINVAL;
 167         }
 168
 169         if (test_bit(ENTRY_OWNER_NIC, &entry->flags)) {
 170                 ERROR(rt2x00dev,
 171                       "Arrived at non-free entry in the non-full queue %d.\n"
 172                       "Please file bug report to %s.\n",
 173                       control->queue, DRV_PROJECT);
 174                 ieee80211_stop_queue(rt2x00dev->hw, control->queue);
 175                 return -EINVAL;
 176         }
 177
 178         /*
 179          * Add the descriptor in front of the skb.
 180          */
 181         skb_push(skb, ring->desc_size);
 182         memset(skb->data, 0, ring->desc_size);
 183
 184         rt2x00lib_write_tx_desc(rt2x00dev, (struct data_desc *)skb->data,
 185                                 (struct ieee80211_hdr *)(skb->data +
 186                                                          ring->desc_size),
 187                                 skb->len - ring->desc_size, control);
 188         memcpy(&entry->tx_status.control, control, sizeof(*control));
 189         entry->skb = skb;
 190
 191         /*
 192          * USB devices cannot blindly pass the skb->len as the
 193          * length of the data to usb_fill_bulk_urb. Pass the skb
 194          * to the driver to determine what the length should be.
 195          */
 196         length = rt2x00dev->ops->lib->get_tx_data_len(rt2x00dev, skb);
 197
 198         /*
 199          * Initialize URB and send the frame to the device.
 200          */
 201         __set_bit(ENTRY_OWNER_NIC, &entry->flags);
 202         usb_fill_bulk_urb(entry->priv, usb_dev, pipe,
 203                           skb->data, length, rt2x00usb_interrupt_txdone, entry);
 204         usb_submit_urb(entry->priv, GFP_ATOMIC);
 205
 206         rt2x00_ring_index_inc(ring);
 207
 208         if (rt2x00_ring_full(ring))
 209                 ieee80211_stop_queue(rt2x00dev->hw, control->queue);
 210
 211         return 0;
 212 }
 213 EXPORT_SYMBOL_GPL(rt2x00usb_write_tx_data);
 214
 215 /*
 216  * RX data handlers.
 217  */
 218 static void rt2x00usb_interrupt_rxdone(struct urb *urb)
 219 {
 220         struct data_entry *entry = (struct data_entry *)urb->context;
 221         struct data_ring *ring = entry->ring;
 222         struct rt2x00_dev *rt2x00dev = ring->rt2x00dev;
 223         struct sk_buff *skb;
 224         struct ieee80211_hdr *hdr;
 225         struct rxdata_entry_desc desc;
 226         int header_size;
 227         int frame_size;
 228
 229         if (!test_bit(DEVICE_ENABLED_RADIO, &rt2x00dev->flags) ||
 230             !test_and_clear_bit(ENTRY_OWNER_NIC, &entry->flags))
 231                 return;
 232
 233         /*
 234          * Check if the received data is simply too small
 235          * to be actually valid, or if the urb is signaling
 236          * a problem.
 237          */
 238         if (urb->actual_length < entry->ring->desc_size || urb->status)
 239                 goto skip_entry;
 240
 241         memset(&desc, 0x00, sizeof(desc));
 242         rt2x00dev->ops->lib->fill_rxdone(entry, &desc);
 243
 244         /*
 245          * Allocate a new sk buffer to replace the current one.
 246          * If allocation fails, we should drop the current frame
 247          * so we can recycle the existing sk buffer for the new frame.
 248          * As alignment we use 2 and not NET_IP_ALIGN because we need
 249          * to be sure we have 2 bytes room in the head. (NET_IP_ALIGN
 250          * can be 0 on some hardware). We use these 2 bytes for frame
 251          * alignment later, we assume that the chance that
 252          * header_size % 4 == 2 is bigger then header_size % 2 == 0
 253          * and thus optimize alignment by reserving the 2 bytes in
 254          * advance.
 255          */
 256         frame_size = entry->ring->data_size + entry->ring->desc_size;
 257         skb = dev_alloc_skb(frame_size + 2);
 258         if (!skb)
 259                 goto skip_entry;
 260
 261         skb_reserve(skb, 2);
 262         skb_put(skb, frame_size);
 263
 264         /*
 265          * The data behind the ieee80211 header must be
 266          * aligned on a 4 byte boundary.
 267          * After that trim the entire buffer down to only
 268          * contain the valid frame data excluding the device
 269          * descriptor.
 270          */
 271         hdr = (struct ieee80211_hdr *)entry->skb->data;
 272         header_size =
 273             ieee80211_get_hdrlen(le16_to_cpu(hdr->frame_control));
 274
 275         if (header_size % 4 == 0) {
 276                 skb_push(entry->skb, 2);
 277                 memmove(entry->skb->data, entry->skb->data + 2, skb->len - 2);
 278         }
 279         skb_trim(entry->skb, desc.size);
 280
 281         /*
 282          * Send the frame to rt2x00lib for further processing.
 283          */
 284         rt2x00lib_rxdone(entry, entry->skb, &desc);
 285
 286         /*
 287          * Replace current entry's skb with the newly allocated one,
 288          * and reinitialize the urb.
 289          */
 290         entry->skb = skb;
 291         urb->transfer_buffer = entry->skb->data;
 292         urb->transfer_buffer_length = entry->skb->len;
 293
 294 skip_entry:
 295         if (test_bit(DEVICE_ENABLED_RADIO, &ring->rt2x00dev->flags)) {
 296                 __set_bit(ENTRY_OWNER_NIC, &entry->flags);
 297                 usb_submit_urb(urb, GFP_ATOMIC);
 298         }
 299
 300         rt2x00_ring_index_inc(ring);
 301 }
 302
 303 /*
 304  * Radio handlers
 305  */
 306 void rt2x00usb_enable_radio(struct rt2x00_dev *rt2x00dev)
 307 {
 308         struct usb_device *usb_dev =
 309             interface_to_usbdev(rt2x00dev_usb(rt2x00dev));
 310         struct data_ring *ring;
 311         struct data_entry *entry;
 312         unsigned int i;
 313
 314         /*
 315          * Initialize the TX rings
 316          */
 317         txringall_for_each(rt2x00dev, ring) {
 318                 for (i = 0; i < ring->stats.limit; i++)
 319                         ring->entry[i].flags = 0;
 320
 321                 rt2x00_ring_index_clear(ring);
 322         }
 323
 324         /*
 325          * Initialize and start the RX ring.
 326          */
 327         rt2x00_ring_index_clear(rt2x00dev->rx);
 328
 329         for (i = 0; i < rt2x00dev->rx->stats.limit; i++) {
 330                 entry = &rt2x00dev->rx->entry[i];
 331
 332                 usb_fill_bulk_urb(entry->priv, usb_dev,
 333                                   usb_rcvbulkpipe(usb_dev, 1),
 334                                   entry->skb->data, entry->skb->len,
 335                                   rt2x00usb_interrupt_rxdone, entry);
 336
 337                 __set_bit(ENTRY_OWNER_NIC, &entry->flags);
 338                 usb_submit_urb(entry->priv, GFP_ATOMIC);
 339         }
 340 }
 341 EXPORT_SYMBOL_GPL(rt2x00usb_enable_radio);
 342
 343 void rt2x00usb_disable_radio(struct rt2x00_dev *rt2x00dev)
 344 {
 345         struct data_ring *ring;
 346         unsigned int i;
 347
 348         rt2x00usb_vendor_request_sw(rt2x00dev, USB_RX_CONTROL, 0x0000, 0x0000,
 349                                     REGISTER_TIMEOUT);
 350
 351         /*
 352          * Cancel all rings.
 353          */
 354         ring_for_each(rt2x00dev, ring) {
 355                 for (i = 0; i < ring->stats.limit; i++)
 356                         usb_kill_urb(ring->entry[i].priv);
 357         }
 358 }
 359 EXPORT_SYMBOL_GPL(rt2x00usb_disable_radio);
 360
 361 /*
 362  * Device initialization handlers.
 363  */
 364 static int rt2x00usb_alloc_urb(struct rt2x00_dev *rt2x00dev,
 365                                struct data_ring *ring)
 366 {
 367         unsigned int i;
 368
 369         /*
 370          * Allocate the URB's
 371          */
 372         for (i = 0; i < ring->stats.limit; i++) {
 373                 ring->entry[i].priv = usb_alloc_urb(0, GFP_KERNEL);
 374                 if (!ring->entry[i].priv)
 375                         return -ENOMEM;
 376         }
 377
 378         return 0;
 379 }
 380
 381 static void rt2x00usb_free_urb(struct rt2x00_dev *rt2x00dev,
 382                                struct data_ring *ring)
 383 {
 384         unsigned int i;
 385
 386         if (!ring->entry)
 387                 return;
 388
 389         for (i = 0; i < ring->stats.limit; i++) {
 390                 usb_kill_urb(ring->entry[i].priv);
 391                 usb_free_urb(ring->entry[i].priv);
 392                 if (ring->entry[i].skb)
 393                         kfree_skb(ring->entry[i].skb);
 394         }
 395 }
 396
 397 int rt2x00usb_initialize(struct rt2x00_dev *rt2x00dev)
 398 {
 399         struct data_ring *ring;
 400         struct sk_buff *skb;
 401         unsigned int entry_size;
 402         unsigned int i;
 403         int status;
 404
 405         /*
 406          * Allocate DMA
 407          */
 408         ring_for_each(rt2x00dev, ring) {
 409                 status = rt2x00usb_alloc_urb(rt2x00dev, ring);
 410                 if (status)
 411                         goto exit;
 412         }
 413
 414         /*
 415          * For the RX ring, skb's should be allocated.
 416          */
 417         entry_size = rt2x00dev->rx->data_size + rt2x00dev->rx->desc_size;
 418         for (i = 0; i < rt2x00dev->rx->stats.limit; i++) {
 419                 skb = dev_alloc_skb(NET_IP_ALIGN + entry_size);
 420                 if (!skb)
 421                         goto exit;
 422
 423                 skb_reserve(skb, NET_IP_ALIGN);
 424                 skb_put(skb, entry_size);
 425
 426                 rt2x00dev->rx->entry[i].skb = skb;
 427         }
 428
 429         return 0;
 430
 431 exit:
 432         rt2x00usb_uninitialize(rt2x00dev);
 433
 434         return status;
 435 }
 436 EXPORT_SYMBOL_GPL(rt2x00usb_initialize);
 437
 438 void rt2x00usb_uninitialize(struct rt2x00_dev *rt2x00dev)
 439 {
 440         struct data_ring *ring;
 441
 442         ring_for_each(rt2x00dev, ring)
 443                 rt2x00usb_free_urb(rt2x00dev, ring);
 444 }
 445 EXPORT_SYMBOL_GPL(rt2x00usb_uninitialize);
 446
 447 /*
 448  * USB driver handlers.
 449  */
 450 static void rt2x00usb_free_reg(struct rt2x00_dev *rt2x00dev)
 451 {
 452         kfree(rt2x00dev->rf);
 453         rt2x00dev->rf = NULL;
 454
 455         kfree(rt2x00dev->eeprom);
 456         rt2x00dev->eeprom = NULL;
 457
 458         kfree(rt2x00dev->csr_cache);
 459         rt2x00dev->csr_cache = NULL;
 460 }
 461
 462 static int rt2x00usb_alloc_reg(struct rt2x00_dev *rt2x00dev)
 463 {
 464         rt2x00dev->csr_cache = kzalloc(CSR_CACHE_SIZE, GFP_KERNEL);
 465         if (!rt2x00dev->csr_cache)
 466                 goto exit;
 467
 468         rt2x00dev->eeprom = kzalloc(rt2x00dev->ops->eeprom_size, GFP_KERNEL);
 469         if (!rt2x00dev->eeprom)
 470                 goto exit;
 471
 472         rt2x00dev->rf = kzalloc(rt2x00dev->ops->rf_size, GFP_KERNEL);
 473         if (!rt2x00dev->rf)
 474                 goto exit;
 475
 476         return 0;
 477
 478 exit:
 479         ERROR_PROBE("Failed to allocate registers.\n");
 480
 481         rt2x00usb_free_reg(rt2x00dev);
 482
 483         return -ENOMEM;
 484 }
 485
 486 int rt2x00usb_probe(struct usb_interface *usb_intf,
 487                     const struct usb_device_id *id)
 488 {
 489         struct usb_device *usb_dev = interface_to_usbdev(usb_intf);
 490         struct rt2x00_ops *ops = (struct rt2x00_ops *)id->driver_info;
 491         struct ieee80211_hw *hw;
 492         struct rt2x00_dev *rt2x00dev;
 493         int retval;
 494
 495         usb_dev = usb_get_dev(usb_dev);
 496
 497         hw = ieee80211_alloc_hw(sizeof(struct rt2x00_dev), ops->hw);
 498         if (!hw) {
 499                 ERROR_PROBE("Failed to allocate hardware.\n");
 500                 retval = -ENOMEM;
 501                 goto exit_put_device;
 502         }
 503
 504         usb_set_intfdata(usb_intf, hw);
 505
 506         rt2x00dev = hw->priv;
 507         rt2x00dev->dev = usb_intf;
 508         rt2x00dev->ops = ops;
 509         rt2x00dev->hw = hw;
 510
 511         rt2x00dev->usb_maxpacket =
 512             usb_maxpacket(usb_dev, usb_sndbulkpipe(usb_dev, 1), 1);
 513         if (!rt2x00dev->usb_maxpacket)
 514                 rt2x00dev->usb_maxpacket = 1;
 515
 516         retval = rt2x00usb_alloc_reg(rt2x00dev);
 517         if (retval)
 518                 goto exit_free_device;
 519
 520         retval = rt2x00lib_probe_dev(rt2x00dev);
 521         if (retval)
 522                 goto exit_free_reg;
 523
 524         return 0;
 525
 526 exit_free_reg:
 527         rt2x00usb_free_reg(rt2x00dev);
 528
 529 exit_free_device:
 530         ieee80211_free_hw(hw);
 531
 532 exit_put_device:
 533         usb_put_dev(usb_dev);
 534
 535         usb_set_intfdata(usb_intf, NULL);
 536
 537         return retval;
 538 }
 539 EXPORT_SYMBOL_GPL(rt2x00usb_probe);
 540
 541 void rt2x00usb_disconnect(struct usb_interface *usb_intf)
 542 {
 543         struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
 544         struct rt2x00_dev *rt2x00dev = hw->priv;
 545
 546         /*
 547          * Free all allocated data.
 548          */
 549         rt2x00lib_remove_dev(rt2x00dev);
 550         rt2x00usb_free_reg(rt2x00dev);
 551         ieee80211_free_hw(hw);
 552
 553         /*
 554          * Free the USB device data.
 555          */
 556         usb_set_intfdata(usb_intf, NULL);
 557         usb_put_dev(interface_to_usbdev(usb_intf));
 558 }
 559 EXPORT_SYMBOL_GPL(rt2x00usb_disconnect);
 560
 561 #ifdef CONFIG_PM
 562 int rt2x00usb_suspend(struct usb_interface *usb_intf, pm_message_t state)
 563 {
 564         struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
 565         struct rt2x00_dev *rt2x00dev = hw->priv;
 566         int retval;
 567
 568         retval = rt2x00lib_suspend(rt2x00dev, state);
 569         if (retval)
 570                 return retval;
 571
 572         rt2x00usb_free_reg(rt2x00dev);
 573
 574         /*
 575          * Decrease usbdev refcount.
 576          */
 577         usb_put_dev(interface_to_usbdev(usb_intf));
 578
 579         return 0;
 580 }
 581 EXPORT_SYMBOL_GPL(rt2x00usb_suspend);
 582
 583 int rt2x00usb_resume(struct usb_interface *usb_intf)
 584 {
 585         struct ieee80211_hw *hw = usb_get_intfdata(usb_intf);
 586         struct rt2x00_dev *rt2x00dev = hw->priv;
 587         int retval;
 588
 589         usb_get_dev(interface_to_usbdev(usb_intf));
 590
 591         retval = rt2x00usb_alloc_reg(rt2x00dev);
 592         if (retval)
 593                 return retval;
 594
 595         retval = rt2x00lib_resume(rt2x00dev);
 596         if (retval)
 597                 goto exit_free_reg;
 598
 599         return 0;
 600
 601 exit_free_reg:
 602         rt2x00usb_free_reg(rt2x00dev);
 603
 604         return retval;
 605 }
 606 EXPORT_SYMBOL_GPL(rt2x00usb_resume);
 607 #endif /* CONFIG_PM */
 608
 609 /*
 610  * rt2x00pci module information.
 611  */
 612 MODULE_AUTHOR(DRV_PROJECT);
 613 MODULE_VERSION(DRV_VERSION);
 614 MODULE_DESCRIPTION("rt2x00 library");
 615 MODULE_LICENSE("GPL");