1 /***************************************************************************
3 * Open \______ \ ____ ____ | | _\_ |__ _______ ___
4 * Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
5 * Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
6 * Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
10 * Copyright (C) 2002 by Linus Nielsen Feltzing
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
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.
22 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
23 * KIND, either express or implied.
25 ****************************************************************************/
37 #include "usb-target.h"
46 #include "screendump.h"
48 /* Conditions under which we want the entire driver */
49 #if !defined(BOOTLOADER) || (CONFIG_CPU == SH7034) || \
50 (defined(TOSHIBA_GIGABEAT_S) && defined(USE_ROCKBOX_USB) && defined(USB_ENABLE_STORAGE)) || \
51 (defined(HAVE_USBSTACK) && (defined(CREATIVE_ZVx))) || \
52 (defined(HAVE_USBSTACK) && (defined(OLYMPUS_MROBE_500))) || \
53 (defined(HAVE_USBSTACK) && (defined(IPOD_NANO2G))) || \
54 defined(CPU_TCC77X) || defined(CPU_TCC780X) || \
55 (CONFIG_USBOTG == USBOTG_JZ4740)
59 #ifdef HAVE_LCD_BITMAP
60 bool do_screendump_instead_of_usb
= false;
63 #if !defined(SIMULATOR) && !defined(USB_NONE)
67 #if (CONFIG_STORAGE & STORAGE_MMC) && defined(USB_FULL_INIT)
68 static int usb_mmc_countdown
= 0;
71 /* FIXME: The extra 0x800 is consumed by fat_mount() when the fsinfo
74 static long usb_stack
[(DEFAULT_STACK_SIZE
+ 0x800)/sizeof(long)];
75 static const char usb_thread_name
[] = "usb";
76 static unsigned int usb_thread_entry
= 0;
77 #ifndef USB_STATUS_BY_EVENT
78 #define NUM_POLL_READINGS (HZ/5)
80 #endif /* USB_STATUS_BY_EVENT */
81 #endif /* USB_FULL_INIT */
82 static struct event_queue usb_queue
;
83 static bool usb_monitor_enabled
;
84 static int last_usb_status
;
86 static bool exclusive_storage_access
;
89 #ifdef USB_FIREWIRE_HANDLING
90 static int firewire_countdown
;
91 static bool last_firewire_status
;
96 #if defined(USB_FIREWIRE_HANDLING) \
97 || (defined(HAVE_USBSTACK) && !defined(USE_ROCKBOX_USB))
98 static void try_reboot(void)
100 #ifdef HAVE_DISK_STORAGE
101 storage_sleepnow(); /* Immediately spindown the disk. */
105 #ifdef IPOD_ARCH /* The following code is based on ipodlinux */
106 #if CONFIG_CPU == PP5020
107 memcpy((void *)0x40017f00, "diskmode\0\0hotstuff\0\0\1", 21);
108 #elif CONFIG_CPU == PP5022
109 memcpy((void *)0x4001ff00, "diskmode\0\0hotstuff\0\0\1", 21);
110 #endif /* CONFIG_CPU */
111 #endif /* IPOD_ARCH */
114 memcpy((void *)0x0002bf00, "diskmodehotstuff\1\0\0\0", 20);
117 system_reboot(); /* Reboot */
119 #endif /* USB_FIRWIRE_HANDLING || (HAVE_USBSTACK && !USE_ROCKBOX_USB) */
122 /* inline since branch is chosen at compile time */
123 static inline void usb_slave_mode(bool on
)
125 #ifdef USE_ROCKBOX_USB
131 #ifdef HAVE_PRIORITY_SCHEDULING
132 thread_set_priority(THREAD_ID_CURRENT
, PRIORITY_REALTIME
);
136 else /* usb_state == USB_INSERTED (only!) */
138 #ifndef USB_DETECT_BY_DRV
141 #ifdef HAVE_PRIORITY_SCHEDULING
142 thread_set_priority(THREAD_ID_CURRENT
, PRIORITY_SYSTEM
);
144 /* Entered exclusive mode */
145 rc
= disk_mount_all();
146 if (rc
<= 0) /* no partition */
147 panicf("mount: %d",rc
);
151 #else /* !USE_ROCKBOX_USB */
154 /* until we have native mass-storage mode, we want to reboot on
158 #endif /* USE_ROCKBOX_USB */
161 void usb_signal_transfer_completion(
162 struct usb_transfer_completion_event_data
* event_data
)
164 queue_post(&usb_queue
, USB_TRANSFER_COMPLETION
, (intptr_t)event_data
);
166 #else /* !HAVE_USBSTACK */
167 /* inline since branch is chosen at compile time */
168 static inline void usb_slave_mode(bool on
)
174 DEBUGF("Entering USB slave mode\n");
175 storage_soft_reset();
177 storage_enable(false);
183 DEBUGF("Leaving USB slave mode\n");
185 cpu_idle_mode(false);
187 /* Let the ISDx00 settle */
194 panicf("storage: %d",rc
);
196 rc
= disk_mount_all();
197 if (rc
<= 0) /* no partition */
198 panicf("mount: %d",rc
);
201 #endif /* HAVE_USBSTACK */
203 #ifdef HAVE_USB_POWER
204 static inline bool usb_power_button(void)
206 #if (defined(IRIVER_H10) || defined (IRIVER_H10_5GB)) && !defined(USE_ROCKBOX_USB)
207 return (button_status() & ~USBPOWER_BTN_IGNORE
) != USBPOWER_BUTTON
;
209 return (button_status() & ~USBPOWER_BTN_IGNORE
) == USBPOWER_BUTTON
;
213 #ifdef USB_FIREWIRE_HANDLING
214 static inline bool usb_reboot_button(void)
216 return (button_status() & ~USBPOWER_BTN_IGNORE
) != USBPOWER_BUTTON
;
219 #endif /* HAVE_USB_POWER */
221 #ifdef USB_ENABLE_HID
222 static bool usb_hid
= true;
225 static void usb_thread(void)
227 int num_acks_to_expect
= 0;
228 struct queue_event ev
;
232 queue_wait(&usb_queue
, &ev
);
235 #ifdef USB_DRIVER_CLOSE
240 case USB_TRANSFER_COMPLETION
:
241 usb_core_handle_transfer_completion(
242 (struct usb_transfer_completion_event_data
*)ev
.data
);
245 #ifdef USB_DETECT_BY_DRV
246 /* In this case, these events the handle cable insertion USB
247 * driver determines INSERTED/EXTRACTED state. */
249 /* Set the state to USB_POWERED for now and enable the driver
250 * to detect a bus reset only. If a bus reset is detected,
251 * USB_INSERTED will be received. */
252 usb_state
= USB_POWERED
;
258 /* This part shouldn't be obligatory for anything that can
259 * reliably detect removal of the data lines. USB_EXTRACTED
260 * could be posted on that event while bus power remains
262 queue_post(&usb_queue
, USB_EXTRACTED
, 0);
264 #endif /* USB_DETECT_BY_DRV */
266 #ifdef HAVE_LCD_BITMAP
267 if(do_screendump_instead_of_usb
)
269 usb_state
= USB_SCREENDUMP
;
271 #ifdef HAVE_REMOTE_LCD
272 remote_screen_dump();
277 #ifdef HAVE_USB_POWER
278 if(usb_power_button())
280 /* Only charging is desired */
281 usb_state
= USB_POWERED
;
283 #ifdef USB_ENABLE_STORAGE
284 usb_core_enable_driver(USB_DRIVER_MASS_STORAGE
, false);
287 #ifdef USB_ENABLE_HID
288 #ifdef USB_ENABLE_CHARGING_ONLY
289 usb_core_enable_driver(USB_DRIVER_HID
, false);
291 usb_core_enable_driver(USB_DRIVER_HID
, true);
292 #endif /* USB_ENABLE_CHARGING_ONLY */
293 #endif /* USB_ENABLE_HID */
295 #ifdef USB_ENABLE_CHARGING_ONLY
296 usb_core_enable_driver(USB_DRIVER_CHARGING_ONLY
, true);
302 #endif /* HAVE_USB_POWER */
304 #ifdef HAVE_USB_POWER
305 /* Set the state to USB_POWERED for now. If permission to connect
306 * by threads and storage is granted it will be changed to
308 usb_state
= USB_POWERED
;
310 #ifdef USB_ENABLE_STORAGE
311 usb_core_enable_driver(USB_DRIVER_MASS_STORAGE
, true);
313 #ifdef USB_ENABLE_HID
314 usb_core_enable_driver(USB_DRIVER_HID
, usb_hid
);
316 #ifdef USB_ENABLE_CHARGING_ONLY
317 usb_core_enable_driver(USB_DRIVER_CHARGING_ONLY
, false);
320 /* Check any drivers enabled at this point for exclusive storage
321 * access requirements. */
322 exclusive_storage_access
= usb_core_any_exclusive_storage();
324 if(!exclusive_storage_access
)
329 #endif /* HAVE_USBSTACK */
330 /* Tell all threads that they have to back off the storage.
331 We subtract one for our own thread. */
332 num_acks_to_expect
= queue_broadcast(SYS_USB_CONNECTED
, 0) - 1;
333 DEBUGF("USB inserted. Waiting for ack from %d threads...\n",
337 case SYS_USB_CONNECTED_ACK
:
338 if(num_acks_to_expect
> 0 && --num_acks_to_expect
== 0)
340 DEBUGF("All threads have acknowledged the connect.\n");
341 usb_slave_mode(true);
342 usb_state
= USB_INSERTED
;
346 DEBUGF("usb: got ack, %d to go...\n",
352 #ifdef HAVE_LCD_BITMAP
353 if(usb_state
== USB_SCREENDUMP
)
355 usb_state
= USB_EXTRACTED
;
356 break; /* Connected for screendump only */
359 #ifndef HAVE_USBSTACK /* Stack must undo this if POWERED state was transitional */
360 #ifdef HAVE_USB_POWER
361 if(usb_state
== USB_POWERED
)
363 usb_state
= USB_EXTRACTED
;
367 #endif /* HAVE_USBSTACK */
368 if(usb_state
== USB_INSERTED
)
370 /* Only disable the USB mode if we really have enabled it
371 some threads might not have acknowledged the
373 usb_slave_mode(false);
376 usb_state
= USB_EXTRACTED
;
378 if(!exclusive_storage_access
)
380 #ifndef USB_DETECT_BY_DRV /* Disabled handling USB_UNPOWERED */
386 #endif /* HAVE_USBSTACK */
387 num_acks_to_expect
= usb_release_exclusive_storage();
391 case SYS_USB_DISCONNECTED_ACK
:
392 if(num_acks_to_expect
> 0 && --num_acks_to_expect
== 0)
394 DEBUGF("All threads have acknowledged. "
395 "We're in business.\n");
399 DEBUGF("usb: got ack, %d to go...\n",
405 case SYS_HOTSWAP_INSERTED
:
406 case SYS_HOTSWAP_EXTRACTED
:
408 usb_core_hotswap_event(1,ev
.id
== SYS_HOTSWAP_INSERTED
);
409 #else /* !HAVE_USBSTACK */
410 if(usb_state
== USB_INSERTED
)
413 #if (CONFIG_STORAGE & STORAGE_MMC)
414 usb_mmc_countdown
= HZ
/2; /* re-enable after 0.5 sec */
415 #endif /* STORAGE_MMC */
417 #endif /* HAVE_USBSTACK */
420 #if (CONFIG_STORAGE & STORAGE_MMC)
422 if(usb_state
== USB_INSERTED
)
423 usb_enable(true); /* reenable only if still inserted */
425 #endif /* STORAGE_MMC */
426 #endif /* HAVE_HOTSWAP */
428 #ifdef USB_FIREWIRE_HANDLING
429 case USB_REQUEST_REBOOT
:
430 #ifdef HAVE_USB_POWER
431 if (usb_reboot_button())
435 #endif /* USB_FIREWIRE_HANDLING */
440 #ifdef USB_STATUS_BY_EVENT
441 void usb_status_event(int current_status
)
443 /* Caller isn't expected to filter for changes in status.
445 * USB_DETECT_BY_DRV: USB_POWERED, USB_UNPOWERED, USB_INSERTED (driver)
446 * else: USB_INSERTED, USB_EXTRACTED
448 if(usb_monitor_enabled
)
450 int oldstatus
= disable_irq_save(); /* Dual-use function */
452 if(last_usb_status
!= current_status
)
454 last_usb_status
= current_status
;
455 queue_post(&usb_queue
, current_status
, 0);
458 restore_irq(oldstatus
);
462 void usb_start_monitoring(void)
464 int oldstatus
= disable_irq_save(); /* Sync to event */
465 int status
= usb_detect();
467 usb_monitor_enabled
= true;
469 #ifdef USB_DETECT_BY_DRV
470 status
= (status
== USB_INSERTED
) ? USB_POWERED
: USB_UNPOWERED
;
472 usb_status_event(status
);
474 #ifdef USB_FIREWIRE_HANDLING
475 if (firewire_detect())
476 usb_firewire_connect_event();
479 restore_irq(oldstatus
);
482 #ifdef USB_FIREWIRE_HANDLING
483 void usb_firewire_connect_event(void)
485 queue_post(&usb_queue
, USB_REQUEST_REBOOT
, 0);
487 #endif /* USB_FIREWIRE_HANDLING */
488 #else /* !USB_STATUS_BY_EVENT */
489 static void usb_tick(void)
493 if(usb_monitor_enabled
)
495 #ifdef USB_FIREWIRE_HANDLING
496 int current_firewire_status
= firewire_detect();
497 if(current_firewire_status
!= last_firewire_status
)
499 last_firewire_status
= current_firewire_status
;
500 firewire_countdown
= NUM_POLL_READINGS
;
504 /* Count down until it gets negative */
505 if(firewire_countdown
>= 0)
506 firewire_countdown
--;
508 /* Report to the thread if we have had 3 identical status
510 if(firewire_countdown
== 0)
512 queue_post(&usb_queue
, USB_REQUEST_REBOOT
, 0);
515 #endif /* USB_FIREWIRE_HANDLING */
517 current_status
= usb_detect();
519 /* Only report when the status has changed */
520 if(current_status
!= last_usb_status
)
522 last_usb_status
= current_status
;
523 countdown
= NUM_POLL_READINGS
;
527 /* Count down until it gets negative */
531 /* Report to the thread if we have had 3 identical status
535 queue_post(&usb_queue
, current_status
, 0);
539 #if (CONFIG_STORAGE & STORAGE_MMC)
540 if(usb_mmc_countdown
> 0)
543 if (usb_mmc_countdown
== 0)
544 queue_post(&usb_queue
, USB_REENABLE
, 0);
549 void usb_start_monitoring(void)
551 usb_monitor_enabled
= true;
553 #endif /* USB_STATUS_BY_EVENT */
554 #endif /* USB_FULL_INIT */
556 void usb_acknowledge(long id
)
558 queue_post(&usb_queue
, id
, 0);
563 /* We assume that the USB cable is extracted */
564 usb_state
= USB_EXTRACTED
;
565 #ifdef USB_DETECT_BY_DRV
566 last_usb_status
= USB_UNPOWERED
;
568 last_usb_status
= USB_EXTRACTED
;
570 usb_monitor_enabled
= false;
573 exclusive_storage_access
= false;
576 #ifdef USB_FIREWIRE_HANDLING
577 firewire_countdown
= -1;
578 last_firewire_status
= false;
585 queue_init(&usb_queue
, true);
587 usb_thread_entry
= create_thread(usb_thread
, usb_stack
,
588 sizeof(usb_stack
), 0, usb_thread_name
589 IF_PRIO(, PRIORITY_SYSTEM
) IF_COP(, CPU
));
591 #ifndef USB_STATUS_BY_EVENT
593 tick_add_task(usb_tick
);
595 #endif /* USB_FULL_INIT */
598 void usb_wait_for_disconnect(struct event_queue
*q
)
601 struct queue_event ev
;
603 /* Don't return until we get SYS_USB_DISCONNECTED */
607 if(ev
.id
== SYS_USB_DISCONNECTED
)
609 usb_acknowledge(SYS_USB_DISCONNECTED_ACK
);
615 #endif /* USB_FULL_INIT */
618 int usb_wait_for_disconnect_w_tmo(struct event_queue
*q
, int ticks
)
621 struct queue_event ev
;
623 /* Don't return until we get SYS_USB_DISCONNECTED or SYS_TIMEOUT */
626 queue_wait_w_tmo(q
, &ev
, ticks
);
629 case SYS_USB_DISCONNECTED
:
630 usb_acknowledge(SYS_USB_DISCONNECTED_ACK
);
637 (void)q
; (void)ticks
;
639 #endif /* USB_FULL_INIT */
642 #ifdef USB_DRIVER_CLOSE
645 unsigned int thread
= usb_thread_entry
;
646 usb_thread_entry
= 0;
651 #ifndef USB_STATUS_BY_EVENT
652 tick_remove_task(usb_tick
);
654 usb_monitor_enabled
= false;
656 queue_post(&usb_queue
, USB_QUIT
, 0);
659 #endif /* USB_DRIVER_CLOSE */
661 bool usb_inserted(void)
663 #ifdef HAVE_USB_POWER
664 return usb_state
== USB_INSERTED
|| usb_state
== USB_POWERED
;
666 return usb_state
== USB_INSERTED
;
671 bool usb_exclusive_storage(void)
673 return exclusive_storage_access
;
677 int usb_release_exclusive_storage(void)
679 int num_acks_to_expect
;
681 exclusive_storage_access
= false;
682 #endif /* HAVE_USBSTACK */
683 /* Tell all threads that we are back in business */
685 queue_broadcast(SYS_USB_DISCONNECTED
, 0) - 1;
686 DEBUGF("USB extracted. Waiting for ack from %d threads...\n",
688 return num_acks_to_expect
;
691 #ifdef HAVE_USB_POWER
692 bool usb_powered(void)
694 return usb_state
== USB_POWERED
;
698 #ifdef USB_ENABLE_HID
699 void usb_set_hid(bool enable
)
702 usb_core_enable_driver(USB_DRIVER_HID
, usb_hid
);
709 bool usb_inserted(void)
715 /* Dummy simulator functions */
716 void usb_acknowledge(long id
)
725 void usb_start_monitoring(void)
731 return USB_EXTRACTED
;
734 void usb_wait_for_disconnect(struct event_queue
*q
)
739 #endif /* USB_NONE or SIMULATOR */