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(CPU_TCC77X) || defined(CPU_TCC780X))) || \
53 (CONFIG_USBOTG == USBOTG_JZ4740)
57 #ifdef HAVE_LCD_BITMAP
58 bool do_screendump_instead_of_usb
= false;
61 #if !defined(SIMULATOR) && !defined(USB_NONE)
65 #if (CONFIG_STORAGE & STORAGE_MMC) && defined(USB_FULL_INIT)
66 static int usb_mmc_countdown
= 0;
69 /* FIXME: The extra 0x800 is consumed by fat_mount() when the fsinfo
72 static long usb_stack
[(DEFAULT_STACK_SIZE
+ 0x800)/sizeof(long)];
73 static const char usb_thread_name
[] = "usb";
74 static unsigned int usb_thread_entry
= 0;
75 #ifndef USB_STATUS_BY_EVENT
76 #define NUM_POLL_READINGS (HZ/5)
78 #endif /* USB_STATUS_BY_EVENT */
79 #endif /* USB_FULL_INIT */
80 static struct event_queue usb_queue
;
81 static bool usb_monitor_enabled
;
82 static int last_usb_status
;
84 static bool exclusive_storage_access
;
87 #ifdef USB_FIREWIRE_HANDLING
88 static int firewire_countdown
;
89 static bool last_firewire_status
;
94 #if defined(USB_FIREWIRE_HANDLING) \
95 || (defined(HAVE_USBSTACK) && !defined(USE_ROCKBOX_USB))
96 static void try_reboot(void)
98 #ifdef HAVE_DISK_STORAGE
99 storage_sleepnow(); /* Immediately spindown the disk. */
103 #ifdef IPOD_ARCH /* The following code is based on ipodlinux */
104 #if CONFIG_CPU == PP5020
105 memcpy((void *)0x40017f00, "diskmode\0\0hotstuff\0\0\1", 21);
106 #elif CONFIG_CPU == PP5022
107 memcpy((void *)0x4001ff00, "diskmode\0\0hotstuff\0\0\1", 21);
108 #endif /* CONFIG_CPU */
109 #endif /* IPOD_ARCH */
111 system_reboot(); /* Reboot */
113 #endif /* USB_FIRWIRE_HANDLING || (HAVE_USBSTACK && !USE_ROCKBOX_USB) */
116 /* inline since branch is chosen at compile time */
117 static inline void usb_slave_mode(bool on
)
119 #ifdef USE_ROCKBOX_USB
125 #ifdef HAVE_PRIORITY_SCHEDULING
126 thread_set_priority(THREAD_ID_CURRENT
, PRIORITY_REALTIME
);
130 else /* usb_state == USB_INSERTED (only!) */
132 #ifndef USB_DETECT_BY_DRV
135 #ifdef HAVE_PRIORITY_SCHEDULING
136 thread_set_priority(THREAD_ID_CURRENT
, PRIORITY_SYSTEM
);
138 /* Entered exclusive mode */
139 rc
= disk_mount_all();
140 if (rc
<= 0) /* no partition */
141 panicf("mount: %d",rc
);
145 #else /* !USB_ROCKBOX_USB */
148 /* until we have native mass-storage mode, we want to reboot on
152 #endif /* USE_ROCKBOX_USB */
155 void usb_signal_transfer_completion(
156 struct usb_transfer_completion_event_data
* event_data
)
158 queue_post(&usb_queue
, USB_TRANSFER_COMPLETION
, (intptr_t)event_data
);
160 #else /* !HAVE_USBSTACK */
161 /* inline since branch is chosen at compile time */
162 static inline void usb_slave_mode(bool on
)
168 DEBUGF("Entering USB slave mode\n");
169 storage_soft_reset();
171 storage_enable(false);
177 DEBUGF("Leaving USB slave mode\n");
179 cpu_idle_mode(false);
181 /* Let the ISDx00 settle */
188 panicf("storage: %d",rc
);
190 rc
= disk_mount_all();
191 if (rc
<= 0) /* no partition */
192 panicf("mount: %d",rc
);
195 #endif /* HAVE_USBSTACK */
197 #ifdef HAVE_USB_POWER
198 static inline bool usb_power_button(void)
200 #if (defined(IRIVER_H10) || defined (IRIVER_H10_5GB)) && !defined(USE_ROCKBOX_USB)
201 return (button_status() & ~USBPOWER_BTN_IGNORE
) != USBPOWER_BUTTON
;
203 return (button_status() & ~USBPOWER_BTN_IGNORE
) == USBPOWER_BUTTON
;
207 #ifdef USB_FIREWIRE_HANDLING
208 static inline bool usb_reboot_button(void)
210 return (button_status() & ~USBPOWER_BTN_IGNORE
) != USBPOWER_BUTTON
;
213 #endif /* HAVE_USB_POWER */
215 static void usb_thread(void)
217 int num_acks_to_expect
= 0;
218 struct queue_event ev
;
222 queue_wait(&usb_queue
, &ev
);
225 #ifdef USB_DRIVER_CLOSE
230 case USB_TRANSFER_COMPLETION
:
231 usb_core_handle_transfer_completion(
232 (struct usb_transfer_completion_event_data
*)ev
.data
);
235 #ifdef USB_DETECT_BY_DRV
236 /* In this case, these events the handle cable insertion USB
237 * driver determines INSERTED/EXTRACTED state. */
239 /* Set the state to USB_POWERED for now and enable the driver
240 * to detect a bus reset only. If a bus reset is detected,
241 * USB_INSERTED will be received. */
242 usb_state
= USB_POWERED
;
248 /* This part shouldn't be obligatory for anything that can
249 * reliably detect removal of the data lines. USB_EXTRACTED
250 * could be posted on that event while bus power remains
252 queue_post(&usb_queue
, USB_EXTRACTED
, 0);
254 #endif /* USB_DETECT_BY_DRV */
256 #ifdef HAVE_LCD_BITMAP
257 if(do_screendump_instead_of_usb
)
259 usb_state
= USB_SCREENDUMP
;
261 #ifdef HAVE_REMOTE_LCD
262 remote_screen_dump();
267 #ifdef HAVE_USB_POWER
268 if(usb_power_button())
270 /* Only charging is desired */
271 usb_state
= USB_POWERED
;
273 #ifdef USB_ENABLE_STORAGE
274 usb_core_enable_driver(USB_DRIVER_MASS_STORAGE
, false);
277 #ifdef USB_ENABLE_HID
278 #ifdef USB_ENABLE_CHARGING_ONLY
279 usb_core_enable_driver(USB_DRIVER_HID
, false);
281 usb_core_enable_driver(USB_DRIVER_HID
, true);
282 #endif /* USB_ENABLE_CHARGING_ONLY */
283 #endif /* USB_ENABLE_HID */
285 #ifdef USB_ENABLE_CHARGING_ONLY
286 usb_core_enable_driver(USB_DRIVER_CHARGING_ONLY
, true);
292 #endif /* HAVE_USB_POWER */
294 #ifdef HAVE_USB_POWER
295 /* Set the state to USB_POWERED for now. If permission to connect
296 * by threads and storage is granted it will be changed to
298 usb_state
= USB_POWERED
;
300 #ifdef USB_ENABLE_STORAGE
301 usb_core_enable_driver(USB_DRIVER_MASS_STORAGE
, true);
303 #ifdef USB_ENABLE_HID
304 usb_core_enable_driver(USB_DRIVER_HID
, true);
306 #ifdef USB_ENABLE_CHARGING_ONLY
307 usb_core_enable_driver(USB_DRIVER_CHARGING_ONLY
, false);
310 /* Check any drivers enabled at this point for exclusive storage
311 * access requirements. */
312 exclusive_storage_access
= usb_core_any_exclusive_storage();
314 if(!exclusive_storage_access
)
319 #endif /* HAVE_USBSTACK */
320 /* Tell all threads that they have to back off the storage.
321 We subtract one for our own thread. */
322 num_acks_to_expect
= queue_broadcast(SYS_USB_CONNECTED
, 0) - 1;
323 DEBUGF("USB inserted. Waiting for ack from %d threads...\n",
327 case SYS_USB_CONNECTED_ACK
:
328 if(num_acks_to_expect
> 0 && --num_acks_to_expect
== 0)
330 DEBUGF("All threads have acknowledged the connect.\n");
331 usb_slave_mode(true);
332 usb_state
= USB_INSERTED
;
336 DEBUGF("usb: got ack, %d to go...\n",
342 #ifdef HAVE_LCD_BITMAP
343 if(usb_state
== USB_SCREENDUMP
)
345 usb_state
= USB_EXTRACTED
;
346 break; /* Connected for screendump only */
349 #ifndef HAVE_USBSTACK /* Stack must undo this if POWERED state was transitional */
350 #ifdef HAVE_USB_POWER
351 if(usb_state
== USB_POWERED
)
353 usb_state
= USB_EXTRACTED
;
357 #endif /* HAVE_USBSTACK */
358 if(usb_state
== USB_INSERTED
)
360 /* Only disable the USB mode if we really have enabled it
361 some threads might not have acknowledged the
363 usb_slave_mode(false);
366 usb_state
= USB_EXTRACTED
;
368 if(!exclusive_storage_access
)
370 #ifndef USB_DETECT_BY_DRV /* Disabled handling USB_UNPOWERED */
376 #endif /* HAVE_USBSTACK */
377 num_acks_to_expect
= usb_release_exclusive_storage();
381 case SYS_USB_DISCONNECTED_ACK
:
382 if(num_acks_to_expect
> 0 && --num_acks_to_expect
== 0)
384 DEBUGF("All threads have acknowledged. "
385 "We're in business.\n");
389 DEBUGF("usb: got ack, %d to go...\n",
395 case SYS_HOTSWAP_INSERTED
:
396 case SYS_HOTSWAP_EXTRACTED
:
398 usb_core_hotswap_event(1,ev
.id
== SYS_HOTSWAP_INSERTED
);
399 #else /* !HAVE_USBSTACK */
400 if(usb_state
== USB_INSERTED
)
403 #if (CONFIG_STORAGE & STORAGE_MMC)
404 usb_mmc_countdown
= HZ
/2; /* re-enable after 0.5 sec */
405 #endif /* STORAGE_MMC */
407 #endif /* HAVE_USBSTACK */
410 #if (CONFIG_STORAGE & STORAGE_MMC)
412 if(usb_state
== USB_INSERTED
)
413 usb_enable(true); /* reenable only if still inserted */
415 #endif /* STORAGE_MMC */
416 #endif /* HAVE_HOTSWAP */
418 #ifdef USB_FIREWIRE_HANDLING
419 case USB_REQUEST_REBOOT
:
420 #ifdef HAVE_USB_POWER
421 if (usb_reboot_button())
425 #endif /* USB_FIREWIRE_HANDLING */
430 #ifdef USB_STATUS_BY_EVENT
431 void usb_status_event(int current_status
)
433 /* Caller isn't expected to filter for changes in status.
435 * USB_DETECT_BY_DRV: USB_POWERED, USB_UNPOWERED, USB_INSERTED (driver)
436 * else: USB_INSERTED, USB_EXTRACTED
438 if(usb_monitor_enabled
)
440 int oldstatus
= disable_irq_save(); /* Dual-use function */
442 if(last_usb_status
!= current_status
)
444 last_usb_status
= current_status
;
445 queue_post(&usb_queue
, current_status
, 0);
448 restore_irq(oldstatus
);
452 void usb_start_monitoring(void)
454 int oldstatus
= disable_irq_save(); /* Sync to event */
455 int status
= usb_detect();
457 usb_monitor_enabled
= true;
459 #ifdef USB_DETECT_BY_DRV
460 status
= (status
== USB_INSERTED
) ? USB_POWERED
: USB_UNPOWERED
;
462 usb_status_event(status
);
464 #ifdef USB_FIREWIRE_HANDLING
465 if (firewire_detect())
466 usb_firewire_connect_event();
469 restore_irq(oldstatus
);
472 #ifdef USB_FIREWIRE_HANDLING
473 void usb_firewire_connect_event(void)
475 queue_post(&usb_queue
, USB_REQUEST_REBOOT
, 0);
477 #endif /* USB_FIREWIRE_HANDLING */
478 #else /* !USB_STATUS_BY_EVENT */
479 static void usb_tick(void)
483 if(usb_monitor_enabled
)
485 #ifdef USB_FIREWIRE_HANDLING
486 int current_firewire_status
= firewire_detect();
487 if(current_firewire_status
!= last_firewire_status
)
489 last_firewire_status
= current_firewire_status
;
490 firewire_countdown
= NUM_POLL_READINGS
;
494 /* Count down until it gets negative */
495 if(firewire_countdown
>= 0)
496 firewire_countdown
--;
498 /* Report to the thread if we have had 3 identical status
500 if(firewire_countdown
== 0)
502 queue_post(&usb_queue
, USB_REQUEST_REBOOT
, 0);
505 #endif /* USB_FIREWIRE_HANDLING */
507 current_status
= usb_detect();
509 /* Only report when the status has changed */
510 if(current_status
!= last_usb_status
)
512 last_usb_status
= current_status
;
513 countdown
= NUM_POLL_READINGS
;
517 /* Count down until it gets negative */
521 /* Report to the thread if we have had 3 identical status
525 queue_post(&usb_queue
, current_status
, 0);
529 #if (CONFIG_STORAGE & STORAGE_MMC)
530 if(usb_mmc_countdown
> 0)
533 if (usb_mmc_countdown
== 0)
534 queue_post(&usb_queue
, USB_REENABLE
, 0);
539 void usb_start_monitoring(void)
541 usb_monitor_enabled
= true;
543 #endif /* USB_STATUS_BY_EVENT */
544 #endif /* USB_FULL_INIT */
546 void usb_acknowledge(long id
)
548 queue_post(&usb_queue
, id
, 0);
553 /* We assume that the USB cable is extracted */
554 usb_state
= USB_EXTRACTED
;
555 #ifdef USB_DETECT_BY_DRV
556 last_usb_status
= USB_UNPOWERED
;
558 last_usb_status
= USB_EXTRACTED
;
560 usb_monitor_enabled
= false;
563 exclusive_storage_access
= false;
566 #ifdef USB_FIREWIRE_HANDLING
567 firewire_countdown
= -1;
568 last_firewire_status
= false;
575 queue_init(&usb_queue
, true);
577 usb_thread_entry
= create_thread(usb_thread
, usb_stack
,
578 sizeof(usb_stack
), 0, usb_thread_name
579 IF_PRIO(, PRIORITY_SYSTEM
) IF_COP(, CPU
));
581 #ifndef USB_STATUS_BY_EVENT
583 tick_add_task(usb_tick
);
585 #endif /* USB_FULL_INIT */
588 void usb_wait_for_disconnect(struct event_queue
*q
)
591 struct queue_event ev
;
593 /* Don't return until we get SYS_USB_DISCONNECTED */
597 if(ev
.id
== SYS_USB_DISCONNECTED
)
599 usb_acknowledge(SYS_USB_DISCONNECTED_ACK
);
605 #endif /* USB_FULL_INIT */
608 int usb_wait_for_disconnect_w_tmo(struct event_queue
*q
, int ticks
)
611 struct queue_event ev
;
613 /* Don't return until we get SYS_USB_DISCONNECTED or SYS_TIMEOUT */
616 queue_wait_w_tmo(q
, &ev
, ticks
);
619 case SYS_USB_DISCONNECTED
:
620 usb_acknowledge(SYS_USB_DISCONNECTED_ACK
);
627 (void)q
; (void)ticks
;
629 #endif /* USB_FULL_INIT */
632 #ifdef USB_DRIVER_CLOSE
635 unsigned int thread
= usb_thread_entry
;
636 usb_thread_entry
= 0;
641 #ifndef USB_STATUS_BY_EVENT
642 tick_remove_task(usb_tick
);
644 usb_monitor_enabled
= false;
646 queue_post(&usb_queue
, USB_QUIT
, 0);
649 #endif /* USB_DRIVER_CLOSE */
651 bool usb_inserted(void)
653 #ifdef HAVE_USB_POWER
654 return usb_state
== USB_INSERTED
|| usb_state
== USB_POWERED
;
656 return usb_state
== USB_INSERTED
;
661 bool usb_exclusive_storage(void)
663 return exclusive_storage_access
;
667 int usb_release_exclusive_storage(void)
669 int num_acks_to_expect
;
671 exclusive_storage_access
= false;
672 #endif /* HAVE_USBSTACK */
673 /* Tell all threads that we are back in business */
675 queue_broadcast(SYS_USB_DISCONNECTED
, 0) - 1;
676 DEBUGF("USB extracted. Waiting for ack from %d threads...\n",
678 return num_acks_to_expect
;
681 #ifdef HAVE_USB_POWER
682 bool usb_powered(void)
684 return usb_state
== USB_POWERED
;
691 bool usb_inserted(void)
697 /* Dummy simulator functions */
698 void usb_acknowledge(long id
)
707 void usb_start_monitoring(void)
713 return USB_EXTRACTED
;
716 void usb_wait_for_disconnect(struct event_queue
*q
)
721 #endif /* USB_NONE or SIMULATOR */