firmware/usb.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 by Linus Nielsen Feltzing
  11  *
  12  * iPod driver based on code from the ipodlinux project - http://ipodlinux.org
  13  * Adapted for Rockbox in January 2006
  14  * Original file: podzilla/usb.c
  15  * Copyright (C) 2005 Adam Johnston
  16  *
  17  * All files in this archive are subject to the GNU General Public License.
  18  * See the file COPYING in the source tree root for full license agreement.
  19  *
  20  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  21  * KIND, either express or implied.
  22  *
  23  ****************************************************************************/
  24 #include "config.h"
  25 #include "cpu.h"
  26 #include "kernel.h"
  27 #include "thread.h"
  28 #include "system.h"
  29 #include "debug.h"
  30 #include "ata.h"
  31 #include "fat.h"
  32 #include "disk.h"
  33 #include "panic.h"
  34 #include "lcd.h"
  35 #include "usb.h"
  36 #include "button.h"
  37 #include "sprintf.h"
  38 #include "string.h"
  39 #include "usb-target.h"
  40 #ifdef HAVE_USBSTACK
  41 #include "usb_core.h"
  42 #endif
  43 #ifdef IRIVER_H300_SERIES
  44 #include "pcf50606.h"        /* for pcf50606_usb_charging_... */
  45 #endif
  46 #include "logf.h"
  47
  48 extern void dbg_ports(void); /* NASTY! defined in apps/ */
  49
  50 #ifdef HAVE_LCD_BITMAP
  51 bool do_screendump_instead_of_usb = false;
  52 void screen_dump(void);   /* Nasty again. Defined in apps/ too */
  53 #endif
  54
  55 #if !defined(SIMULATOR) && !defined(USB_NONE)
  56
  57 #define NUM_POLL_READINGS (HZ/5)
  58 static int countdown;
  59
  60 static int usb_state;
  61
  62 #if defined(HAVE_MMC) && !defined(BOOTLOADER)
  63 static int usb_mmc_countdown = 0;
  64 #endif
  65
  66 /* FIXME: The extra 0x800 is consumed by fat_mount() when the fsinfo
  67    needs updating */
  68 #ifndef BOOTLOADER
  69 static long usb_stack[(DEFAULT_STACK_SIZE + 0x800)/sizeof(long)];
  70 static const char usb_thread_name[] = "usb";
  71 static struct thread_entry *usb_thread_entry;
  72 #endif
  73 static struct event_queue usb_queue;
  74 static int last_usb_status;
  75 static bool usb_monitor_enabled;
  76 #ifdef HAVE_USBSTACK
  77 static bool exclusive_ata_access;
  78 #endif
  79
  80
  81 #if defined(IPOD_COLOR) || defined(IPOD_4G) \
  82  || defined(IPOD_MINI)  || defined(IPOD_MINI2G)
  83 static int firewire_countdown;
  84 static bool last_firewire_status;
  85 #endif
  86
  87
  88
  89 #ifndef BOOTLOADER
  90 #ifndef HAVE_USBSTACK
  91 static void usb_slave_mode(bool on)
  92 {
  93     int rc;
  94
  95     if(on)
  96     {
  97         DEBUGF("Entering USB slave mode\n");
  98         ata_soft_reset();
  99         ata_init();
 100         ata_enable(false);
 101         usb_enable(true);
 102     }
 103     else
 104     {
 105         DEBUGF("Leaving USB slave mode\n");
 106
 107         /* Let the ISDx00 settle */
 108         sleep(HZ*1);
 109
 110         usb_enable(false);
 111
 112         rc = ata_init();
 113         if(rc)
 114         {
 115             /* fixme: can we remove this? (already such in main.c) */
 116             char str[32];
 117             lcd_clear_display();
 118             snprintf(str, 31, "ATA error: %d", rc);
 119             lcd_puts(0, 0, str);
 120             lcd_puts(0, 1, "Press ON to debug");
 121             lcd_update();
 122             while(!(button_get(true) & BUTTON_REL)) {};
 123             dbg_ports();
 124             panicf("ata: %d",rc);
 125         }
 126
 127         rc = disk_mount_all();
 128         if (rc <= 0) /* no partition */
 129             panicf("mount: %d",rc);
 130
 131     }
 132 }
 133 #endif
 134
 135 static void try_reboot(void)
 136 {
 137 #ifndef HAVE_FLASH_STORAGE
 138     ata_sleepnow(); /* Immediately spindown the disk. */
 139     sleep(HZ*2);
 140 #endif
 141
 142 #ifdef IPOD_ARCH  /* The following code is based on ipodlinux */
 143 #if CONFIG_CPU == PP5020
 144     memcpy((void *)0x40017f00, "diskmode\0\0hotstuff\0\0\1", 21);
 145 #elif CONFIG_CPU == PP5022
 146     memcpy((void *)0x4001ff00, "diskmode\0\0hotstuff\0\0\1", 21);
 147 #endif /* CONFIG_CPU */
 148 #endif /* IPOD_ARCH */
 149
 150     system_reboot(); /* Reboot */
 151 }
 152
 153 static void usb_thread(void)
 154 {
 155     int num_acks_to_expect = -1;
 156     bool waiting_for_ack;
 157     struct queue_event ev;
 158
 159     waiting_for_ack = false;
 160
 161     while(1)
 162     {
 163         queue_wait(&usb_queue, &ev);
 164         switch(ev.id)
 165         {
 166 #ifdef HAVE_USBSTACK
 167             case USB_TRANSFER_COMPLETION:
 168                 usb_core_handle_transfer_completion((struct usb_transfer_completion_event_data*)ev.data);
 169                 break;
 170 #endif
 171 #ifdef HAVE_USB_POWER
 172             case USB_POWERED:
 173                 usb_state = USB_POWERED;
 174                 break;
 175 #endif
 176             case USB_INSERTED:
 177 #ifdef HAVE_LCD_BITMAP
 178                 if(do_screendump_instead_of_usb)
 179                 {
 180                     screen_dump();
 181                 }
 182                 else
 183 #endif
 184 #ifdef HAVE_USB_POWER
 185 #if defined(IRIVER_H10) || defined (IRIVER_H10_5GB)
 186                 if((button_status() & ~USBPOWER_BTN_IGNORE) != USBPOWER_BUTTON)
 187 #else
 188                 if((button_status() & ~USBPOWER_BTN_IGNORE) == USBPOWER_BUTTON)
 189 #endif
 190                 {
 191                     usb_state = USB_POWERED;
 192 #ifdef HAVE_USBSTACK
 193                     usb_core_enable_driver(USB_DRIVER_MASS_STORAGE,false);
 194                     usb_core_enable_driver(USB_DRIVER_CHARGING_ONLY,true);
 195                     usb_enable(true);
 196 #endif
 197                 }
 198                 else
 199 #endif
 200                 {
 201 #ifdef HAVE_USBSTACK
 202                     /* Set the state to USB_POWERED for now. if a real
 203                        connection is detected it will switch to USB_INSERTED */
 204                     usb_state = USB_POWERED;
 205                     usb_core_enable_driver(USB_DRIVER_MASS_STORAGE,true);
 206                     usb_core_enable_driver(USB_DRIVER_CHARGING_ONLY,false);
 207                     usb_enable(true);
 208 #else
 209                     /* Tell all threads that they have to back off the ATA.
 210                        We subtract one for our own thread. */
 211                     num_acks_to_expect =
 212                         queue_broadcast(SYS_USB_CONNECTED, 0) - 1;
 213                     waiting_for_ack = true;
 214                     DEBUGF("USB inserted. Waiting for ack from %d threads...\n",
 215                            num_acks_to_expect);
 216 #endif
 217                 }
 218                 break;
 219 #ifdef HAVE_USBSTACK
 220             case USB_REQUEST_DISK:
 221                 if(!waiting_for_ack)
 222                 {
 223                     /* Tell all threads that they have to back off the ATA.
 224                        We subtract one for our own thread. */
 225                     num_acks_to_expect =
 226                         queue_broadcast(SYS_USB_CONNECTED, 0) - 1;
 227                     waiting_for_ack = true;
 228                     DEBUGF("USB inserted. Waiting for ack from %d threads...\n",
 229                            num_acks_to_expect);
 230                 }
 231                 break;
 232             case USB_RELEASE_DISK:
 233                 if(!waiting_for_ack)
 234                 {
 235                     /* Tell all threads that they have to back off the ATA.
 236                        We subtract one for our own thread. */
 237                     num_acks_to_expect =
 238                         queue_broadcast(SYS_USB_DISCONNECTED, 0) - 1;
 239                     waiting_for_ack = true;
 240                     DEBUGF("USB inserted. Waiting for ack from %d threads...\n",
 241                            num_acks_to_expect);
 242                 }
 243                 break;
 244 #endif
 245             case SYS_USB_CONNECTED_ACK:
 246                 if(waiting_for_ack)
 247                 {
 248                     num_acks_to_expect--;
 249                     if(num_acks_to_expect == 0)
 250                     {
 251                         DEBUGF("All threads have acknowledged the connect.\n");
 252 #ifdef HAVE_USBSTACK
 253 #ifndef USE_ROCKBOX_USB
 254                         /* until we have native mass-storage mode, we want to reboot on
 255                            usb host connect */
 256                         try_reboot();
 257 #endif  /* USE_ROCKBOX_USB */
 258 #ifdef HAVE_PRIORITY_SCHEDULING
 259                         thread_set_priority(usb_thread_entry,PRIORITY_REALTIME);
 260 #endif
 261                         exclusive_ata_access = true;
 262
 263 #else
 264                         usb_slave_mode(true);
 265                         cpu_idle_mode(true);
 266 #endif
 267                         usb_state = USB_INSERTED;
 268                         waiting_for_ack = false;
 269                     }
 270                     else
 271                     {
 272                         DEBUGF("usb: got ack, %d to go...\n",
 273                                num_acks_to_expect);
 274                     }
 275                 }
 276                 break;
 277
 278             case USB_EXTRACTED:
 279 #ifdef HAVE_USBSTACK
 280                 usb_enable(false);
 281 #ifdef HAVE_PRIORITY_SCHEDULING
 282                 thread_set_priority(usb_thread_entry,PRIORITY_SYSTEM);
 283 #endif
 284 #endif
 285 #ifdef HAVE_LCD_BITMAP
 286                 if(do_screendump_instead_of_usb)
 287                     break;
 288 #endif
 289 #ifdef HAVE_USB_POWER
 290                 if(usb_state == USB_POWERED)
 291                 {
 292                     usb_state = USB_EXTRACTED;
 293                     break;
 294                 }
 295 #endif
 296 #ifndef HAVE_USBSTACK
 297                 if(usb_state == USB_INSERTED)
 298                 {
 299                     /* Only disable the USB mode if we really have enabled it
 300                        some threads might not have acknowledged the
 301                        insertion */
 302                     usb_slave_mode(false);
 303                     cpu_idle_mode(false);
 304                 }
 305 #endif
 306
 307                 usb_state = USB_EXTRACTED;
 308 #ifdef HAVE_USBSTACK
 309                 if(exclusive_ata_access)
 310                 {
 311                     exclusive_ata_access = false;
 312 #endif
 313                     /* Tell all threads that we are back in business */
 314                     num_acks_to_expect =
 315                         queue_broadcast(SYS_USB_DISCONNECTED, 0) - 1;
 316                     waiting_for_ack = true;
 317                     DEBUGF("USB extracted. Waiting for ack from %d threads...\n",
 318                            num_acks_to_expect);
 319 #ifdef HAVE_USBSTACK
 320                 }
 321 #endif
 322                 break;
 323
 324             case SYS_USB_DISCONNECTED_ACK:
 325                 if(waiting_for_ack)
 326                 {
 327                     num_acks_to_expect--;
 328                     if(num_acks_to_expect == 0)
 329                     {
 330                         DEBUGF("All threads have acknowledged. "
 331                                "We're in business.\n");
 332                         waiting_for_ack = false;
 333                     }
 334                     else
 335                     {
 336                         DEBUGF("usb: got ack, %d to go...\n",
 337                                num_acks_to_expect);
 338                     }
 339                 }
 340                 break;
 341
 342 #ifdef HAVE_HOTSWAP
 343             case SYS_HOTSWAP_INSERTED:
 344             case SYS_HOTSWAP_EXTRACTED:
 345 #ifdef HAVE_USBSTACK
 346                 usb_core_hotswap_event(1,ev.id == SYS_HOTSWAP_INSERTED);
 347 #else
 348                 if(usb_state == USB_INSERTED)
 349                 {
 350                     usb_enable(false);
 351                     usb_mmc_countdown = HZ/2; /* re-enable after 0.5 sec */
 352                 }
 353                 break;
 354 #endif
 355
 356             case USB_REENABLE:
 357                 if(usb_state == USB_INSERTED)
 358                     usb_enable(true);  /* reenable only if still inserted */
 359                 break;
 360 #endif
 361             case USB_REQUEST_REBOOT:
 362 #ifdef HAVE_USB_POWER
 363                 if((button_status() & ~USBPOWER_BTN_IGNORE) != USBPOWER_BUTTON)
 364 #endif
 365                     try_reboot();
 366                 break;
 367         }
 368     }
 369 }
 370 #endif
 371
 372 #ifdef HAVE_USBSTACK
 373 void usb_signal_transfer_completion(struct usb_transfer_completion_event_data* event_data)
 374 {
 375     queue_post(&usb_queue, USB_TRANSFER_COMPLETION, (intptr_t)event_data);
 376 }
 377 #endif
 378
 379 #ifndef BOOTLOADER
 380 static void usb_tick(void)
 381 {
 382     int current_status;
 383
 384     if(usb_monitor_enabled)
 385     {
 386 #if defined(IPOD_COLOR) || defined(IPOD_4G) \
 387  || defined(IPOD_MINI)  || defined(IPOD_MINI2G)
 388         int current_firewire_status = firewire_detect();
 389         if(current_firewire_status != last_firewire_status)
 390         {
 391             last_firewire_status = current_firewire_status;
 392             firewire_countdown = NUM_POLL_READINGS;
 393         }
 394         else
 395         {
 396             /* Count down until it gets negative */
 397             if(firewire_countdown >= 0)
 398                 firewire_countdown--;
 399
 400             /* Report to the thread if we have had 3 identical status
 401                readings in a row */
 402             if(firewire_countdown == 0)
 403             {
 404                 queue_post(&usb_queue, USB_REQUEST_REBOOT, 0);
 405             }
 406         }
 407 #endif
 408
 409         current_status = usb_detect();
 410
 411         /* Only report when the status has changed */
 412         if(current_status != last_usb_status)
 413         {
 414             last_usb_status = current_status;
 415             countdown = NUM_POLL_READINGS;
 416         }
 417         else
 418         {
 419             /* Count down until it gets negative */
 420             if(countdown >= 0)
 421                 countdown--;
 422
 423             /* Report to the thread if we have had 3 identical status
 424                readings in a row */
 425             if(countdown == 0)
 426             {
 427                 queue_post(&usb_queue, current_status, 0);
 428             }
 429         }
 430     }
 431 #ifdef HAVE_MMC
 432     if(usb_mmc_countdown > 0)
 433     {
 434         usb_mmc_countdown--;
 435         if (usb_mmc_countdown == 0)
 436             queue_post(&usb_queue, USB_REENABLE, 0);
 437     }
 438 #endif
 439 }
 440 #endif
 441
 442 void usb_acknowledge(long id)
 443 {
 444     queue_post(&usb_queue, id, 0);
 445 }
 446
 447 void usb_init(void)
 448 {
 449     usb_state = USB_EXTRACTED;
 450 #ifdef HAVE_USBSTACK
 451     exclusive_ata_access = false;
 452 #endif
 453     usb_monitor_enabled = false;
 454     countdown = -1;
 455
 456 #if defined(IPOD_COLOR) || defined(IPOD_4G) \
 457  || defined(IPOD_MINI)  || defined(IPOD_MINI2G)
 458     firewire_countdown = -1;
 459     last_firewire_status = false;
 460 #endif
 461
 462     usb_init_device();
 463     usb_enable(false);
 464
 465     /* We assume that the USB cable is extracted */
 466     last_usb_status = USB_EXTRACTED;
 467
 468 #ifndef BOOTLOADER
 469     queue_init(&usb_queue, true);
 470
 471     usb_thread_entry = create_thread(usb_thread, usb_stack,
 472                        sizeof(usb_stack), 0, usb_thread_name
 473                        IF_PRIO(, PRIORITY_SYSTEM) IF_COP(, CPU));
 474
 475     tick_add_task(usb_tick);
 476 #endif
 477
 478 }
 479
 480 void usb_wait_for_disconnect(struct event_queue *q)
 481 {
 482     struct queue_event ev;
 483
 484     /* Don't return until we get SYS_USB_DISCONNECTED */
 485     while(1)
 486     {
 487         queue_wait(q, &ev);
 488         if(ev.id == SYS_USB_DISCONNECTED)
 489         {
 490             usb_acknowledge(SYS_USB_DISCONNECTED_ACK);
 491             return;
 492         }
 493     }
 494 }
 495
 496 int usb_wait_for_disconnect_w_tmo(struct event_queue *q, int ticks)
 497 {
 498     struct queue_event ev;
 499
 500     /* Don't return until we get SYS_USB_DISCONNECTED or SYS_TIMEOUT */
 501     while(1)
 502     {
 503         queue_wait_w_tmo(q, &ev, ticks);
 504         switch(ev.id)
 505         {
 506             case SYS_USB_DISCONNECTED:
 507                 usb_acknowledge(SYS_USB_DISCONNECTED_ACK);
 508                 return 0;
 509                 break;
 510             case SYS_TIMEOUT:
 511                 return 1;
 512                 break;
 513         }
 514     }
 515 }
 516
 517 void usb_start_monitoring(void)
 518 {
 519     usb_monitor_enabled = true;
 520 }
 521
 522 bool usb_inserted(void)
 523 {
 524 #ifdef HAVE_USB_POWER
 525     return usb_state == USB_INSERTED || usb_state == USB_POWERED;
 526 #else
 527     return usb_state == USB_INSERTED;
 528 #endif
 529 }
 530
 531 #ifdef HAVE_USBSTACK
 532 void usb_request_exclusive_ata(void)
 533 {
 534     /* This is not really a clean place to start boosting the cpu. but it's
 535      * currently the best one. We want to get rid of having to boost the cpu
 536      * for usb anyway */
 537     trigger_cpu_boost();
 538     if(!exclusive_ata_access) {
 539         queue_post(&usb_queue, USB_REQUEST_DISK, 0);
 540     }
 541 }
 542
 543 void usb_release_exclusive_ata(void)
 544 {
 545     cancel_cpu_boost();
 546     if(exclusive_ata_access) {
 547         queue_post(&usb_queue, USB_RELEASE_DISK, 0);
 548         exclusive_ata_access = false;
 549     }
 550 }
 551
 552 bool usb_exclusive_ata(void)
 553 {
 554     return exclusive_ata_access;
 555 }
 556 #endif
 557
 558 #ifdef HAVE_USB_POWER
 559 bool usb_powered(void)
 560 {
 561     return usb_state == USB_POWERED;
 562 }
 563
 564 #if CONFIG_CHARGING
 565 bool usb_charging_enable(bool on)
 566 {
 567     bool rc = false;
 568 #ifdef IRIVER_H300_SERIES
 569     int irqlevel;
 570     logf("usb_charging_enable(%s)\n", on ? "on" : "off" );
 571     irqlevel = disable_irq_save();
 572     pcf50606_set_usb_charging(on);
 573     rc = on;
 574     restore_irq(irqlevel);
 575 #else
 576     /* TODO: implement it for other targets... */
 577     (void)on;
 578 #endif
 579     return rc;
 580 }
 581
 582 bool usb_charging_enabled(void)
 583 {
 584     bool rc = false;
 585 #ifdef IRIVER_H300_SERIES
 586     /* TODO: read the state of the GPOOD2 register...
 587      * (this also means to set the irq level here) */
 588     rc = pcf50606_usb_charging_enabled();
 589 #else
 590     /* TODO: implement it for other targets... */
 591 #endif
 592
 593     logf("usb charging %s", rc ? "enabled" : "disabled" );
 594     return rc;
 595 }
 596 #endif
 597 #endif
 598
 599 #else
 600
 601 #ifdef USB_NONE
 602 bool usb_inserted(void)
 603 {
 604     return false;
 605 }
 606 #endif
 607
 608 /* Dummy simulator functions */
 609 void usb_acknowledge(long id)
 610 {
 611     id = id;
 612 }
 613
 614 void usb_init(void)
 615 {
 616 }
 617
 618 void usb_start_monitoring(void)
 619 {
 620 }
 621
 622 int usb_detect(void)
 623 {
 624     return USB_EXTRACTED;
 625 }
 626
 627 void usb_wait_for_disconnect(struct event_queue *q)
 628 {
 629    (void)q;
 630 }
 631
 632 #endif /* USB_NONE or SIMULATOR */