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