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