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  * All files in this archive are subject to the GNU General Public License.
  13  * See the file COPYING in the source tree root for full license agreement.
  14  *
  15  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  16  * KIND, either express or implied.
  17  *
  18  ****************************************************************************/
  19 #include "config.h"
  20 #include "sh7034.h"
  21 #include "kernel.h"
  22 #include "thread.h"
  23 #include "system.h"
  24 #include "debug.h"
  25 #include "ata.h"
  26 #include "fat.h"
  27 #include "disk.h"
  28 #include "panic.h"
  29 #include "lcd.h"
  30 #include "adc.h"
  31 #include "usb.h"
  32 #include "button.h"
  33 #include "sprintf.h"
  34
  35 extern void dbg_ports(void); /* NASTY! defined in apps/ */
  36
  37 #define USB_REALLY_BRAVE
  38
  39
  40 #ifndef SIMULATOR
  41
  42 /* Messages from usb_tick */
  43 #define USB_INSERTED    1
  44 #define USB_EXTRACTED   2
  45
  46 /* Thread states */
  47 #define EXTRACTING      1
  48 #define EXTRACTED       2
  49 #define INSERTED        3
  50 #define INSERTING       4
  51
  52 /* The ADC tick reads one channel per tick, and we want to check 3 successive
  53    readings on the USB voltage channel. This doesn't apply to the Player, but
  54    debouncing the USB detection port won't hurt us either. */
  55 #define NUM_POLL_READINGS (NUM_ADC_CHANNELS * 3)
  56 static int countdown;
  57
  58 static int usb_state;
  59
  60 static char usb_stack[DEFAULT_STACK_SIZE];
  61 static char usb_thread_name[] = "usb";
  62 static struct event_queue usb_queue;
  63 static bool last_usb_status;
  64 static bool usb_monitor_enabled;
  65 static bool usb_inverted;
  66
  67 static void usb_enable(bool on)
  68 {
  69     if(usb_inverted)
  70         on = !on;
  71
  72     if(on)
  73         PADR &= ~0x400; /* enable USB */
  74     else
  75         PADR |= 0x400;
  76     PAIOR |= 0x400;
  77 }
  78
  79 static void usb_slave_mode(bool on)
  80 {
  81     int rc;
  82     struct partinfo* pinfo;
  83
  84     if(on)
  85     {
  86         DEBUGF("Entering USB slave mode\n");
  87         ata_soft_reset();
  88         ata_init();
  89         ata_enable(false);
  90         usb_enable(true);
  91     }
  92     else
  93     {
  94         DEBUGF("Leaving USB slave mode\n");
  95
  96         /* Let the ISDx00 settle */
  97         sleep(HZ*1);
  98
  99         usb_enable(false);
 100
 101         rc = ata_init();
 102         if(rc)
 103         {
 104             char str[32];
 105             lcd_clear_display();
 106             snprintf(str, 31, "ATA error: %d", rc);
 107             lcd_puts(0, 0, str);
 108             lcd_puts(0, 1, "Press ON to debug");
 109             lcd_update();
 110             while(button_get(true) != BUTTON_ON) {};
 111             dbg_ports();
 112             panicf("ata: %d",rc);
 113         }
 114
 115         pinfo = disk_init();
 116         if (!pinfo)
 117             panicf("disk: NULL");
 118
 119         rc = fat_mount(pinfo[0].start);
 120         if(rc)
 121             panicf("mount: %d",rc);
 122     }
 123 }
 124
 125 static void usb_thread(void)
 126 {
 127     int num_acks_to_expect = -1;
 128     bool waiting_for_ack;
 129     struct event ev;
 130
 131     waiting_for_ack = false;
 132
 133     while(1)
 134     {
 135         queue_wait(&usb_queue, &ev);
 136         switch(ev.id)
 137         {
 138             case USB_INSERTED:
 139                 /* Tell all threads that they have to back off the ATA.
 140                    We subtract one for our own thread. */
 141                 num_acks_to_expect =
 142                     queue_broadcast(SYS_USB_CONNECTED, NULL) - 1;
 143                 waiting_for_ack = true;
 144                 DEBUGF("USB inserted. Waiting for ack from %d threads...\n",
 145                        num_acks_to_expect);
 146                 break;
 147
 148             case SYS_USB_CONNECTED_ACK:
 149                 if(waiting_for_ack)
 150                 {
 151                     num_acks_to_expect--;
 152                     if(num_acks_to_expect == 0)
 153                     {
 154                         DEBUGF("All threads have acknowledged the connect.\n");
 155 #ifdef USB_REALLY_BRAVE
 156                         usb_slave_mode(true);
 157                         usb_state = USB_INSERTED;
 158 #else
 159                         system_reboot();
 160 #endif
 161                     }
 162                     else
 163                     {
 164                         DEBUGF("usb: got ack, %d to go...\n",
 165                                num_acks_to_expect);
 166                     }
 167                 }
 168                 break;
 169
 170             case USB_EXTRACTED:
 171                 if(usb_state == USB_INSERTED)
 172                 {
 173                     /* Only disable the USB mode if we really have enabled it
 174                        some threads might not have acknowledged the
 175                        insertion */
 176                     usb_slave_mode(false);
 177                 }
 178
 179                 usb_state = USB_EXTRACTED;
 180
 181                 /* Tell all threads that we are back in business */
 182                 num_acks_to_expect =
 183                     queue_broadcast(SYS_USB_DISCONNECTED, NULL) - 1;
 184                 waiting_for_ack = true;
 185                 DEBUGF("USB extracted. Waiting for ack from %d threads...\n",
 186                        num_acks_to_expect);
 187 #ifdef HAVE_LCD_CHARCELLS
 188                 lcd_icon(ICON_USB, false);
 189 #endif
 190                 break;
 191
 192             case SYS_USB_DISCONNECTED_ACK:
 193                 if(waiting_for_ack)
 194                 {
 195                     num_acks_to_expect--;
 196                     if(num_acks_to_expect == 0)
 197                     {
 198                         DEBUGF("All threads have acknowledged. "
 199                                "We're in business.\n");
 200                     }
 201                     else
 202                     {
 203                         DEBUGF("usb: got ack, %d to go...\n",
 204                                num_acks_to_expect);
 205                     }
 206                 }
 207                 break;
 208         }
 209     }
 210 }
 211
 212 static void usb_tick(void)
 213 {
 214     bool current_status;
 215
 216     if(usb_monitor_enabled)
 217     {
 218 #ifdef ARCHOS_RECORDER
 219         current_status = (adc_read(ADC_USB_POWER) > 500)?true:false;
 220 #else
 221         current_status = (PADR & 0x8000)?false:true;
 222 #endif
 223
 224         /* Only report when the status has changed */
 225         if(current_status != last_usb_status)
 226         {
 227             last_usb_status = current_status;
 228             countdown = NUM_POLL_READINGS;
 229         }
 230         else
 231         {
 232             /* Count down until it gets negative */
 233             if(countdown >= 0)
 234                 countdown--;
 235
 236             /* Report to the thread if we have had 3 identical status
 237                readings in a row */
 238             if(countdown == 0)
 239             {
 240                 if(current_status)
 241                     queue_post(&usb_queue, USB_INSERTED, NULL);
 242                 else
 243                     queue_post(&usb_queue, USB_EXTRACTED, NULL);
 244             }
 245         }
 246     }
 247 }
 248
 249 void usb_acknowledge(int id)
 250 {
 251     queue_post(&usb_queue, id, NULL);
 252 }
 253
 254 void usb_init(void)
 255 {
 256     usb_state = USB_EXTRACTED;
 257     usb_monitor_enabled = false;
 258     countdown = -1;
 259
 260     /* This is lame. Really lame. We determine the polarity of the USB
 261        enable pin by checking how it is set by the Archos firmware. */
 262     if(PADR & 0x400)
 263         usb_inverted = false;
 264     else
 265         usb_inverted = true;
 266
 267     usb_enable(false);
 268
 269     /* We assume that the USB cable is extracted */
 270     last_usb_status = false;
 271
 272     queue_init(&usb_queue);
 273     create_thread(usb_thread, usb_stack, sizeof(usb_stack), usb_thread_name);
 274
 275     tick_add_task(usb_tick);
 276 }
 277
 278 void usb_wait_for_disconnect(struct event_queue *q)
 279 {
 280     struct event ev;
 281
 282     /* Don't return until we get SYS_USB_DISCONNECTED */
 283     while(1)
 284     {
 285         queue_wait(q, &ev);
 286         if(ev.id == SYS_USB_DISCONNECTED)
 287         {
 288             usb_acknowledge(SYS_USB_DISCONNECTED_ACK);
 289             return;
 290         }
 291     }
 292 }
 293
 294 int usb_wait_for_disconnect_w_tmo(struct event_queue *q, int ticks)
 295 {
 296     struct event ev;
 297
 298     /* Don't return until we get SYS_USB_DISCONNECTED or SYS_TIMEOUT */
 299     while(1)
 300     {
 301         queue_wait_w_tmo(q, &ev, ticks);
 302         switch(ev.id)
 303         {
 304             case SYS_USB_DISCONNECTED:
 305                 usb_acknowledge(SYS_USB_DISCONNECTED_ACK);
 306                 return 0;
 307                 break;
 308             case SYS_TIMEOUT:
 309                 return 1;
 310                 break;
 311         }
 312     }
 313 }
 314
 315 void usb_start_monitoring(void)
 316 {
 317     usb_monitor_enabled = true;
 318 }
 319
 320 bool usb_inserted(void)
 321 {
 322     return usb_state == USB_INSERTED;
 323 }
 324
 325 #else
 326
 327 /* Dummy simulator functions */
 328 void usb_acknowledge(int id)
 329 {
 330     id = id;
 331 }
 332
 333 void usb_init(void)
 334 {
 335 }
 336
 337 void usb_start_monitoring(void)
 338 {
 339 }
 340
 341 #endif