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