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"
45 #include "screendump.h"
47 /* Conditions under which we want the entire driver */
48 #if !defined(BOOTLOADER) || (CONFIG_CPU == SH7034) || \
49 (defined(TOSHIBA_GIGABEAT_S) && defined(USE_ROCKBOX_USB) && defined(USB_ENABLE_STORAGE)) || \
50 (defined(HAVE_USBSTACK) && (defined(CREATIVE_ZVx))) || \
51 (defined(HAVE_USBSTACK) && (defined(OLYMPUS_MROBE_500))) || \
52 (defined(HAVE_USBSTACK) && (defined(IPOD_NANO2G))) || \
53 defined(CPU_TCC77X) || defined(CPU_TCC780X) || \
54 (CONFIG_USBOTG == USBOTG_JZ4740) || \
55 (defined(USE_ROCKBOX_USB) && CONFIG_USBOTG == USBOTG_AS3525) || \
56 (defined(USE_ROCKBOX_USB) && CONFIG_USBOTG == USBOTG_AS3525v2)
60 #ifdef HAVE_LCD_BITMAP
61 bool do_screendump_instead_of_usb
= false;
64 #if !defined(SIMULATOR) && !defined(USB_NONE)
68 #if (CONFIG_STORAGE & STORAGE_MMC) && defined(USB_FULL_INIT)
69 static int usb_mmc_countdown
= 0;
72 /* Make sure there's enough stack space for screendump */
74 static long usb_stack
[(DEFAULT_STACK_SIZE
+ SECTOR_SIZE
+ DUMP_BMP_LINESIZE
)/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
);
137 else /* usb_state == USB_INSERTED (only!) */
139 #ifndef USB_DETECT_BY_DRV
142 #ifdef HAVE_PRIORITY_SCHEDULING
143 thread_set_priority(THREAD_ID_CURRENT
, PRIORITY_SYSTEM
);
145 /* Entered exclusive mode */
146 rc
= disk_mount_all();
147 if (rc
<= 0) /* no partition */
148 panicf("mount: %d",rc
);
152 #else /* !USE_ROCKBOX_USB */
155 /* until we have native mass-storage mode, we want to reboot on
159 #endif /* USE_ROCKBOX_USB */
162 void usb_signal_transfer_completion(
163 struct usb_transfer_completion_event_data
* event_data
)
165 queue_post(&usb_queue
, USB_TRANSFER_COMPLETION
, (intptr_t)event_data
);
167 #else /* !HAVE_USBSTACK */
168 /* inline since branch is chosen at compile time */
169 static inline void usb_slave_mode(bool on
)
175 DEBUGF("Entering USB slave mode\n");
177 storage_soft_reset();
179 storage_enable(false);
185 DEBUGF("Leaving USB slave mode\n");
187 cpu_idle_mode(false);
189 /* Let the ISDx00 settle */
196 panicf("storage: %d",rc
);
198 rc
= disk_mount_all();
199 if (rc
<= 0) /* no partition */
200 panicf("mount: %d",rc
);
203 #endif /* HAVE_USBSTACK */
205 #ifdef HAVE_USB_POWER
206 static inline bool usb_power_button(void)
208 #if (defined(IRIVER_H10) || defined (IRIVER_H10_5GB)) && !defined(USE_ROCKBOX_USB)
209 return (button_status() & ~USBPOWER_BTN_IGNORE
) != USBPOWER_BUTTON
;
211 return (button_status() & ~USBPOWER_BTN_IGNORE
) == USBPOWER_BUTTON
;
215 #ifdef USB_FIREWIRE_HANDLING
216 static inline bool usb_reboot_button(void)
218 return (button_status() & ~USBPOWER_BTN_IGNORE
) != USBPOWER_BUTTON
;
221 #endif /* HAVE_USB_POWER */
223 #ifdef USB_ENABLE_HID
224 static bool usb_hid
= true;
227 static void usb_thread(void)
229 int num_acks_to_expect
= 0;
230 struct queue_event ev
;
234 queue_wait(&usb_queue
, &ev
);
237 #ifdef USB_DRIVER_CLOSE
242 case USB_TRANSFER_COMPLETION
:
243 usb_core_handle_transfer_completion(
244 (struct usb_transfer_completion_event_data
*)ev
.data
);
247 #ifdef USB_DETECT_BY_DRV
248 /* In this case, these events the handle cable insertion USB
249 * driver determines INSERTED/EXTRACTED state. */
251 /* Set the state to USB_POWERED for now and enable the driver
252 * to detect a bus reset only. If a bus reset is detected,
253 * USB_INSERTED will be received. */
254 usb_state
= USB_POWERED
;
260 /* This part shouldn't be obligatory for anything that can
261 * reliably detect removal of the data lines. USB_EXTRACTED
262 * could be posted on that event while bus power remains
264 queue_post(&usb_queue
, USB_EXTRACTED
, 0);
266 #endif /* USB_DETECT_BY_DRV */
268 #ifdef HAVE_LCD_BITMAP
269 if(do_screendump_instead_of_usb
)
271 usb_state
= USB_SCREENDUMP
;
273 #ifdef HAVE_REMOTE_LCD
274 remote_screen_dump();
279 #ifdef HAVE_USB_POWER
280 if(usb_power_button())
282 /* Only charging is desired */
283 usb_state
= USB_POWERED
;
285 #ifdef USB_ENABLE_STORAGE
286 usb_core_enable_driver(USB_DRIVER_MASS_STORAGE
, false);
289 #ifdef USB_ENABLE_HID
290 #ifdef USB_ENABLE_CHARGING_ONLY
291 usb_core_enable_driver(USB_DRIVER_HID
, false);
293 usb_core_enable_driver(USB_DRIVER_HID
, true);
294 #endif /* USB_ENABLE_CHARGING_ONLY */
295 #endif /* USB_ENABLE_HID */
297 #ifdef USB_ENABLE_CHARGING_ONLY
298 usb_core_enable_driver(USB_DRIVER_CHARGING_ONLY
, true);
304 #endif /* HAVE_USB_POWER */
306 #ifdef HAVE_USB_POWER
307 /* Set the state to USB_POWERED for now. If permission to connect
308 * by threads and storage is granted it will be changed to
310 usb_state
= USB_POWERED
;
312 #ifdef USB_ENABLE_STORAGE
313 usb_core_enable_driver(USB_DRIVER_MASS_STORAGE
, true);
315 #ifdef USB_ENABLE_HID
316 usb_core_enable_driver(USB_DRIVER_HID
, usb_hid
);
318 #ifdef USB_ENABLE_CHARGING_ONLY
319 usb_core_enable_driver(USB_DRIVER_CHARGING_ONLY
, false);
322 /* Check any drivers enabled at this point for exclusive storage
323 * access requirements. */
324 exclusive_storage_access
= usb_core_any_exclusive_storage();
326 if(!exclusive_storage_access
)
331 #endif /* HAVE_USBSTACK */
332 /* Tell all threads that they have to back off the storage.
333 We subtract one for our own thread. */
334 num_acks_to_expect
= queue_broadcast(SYS_USB_CONNECTED
, 0) - 1;
335 DEBUGF("USB inserted. Waiting for ack from %d threads...\n",
339 case SYS_USB_CONNECTED_ACK
:
340 if(num_acks_to_expect
> 0 && --num_acks_to_expect
== 0)
342 DEBUGF("All threads have acknowledged the connect.\n");
343 usb_slave_mode(true);
344 usb_state
= USB_INSERTED
;
348 DEBUGF("usb: got ack, %d to go...\n",
354 #ifdef HAVE_LCD_BITMAP
355 if(usb_state
== USB_SCREENDUMP
)
357 usb_state
= USB_EXTRACTED
;
358 break; /* Connected for screendump only */
361 #ifndef HAVE_USBSTACK /* Stack must undo this if POWERED state was transitional */
362 #ifdef HAVE_USB_POWER
363 if(usb_state
== USB_POWERED
)
365 usb_state
= USB_EXTRACTED
;
369 #endif /* HAVE_USBSTACK */
370 if(usb_state
== USB_INSERTED
)
372 /* Only disable the USB mode if we really have enabled it
373 some threads might not have acknowledged the
375 usb_slave_mode(false);
378 usb_state
= USB_EXTRACTED
;
380 if(!exclusive_storage_access
)
382 #ifndef USB_DETECT_BY_DRV /* Disabled handling USB_UNPOWERED */
388 #endif /* HAVE_USBSTACK */
389 num_acks_to_expect
= usb_release_exclusive_storage();
393 case SYS_USB_DISCONNECTED_ACK
:
394 if(num_acks_to_expect
> 0 && --num_acks_to_expect
== 0)
396 DEBUGF("All threads have acknowledged. "
397 "We're in business.\n");
401 DEBUGF("usb: got ack, %d to go...\n",
407 case SYS_HOTSWAP_INSERTED
:
408 case SYS_HOTSWAP_EXTRACTED
:
410 usb_core_hotswap_event(1,ev
.id
== SYS_HOTSWAP_INSERTED
);
411 #else /* !HAVE_USBSTACK */
412 if(usb_state
== USB_INSERTED
)
414 #if (CONFIG_STORAGE & STORAGE_MMC)
416 usb_mmc_countdown
= HZ
/2; /* re-enable after 0.5 sec */
417 #endif /* STORAGE_MMC */
419 #endif /* HAVE_USBSTACK */
422 #if (CONFIG_STORAGE & STORAGE_MMC)
424 if(usb_state
== USB_INSERTED
)
425 usb_enable(true); /* reenable only if still inserted */
427 #endif /* STORAGE_MMC */
428 #endif /* HAVE_HOTSWAP */
430 #ifdef USB_FIREWIRE_HANDLING
431 case USB_REQUEST_REBOOT
:
432 #ifdef HAVE_USB_POWER
433 if (usb_reboot_button())
437 #endif /* USB_FIREWIRE_HANDLING */
439 #if defined(HAVE_USB_CHARGING_ENABLE) && defined(HAVE_USBSTACK)
440 case USB_CHARGER_UPDATE
:
441 usb_charging_maxcurrent_change(usb_charging_maxcurrent());
448 #if defined(HAVE_USB_CHARGING_ENABLE) && defined(HAVE_USBSTACK)
449 void usb_charger_update(void)
451 queue_post(&usb_queue
, USB_CHARGER_UPDATE
, 0);
455 #ifdef USB_STATUS_BY_EVENT
456 void usb_status_event(int current_status
)
458 /* Caller isn't expected to filter for changes in status.
460 * USB_DETECT_BY_DRV: USB_POWERED, USB_UNPOWERED, USB_INSERTED (driver)
461 * else: USB_INSERTED, USB_EXTRACTED
463 if(usb_monitor_enabled
)
465 int oldstatus
= disable_irq_save(); /* Dual-use function */
467 if(last_usb_status
!= current_status
)
469 last_usb_status
= current_status
;
470 queue_post(&usb_queue
, current_status
, 0);
473 restore_irq(oldstatus
);
477 void usb_start_monitoring(void)
479 int oldstatus
= disable_irq_save(); /* Sync to event */
480 int status
= usb_detect();
482 usb_monitor_enabled
= true;
484 #ifdef USB_DETECT_BY_DRV
485 status
= (status
== USB_INSERTED
) ? USB_POWERED
: USB_UNPOWERED
;
487 usb_status_event(status
);
489 #ifdef USB_FIREWIRE_HANDLING
490 if (firewire_detect())
491 usb_firewire_connect_event();
494 restore_irq(oldstatus
);
497 #ifdef USB_FIREWIRE_HANDLING
498 void usb_firewire_connect_event(void)
500 queue_post(&usb_queue
, USB_REQUEST_REBOOT
, 0);
502 #endif /* USB_FIREWIRE_HANDLING */
503 #else /* !USB_STATUS_BY_EVENT */
504 static void usb_tick(void)
508 if(usb_monitor_enabled
)
510 #ifdef USB_FIREWIRE_HANDLING
511 int current_firewire_status
= firewire_detect();
512 if(current_firewire_status
!= last_firewire_status
)
514 last_firewire_status
= current_firewire_status
;
515 firewire_countdown
= NUM_POLL_READINGS
;
519 /* Count down until it gets negative */
520 if(firewire_countdown
>= 0)
521 firewire_countdown
--;
523 /* Report to the thread if we have had 3 identical status
525 if(firewire_countdown
== 0)
527 queue_post(&usb_queue
, USB_REQUEST_REBOOT
, 0);
530 #endif /* USB_FIREWIRE_HANDLING */
532 current_status
= usb_detect();
534 /* Only report when the status has changed */
535 if(current_status
!= last_usb_status
)
537 last_usb_status
= current_status
;
538 countdown
= NUM_POLL_READINGS
;
542 /* Count down until it gets negative */
546 /* Report to the thread if we have had 3 identical status
550 queue_post(&usb_queue
, current_status
, 0);
554 #if (CONFIG_STORAGE & STORAGE_MMC)
555 if(usb_mmc_countdown
> 0)
558 if (usb_mmc_countdown
== 0)
559 queue_post(&usb_queue
, USB_REENABLE
, 0);
564 void usb_start_monitoring(void)
566 usb_monitor_enabled
= true;
568 #endif /* USB_STATUS_BY_EVENT */
569 #endif /* USB_FULL_INIT */
571 void usb_acknowledge(long id
)
573 queue_post(&usb_queue
, id
, 0);
578 /* We assume that the USB cable is extracted */
579 usb_state
= USB_EXTRACTED
;
580 #ifdef USB_DETECT_BY_DRV
581 last_usb_status
= USB_UNPOWERED
;
583 last_usb_status
= USB_EXTRACTED
;
585 usb_monitor_enabled
= false;
588 exclusive_storage_access
= false;
591 #ifdef USB_FIREWIRE_HANDLING
592 firewire_countdown
= -1;
593 last_firewire_status
= false;
600 queue_init(&usb_queue
, true);
602 usb_thread_entry
= create_thread(usb_thread
, usb_stack
,
603 sizeof(usb_stack
), 0, usb_thread_name
604 IF_PRIO(, PRIORITY_SYSTEM
) IF_COP(, CPU
));
606 #ifndef USB_STATUS_BY_EVENT
608 tick_add_task(usb_tick
);
610 #endif /* USB_FULL_INIT */
613 void usb_wait_for_disconnect(struct event_queue
*q
)
616 struct queue_event ev
;
618 /* Don't return until we get SYS_USB_DISCONNECTED */
622 if(ev
.id
== SYS_USB_DISCONNECTED
)
624 usb_acknowledge(SYS_USB_DISCONNECTED_ACK
);
630 #endif /* USB_FULL_INIT */
633 int usb_wait_for_disconnect_w_tmo(struct event_queue
*q
, int ticks
)
636 struct queue_event ev
;
638 /* Don't return until we get SYS_USB_DISCONNECTED or SYS_TIMEOUT */
641 queue_wait_w_tmo(q
, &ev
, ticks
);
644 case SYS_USB_DISCONNECTED
:
645 usb_acknowledge(SYS_USB_DISCONNECTED_ACK
);
652 (void)q
; (void)ticks
;
654 #endif /* USB_FULL_INIT */
657 #ifdef USB_DRIVER_CLOSE
660 unsigned int thread
= usb_thread_entry
;
661 usb_thread_entry
= 0;
666 #ifndef USB_STATUS_BY_EVENT
667 tick_remove_task(usb_tick
);
669 usb_monitor_enabled
= false;
671 queue_post(&usb_queue
, USB_QUIT
, 0);
674 #endif /* USB_DRIVER_CLOSE */
676 bool usb_inserted(void)
678 #ifdef HAVE_USB_POWER
679 return usb_state
== USB_INSERTED
|| usb_state
== USB_POWERED
;
681 return usb_state
== USB_INSERTED
;
686 bool usb_exclusive_storage(void)
688 return exclusive_storage_access
;
692 int usb_release_exclusive_storage(void)
694 int num_acks_to_expect
;
696 exclusive_storage_access
= false;
697 #endif /* HAVE_USBSTACK */
698 /* Tell all threads that we are back in business */
700 queue_broadcast(SYS_USB_DISCONNECTED
, 0) - 1;
701 DEBUGF("USB extracted. Waiting for ack from %d threads...\n",
703 return num_acks_to_expect
;
706 #ifdef HAVE_USB_POWER
707 bool usb_powered(void)
709 return usb_state
== USB_POWERED
;
713 #ifdef USB_ENABLE_HID
714 void usb_set_hid(bool enable
)
717 usb_core_enable_driver(USB_DRIVER_HID
, usb_hid
);
724 bool usb_inserted(void)
730 /* Dummy simulator functions */
731 void usb_acknowledge(long id
)
740 void usb_start_monitoring(void)
746 return USB_EXTRACTED
;
749 void usb_wait_for_disconnect(struct event_queue
*q
)
754 #endif /* USB_NONE or SIMULATOR */