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 IRIVER_H300_SERIES
  41 #include "pcf50606.h"        /* for pcf50606_usb_charging_... */
  42 #endif
  43 #include "logf.h"
  44
  45 extern void dbg_ports(void); /* NASTY! defined in apps/ */
  46
  47 #ifdef HAVE_LCD_BITMAP
  48 bool do_screendump_instead_of_usb = false;
  49 void screen_dump(void);   /* Nasty again. Defined in apps/ too */
  50 #endif
  51
  52 #if !defined(SIMULATOR) && !defined(USB_NONE)
  53
  54 #define NUM_POLL_READINGS (HZ/5)
  55 static int countdown;
  56
  57 static int usb_state;
  58
  59 #if defined(HAVE_MMC) && !defined(BOOTLOADER)
  60 static int usb_mmc_countdown = 0;
  61 #endif
  62
  63 /* FIXME: The extra 0x800 is consumed by fat_mount() when the fsinfo
  64    needs updating */
  65 #ifndef BOOTLOADER
  66 static long usb_stack[(DEFAULT_STACK_SIZE + 0x800)/sizeof(long)];
  67 static const char usb_thread_name[] = "usb";
  68 #endif
  69 static struct event_queue usb_queue;
  70 static int last_usb_status;
  71 static bool usb_monitor_enabled;
  72
  73
  74 #ifndef BOOTLOADER
  75 static void usb_slave_mode(bool on)
  76 {
  77     int rc;
  78
  79     if(on)
  80     {
  81         DEBUGF("Entering USB slave mode\n");
  82         ata_soft_reset();
  83         ata_init();
  84         ata_enable(false);
  85         usb_enable(true);
  86     }
  87     else
  88     {
  89         DEBUGF("Leaving USB slave mode\n");
  90
  91         /* Let the ISDx00 settle */
  92         sleep(HZ*1);
  93
  94         usb_enable(false);
  95
  96         rc = ata_init();
  97         if(rc)
  98         {
  99             /* fixme: can we remove this? (already such in main.c) */
 100             char str[32];
 101             lcd_clear_display();
 102             snprintf(str, 31, "ATA error: %d", rc);
 103             lcd_puts(0, 0, str);
 104             lcd_puts(0, 1, "Press ON to debug");
 105             lcd_update();
 106             while(!(button_get(true) & BUTTON_REL)) {};
 107             dbg_ports();
 108             panicf("ata: %d",rc);
 109         }
 110
 111         rc = disk_mount_all();
 112         if (rc <= 0) /* no partition */
 113             panicf("mount: %d",rc);
 114
 115     }
 116 }
 117
 118 static void usb_thread(void)
 119 {
 120     int num_acks_to_expect = -1;
 121     bool waiting_for_ack;
 122     struct queue_event ev;
 123
 124     waiting_for_ack = false;
 125
 126     while(1)
 127     {
 128         queue_wait(&usb_queue, &ev);
 129         switch(ev.id)
 130         {
 131 #ifdef HAVE_USB_POWER
 132             case USB_POWERED:
 133                 usb_state = USB_POWERED;
 134                 break;
 135 #endif
 136             case USB_INSERTED:
 137 #ifdef HAVE_LCD_BITMAP
 138                 if(do_screendump_instead_of_usb)
 139                 {
 140                     screen_dump();
 141                 }
 142                 else
 143 #endif
 144 #ifdef HAVE_USB_POWER
 145                 if((button_status() & ~USBPOWER_BTN_IGNORE) == USBPOWER_BUTTON)
 146                 {
 147                     usb_state = USB_POWERED;
 148                 }
 149                 else
 150 #endif
 151                 {
 152                     /* Tell all threads that they have to back off the ATA.
 153                        We subtract one for our own thread. */
 154                     num_acks_to_expect =
 155                         queue_broadcast(SYS_USB_CONNECTED, 0) - 1;
 156                     waiting_for_ack = true;
 157                     DEBUGF("USB inserted. Waiting for ack from %d threads...\n",
 158                            num_acks_to_expect);
 159                 }
 160                 break;
 161
 162             case SYS_USB_CONNECTED_ACK:
 163                 if(waiting_for_ack)
 164                 {
 165                     num_acks_to_expect--;
 166                     if(num_acks_to_expect == 0)
 167                     {
 168                         DEBUGF("All threads have acknowledged the connect.\n");
 169                         usb_slave_mode(true);
 170                         usb_state = USB_INSERTED;
 171                         cpu_idle_mode(true);
 172                     }
 173                     else
 174                     {
 175                         DEBUGF("usb: got ack, %d to go...\n",
 176                                num_acks_to_expect);
 177                     }
 178                 }
 179                 break;
 180
 181             case USB_EXTRACTED:
 182 #ifdef HAVE_LCD_BITMAP
 183                 if(do_screendump_instead_of_usb)
 184                     break;
 185 #endif
 186 #ifdef HAVE_USB_POWER
 187                 if(usb_state == USB_POWERED)
 188                 {
 189                     usb_state = USB_EXTRACTED;
 190                     break;
 191                 }
 192 #endif
 193                 if(usb_state == USB_INSERTED)
 194                 {
 195                     /* Only disable the USB mode if we really have enabled it
 196                        some threads might not have acknowledged the
 197                        insertion */
 198                     usb_slave_mode(false);
 199                     cpu_idle_mode(false);
 200                 }
 201
 202                 usb_state = USB_EXTRACTED;
 203
 204                 /* Tell all threads that we are back in business */
 205                 num_acks_to_expect =
 206                     queue_broadcast(SYS_USB_DISCONNECTED, 0) - 1;
 207                 waiting_for_ack = true;
 208                 DEBUGF("USB extracted. Waiting for ack from %d threads...\n",
 209                        num_acks_to_expect);
 210                 break;
 211
 212             case SYS_USB_DISCONNECTED_ACK:
 213                 if(waiting_for_ack)
 214                 {
 215                     num_acks_to_expect--;
 216                     if(num_acks_to_expect == 0)
 217                     {
 218                         DEBUGF("All threads have acknowledged. "
 219                                "We're in business.\n");
 220                     }
 221                     else
 222                     {
 223                         DEBUGF("usb: got ack, %d to go...\n",
 224                                num_acks_to_expect);
 225                     }
 226                 }
 227                 break;
 228
 229 #ifdef HAVE_MMC
 230             case SYS_HOTSWAP_INSERTED:
 231             case SYS_HOTSWAP_EXTRACTED:
 232                 if(usb_state == USB_INSERTED)
 233                 {
 234                     usb_enable(false);
 235                     usb_mmc_countdown = HZ/2; /* re-enable after 0.5 sec */
 236                 }
 237                 break;
 238
 239             case USB_REENABLE:
 240                 if(usb_state == USB_INSERTED)
 241                     usb_enable(true);  /* reenable only if still inserted */
 242                 break;
 243 #endif
 244         }
 245     }
 246 }
 247 #endif
 248
 249
 250 #ifndef BOOTLOADER
 251 static void usb_tick(void)
 252 {
 253     int current_status;
 254
 255     if(usb_monitor_enabled)
 256     {
 257         current_status = usb_detect();
 258
 259         /* Only report when the status has changed */
 260         if(current_status != last_usb_status)
 261         {
 262             last_usb_status = current_status;
 263             countdown = NUM_POLL_READINGS;
 264         }
 265         else
 266         {
 267             /* Count down until it gets negative */
 268             if(countdown >= 0)
 269                 countdown--;
 270
 271             /* Report to the thread if we have had 3 identical status
 272                readings in a row */
 273             if(countdown == 0)
 274             {
 275                 queue_post(&usb_queue, current_status, 0);
 276             }
 277         }
 278     }
 279 #ifdef HAVE_MMC
 280     if(usb_mmc_countdown > 0)
 281     {
 282         usb_mmc_countdown--;
 283         if (usb_mmc_countdown == 0)
 284             queue_post(&usb_queue, USB_REENABLE, 0);
 285     }
 286 #endif
 287 }
 288 #endif
 289
 290 void usb_acknowledge(long id)
 291 {
 292     queue_post(&usb_queue, id, 0);
 293 }
 294
 295 void usb_init(void)
 296 {
 297     usb_state = USB_EXTRACTED;
 298     usb_monitor_enabled = false;
 299     countdown = -1;
 300
 301     usb_init_device();
 302     usb_enable(false);
 303
 304     /* We assume that the USB cable is extracted */
 305     last_usb_status = false;
 306
 307 #ifndef BOOTLOADER
 308     queue_init(&usb_queue, true);
 309
 310     create_thread(usb_thread, usb_stack, sizeof(usb_stack), 0,
 311                   usb_thread_name IF_PRIO(, PRIORITY_SYSTEM)
 312                           IF_COP(, CPU));
 313
 314     tick_add_task(usb_tick);
 315 #endif
 316
 317 }
 318
 319 void usb_wait_for_disconnect(struct event_queue *q)
 320 {
 321     struct queue_event ev;
 322
 323     /* Don't return until we get SYS_USB_DISCONNECTED */
 324     while(1)
 325     {
 326         queue_wait(q, &ev);
 327         if(ev.id == SYS_USB_DISCONNECTED)
 328         {
 329             usb_acknowledge(SYS_USB_DISCONNECTED_ACK);
 330             return;
 331         }
 332     }
 333 }
 334
 335 int usb_wait_for_disconnect_w_tmo(struct event_queue *q, int ticks)
 336 {
 337     struct queue_event ev;
 338
 339     /* Don't return until we get SYS_USB_DISCONNECTED or SYS_TIMEOUT */
 340     while(1)
 341     {
 342         queue_wait_w_tmo(q, &ev, ticks);
 343         switch(ev.id)
 344         {
 345             case SYS_USB_DISCONNECTED:
 346                 usb_acknowledge(SYS_USB_DISCONNECTED_ACK);
 347                 return 0;
 348                 break;
 349             case SYS_TIMEOUT:
 350                 return 1;
 351                 break;
 352         }
 353     }
 354 }
 355
 356 void usb_start_monitoring(void)
 357 {
 358     usb_monitor_enabled = true;
 359 }
 360
 361 bool usb_inserted(void)
 362 {
 363 #ifdef HAVE_USB_POWER
 364     return usb_state == USB_INSERTED || usb_state == USB_POWERED;
 365 #else
 366     return usb_state == USB_INSERTED;
 367 #endif
 368 }
 369
 370 #ifdef HAVE_USB_POWER
 371 bool usb_powered(void)
 372 {
 373     return usb_state == USB_POWERED;
 374 }
 375
 376 #if CONFIG_CHARGING
 377 bool usb_charging_enable(bool on)
 378 {
 379     bool rc = false;
 380 #ifdef IRIVER_H300_SERIES
 381     int irqlevel;
 382     logf("usb_charging_enable(%s)\n", on ? "on" : "off" );
 383     irqlevel = set_irq_level(HIGHEST_IRQ_LEVEL);
 384     pcf50606_set_usb_charging(on);
 385     rc = on;
 386     (void)set_irq_level(irqlevel);
 387 #else
 388     /* TODO: implement it for other targets... */
 389     (void)on;
 390 #endif
 391     return rc;
 392 }
 393
 394 bool usb_charging_enabled(void)
 395 {
 396     bool rc = false;
 397 #ifdef IRIVER_H300_SERIES
 398     /* TODO: read the state of the GPOOD2 register...
 399      * (this also means to set the irq level here) */
 400     rc = pcf50606_usb_charging_enabled();
 401 #else
 402     /* TODO: implement it for other targets... */
 403 #endif
 404
 405     logf("usb_charging_enabled: %s\n", rc ? "true" : "false" );
 406     return rc;
 407 }
 408 #endif
 409 #endif
 410
 411 #else
 412
 413 #ifdef USB_NONE
 414 bool usb_inserted(void)
 415 {
 416     return false;
 417 }
 418 #endif
 419
 420 /* Dummy simulator functions */
 421 void usb_acknowledge(long id)
 422 {
 423     id = id;
 424 }
 425
 426 void usb_init(void)
 427 {
 428 }
 429
 430 void usb_start_monitoring(void)
 431 {
 432 }
 433
 434 int usb_detect(void)
 435 {
 436     return USB_EXTRACTED;
 437 }
 438
 439 void usb_wait_for_disconnect(struct event_queue *q)
 440 {
 441    (void)q;
 442 }
 443
 444 #endif /* USB_NONE or SIMULATOR */