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