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 "adc.h"
  36 #include "usb.h"
  37 #include "button.h"
  38 #include "sprintf.h"
  39 #include "string.h"
  40 #include "hwcompat.h"
  41 #ifdef HAVE_MMC
  42 #include "ata_mmc.h"
  43 #endif
  44 #ifdef TARGET_TREE
  45 #include "usb-target.h"
  46 #endif
  47 #ifdef IRIVER_H300_SERIES
  48 #include "pcf50606.h"        /* for pcf50606_usb_charging_... */
  49 #endif
  50 #include "logf.h"
  51
  52 extern void dbg_ports(void); /* NASTY! defined in apps/ */
  53
  54 #ifdef HAVE_LCD_BITMAP
  55 bool do_screendump_instead_of_usb = false;
  56 void screen_dump(void);   /* Nasty again. Defined in apps/ too */
  57 #endif
  58
  59 #define USB_REALLY_BRAVE
  60
  61 #if !defined(SIMULATOR) && !defined(USB_NONE)
  62
  63 /* Messages from usb_tick and thread states */
  64 #define USB_INSERTED    1
  65 #define USB_EXTRACTED   2
  66 #ifdef HAVE_MMC
  67 #define USB_REENABLE    3
  68 #endif
  69 #ifdef HAVE_USB_POWER
  70 #define USB_POWERED     4
  71
  72 #if CONFIG_KEYPAD == RECORDER_PAD
  73 #define USBPOWER_BUTTON BUTTON_F1
  74 #define USBPOWER_BTN_IGNORE BUTTON_ON
  75 #elif CONFIG_KEYPAD == ONDIO_PAD
  76 #define USBPOWER_BUTTON BUTTON_MENU
  77 #define USBPOWER_BTN_IGNORE BUTTON_OFF
  78 #elif (CONFIG_KEYPAD == IPOD_4G_PAD)
  79 #define USBPOWER_BUTTON BUTTON_MENU
  80 #define USBPOWER_BTN_IGNORE BUTTON_PLAY
  81 #elif CONFIG_KEYPAD == IRIVER_H300_PAD
  82 #define USBPOWER_BUTTON BUTTON_REC
  83 #define USBPOWER_BTN_IGNORE BUTTON_ON
  84 #elif CONFIG_KEYPAD == GIGABEAT_PAD
  85 #define USBPOWER_BUTTON BUTTON_MENU
  86 #define USBPOWER_BTN_IGNORE BUTTON_POWER
  87 #elif CONFIG_KEYPAD == IRIVER_H10_PAD
  88 #define USBPOWER_BUTTON BUTTON_NONE
  89 #define USBPOWER_BTN_IGNORE BUTTON_POWER
  90 #elif CONFIG_KEYPAD == SANSA_E200_PAD
  91 #define USBPOWER_BUTTON BUTTON_SELECT
  92 #define USBPOWER_BTN_IGNORE BUTTON_POWER
  93 #endif
  94 #endif /* HAVE_USB_POWER */
  95
  96 /* The ADC tick reads one channel per tick, and we want to check 3 successive
  97    readings on the USB voltage channel. This doesn't apply to the Player, but
  98    debouncing the USB detection port won't hurt us either. */
  99 #define NUM_POLL_READINGS (NUM_ADC_CHANNELS * 3)
 100 static int countdown;
 101
 102 static int usb_state;
 103
 104 #if defined(HAVE_MMC) && !defined(BOOTLOADER)
 105 static int usb_mmc_countdown = 0;
 106 #endif
 107
 108 /* FIXME: The extra 0x800 is consumed by fat_mount() when the fsinfo
 109    needs updating */
 110 #ifndef BOOTLOADER
 111 static long usb_stack[(DEFAULT_STACK_SIZE + 0x800)/sizeof(long)];
 112 static const char usb_thread_name[] = "usb";
 113 #endif
 114 static struct event_queue usb_queue;
 115 static bool last_usb_status;
 116 static bool usb_monitor_enabled;
 117
 118 #ifndef TARGET_TREE
 119 void usb_enable(bool on)
 120 {
 121 #ifdef USB_ENABLE_ONDIOSTYLE
 122     PACR2 &= ~0x04C0; /* use PA3, PA5 as GPIO */
 123     if(on)
 124     {
 125 #ifdef HAVE_MMC
 126         mmc_enable_int_flash_clock(!mmc_detect());
 127 #endif
 128         if (!(read_hw_mask() & MMC_CLOCK_POLARITY))
 129             and_b(~0x20, &PBDRH); /* old circuit needs SCK1 = low while on USB */
 130         or_b(0x20, &PADRL); /* enable USB */
 131         and_b(~0x08, &PADRL); /* assert card detect */
 132     }
 133     else
 134     {
 135         if (!(read_hw_mask() & MMC_CLOCK_POLARITY))
 136             or_b(0x20, &PBDRH); /* reset SCK1 = high for old circuit */
 137         and_b(~0x20, &PADRL); /* disable USB */
 138         or_b(0x08, &PADRL); /* deassert card detect */
 139     }
 140     or_b(0x28, &PAIORL); /* output for USB enable and card detect */
 141 #elif defined(USB_ISP1582)
 142     /* TODO: Implement USB_ISP1582 */
 143     (void) on;
 144 #elif defined(USB_X5M5_STYLE)
 145     /* TODO X5 */
 146 #elif defined(USB_GIGABEAT_STYLE)
 147     /* TODO gigabeat */
 148 #else
 149 #ifdef HAVE_LCD_BITMAP
 150     if(read_hw_mask() & USB_ACTIVE_HIGH)
 151         on = !on;
 152 #endif
 153     if(on)
 154     {
 155         and_b(~0x04, &PADRH); /* enable USB */
 156     }
 157     else
 158     {
 159         or_b(0x04, &PADRH);
 160     }
 161     or_b(0x04, &PAIORH);
 162 #endif
 163 }
 164 #endif
 165
 166 #ifndef BOOTLOADER
 167 static void usb_slave_mode(bool on)
 168 {
 169     int rc;
 170
 171     if(on)
 172     {
 173         DEBUGF("Entering USB slave mode\n");
 174         ata_soft_reset();
 175         ata_init();
 176         ata_enable(false);
 177         usb_enable(true);
 178     }
 179     else
 180     {
 181         DEBUGF("Leaving USB slave mode\n");
 182
 183         /* Let the ISDx00 settle */
 184         sleep(HZ*1);
 185
 186         usb_enable(false);
 187
 188         rc = ata_init();
 189         if(rc)
 190         {
 191             /* fixme: can we remove this? (already such in main.c) */
 192             char str[32];
 193             lcd_clear_display();
 194             snprintf(str, 31, "ATA error: %d", rc);
 195             lcd_puts(0, 0, str);
 196             lcd_puts(0, 1, "Press ON to debug");
 197             lcd_update();
 198             while(!(button_get(true) & BUTTON_REL)) {};
 199             dbg_ports();
 200             panicf("ata: %d",rc);
 201         }
 202
 203         rc = disk_mount_all();
 204         if (rc <= 0) /* no partition */
 205             panicf("mount: %d",rc);
 206
 207     }
 208 }
 209
 210 static void usb_thread(void)
 211 {
 212     int num_acks_to_expect = -1;
 213     bool waiting_for_ack;
 214     struct event ev;
 215
 216     waiting_for_ack = false;
 217
 218     while(1)
 219     {
 220         queue_wait(&usb_queue, &ev);
 221         switch(ev.id)
 222         {
 223             case USB_INSERTED:
 224 #ifdef HAVE_LCD_BITMAP
 225                 if(do_screendump_instead_of_usb)
 226                 {
 227                     screen_dump();
 228                 }
 229                 else
 230 #endif
 231 #ifdef HAVE_USB_POWER
 232                 if((button_status() & ~USBPOWER_BTN_IGNORE) == USBPOWER_BUTTON)
 233                 {
 234                     usb_state = USB_POWERED;
 235                 }
 236                 else
 237 #endif
 238                 {
 239                     /* Tell all threads that they have to back off the ATA.
 240                        We subtract one for our own thread. */
 241                     num_acks_to_expect =
 242                         queue_broadcast(SYS_USB_CONNECTED, 0) - 1;
 243                     waiting_for_ack = true;
 244                     DEBUGF("USB inserted. Waiting for ack from %d threads...\n",
 245                            num_acks_to_expect);
 246                 }
 247                 break;
 248
 249             case SYS_USB_CONNECTED_ACK:
 250                 if(waiting_for_ack)
 251                 {
 252                     num_acks_to_expect--;
 253                     if(num_acks_to_expect == 0)
 254                     {
 255                         DEBUGF("All threads have acknowledged the connect.\n");
 256 #ifdef USB_REALLY_BRAVE
 257                         usb_slave_mode(true);
 258                         usb_state = USB_INSERTED;
 259                         cpu_idle_mode(true);
 260 #else
 261                         system_reboot();
 262 #endif
 263                     }
 264                     else
 265                     {
 266                         DEBUGF("usb: got ack, %d to go...\n",
 267                                num_acks_to_expect);
 268                     }
 269                 }
 270                 break;
 271
 272             case USB_EXTRACTED:
 273 #ifdef HAVE_LCD_BITMAP
 274                 if(do_screendump_instead_of_usb)
 275                     break;
 276 #endif
 277 #ifdef HAVE_USB_POWER
 278                 if(usb_state == USB_POWERED)
 279                 {
 280                     usb_state = USB_EXTRACTED;
 281                     break;
 282                 }
 283 #endif
 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
 293                 usb_state = USB_EXTRACTED;
 294
 295                 /* Tell all threads that we are back in business */
 296                 num_acks_to_expect =
 297                     queue_broadcast(SYS_USB_DISCONNECTED, 0) - 1;
 298                 waiting_for_ack = true;
 299                 DEBUGF("USB extracted. Waiting for ack from %d threads...\n",
 300                        num_acks_to_expect);
 301 #ifdef HAVE_LCD_CHARCELLS
 302                 lcd_icon(ICON_USB, false);
 303 #endif
 304                 break;
 305
 306             case SYS_USB_DISCONNECTED_ACK:
 307                 if(waiting_for_ack)
 308                 {
 309                     num_acks_to_expect--;
 310                     if(num_acks_to_expect == 0)
 311                     {
 312                         DEBUGF("All threads have acknowledged. "
 313                                "We're in business.\n");
 314                     }
 315                     else
 316                     {
 317                         DEBUGF("usb: got ack, %d to go...\n",
 318                                num_acks_to_expect);
 319                     }
 320                 }
 321                 break;
 322
 323 #ifdef HAVE_MMC
 324             case SYS_MMC_INSERTED:
 325             case SYS_MMC_EXTRACTED:
 326                 if(usb_state == USB_INSERTED)
 327                 {
 328                     usb_enable(false);
 329                     usb_mmc_countdown = HZ/2; /* re-enable after 0.5 sec */
 330                 }
 331                 break;
 332
 333             case USB_REENABLE:
 334                 if(usb_state == USB_INSERTED)
 335                     usb_enable(true);  /* reenable only if still inserted */
 336                 break;
 337 #endif
 338         }
 339     }
 340 }
 341 #endif
 342
 343 #ifndef TARGET_TREE
 344 bool usb_detect(void)
 345 {
 346     bool current_status;
 347
 348 #ifdef USB_RECORDERSTYLE
 349     current_status = (adc_read(ADC_USB_POWER) > 500)?true:false;
 350 #endif
 351 #ifdef USB_FMRECORDERSTYLE
 352     current_status = (adc_read(ADC_USB_POWER) <= 512)?true:false;
 353 #endif
 354 #ifdef USB_PLAYERSTYLE
 355     current_status = (PADR & 0x8000)?false:true;
 356 #endif
 357 #ifdef USB_ISP1582
 358     /* TODO: Implement USB_ISP1582 */
 359     current_status = false;
 360 #endif
 361     return current_status;
 362 }
 363 #endif
 364
 365 #ifndef BOOTLOADER
 366 static void usb_tick(void)
 367 {
 368     bool current_status;
 369
 370     if(usb_monitor_enabled)
 371     {
 372         current_status = usb_detect();
 373
 374         /* Only report when the status has changed */
 375         if(current_status != last_usb_status)
 376         {
 377             last_usb_status = current_status;
 378             countdown = NUM_POLL_READINGS;
 379         }
 380         else
 381         {
 382             /* Count down until it gets negative */
 383             if(countdown >= 0)
 384                 countdown--;
 385
 386             /* Report to the thread if we have had 3 identical status
 387                readings in a row */
 388             if(countdown == 0)
 389             {
 390                 if(current_status)
 391                     queue_post(&usb_queue, USB_INSERTED, 0);
 392                 else
 393                     queue_post(&usb_queue, USB_EXTRACTED, 0);
 394             }
 395         }
 396     }
 397 #ifdef HAVE_MMC
 398     if(usb_mmc_countdown > 0)
 399     {
 400         usb_mmc_countdown--;
 401         if (usb_mmc_countdown == 0)
 402             queue_post(&usb_queue, USB_REENABLE, 0);
 403     }
 404 #endif
 405 }
 406 #endif
 407
 408 void usb_acknowledge(long id)
 409 {
 410     queue_post(&usb_queue, id, 0);
 411 }
 412
 413 void usb_init(void)
 414 {
 415     usb_state = USB_EXTRACTED;
 416     usb_monitor_enabled = false;
 417     countdown = -1;
 418
 419 #ifdef TARGET_TREE
 420     usb_init_device();
 421 #endif
 422
 423     usb_enable(false);
 424
 425     /* We assume that the USB cable is extracted */
 426     last_usb_status = false;
 427
 428 #ifndef BOOTLOADER
 429     queue_init(&usb_queue, true);
 430     create_thread(usb_thread, usb_stack, sizeof(usb_stack),
 431                   usb_thread_name IF_PRIO(, PRIORITY_SYSTEM)
 432                   IF_COP(, CPU, false));
 433
 434     tick_add_task(usb_tick);
 435 #endif
 436
 437 }
 438
 439 void usb_wait_for_disconnect(struct event_queue *q)
 440 {
 441     struct event ev;
 442
 443     /* Don't return until we get SYS_USB_DISCONNECTED */
 444     while(1)
 445     {
 446         queue_wait(q, &ev);
 447         if(ev.id == SYS_USB_DISCONNECTED)
 448         {
 449             usb_acknowledge(SYS_USB_DISCONNECTED_ACK);
 450             return;
 451         }
 452     }
 453 }
 454
 455 int usb_wait_for_disconnect_w_tmo(struct event_queue *q, int ticks)
 456 {
 457     struct event ev;
 458
 459     /* Don't return until we get SYS_USB_DISCONNECTED or SYS_TIMEOUT */
 460     while(1)
 461     {
 462         queue_wait_w_tmo(q, &ev, ticks);
 463         switch(ev.id)
 464         {
 465             case SYS_USB_DISCONNECTED:
 466                 usb_acknowledge(SYS_USB_DISCONNECTED_ACK);
 467                 return 0;
 468                 break;
 469             case SYS_TIMEOUT:
 470                 return 1;
 471                 break;
 472         }
 473     }
 474 }
 475
 476 void usb_start_monitoring(void)
 477 {
 478     usb_monitor_enabled = true;
 479 }
 480
 481 bool usb_inserted(void)
 482 {
 483 #ifdef HAVE_USB_POWER
 484     return usb_state == USB_INSERTED || usb_state == USB_POWERED;
 485 #else
 486     return usb_state == USB_INSERTED;
 487 #endif
 488 }
 489
 490 #ifdef HAVE_USB_POWER
 491 bool usb_powered(void)
 492 {
 493     return usb_state == USB_POWERED;
 494 }
 495
 496 #if CONFIG_CHARGING
 497 bool usb_charging_enable(bool on)
 498 {
 499     bool rc = false;
 500 #ifdef IRIVER_H300_SERIES
 501     int irqlevel;
 502     logf("usb_charging_enable(%s)\n", on ? "on" : "off" );
 503     irqlevel = set_irq_level(HIGHEST_IRQ_LEVEL);
 504     pcf50606_set_usb_charging(on);
 505     rc = on;
 506     (void)set_irq_level(irqlevel);
 507 #else
 508     /* TODO: implement it for other targets... */
 509     (void)on;
 510 #endif
 511     return rc;
 512 }
 513
 514 bool usb_charging_enabled(void)
 515 {
 516     bool rc = false;
 517 #ifdef IRIVER_H300_SERIES
 518     /* TODO: read the state of the GPOOD2 register...
 519      * (this also means to set the irq level here) */
 520     rc = pcf50606_usb_charging_enabled();
 521 #else
 522     /* TODO: implement it for other targets... */
 523 #endif
 524
 525     logf("usb_charging_enabled: %s\n", rc ? "true" : "false" );
 526     return rc;
 527 }
 528 #endif
 529 #endif
 530
 531 #else
 532
 533 #ifdef USB_NONE
 534 bool usb_inserted(void)
 535 {
 536     return false;
 537 }
 538 #endif
 539
 540 /* Dummy simulator functions */
 541 void usb_acknowledge(long id)
 542 {
 543     id = id;
 544 }
 545
 546 void usb_init(void)
 547 {
 548 }
 549
 550 void usb_start_monitoring(void)
 551 {
 552 }
 553
 554 bool usb_detect(void)
 555 {
 556     return false;
 557 }
 558
 559 void usb_wait_for_disconnect(struct event_queue *q)
 560 {
 561    (void)q;
 562 }
 563
 564 #endif /* USB_NONE or SIMULATOR */