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                     usb_core_enable_driver(USB_DRIVER_MASS_STORAGE,true);
 203                     usb_core_enable_driver(USB_DRIVER_CHARGING_ONLY,false);
 204                     usb_enable(true);
 205 #else
 206                     /* Tell all threads that they have to back off the ATA.
 207                        We subtract one for our own thread. */
 208                     num_acks_to_expect =
 209                         queue_broadcast(SYS_USB_CONNECTED, 0) - 1;
 210                     waiting_for_ack = true;
 211                     DEBUGF("USB inserted. Waiting for ack from %d threads...\n",
 212                            num_acks_to_expect);
 213 #endif
 214                 }
 215                 break;
 216 #ifdef HAVE_USBSTACK
 217             case USB_REQUEST_DISK:
 218                 if(!waiting_for_ack)
 219                 {
 220                     /* Tell all threads that they have to back off the ATA.
 221                        We subtract one for our own thread. */
 222                     num_acks_to_expect =
 223                         queue_broadcast(SYS_USB_CONNECTED, 0) - 1;
 224                     waiting_for_ack = true;
 225                     DEBUGF("USB inserted. Waiting for ack from %d threads...\n",
 226                            num_acks_to_expect);
 227                 }
 228                 break;
 229             case USB_RELEASE_DISK:
 230                 if(!waiting_for_ack)
 231                 {
 232                     /* Tell all threads that they have to back off the ATA.
 233                        We subtract one for our own thread. */
 234                     num_acks_to_expect =
 235                         queue_broadcast(SYS_USB_DISCONNECTED, 0) - 1;
 236                     waiting_for_ack = true;
 237                     DEBUGF("USB inserted. Waiting for ack from %d threads...\n",
 238                            num_acks_to_expect);
 239                 }
 240                 break;
 241 #endif
 242             case SYS_USB_CONNECTED_ACK:
 243                 if(waiting_for_ack)
 244                 {
 245                     num_acks_to_expect--;
 246                     if(num_acks_to_expect == 0)
 247                     {
 248                         DEBUGF("All threads have acknowledged the connect.\n");
 249 #ifdef HAVE_USBSTACK
 250 #ifndef USE_ROCKBOX_USB
 251                         /* until we have native mass-storage mode, we want to reboot on
 252                            usb host connect */
 253                         try_reboot();
 254 #endif  /* USE_ROCKBOX_USB */
 255 #ifdef HAVE_PRIORITY_SCHEDULING
 256                         thread_set_priority(usb_thread_entry,PRIORITY_REALTIME);
 257 #endif
 258                         exclusive_ata_access = true;
 259
 260 #else
 261                         usb_slave_mode(true);
 262                         cpu_idle_mode(true);
 263 #endif
 264                         usb_state = USB_INSERTED;
 265                         waiting_for_ack = false;
 266                     }
 267                     else
 268                     {
 269                         DEBUGF("usb: got ack, %d to go...\n",
 270                                num_acks_to_expect);
 271                     }
 272                 }
 273                 break;
 274
 275             case USB_EXTRACTED:
 276 #ifdef HAVE_USBSTACK
 277                 usb_enable(false);
 278 #ifdef HAVE_PRIORITY_SCHEDULING
 279                 thread_set_priority(usb_thread_entry,PRIORITY_SYSTEM);
 280 #endif
 281 #endif
 282 #ifdef HAVE_LCD_BITMAP
 283                 if(do_screendump_instead_of_usb)
 284                     break;
 285 #endif
 286 #ifdef HAVE_USB_POWER
 287                 if(usb_state == USB_POWERED)
 288                 {
 289                     usb_state = USB_EXTRACTED;
 290                     break;
 291                 }
 292 #endif
 293 #ifndef HAVE_USBSTACK
 294                 if(usb_state == USB_INSERTED)
 295                 {
 296                     /* Only disable the USB mode if we really have enabled it
 297                        some threads might not have acknowledged the
 298                        insertion */
 299                     usb_slave_mode(false);
 300                     cpu_idle_mode(false);
 301                 }
 302 #endif
 303
 304                 usb_state = USB_EXTRACTED;
 305 #ifdef HAVE_USBSTACK
 306                 if(exclusive_ata_access)
 307                 {
 308                     exclusive_ata_access = false;
 309 #endif
 310                     /* Tell all threads that we are back in business */
 311                     num_acks_to_expect =
 312                         queue_broadcast(SYS_USB_DISCONNECTED, 0) - 1;
 313                     waiting_for_ack = true;
 314                     DEBUGF("USB extracted. Waiting for ack from %d threads...\n",
 315                            num_acks_to_expect);
 316 #ifdef HAVE_USBSTACK
 317                 }
 318 #endif
 319                 break;
 320
 321             case SYS_USB_DISCONNECTED_ACK:
 322                 if(waiting_for_ack)
 323                 {
 324                     num_acks_to_expect--;
 325                     if(num_acks_to_expect == 0)
 326                     {
 327                         DEBUGF("All threads have acknowledged. "
 328                                "We're in business.\n");
 329                         waiting_for_ack = false;
 330                     }
 331                     else
 332                     {
 333                         DEBUGF("usb: got ack, %d to go...\n",
 334                                num_acks_to_expect);
 335                     }
 336                 }
 337                 break;
 338
 339 #ifdef HAVE_HOTSWAP
 340             case SYS_HOTSWAP_INSERTED:
 341             case SYS_HOTSWAP_EXTRACTED:
 342 #ifdef HAVE_USBSTACK
 343                 usb_core_hotswap_event(1,ev.id == SYS_HOTSWAP_INSERTED);
 344 #else
 345                 if(usb_state == USB_INSERTED)
 346                 {
 347                     usb_enable(false);
 348                     usb_mmc_countdown = HZ/2; /* re-enable after 0.5 sec */
 349                 }
 350                 break;
 351 #endif
 352
 353             case USB_REENABLE:
 354                 if(usb_state == USB_INSERTED)
 355                     usb_enable(true);  /* reenable only if still inserted */
 356                 break;
 357 #endif
 358             case USB_REQUEST_REBOOT:
 359 #ifdef HAVE_USB_POWER
 360                 if((button_status() & ~USBPOWER_BTN_IGNORE) != USBPOWER_BUTTON)
 361 #endif
 362                     try_reboot();
 363                 break;
 364         }
 365     }
 366 }
 367 #endif
 368
 369 #ifdef HAVE_USBSTACK
 370 void usb_signal_transfer_completion(struct usb_transfer_completion_event_data* event_data)
 371 {
 372     queue_post(&usb_queue, USB_TRANSFER_COMPLETION, (intptr_t)event_data);
 373 }
 374 #endif
 375
 376 #ifndef BOOTLOADER
 377 static void usb_tick(void)
 378 {
 379     int current_status;
 380
 381     if(usb_monitor_enabled)
 382     {
 383 #if defined(IPOD_COLOR) || defined(IPOD_4G) \
 384  || defined(IPOD_MINI)  || defined(IPOD_MINI2G)
 385         int current_firewire_status = firewire_detect();
 386         if(current_firewire_status != last_firewire_status)
 387         {
 388             last_firewire_status = current_firewire_status;
 389             firewire_countdown = NUM_POLL_READINGS;
 390         }
 391         else
 392         {
 393             /* Count down until it gets negative */
 394             if(firewire_countdown >= 0)
 395                 firewire_countdown--;
 396
 397             /* Report to the thread if we have had 3 identical status
 398                readings in a row */
 399             if(firewire_countdown == 0)
 400             {
 401                 queue_post(&usb_queue, USB_REQUEST_REBOOT, 0);
 402             }
 403         }
 404 #endif
 405
 406         current_status = usb_detect();
 407
 408         /* Only report when the status has changed */
 409         if(current_status != last_usb_status)
 410         {
 411             last_usb_status = current_status;
 412             countdown = NUM_POLL_READINGS;
 413         }
 414         else
 415         {
 416             /* Count down until it gets negative */
 417             if(countdown >= 0)
 418                 countdown--;
 419
 420             /* Report to the thread if we have had 3 identical status
 421                readings in a row */
 422             if(countdown == 0)
 423             {
 424                 queue_post(&usb_queue, current_status, 0);
 425             }
 426         }
 427     }
 428 #ifdef HAVE_MMC
 429     if(usb_mmc_countdown > 0)
 430     {
 431         usb_mmc_countdown--;
 432         if (usb_mmc_countdown == 0)
 433             queue_post(&usb_queue, USB_REENABLE, 0);
 434     }
 435 #endif
 436 }
 437 #endif
 438
 439 void usb_acknowledge(long id)
 440 {
 441     queue_post(&usb_queue, id, 0);
 442 }
 443
 444 void usb_init(void)
 445 {
 446     usb_state = USB_EXTRACTED;
 447 #ifdef HAVE_USBSTACK
 448     exclusive_ata_access = false;
 449 #endif
 450     usb_monitor_enabled = false;
 451     countdown = -1;
 452
 453 #if defined(IPOD_COLOR) || defined(IPOD_4G) \
 454  || defined(IPOD_MINI)  || defined(IPOD_MINI2G)
 455     firewire_countdown = -1;
 456     last_firewire_status = false;
 457 #endif
 458
 459     usb_init_device();
 460     usb_enable(false);
 461
 462     /* We assume that the USB cable is extracted */
 463     last_usb_status = USB_EXTRACTED;
 464
 465 #ifndef BOOTLOADER
 466     queue_init(&usb_queue, true);
 467
 468     usb_thread_entry = create_thread(usb_thread, usb_stack,
 469                        sizeof(usb_stack), 0, usb_thread_name
 470                        IF_PRIO(, PRIORITY_SYSTEM) IF_COP(, CPU));
 471
 472     tick_add_task(usb_tick);
 473 #endif
 474
 475 }
 476
 477 void usb_wait_for_disconnect(struct event_queue *q)
 478 {
 479     struct queue_event ev;
 480
 481     /* Don't return until we get SYS_USB_DISCONNECTED */
 482     while(1)
 483     {
 484         queue_wait(q, &ev);
 485         if(ev.id == SYS_USB_DISCONNECTED)
 486         {
 487             usb_acknowledge(SYS_USB_DISCONNECTED_ACK);
 488             return;
 489         }
 490     }
 491 }
 492
 493 int usb_wait_for_disconnect_w_tmo(struct event_queue *q, int ticks)
 494 {
 495     struct queue_event ev;
 496
 497     /* Don't return until we get SYS_USB_DISCONNECTED or SYS_TIMEOUT */
 498     while(1)
 499     {
 500         queue_wait_w_tmo(q, &ev, ticks);
 501         switch(ev.id)
 502         {
 503             case SYS_USB_DISCONNECTED:
 504                 usb_acknowledge(SYS_USB_DISCONNECTED_ACK);
 505                 return 0;
 506                 break;
 507             case SYS_TIMEOUT:
 508                 return 1;
 509                 break;
 510         }
 511     }
 512 }
 513
 514 void usb_start_monitoring(void)
 515 {
 516     usb_monitor_enabled = true;
 517 }
 518
 519 bool usb_inserted(void)
 520 {
 521 #ifdef HAVE_USB_POWER
 522     return usb_state == USB_INSERTED || usb_state == USB_POWERED;
 523 #else
 524     return usb_state == USB_INSERTED;
 525 #endif
 526 }
 527
 528 #ifdef HAVE_USBSTACK
 529 void usb_request_exclusive_ata(void)
 530 {
 531     /* This is not really a clean place to start boosting the cpu. but it's
 532      * currently the best one. We want to get rid of having to boost the cpu
 533      * for usb anyway */
 534     trigger_cpu_boost();
 535     if(!exclusive_ata_access) {
 536         queue_post(&usb_queue, USB_REQUEST_DISK, 0);
 537     }
 538 }
 539
 540 void usb_release_exclusive_ata(void)
 541 {
 542     cancel_cpu_boost();
 543     if(exclusive_ata_access) {
 544         queue_post(&usb_queue, USB_RELEASE_DISK, 0);
 545         exclusive_ata_access = false;
 546     }
 547 }
 548
 549 bool usb_exclusive_ata(void)
 550 {
 551     return exclusive_ata_access;
 552 }
 553 #endif
 554
 555 #ifdef HAVE_USB_POWER
 556 bool usb_powered(void)
 557 {
 558     return usb_state == USB_POWERED;
 559 }
 560
 561 #if CONFIG_CHARGING
 562 bool usb_charging_enable(bool on)
 563 {
 564     bool rc = false;
 565 #ifdef IRIVER_H300_SERIES
 566     int irqlevel;
 567     logf("usb_charging_enable(%s)\n", on ? "on" : "off" );
 568     irqlevel = set_irq_level(HIGHEST_IRQ_LEVEL);
 569     pcf50606_set_usb_charging(on);
 570     rc = on;
 571     (void)set_irq_level(irqlevel);
 572 #else
 573     /* TODO: implement it for other targets... */
 574     (void)on;
 575 #endif
 576     return rc;
 577 }
 578
 579 bool usb_charging_enabled(void)
 580 {
 581     bool rc = false;
 582 #ifdef IRIVER_H300_SERIES
 583     /* TODO: read the state of the GPOOD2 register...
 584      * (this also means to set the irq level here) */
 585     rc = pcf50606_usb_charging_enabled();
 586 #else
 587     /* TODO: implement it for other targets... */
 588 #endif
 589
 590     logf("usb charging %s", rc ? "enabled" : "disabled" );
 591     return rc;
 592 }
 593 #endif
 594 #endif
 595
 596 #else
 597
 598 #ifdef USB_NONE
 599 bool usb_inserted(void)
 600 {
 601     return false;
 602 }
 603 #endif
 604
 605 /* Dummy simulator functions */
 606 void usb_acknowledge(long id)
 607 {
 608     id = id;
 609 }
 610
 611 void usb_init(void)
 612 {
 613 }
 614
 615 void usb_start_monitoring(void)
 616 {
 617 }
 618
 619 int usb_detect(void)
 620 {
 621     return USB_EXTRACTED;
 622 }
 623
 624 void usb_wait_for_disconnect(struct event_queue *q)
 625 {
 626    (void)q;
 627 }
 628
 629 #endif /* USB_NONE or SIMULATOR */