Index: .bzrignore =================================================================== --- .bzrignore (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ .bzrignore (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,145 @@ +# user makefile for local targets +Makefile.local + +# generated files (misc) +Makefile.depend +*.prev +*.map +*.disasm +_link.ld +./*.iso + +./tools/__pycache__/ + +./Makefile.common +./Makefile.config +./common.h +./config.h +./autotool/ +./image.iso +./boot/distroot/ +./boot/initrd.fs +./boot/initrd.img +./kernel/kernel.bin +./kernel/kernel.dump +./kernel/kernel.raw +./kernel/generic/src/debug/real_map.bin + +./kernel/arch/ia32/include/common.h +./kernel/arch/amd64/include/common.h +./kernel/generic/include/arch +./kernel/generic/include/genarch +./uspace/lib/c/arch/amd64/include/common.h +./uspace/lib/c/arch/ia32/include/common.h +./uspace/lib/c/include/arch +./uspace/lib/c/include/kernel +./uspace/lib/c/include/libarch + + + + + + +# generated files (executables) +./uspace/app/bdsh/bdsh +./uspace/app/edit/edit +./uspace/app/getterm/getterm +./uspace/app/init/init +./uspace/app/kill/kill +./uspace/app/killall/killall +./uspace/app/klog/klog +./uspace/app/mkfat/mkfat +./uspace/app/netstart/netstart +./uspace/app/netecho/netecho +./uspace/app/nettest1/nettest1 +./uspace/app/nettest2/nettest2 +./uspace/app/ping/ping +./uspace/app/redir/redir +./uspace/app/sysinfo/sysinfo +./uspace/app/sbi/sbi +./uspace/app/stats/stats +./uspace/app/taskdump/taskdump +./uspace/app/tasks/tasks +./uspace/app/tester/tester +./uspace/app/test_serial/test_serial +./uspace/app/tetris/tetris +./uspace/app/top/top +./uspace/app/trace/trace +./uspace/app/usb/usb +./uspace/app/usbinfo/usbinfo +./uspace/app/virtusbkbd/vuk +./uspace/app/virtusbhub/vuh +./uspace/app/virtusbhub/vhc_hub/* +./uspace/app/websrv/websrv +./uspace/dist/app/* +./uspace/dist/cfg/net/general +./uspace/dist/cfg/net/lo +./uspace/dist/cfg/net/ne2k +./uspace/dist/drv/* +./uspace/dist/srv/* +./uspace/drv/root/root +./uspace/drv/isa/isa +./uspace/drv/ns8250/ns8250 +./uspace/drv/pciintel/pciintel +./uspace/drv/rootpc/rootpc +./uspace/drv/rootvirt/rootvirt +./uspace/drv/test1/test1 +./uspace/drv/test2/test2 +./uspace/drv/ohci/ohci +./uspace/drv/ehci-hcd/ehci-hcd +./uspace/drv/uhci-hcd/uhci-hcd +./uspace/drv/uhci-rhd/uhci-rhd +./uspace/drv/usbflbk/usbflbk +./uspace/drv/usbhub/usbhub +./uspace/drv/usbhid/usbhid +./uspace/drv/usbmid/usbmid +./uspace/drv/usbmouse/usbmouse +./uspace/drv/vhc/vhc +./uspace/srv/bd/ata_bd/ata_bd +./uspace/srv/bd/file_bd/file_bd +./uspace/srv/bd/gxe_bd/gxe_bd +./uspace/srv/bd/part/guid_part/g_part +./uspace/srv/bd/part/mbr_part/mbr_part +./uspace/srv/bd/rd/rd +./uspace/srv/clip/clip +./uspace/srv/devman/devman +./uspace/srv/devmap/devmap +./uspace/srv/fs/devfs/devfs +./uspace/srv/fs/fat/fat +./uspace/srv/fs/tmpfs/tmpfs +./uspace/srv/hid/adb_mouse/adb_ms +./uspace/srv/hid/char_mouse/char_ms +./uspace/srv/hid/console/console +./uspace/srv/hid/fb/fb +./uspace/srv/hid/kbd/kbd +./uspace/srv/hid/s3c24xx_ts/s3c24ts +./uspace/srv/hw/bus/pci/pci +./uspace/srv/hw/char/i8042/i8042 +./uspace/srv/hw/char/s3c24xx_uart/s3c24ser +./uspace/srv/hw/irc/apic/apic +./uspace/srv/hw/irc/i8259/i8259 +./uspace/srv/hw/netif/ne2000/dp8390 +./uspace/srv/hw/netif/ne2000/ne2000 +./uspace/srv/loader/loader +./uspace/srv/net/cfg/lo +./uspace/srv/net/cfg/ne2k +./uspace/srv/net/il/arp/arp +./uspace/srv/net/il/ip/ip +./uspace/srv/net/net/net +./uspace/srv/net/netif/lo/lo +./uspace/srv/net/netstart/netstart +./uspace/srv/net/nil/eth/eth +./uspace/srv/net/nil/nildummy/nildummy +./uspace/srv/net/tl/icmp/icmp +./uspace/srv/net/tl/tcp/tcp +./uspace/srv/net/tl/udp/udp +./uspace/srv/ns/ns +./uspace/srv/taskmon/taskmon +./uspace/srv/vfs/vfs + +# IDE files +.cproject +.project +.settings +.pydevproject + Index: HelenOS.config =================================================================== --- HelenOS.config (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ HelenOS.config (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -529,5 +529,5 @@ % Run devman on startup -! CONFIG_START_DEVMAN (y/n) +! CONFIG_START_DEVMAN (y) % Launch (devman) test drivers @@ -554,2 +554,11 @@ % Line debugging information ! [CONFIG_STRIP_BINARIES!=y] CONFIG_LINE_DEBUG (n/y) + +% Start virtual USB host controller +! CONFIG_RUN_VIRTUAL_USB_HC (n/y) + +% Polling UHCI & OHCI (no interrupts) +! [PLATFORM=ia32|PLATFORM=amd64] CONFIG_USBHC_NO_INTERRUPTS (y/n) + +% Run devman in kconsole (not recommended) +! CONFIG_DEVMAN_EARLY_LAUNCH (n/y) Index: Makefile =================================================================== --- Makefile (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -106,2 +106,4 @@ $(MAKE) -C uspace clean $(MAKE) -C boot clean + +-include Makefile.local Index: boot/Makefile.common =================================================================== --- boot/Makefile.common (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ boot/Makefile.common (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -139,6 +139,10 @@ $(USPACE_PATH)/app/ping/ping \ $(USPACE_PATH)/app/stats/stats \ + $(USPACE_PATH)/app/sysinfo/sysinfo \ + $(USPACE_PATH)/app/tasks/tasks \ $(USPACE_PATH)/app/top/top \ - $(USPACE_PATH)/app/sysinfo/sysinfo \ + $(USPACE_PATH)/app/usbinfo/usbinfo \ + $(USPACE_PATH)/app/virtusbkbd/vuk \ + $(USPACE_PATH)/app/virtusbhub/vuh \ $(USPACE_PATH)/app/websrv/websrv Index: boot/arch/amd64/Makefile.inc =================================================================== --- boot/arch/amd64/Makefile.inc (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ boot/arch/amd64/Makefile.inc (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -42,5 +42,15 @@ pciintel \ isa \ - ns8250 + ns8250 \ + ehci-hcd \ + ohci \ + uhci-hcd \ + uhci-rhd \ + usbflbk \ + usbhub \ + usbkbd \ + usbmid \ + usbmouse \ + vhc RD_DRV_CFG += \ Index: kernel/generic/include/mm/page.h =================================================================== --- kernel/generic/include/mm/page.h (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ kernel/generic/include/mm/page.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -37,4 +37,5 @@ #include +#include #include #include @@ -62,4 +63,6 @@ extern uintptr_t hw_map(uintptr_t, size_t); +extern sysarg_t sys_page_find_mapping(uintptr_t, uintptr_t *); + #endif Index: kernel/generic/include/syscall/syscall.h =================================================================== --- kernel/generic/include/syscall/syscall.h (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ kernel/generic/include/syscall/syscall.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -61,4 +61,6 @@ SYS_AS_GET_UNMAPPED_AREA, + SYS_PAGE_FIND_MAPPING, + SYS_IPC_CALL_SYNC_FAST, SYS_IPC_CALL_SYNC_SLOW, Index: kernel/generic/src/console/console.c =================================================================== --- kernel/generic/src/console/console.c (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ kernel/generic/src/console/console.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -53,5 +53,14 @@ #include +/* + * devman produces a lot of output and by giving so many pages + * we to allow /app/klog to catch-up. + */ +#ifdef CONFIG_DEVMAN_EARLY_LAUNCH +#define KLOG_PAGES 64 +#else #define KLOG_PAGES 4 +#endif + #define KLOG_LENGTH (KLOG_PAGES * PAGE_SIZE / sizeof(wchar_t)) #define KLOG_LATENCY 8 Index: kernel/generic/src/mm/as.c =================================================================== --- kernel/generic/src/mm/as.c (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ kernel/generic/src/mm/as.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -1949,5 +1949,5 @@ sysarg_t sys_as_area_create(uintptr_t address, size_t size, unsigned int flags) { - if (as_area_create(AS, flags | AS_AREA_CACHEABLE, size, address, + if (as_area_create(AS, flags, size, address, AS_AREA_ATTR_NONE, &anon_backend, NULL)) return (sysarg_t) address; Index: kernel/generic/src/mm/page.c =================================================================== --- kernel/generic/src/mm/page.c (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ kernel/generic/src/mm/page.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -60,4 +60,6 @@ #include +#include +#include #include #include @@ -70,4 +72,6 @@ #include #include +#include +#include /** Virtual operations for page subsystem. */ @@ -173,4 +177,35 @@ } +/** Syscall wrapper for getting mapping of a virtual page. + * + * @retval EOK Everything went find, @p uspace_frame and @p uspace_node + * contains correct values. + * @retval ENOENT Virtual address has no mapping. + */ +sysarg_t sys_page_find_mapping(uintptr_t virt_address, + uintptr_t *uspace_frame) +{ + mutex_lock(&AS->lock); + + pte_t *pte = page_mapping_find(AS, virt_address); + if (!PTE_VALID(pte) || !PTE_PRESENT(pte)) { + mutex_unlock(&AS->lock); + + return (sysarg_t) ENOENT; + } + + uintptr_t phys_address = PTE_GET_FRAME(pte); + + mutex_unlock(&AS->lock); + + int rc = copy_to_uspace(uspace_frame, + &phys_address, sizeof(phys_address)); + if (rc != EOK) { + return (sysarg_t) rc; + } + + return EOK; +} + /** @} */ Index: kernel/generic/src/syscall/syscall.c =================================================================== --- kernel/generic/src/syscall/syscall.c (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ kernel/generic/src/syscall/syscall.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -41,4 +41,5 @@ #include #include +#include #include #include @@ -145,4 +146,7 @@ (syshandler_t) sys_as_get_unmapped_area, + /* Page mapping related syscalls. */ + (syshandler_t) sys_page_find_mapping, + /* IPC related syscalls. */ (syshandler_t) sys_ipc_call_sync_fast, Index: uspace/Makefile =================================================================== --- uspace/Makefile (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -50,4 +50,7 @@ app/trace \ app/top \ + app/usbinfo \ + app/virtusbkbd \ + app/virtusbhub \ app/netecho \ app/nettest1 \ @@ -113,5 +116,15 @@ drv/ns8250 \ srv/hw/irc/apic \ - srv/hw/irc/i8259 + srv/hw/irc/i8259 \ + drv/ehci-hcd \ + drv/ohci \ + drv/uhci-hcd \ + drv/uhci-rhd \ + drv/usbflbk \ + drv/usbkbd \ + drv/usbhub \ + drv/usbmid \ + drv/usbmouse \ + drv/vhc endif @@ -123,5 +136,15 @@ drv/ns8250 \ srv/hw/irc/apic \ - srv/hw/irc/i8259 + srv/hw/irc/i8259 \ + drv/ehci-hcd \ + drv/ohci \ + drv/uhci-hcd \ + drv/uhci-rhd \ + drv/usbflbk \ + drv/usbkbd \ + drv/usbhub \ + drv/usbmid \ + drv/usbmouse \ + drv/vhc endif @@ -150,4 +173,14 @@ lib/net +ifeq ($(UARCH),amd64) + LIBS += lib/usb + LIBS += lib/usbvirt +endif + +ifeq ($(UARCH),ia32) + LIBS += lib/usb + LIBS += lib/usbvirt +endif + LIBC_BUILD = $(addsuffix .build,$(LIBC)) LIBS_BUILD = $(addsuffix .build,$(LIBS)) Index: uspace/Makefile.common =================================================================== --- uspace/Makefile.common (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/Makefile.common (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -86,4 +86,7 @@ LIBCLUI_PREFIX = $(LIB_PREFIX)/clui + +LIBUSB_PREFIX = $(LIB_PREFIX)/usb +LIBUSBVIRT_PREFIX = $(LIB_PREFIX)/usbvirt LIBDRV_PREFIX = $(LIB_PREFIX)/drv LIBPACKET_PREFIX = $(LIB_PREFIX)/packet Index: uspace/app/init/init.c =================================================================== --- uspace/app/init/init.c (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/app/init/init.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -272,7 +272,4 @@ mount_tmpfs(); -#ifdef CONFIG_START_DEVMAN - spawn("/srv/devman"); -#endif spawn("/srv/apic"); spawn("/srv/i8259"); @@ -316,5 +313,15 @@ getterm("term/vc5", "/app/bdsh", false); getterm("term/vc6", "/app/klog", false); - + +#ifdef CONFIG_START_DEVMAN + +#ifdef CONFIG_DEVMAN_EARLY_LAUNCH + spawn("/srv/devman"); +#else + getterm("term/vc7", "/srv/devman", false); +#endif + +#endif + return 0; } Index: uspace/app/klog/klog.c =================================================================== --- uspace/app/klog/klog.c (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/app/klog/klog.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -44,4 +44,5 @@ #include #include +#include #define NAME "klog" @@ -54,6 +55,12 @@ static FILE *log; +/* Serialize the output a bit. This will not avoid messed-up log completely + but chances for are pretty high (experimentally confirmed). */ +static FIBRIL_MUTEX_INITIALIZE(log_mutex); + static void interrupt_received(ipc_callid_t callid, ipc_call_t *call) { + fibril_mutex_lock(&log_mutex); + size_t klog_start = (size_t) IPC_GET_ARG1(*call); size_t klog_len = (size_t) IPC_GET_ARG2(*call); @@ -74,4 +81,6 @@ fsync(fileno(log)); } + + fibril_mutex_unlock(&log_mutex); } Index: uspace/app/tester/Makefile =================================================================== --- uspace/app/tester/Makefile (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/app/tester/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -31,6 +31,10 @@ BINARY = tester +LIBS += $(LIBUSB_PREFIX)/libusb.a +EXTRA_CFLAGS += -I$(LIBUSB_PREFIX)/include + SOURCES = \ tester.c \ + adt/usbaddrkeep.c \ thread/thread1.c \ print/print1.c \ @@ -49,4 +53,5 @@ loop/loop1.c \ mm/malloc1.c \ + mm/mapping1.c \ devs/devman1.c \ hw/misc/virtchar1.c \ Index: uspace/app/tester/adt/usbaddrkeep.c =================================================================== --- uspace/app/tester/adt/usbaddrkeep.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/tester/adt/usbaddrkeep.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,66 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#include +#include +#include +#include +#include "../tester.h" + +#define MAX_ADDRESS 5 + + +const char *test_usbaddrkeep(void) +{ + int rc; + usb_address_keeping_t addresses; + + TPRINTF("Initializing addresses keeping structure...\n"); + usb_address_keeping_init(&addresses, MAX_ADDRESS); + + TPRINTF("Requesting address...\n"); + usb_address_t addr = usb_address_keeping_request(&addresses); + TPRINTF("Address assigned: %d\n", (int) addr); + if (addr != 1) { + return "have not received expected address 1"; + } + + TPRINTF("Releasing not assigned address...\n"); + rc = usb_address_keeping_release(&addresses, 2); + if (rc != ENOENT) { + return "have not received expected ENOENT"; + } + + TPRINTF("Releasing acquired address...\n"); + rc = usb_address_keeping_release(&addresses, addr); + if (rc != EOK) { + return "have not received expected EOK"; + } + + return NULL; +} Index: uspace/app/tester/adt/usbaddrkeep.def =================================================================== --- uspace/app/tester/adt/usbaddrkeep.def (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/tester/adt/usbaddrkeep.def (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,6 @@ +{ + "usbaddrkeep", + "USB address keeping structure", + &test_usbaddrkeep, + true +}, Index: uspace/app/tester/mm/mapping1.c =================================================================== --- uspace/app/tester/mm/mapping1.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/tester/mm/mapping1.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,123 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#include +#include +#include +#include +#include +#include +#include "../tester.h" + +#define BUFFER1_PAGES 4 +#define BUFFER2_PAGES 2 + +static void *create_as_area(size_t size) +{ + void *result = as_get_mappable_page(size); + TPRINTF("Creating AS area...\n"); + if (as_area_create(result, size, + AS_AREA_READ | AS_AREA_WRITE | AS_AREA_CACHEABLE) != result) { + return NULL; + } + return result; +} + +static void touch_area(void *area, size_t size) +{ + TPRINTF("Touching (faulting-in) AS area...\n"); + + char *ptr = (char *)area; + + while (size > 0) { + *ptr = 0; + size--; + ptr++; + } +} + +#define VERIFY_MAPPING(area, page_count, expected_rc) \ + verify_mapping((area), (page_count), (expected_rc), #expected_rc) + +static bool verify_mapping(void *area, int page_count, int expected_rc, + const char *expected_rc_str) +{ + TPRINTF("Verifying mapping (expected: %s).\n", expected_rc_str); + int i; + for (i = 0; i < page_count; i++) { + void *page_start = ((char *)area) + PAGE_SIZE * i; + int rc = as_get_physical_mapping(page_start, NULL); + if (rc != expected_rc) { + TPRINTF("as_get_physical_mapping() = %d != %d\n", + rc, expected_rc); + return false; + } + } + return true; +} + +const char *test_mapping1(void) +{ + int rc; + + size_t buffer1_len = BUFFER1_PAGES * PAGE_SIZE; + size_t buffer2_len = BUFFER2_PAGES * PAGE_SIZE; + void *buffer1 = create_as_area(buffer1_len); + void *buffer2 = create_as_area(buffer2_len); + if (!buffer1 || !buffer2) { + return "Cannot allocate memory"; + } + + touch_area(buffer1, buffer1_len); + touch_area(buffer2, buffer2_len); + + /* Now verify that mapping to physical frames exist. */ + if (!VERIFY_MAPPING(buffer1, BUFFER1_PAGES, EOK)) { + return "Failed to find mapping (buffer1)"; + } + if (!VERIFY_MAPPING(buffer2, BUFFER2_PAGES, EOK)) { + return "Failed to find mapping (buffer2)"; + } + + /* Let's destroy the buffer1 area and access it again. */ + rc = as_area_destroy(buffer1); + if (rc != EOK) { + return "Failed to destroy AS area"; + } + if (!VERIFY_MAPPING(buffer1, BUFFER1_PAGES, ENOENT)) { + return "Mapping of destroyed area still exists"; + } + + /* clean-up */ + rc = as_area_destroy(buffer2); + if (rc != EOK) { + return "Failed to destroy AS area"; + } + + return NULL; +} Index: uspace/app/tester/mm/mapping1.def =================================================================== --- uspace/app/tester/mm/mapping1.def (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/tester/mm/mapping1.def (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,6 @@ +{ + "mapping1", + "Page mapping test", + &test_mapping1, + true +}, Index: uspace/app/tester/tester.c =================================================================== --- uspace/app/tester/tester.c (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/app/tester/tester.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -62,5 +62,7 @@ #include "loop/loop1.def" #include "mm/malloc1.def" +#include "mm/mapping1.def" #include "hw/serial/serial1.def" +#include "adt/usbaddrkeep.def" #include "hw/misc/virtchar1.def" #include "devs/devman1.def" Index: uspace/app/tester/tester.h =================================================================== --- uspace/app/tester/tester.h (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/app/tester/tester.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -78,5 +78,7 @@ extern const char *test_loop1(void); extern const char *test_malloc1(void); +extern const char *test_mapping1(void); extern const char *test_serial1(void); +extern const char *test_usbaddrkeep(void); extern const char *test_virtchar1(void); extern const char *test_devman1(void); Index: uspace/app/usbinfo/Makefile =================================================================== --- uspace/app/usbinfo/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/usbinfo/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,42 @@ +# +# Copyright (c) 2010 Vojtech Horky +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +BINARY = usbinfo + +LIBS = $(LIBUSB_PREFIX)/libusb.a $(LIBDRV_PREFIX)/libdrv.a +EXTRA_CFLAGS = -I$(LIBUSB_PREFIX)/include -I$(LIBDRV_PREFIX)/include + +SOURCES = \ + desctree.c \ + dev.c \ + dump.c \ + info.c \ + main.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/app/usbinfo/desctree.c =================================================================== --- uspace/app/usbinfo/desctree.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/usbinfo/desctree.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,87 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup usbinfo + * @{ + */ +/** + * @file + * Descriptor tree dump. + */ + +#include +#include +#include +#include +#include + +#include +#include +#include +#include + +#include "usbinfo.h" +#include + +static void browse_descriptor_tree_internal(usb_dp_parser_t *parser, + usb_dp_parser_data_t *data, uint8_t *root, size_t depth, + dump_descriptor_in_tree_t callback, void *arg) +{ + if (root == NULL) { + return; + } + callback(root, depth, arg); + uint8_t *child = usb_dp_get_nested_descriptor(parser, data, root); + do { + browse_descriptor_tree_internal(parser, data, child, depth + 1, + callback, arg); + child = usb_dp_get_sibling_descriptor(parser, data, + root, child); + } while (child != NULL); +} + +void browse_descriptor_tree(uint8_t *descriptors, size_t descriptors_size, + usb_dp_descriptor_nesting_t *descriptor_nesting, + dump_descriptor_in_tree_t callback, size_t initial_depth, void *arg) +{ + usb_dp_parser_data_t data = { + .data = descriptors, + .size = descriptors_size, + .arg = NULL + }; + + usb_dp_parser_t parser = { + .nesting = descriptor_nesting + }; + + browse_descriptor_tree_internal(&parser, &data, descriptors, + initial_depth, callback, arg); +} + +/** @} + */ Index: uspace/app/usbinfo/dev.c =================================================================== --- uspace/app/usbinfo/dev.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/usbinfo/dev.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,125 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup usbinfo + * @{ + */ +/** + * @file + * Representation of queried device. + */ +#include +#include +#include +#include +#include "usbinfo.h" + +usbinfo_device_t *prepare_device(devman_handle_t hc_handle, + usb_address_t dev_addr) +{ + usbinfo_device_t *dev = malloc(sizeof(usbinfo_device_t)); + if (dev == NULL) { + fprintf(stderr, NAME ": memory allocation failed.\n"); + return NULL; + } + + int rc; + + rc = usb_device_connection_initialize(&dev->wire, hc_handle, dev_addr); + if (rc != EOK) { + fprintf(stderr, + NAME ": failed to create connection to the device: %s.\n", + str_error(rc)); + goto leave; + } + + rc = usb_pipe_initialize_default_control(&dev->ctrl_pipe, + &dev->wire); + if (rc != EOK) { + fprintf(stderr, + NAME ": failed to create default control pipe: %s.\n", + str_error(rc)); + goto leave; + } + + rc = usb_pipe_probe_default_control(&dev->ctrl_pipe); + if (rc != EOK) { + fprintf(stderr, + NAME ": probing default control pipe failed: %s.\n", + str_error(rc)); + goto leave; + } + + rc = usb_pipe_start_session(&dev->ctrl_pipe); + if (rc != EOK) { + fprintf(stderr, + NAME ": failed to start session on control pipe: %s.\n", + str_error(rc)); + goto leave; + } + + rc = usb_request_get_device_descriptor(&dev->ctrl_pipe, + &dev->device_descriptor); + if (rc != EOK) { + fprintf(stderr, + NAME ": failed to retrieve device descriptor: %s.\n", + str_error(rc)); + goto leave; + } + + rc = usb_request_get_full_configuration_descriptor_alloc( + &dev->ctrl_pipe, 0, (void **)&dev->full_configuration_descriptor, + &dev->full_configuration_descriptor_size); + if (rc != EOK) { + fprintf(stderr, + NAME ": failed to retrieve configuration descriptor: %s.\n", + str_error(rc)); + goto leave; + } + + return dev; + + +leave: + if (usb_pipe_is_session_started(&dev->ctrl_pipe)) { + usb_pipe_end_session(&dev->ctrl_pipe); + } + + free(dev); + + return NULL; +} + +void destroy_device(usbinfo_device_t *dev) +{ + usb_pipe_end_session(&dev->ctrl_pipe); + free(dev); +} + +/** @} + */ Index: uspace/app/usbinfo/dump.c =================================================================== --- uspace/app/usbinfo/dump.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/usbinfo/dump.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,194 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup usbinfo + * @{ + */ +/** + * @file + * USB querying. + */ + +#include +#include +#include +#include +#include + +#include +#include +#include +#include + +#include "usbinfo.h" +#include + +#define INDENT " " +#define BYTES_PER_LINE 12 + + +const char *get_indent(size_t level) +{ + static const char *indents[] = { + INDENT, + INDENT INDENT, + INDENT INDENT INDENT, + INDENT INDENT INDENT INDENT, + INDENT INDENT INDENT INDENT INDENT + }; + static size_t indents_count = sizeof(indents)/sizeof(indents[0]); + if (level >= indents_count) { + return indents[indents_count - 1]; + } + return indents[level]; +} + +void dump_buffer(const char *msg, size_t indent, + const uint8_t *buffer, size_t length) +{ + if (msg != NULL) { + printf("%s\n", msg); + } + + size_t i; + if (length > 0) { + printf("%s", get_indent(indent)); + } + for (i = 0; i < length; i++) { + printf("0x%02X", buffer[i]); + if (((i > 0) && (((i+1) % BYTES_PER_LINE) == 0)) + || (i + 1 == length)) { + printf("\n"); + if (i + 1 < length) { + printf("%s", get_indent(indent)); + } + } else { + printf(" "); + } + } +} + +void dump_usb_descriptor(uint8_t *descriptor, size_t size) +{ + printf("Device descriptor:\n"); + usb_dump_standard_descriptor(stdout, get_indent(0), "\n", + descriptor, size); +} + +void dump_match_ids(match_id_list_t *matches, const char *line_prefix) +{ + link_t *link; + for (link = matches->ids.next; + link != &matches->ids; + link = link->next) { + match_id_t *match = list_get_instance(link, match_id_t, link); + + printf("%s%3d %s\n", line_prefix, match->score, match->id); + } +} + +static void dump_tree_descriptor(uint8_t *descriptor, size_t depth) +{ + if (descriptor == NULL) { + return; + } + int type = (int) *(descriptor + 1); + const char *name = "unknown"; + switch (type) { +#define _TYPE(descriptor_type) \ + case USB_DESCTYPE_##descriptor_type: name = #descriptor_type; break + _TYPE(DEVICE); + _TYPE(CONFIGURATION); + _TYPE(STRING); + _TYPE(INTERFACE); + _TYPE(ENDPOINT); + _TYPE(HID); + _TYPE(HID_REPORT); + _TYPE(HID_PHYSICAL); + _TYPE(HUB); +#undef _TYPE + } + printf("%s%s (0x%02X):\n", get_indent(depth), name, type); + usb_dump_standard_descriptor(stdout, get_indent(depth), "\n", + descriptor, descriptor[0]); +} + +static void dump_tree_internal(usb_dp_parser_t *parser, usb_dp_parser_data_t *data, + uint8_t *root, size_t depth) +{ + if (root == NULL) { + return; + } + dump_tree_descriptor(root, depth); + uint8_t *child = usb_dp_get_nested_descriptor(parser, data, root); + do { + dump_tree_internal(parser, data, child, depth + 1); + child = usb_dp_get_sibling_descriptor(parser, data, root, child); + } while (child != NULL); +} + +static void dump_tree(usb_dp_parser_t *parser, usb_dp_parser_data_t *data) +{ + uint8_t *ptr = data->data; + printf("Descriptor tree:\n"); + dump_tree_internal(parser, data, ptr, 0); +} + +#define NESTING(parentname, childname) \ + { \ + .child = USB_DESCTYPE_##childname, \ + .parent = USB_DESCTYPE_##parentname, \ + } +#define LAST_NESTING { -1, -1 } + +static usb_dp_descriptor_nesting_t descriptor_nesting[] = { + NESTING(CONFIGURATION, INTERFACE), + NESTING(INTERFACE, ENDPOINT), + NESTING(INTERFACE, HUB), + NESTING(INTERFACE, HID), + NESTING(HID, HID_REPORT), + LAST_NESTING +}; + +static usb_dp_parser_t parser = { + .nesting = descriptor_nesting +}; + +void dump_descriptor_tree(uint8_t *descriptors, size_t length) +{ + usb_dp_parser_data_t data = { + .data = descriptors, + .size = length, + .arg = NULL + }; + + dump_tree(&parser, &data); +} + +/** @} + */ Index: uspace/app/usbinfo/info.c =================================================================== --- uspace/app/usbinfo/info.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/usbinfo/info.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,342 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup usbinfo + * @{ + */ +/** + * @file + * Dumping of generic device properties. + */ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "usbinfo.h" + +void dump_short_device_identification(usbinfo_device_t *dev) +{ + printf("%sDevice 0x%04x by vendor 0x%04x\n", get_indent(0), + (int) dev->device_descriptor.product_id, + (int) dev->device_descriptor.vendor_id); +} + +static void dump_match_ids_from_interface(uint8_t *descriptor, size_t depth, + void *arg) +{ + if (depth != 1) { + return; + } + size_t descr_size = descriptor[0]; + if (descr_size < sizeof(usb_standard_interface_descriptor_t)) { + return; + } + int descr_type = descriptor[1]; + if (descr_type != USB_DESCTYPE_INTERFACE) { + return; + } + + usbinfo_device_t *dev = (usbinfo_device_t *) arg; + + usb_standard_interface_descriptor_t *iface + = (usb_standard_interface_descriptor_t *) descriptor; + + printf("%sInterface #%d match ids (%s, 0x%02x, 0x%02x)\n", + get_indent(0), + (int) iface->interface_number, + usb_str_class(iface->interface_class), + (int) iface->interface_subclass, + (int) iface->interface_protocol); + + match_id_list_t matches; + init_match_ids(&matches); + usb_device_create_match_ids_from_interface(&dev->device_descriptor, + iface, &matches); + dump_match_ids(&matches, get_indent(1)); + clean_match_ids(&matches); +} + +void dump_device_match_ids(usbinfo_device_t *dev) +{ + match_id_list_t matches; + init_match_ids(&matches); + usb_device_create_match_ids_from_device_descriptor( + &dev->device_descriptor, &matches); + printf("%sDevice match ids (0x%04x by 0x%04x, %s)\n", get_indent(0), + (int) dev->device_descriptor.product_id, + (int) dev->device_descriptor.vendor_id, + usb_str_class(dev->device_descriptor.device_class)); + dump_match_ids(&matches, get_indent(1)); + clean_match_ids(&matches); + + usb_dp_walk_simple(dev->full_configuration_descriptor, + dev->full_configuration_descriptor_size, + usb_dp_standard_descriptor_nesting, + dump_match_ids_from_interface, + dev); +} + +static void dump_descriptor_tree_brief_device(const char *prefix, + usb_standard_device_descriptor_t *descriptor) +{ + printf("%sDevice (0x%04x by 0x%04x, %s, %zu configurations)\n", prefix, + (int) descriptor->product_id, + (int) descriptor->vendor_id, + usb_str_class(descriptor->device_class), + (size_t) descriptor->configuration_count); +} + +static void dump_descriptor_tree_brief_configuration(const char *prefix, + usb_standard_configuration_descriptor_t *descriptor) +{ + printf("%sConfiguration #%d (%zu interfaces, total %zuB)\n", prefix, + (int) descriptor->configuration_number, + (size_t) descriptor->interface_count, + (size_t) descriptor->total_length); +} + +static void dump_descriptor_tree_brief_interface(const char *prefix, + usb_standard_interface_descriptor_t *descriptor) +{ + printf("%sInterface #%d (%s, 0x%02x, 0x%02x), alternate %d\n", prefix, + (int) descriptor->interface_number, + usb_str_class(descriptor->interface_class), + (int) descriptor->interface_subclass, + (int) descriptor->interface_protocol, + (int) descriptor->alternate_setting); +} + +static void dump_descriptor_tree_brief_endpoint(const char *prefix, + usb_standard_endpoint_descriptor_t *descriptor) +{ + usb_endpoint_t endpoint_no = descriptor->endpoint_address & 0xF; + usb_transfer_type_t transfer = descriptor->attributes & 0x3; + usb_direction_t direction = descriptor->endpoint_address & 0x80 + ? USB_DIRECTION_IN : USB_DIRECTION_OUT; + printf("%sEndpoint #%d (%s %s, %zu)\n", prefix, + endpoint_no, usb_str_transfer_type(transfer), + direction == USB_DIRECTION_IN ? "in" : "out", + (size_t) descriptor->max_packet_size); +} + +static void dump_descriptor_tree_brief_hid(const char *prefix, + usb_standard_hid_descriptor_t *descriptor) +{ + printf("%sHID (country %d, %d descriptors)\n", prefix, + (int) descriptor->country_code, + (int) descriptor->class_desc_count); +} + +static void dump_descriptor_tree_brief_hub(const char *prefix, + usb_hub_descriptor_header_t *descriptor) +{ + printf("%shub (%d ports)\n", prefix, + (int) descriptor->port_count); +} + + +static void dump_descriptor_tree_callback(uint8_t *descriptor, + size_t depth, void *arg) +{ + const char *indent = get_indent(depth + 1); + + int descr_type = -1; + size_t descr_size = descriptor[0]; + if (descr_size > 0) { + descr_type = descriptor[1]; + } + + switch (descr_type) { + +#define _BRANCH(type_enum, descriptor_type, callback) \ + case type_enum: \ + if (descr_size >= sizeof(descriptor_type)) { \ + callback(indent, (descriptor_type *) descriptor); \ + if (arg != NULL) { \ + usb_dump_standard_descriptor(stdout, \ + get_indent(depth +2), "\n", \ + descriptor, descr_size); \ + } \ + } else { \ + descr_type = -1; \ + } \ + break; + + _BRANCH(USB_DESCTYPE_DEVICE, + usb_standard_device_descriptor_t, + dump_descriptor_tree_brief_device); + _BRANCH(USB_DESCTYPE_CONFIGURATION, + usb_standard_configuration_descriptor_t, + dump_descriptor_tree_brief_configuration); + _BRANCH(USB_DESCTYPE_INTERFACE, + usb_standard_interface_descriptor_t, + dump_descriptor_tree_brief_interface); + _BRANCH(USB_DESCTYPE_ENDPOINT, + usb_standard_endpoint_descriptor_t, + dump_descriptor_tree_brief_endpoint); + _BRANCH(USB_DESCTYPE_HID, + usb_standard_hid_descriptor_t, + dump_descriptor_tree_brief_hid); + /* + * Probably useless, hub descriptor shall not be part of + * configuration descriptor. + */ + _BRANCH(USB_DESCTYPE_HUB, + usb_hub_descriptor_header_t, + dump_descriptor_tree_brief_hub); + + default: + break; + } + + if (descr_type == -1) { + printf("%sInvalid descriptor.\n", indent); + } +} + +void dump_descriptor_tree_brief(usbinfo_device_t *dev) +{ + dump_descriptor_tree_callback((uint8_t *)&dev->device_descriptor, + (size_t) -1, NULL); + usb_dp_walk_simple(dev->full_configuration_descriptor, + dev->full_configuration_descriptor_size, + usb_dp_standard_descriptor_nesting, + dump_descriptor_tree_callback, + NULL); +} + +void dump_descriptor_tree_full(usbinfo_device_t *dev) +{ + dump_descriptor_tree_callback((uint8_t *)&dev->device_descriptor, + (size_t) -1, dev); + usb_dp_walk_simple(dev->full_configuration_descriptor, + dev->full_configuration_descriptor_size, + usb_dp_standard_descriptor_nesting, + dump_descriptor_tree_callback, + dev); +} + + +void dump_strings(usbinfo_device_t *dev) +{ + /* Get supported languages. */ + l18_win_locales_t *langs; + size_t langs_count; + int rc = usb_request_get_supported_languages(&dev->ctrl_pipe, + &langs, &langs_count); + if (rc != EOK) { + fprintf(stderr, + NAME ": failed to get list of supported languages: %s.\n", + str_error(rc)); + return; + } + + printf("%sString languages (%zu):", get_indent(0), langs_count); + size_t i; + for (i = 0; i < langs_count; i++) { + printf(" 0x%04x", (int) langs[i]); + } + printf(".\n"); + + /* Get all strings and dump them. */ + for (i = 0; i < langs_count; i++) { + l18_win_locales_t lang = langs[i]; + + printf("%sStrings in %s:\n", get_indent(0), + str_l18_win_locale(lang)); + /* + * Try only the first 15 strings + * (typically, device will not have much more anyway). + */ + size_t idx; + for (idx = 1; idx < 0x0F; idx++) { + char *string; + rc = usb_request_get_string(&dev->ctrl_pipe, idx, lang, + &string); + if (rc != EOK) { + continue; + } + printf("%sString #%zu: \"%s\"\n", get_indent(1), + idx, string); + free(string); + } + } +} + + +void dump_status(usbinfo_device_t *dev) +{ + int rc; + uint16_t device_status = 0; + uint16_t ctrl_pipe_status = 0; + + /* Device status first. */ + rc = usb_request_get_status(&dev->ctrl_pipe, + USB_REQUEST_RECIPIENT_DEVICE, 0, + &device_status); + if (rc != EOK) { + printf("%sFailed to get device status: %s.\n", + get_indent(0), str_error(rc)); + goto try_ctrl_pipe_status; + } + + printf("%sDevice status 0x%04x: power=%s, remote-wakeup=%s.\n", + get_indent(0), + device_status, + device_status & USB_DEVICE_STATUS_SELF_POWERED ? "self" : "bus", + device_status & USB_DEVICE_STATUS_REMOTE_WAKEUP ? "yes" : "no"); + + /* Interface is not interesting, skipping ;-). */ + + /* Control endpoint zero. */ +try_ctrl_pipe_status: + rc = usb_request_get_status(&dev->ctrl_pipe, + USB_REQUEST_RECIPIENT_ENDPOINT, 0, + &ctrl_pipe_status); + if (rc != EOK) { + printf("%sFailed to get control endpoint status: %s.\n", + get_indent(0), str_error(rc)); + goto leave; + } + + printf("%sControl endpoint zero status %04X: halted=%s.\n", + get_indent(0), + ctrl_pipe_status, + ctrl_pipe_status & USB_ENDPOINT_STATUS_HALTED ? "yes" : "no"); + +leave: + return; +} + +/** @} + */ Index: uspace/app/usbinfo/main.c =================================================================== --- uspace/app/usbinfo/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/usbinfo/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,293 @@ +/* + * Copyright (c) 2010-2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup usbinfo + * @{ + */ +/** + * @file + * USB querying. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include "usbinfo.h" + +static bool resolve_hc_handle_and_dev_addr(const char *devpath, + devman_handle_t *out_hc_handle, usb_address_t *out_device_address) +{ + int rc; + + /* Hack for QEMU to save-up on typing ;-). */ + if (str_cmp(devpath, "qemu") == 0) { + devpath = "/hw/pci0/00:01.2/uhci-rh/usb00_a1"; + } + + char *path = str_dup(devpath); + if (path == NULL) { + return ENOMEM; + } + + devman_handle_t hc = 0; + bool hc_found = false; + usb_address_t addr = 0; + bool addr_found = false; + + /* Remove suffixes and hope that we will encounter device node. */ + while (str_length(path) > 0) { + /* Get device handle first. */ + devman_handle_t dev_handle; + rc = devman_device_get_handle(path, &dev_handle, 0); + if (rc != EOK) { + free(path); + return false; + } + + /* Try to find its host controller. */ + if (!hc_found) { + rc = usb_hc_find(dev_handle, &hc); + if (rc == EOK) { + hc_found = true; + } + } + /* Try to get its address. */ + if (!addr_found) { + addr = usb_device_get_assigned_address(dev_handle); + if (addr >= 0) { + addr_found = true; + } + } + + /* Speed-up. */ + if (hc_found && addr_found) { + break; + } + + /* Remove the last suffix. */ + char *slash_pos = str_rchr(path, '/'); + if (slash_pos != NULL) { + *slash_pos = 0; + } + } + + free(path); + + if (hc_found && addr_found) { + if (out_hc_handle != NULL) { + *out_hc_handle = hc; + } + if (out_device_address != NULL) { + *out_device_address = addr; + } + return true; + } else { + return false; + } +} + +static void print_usage(char *app_name) +{ +#define _INDENT " " +#define _OPTION(opt, description) \ + printf(_INDENT opt "\n" _INDENT _INDENT description "\n") + + printf(NAME ": query USB devices for descriptors\n\n"); + printf("Usage: %s [options] device [device [device [ ... ]]]\n", + app_name); + printf(_INDENT "The device is a devman path to the device.\n"); + + _OPTION("-h --help", "Print this help and exit."); + _OPTION("-i --identification", "Brief device identification."); + _OPTION("-m --match-ids", "Print match ids generated for the device."); + _OPTION("-t --descriptor-tree", "Print descriptor tree."); + _OPTION("-T --descriptor-tree-full", "Print detailed descriptor tree"); + _OPTION("-s --strings", "Try to print all string descriptors."); + _OPTION("-S --status", "Get status of the device."); + + printf("\n"); + printf("If no option is specified, `-i' is considered default.\n"); + printf("\n"); + +#undef _OPTION +#undef _INDENT +} + +static struct option long_options[] = { + {"help", no_argument, NULL, 'h'}, + {"identification", no_argument, NULL, 'i'}, + {"match-ids", no_argument, NULL, 'm'}, + {"descriptor-tree", no_argument, NULL, 't'}, + {"descriptor-tree-full", no_argument, NULL, 'T'}, + {"strings", no_argument, NULL, 's'}, + {"status", no_argument, NULL, 'S'}, + {0, 0, NULL, 0} +}; +static const char *short_options = "himtTsS"; + +static usbinfo_action_t actions[] = { + { + .opt = 'i', + .action = dump_short_device_identification, + .active = false + }, + { + .opt = 'm', + .action = dump_device_match_ids, + .active = false + }, + { + .opt = 't', + .action = dump_descriptor_tree_brief, + .active = false + }, + { + .opt = 'T', + .action = dump_descriptor_tree_full, + .active = false + }, + { + .opt = 's', + .action = dump_strings, + .active = false + }, + { + .opt = 'S', + .action = dump_status, + .active = false + }, + { + .opt = 0 + } +}; + +int main(int argc, char *argv[]) +{ + if (argc <= 1) { + print_usage(argv[0]); + return -1; + } + + /* + * Process command-line options. They determine what shall be + * done with the device. + */ + int opt; + do { + opt = getopt_long(argc, argv, + short_options, long_options, NULL); + switch (opt) { + case -1: + break; + case '?': + print_usage(argv[0]); + return 1; + case 'h': + print_usage(argv[0]); + return 0; + default: { + int idx = 0; + while (actions[idx].opt != 0) { + if (actions[idx].opt == opt) { + actions[idx].active = true; + break; + } + idx++; + } + break; + } + } + } while (opt > 0); + + /* Set the default action. */ + int idx = 0; + bool something_active = false; + while (actions[idx].opt != 0) { + if (actions[idx].active) { + something_active = true; + break; + } + idx++; + } + if (!something_active) { + actions[0].active = true; + } + + /* + * Go through all devices given on the command line and run the + * specified actions. + */ + int i; + for (i = optind; i < argc; i++) { + char *devpath = argv[i]; + + /* The initialization is here only to make compiler happy. */ + devman_handle_t hc_handle = 0; + usb_address_t dev_addr = 0; + bool found = resolve_hc_handle_and_dev_addr(devpath, + &hc_handle, &dev_addr); + if (!found) { + fprintf(stderr, NAME ": device `%s' not found " + "or not of USB kind, skipping.\n", + devpath); + continue; + } + + usbinfo_device_t *dev = prepare_device(hc_handle, dev_addr); + if (dev == NULL) { + continue; + } + + /* Run actions the user specified. */ + printf("%s\n", devpath); + + int action = 0; + while (actions[action].opt != 0) { + if (actions[action].active) { + actions[action].action(dev); + } + action++; + } + + /* Destroy the control pipe (close the session etc.). */ + destroy_device(dev); + } + + return 0; +} + + +/** @} + */ Index: uspace/app/usbinfo/usbinfo.h =================================================================== --- uspace/app/usbinfo/usbinfo.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/usbinfo/usbinfo.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,92 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup usbinfo + * @{ + */ +/** @file + * Common header for usbinfo application. + */ +#ifndef USBINFO_USBINFO_H_ +#define USBINFO_USBINFO_H_ + +#include +#include +#include +#include +#include +#include + +typedef struct { + usb_pipe_t ctrl_pipe; + usb_device_connection_t wire; + usb_standard_device_descriptor_t device_descriptor; + uint8_t *full_configuration_descriptor; + size_t full_configuration_descriptor_size; +} usbinfo_device_t; + +typedef struct { + int opt; + void (*action)(usbinfo_device_t *dev); + bool active; +} usbinfo_action_t; + + +#define NAME "usbinfo" + +void dump_buffer(const char *, size_t, const uint8_t *, size_t); +const char *get_indent(size_t); +void dump_match_ids(match_id_list_t *, const char *); +void dump_usb_descriptor(uint8_t *, size_t); +void dump_descriptor_tree(uint8_t *, size_t); + +static inline void internal_error(int err) +{ + fprintf(stderr, NAME ": internal error (%s).\n", str_error(err)); +} + +usbinfo_device_t *prepare_device(devman_handle_t, usb_address_t); +void destroy_device(usbinfo_device_t *); + +typedef void (*dump_descriptor_in_tree_t)(uint8_t *, size_t, void *); +void browse_descriptor_tree(uint8_t *, size_t, usb_dp_descriptor_nesting_t *, + dump_descriptor_in_tree_t, size_t, void *); + + +void dump_short_device_identification(usbinfo_device_t *); +void dump_device_match_ids(usbinfo_device_t *); +void dump_descriptor_tree_brief(usbinfo_device_t *); +void dump_descriptor_tree_full(usbinfo_device_t *); +void dump_strings(usbinfo_device_t *); +void dump_status(usbinfo_device_t *); + + +#endif +/** + * @} + */ Index: uspace/app/virtusbhub/Makefile =================================================================== --- uspace/app/virtusbhub/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/virtusbhub/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,62 @@ +# +# Copyright (c) 2011 Vojtech Horky +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +# acronym for virtual USB hub +# (it is really annoying to write long names) +BINARY = vuh + +LIBS = $(LIBUSB_PREFIX)/libusb.a $(LIBUSBVIRT_PREFIX)/libusbvirt.a +EXTRA_CFLAGS = -DSTANDALONE_HUB \ + -DHUB_PORT_COUNT=10 \ + -I$(LIBUSB_PREFIX)/include -I$(LIBUSBVIRT_PREFIX)/include -I$(LIBDRV_PREFIX)/include + +SOURCES = \ + main.c \ + $(STOLEN_VHC_SOURCES) + +STOLEN_VHC_SOURCES = \ + vhc_hub/hub.c \ + vhc_hub/virthub.c \ + vhc_hub/virthubops.c +STOLEN_VHC_HEADERS = \ + vhc_hub/hub.h \ + vhc_hub/virthub.h + +PRE_DEPEND = $(STOLEN_VHC_SOURCES) $(STOLEN_VHC_HEADERS) + +EXTRA_CLEAN = $(STOLEN_VHC_SOURCES) $(STOLEN_VHC_HEADERS) + +HUB_IN_VHC = $(USPACE_PREFIX)/drv/vhc/hub + +include $(USPACE_PREFIX)/Makefile.common + +vhc_hub/%.h: $(HUB_IN_VHC)/%.h + ln -sfn ../$(HUB_IN_VHC)/$*.h $@ +vhc_hub/%.c: $(HUB_IN_VHC)/%.c + ln -sfn ../$(HUB_IN_VHC)/$*.c $@ Index: uspace/app/virtusbhub/main.c =================================================================== --- uspace/app/virtusbhub/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/virtusbhub/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,102 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup usbvirthub + * @{ + */ +/** + * @file + * @brief Virtual USB hub. + */ + +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include + +#include "vhc_hub/virthub.h" + +#define NAME "vuh" + +static usbvirt_device_t hub_device; + +#define VERBOSE_SLEEP(sec, msg, ...) \ + do { \ + char _status[HUB_PORT_COUNT + 2]; \ + printf(NAME ": doing nothing for %zu seconds...\n", \ + (size_t) (sec)); \ + fibril_sleep((sec)); \ + virthub_get_status(&hub_device, _status, HUB_PORT_COUNT + 1); \ + printf(NAME ": " msg " [%s]\n" #__VA_ARGS__, _status); \ + } while (0) + +static void fibril_sleep(size_t sec) +{ + while (sec-- > 0) { + async_usleep(1000*1000); + } +} + +static int dev1 = 1; + +int main(int argc, char * argv[]) +{ + int rc; + + printf(NAME ": virtual USB hub.\n"); + + rc = virthub_init(&hub_device); + if (rc != EOK) { + printf(NAME ": Unable to start communication with VHCD (%s).\n", + str_error(rc)); + return rc; + } + + while (true) { + VERBOSE_SLEEP(8, "will pretend device plug-in..."); + virthub_connect_device(&hub_device, &dev1); + + VERBOSE_SLEEP(8, "will pretend device un-plug..."); + virthub_disconnect_device(&hub_device, &dev1); + } + + usbvirt_disconnect(&hub_device); + + return 0; +} + + +/** @} + */ Index: uspace/app/virtusbkbd/Makefile =================================================================== --- uspace/app/virtusbkbd/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/virtusbkbd/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,43 @@ +# +# Copyright (c) 2010 Vojtech Horky +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +# acronym for virtual usb keyboard +# (it is really annoying to write long names) +BINARY = vuk + +LIBS = $(LIBUSB_PREFIX)/libusb.a $(LIBUSBVIRT_PREFIX)/libusbvirt.a +EXTRA_CFLAGS = -I$(LIBUSB_PREFIX)/include -I$(LIBUSBVIRT_PREFIX)/include -I$(LIBDRV_PREFIX)/include + +SOURCES = \ + kbdconfig.c \ + keys.c \ + stdreq.c \ + virtusbkbd.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/app/virtusbkbd/descriptor.h =================================================================== --- uspace/app/virtusbkbd/descriptor.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/virtusbkbd/descriptor.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,51 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup usbvirtkbd + * @{ + */ +/** @file + * @brief USB keyboard descriptors. + */ +#ifndef VUK_DESCRIPTOR_H_ +#define VUK_DESCRIPTOR_H_ + +typedef struct { + uint8_t length; + uint8_t type; + uint16_t hid_spec_release; + uint8_t country_code; + uint8_t descriptor_count; + uint8_t descriptor1_type; + uint16_t descriptor1_length; +} __attribute__ ((packed)) hid_descriptor_t; + +#endif +/** + * @} + */ Index: uspace/app/virtusbkbd/items.h =================================================================== --- uspace/app/virtusbkbd/items.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/virtusbkbd/items.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,113 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup usbvirtkbd + * @{ + */ +/** @file + * @brief HID Item related functions. + */ +#ifndef VUK_ITEM_H_ +#define VUK_ITEM_H_ + +#include + +typedef uint8_t report_descriptor_data_t[]; + +/* Item types. */ +#define ITEM_MAIN 0 +#define ITEM_GLOBAL 1 +#define ITEM_LOCAL 2 + + + +/* Item tags. */ + +/* Main item tags. */ +#define TAG_INPUT 8 +#define TAG_OUTPUT 9 +#define TAG_FEATURE 11 +#define TAG_COLLECTION 10 +#define TAG_END_COLLECTION 12 + +/* Global item tags. */ +#define TAG_USAGE_PAGE 0 +#define TAG_LOGICAL_MINIMUM 1 +#define TAG_LOGICAL_MAXIMUM 2 +#define TAG_REPORT_SIZE 7 +#define TAG_REPORT_COUNT 9 + +/* Local item tags. */ +#define TAG_USAGE 0 +#define TAG_USAGE_MINIMUM 1 +#define TAG_USAGE_MAXIMUM 2 + + +/* Bits for Input, Output and Feature items. */ +#define _IOF(value, shift) ((value) << (shift)) +#define IOF_DATA _IOF(0, 0) +#define IOF_CONSTANT _IOF(1, 0) +#define IOF_ARRAY _IOF(0, 1) +#define IOF_VARIABLE _IOF(1, 1) +#define IOF_ABSOLUTE _IOF(0, 2) +#define IOF_RELATIVE _IOF(1, 2) +/* ... */ + +/* Collection types. */ +#define COLLECTION_PHYSICAL 0x00 +#define COLLECTION_APPLICATION 0x01 + + +/** Creates item prefix. + * @param size Item size. + * @param type Item type. + * @param tag Item tag. + */ +#define BUILD_ITEM_PREFIX(size, type, tag) \ + ((size) | ((type) << 2) | ((tag) << 4)) + +/** Create no-data item. + * @param type Item type. + * @param tag Item tag. + */ +#define ITEM_CREATE0(type, tag) \ + BUILD_ITEM_PREFIX(0, type, tag) + +/** Create item with 1-byte data. + * @param type Item type. + * @param tag Item tag. + * @param data Item data (single byte). + */ +#define ITEM_CREATE1(type, tag, data) \ + BUILD_ITEM_PREFIX(1, type, tag), data + + +#endif +/** + * @} + */ Index: uspace/app/virtusbkbd/kbdconfig.c =================================================================== --- uspace/app/virtusbkbd/kbdconfig.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/virtusbkbd/kbdconfig.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,155 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup usbvirtkbd + * @{ + */ +/** + * @file + * @brief Keyboard configuration. + */ +#include "kbdconfig.h" +#include "keys.h" +#include +#include +#include +#include + +/** Standard device descriptor. */ +usb_standard_device_descriptor_t std_device_descriptor = { + .length = sizeof(usb_standard_device_descriptor_t), + .descriptor_type = USB_DESCTYPE_DEVICE, + .usb_spec_version = 0x110, + .device_class = USB_CLASS_USE_INTERFACE, + .device_subclass = 0, + .device_protocol = 0, + .max_packet_size = 64, + .configuration_count = 1 +}; + +/** Standard interface descriptor. */ +usb_standard_interface_descriptor_t std_interface_descriptor = { + .length = sizeof(usb_standard_interface_descriptor_t), + .descriptor_type = USB_DESCTYPE_INTERFACE, + .interface_number = 0, + .alternate_setting = 0, + .endpoint_count = 1, + .interface_class = USB_CLASS_HID, + .interface_subclass = USB_HID_SUBCLASS_BOOT, + .interface_protocol = USB_HID_PROTOCOL_KEYBOARD, + .str_interface = 0 +}; + +/** USB keyboard report descriptor. + * Copied from USB HID 1.11 (section E.6). + */ +report_descriptor_data_t report_descriptor = { + STD_USAGE_PAGE(USB_HIDUT_PAGE_GENERIC_DESKTOP), + USAGE1(USB_HIDUT_USAGE_GENERIC_DESKTOP_KEYBOARD), + START_COLLECTION(COLLECTION_APPLICATION), + STD_USAGE_PAGE(USB_HIDUT_PAGE_KEYBOARD), + USAGE_MINIMUM1(224), + USAGE_MAXIMUM1(231), + LOGICAL_MINIMUM1(0), + LOGICAL_MAXIMUM1(1), + REPORT_SIZE1(1), + REPORT_COUNT1(8), + /* Modifiers */ + INPUT(IOF_DATA | IOF_VARIABLE | IOF_ABSOLUTE), + REPORT_COUNT1(1), + REPORT_SIZE1(8), + /* Reserved */ + INPUT(IOF_CONSTANT), + REPORT_COUNT1(5), + REPORT_SIZE1(1), + STD_USAGE_PAGE(USB_HIDUT_PAGE_LED), + USAGE_MINIMUM1(1), + USAGE_MAXIMUM1(5), + /* LED states */ + OUTPUT(IOF_DATA | IOF_VARIABLE | IOF_ABSOLUTE), + REPORT_COUNT1(1), + REPORT_SIZE1(3), + /* LED states padding */ + OUTPUT(IOF_CONSTANT), + REPORT_COUNT1(KB_MAX_KEYS_AT_ONCE), + REPORT_SIZE1(8), + LOGICAL_MINIMUM1(0), + LOGICAL_MAXIMUM1(101), + STD_USAGE_PAGE(USB_HIDUT_PAGE_KEYBOARD), + USAGE_MINIMUM1(0), + USAGE_MAXIMUM1(101), + /* Key array */ + INPUT(IOF_DATA | IOF_ARRAY), + END_COLLECTION() +}; +size_t report_descriptor_size = sizeof(report_descriptor); + +/** HID descriptor. */ +hid_descriptor_t hid_descriptor = { + .length = sizeof(hid_descriptor_t), + .type = 0x21, // HID descriptor + .hid_spec_release = 0x101, + .country_code = 0, + .descriptor_count = 1, + .descriptor1_type = 0x22, // Report descriptor + .descriptor1_length = sizeof(report_descriptor) +}; + +/** Endpoint descriptor. */ +usb_standard_endpoint_descriptor_t endpoint_descriptor = { + .length = sizeof(usb_standard_endpoint_descriptor_t), + .descriptor_type = USB_DESCTYPE_ENDPOINT, + .endpoint_address = 1 | 128, + .attributes = USB_TRANSFER_INTERRUPT, + .max_packet_size = 8, + .poll_interval = 10 +}; + +/** Standard configuration descriptor. */ +usb_standard_configuration_descriptor_t std_configuration_descriptor = { + .length = sizeof(usb_standard_configuration_descriptor_t), + .descriptor_type = USB_DESCTYPE_CONFIGURATION, + .total_length = + sizeof(usb_standard_configuration_descriptor_t) + + sizeof(std_interface_descriptor) + + sizeof(hid_descriptor) + + sizeof(endpoint_descriptor) + , + .interface_count = 1, + .configuration_number = 1, + .str_configuration = 0, + .attributes = 128, /* denotes bus-powered device */ + .max_power = 50 +}; + + + + + +/** @} + */ Index: uspace/app/virtusbkbd/kbdconfig.h =================================================================== --- uspace/app/virtusbkbd/kbdconfig.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/virtusbkbd/kbdconfig.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,60 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup usbvirtkbd + * @{ + */ +/** @file + * @brief USB keyboard configuration. + */ +#ifndef VUK_KBDCONFIG_H_ +#define VUK_KBDCONFIG_H_ + +#include +#include "report.h" +#include "descriptor.h" + +extern usb_standard_device_descriptor_t std_device_descriptor; + +extern usb_standard_configuration_descriptor_t std_configuration_descriptor; + +extern usb_standard_interface_descriptor_t std_interface_descriptor; + +extern usb_standard_endpoint_descriptor_t endpoint_descriptor; + + +extern hid_descriptor_t hid_descriptor; + +extern report_descriptor_data_t report_descriptor; +extern size_t report_descriptor_size; + + +#endif +/** + * @} + */ Index: uspace/app/virtusbkbd/keys.c =================================================================== --- uspace/app/virtusbkbd/keys.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/virtusbkbd/keys.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,123 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup usbvirtkbd + * @{ + */ +/** + * @file + * @brief Keyboard keys related structures. + */ +#include "keys.h" + +/** Initializes keyboard status. */ +void kb_init(kb_status_t *status) +{ + status->modifiers = 0; + size_t i; + for (i = 0; i < KB_MAX_KEYS_AT_ONCE; i++) { + status->pressed_keys[i] = 0; + } +} + +/** Change pressed modifiers. */ +void kb_change_modifier(kb_status_t *status, kb_key_action_t action, + kb_modifier_t modifier) +{ + if (action == KB_KEY_DOWN) { + status->modifiers = status->modifiers | modifier; + } else { + status->modifiers = status->modifiers & (~modifier); + } +} + +/** Find index of given key in key code array. + * @retval (size_t)-1 Key not found. + */ +static size_t find_key_index(kb_key_code_t *keys, size_t size, kb_key_code_t key) +{ + size_t i; + for (i = 0; i < size; i++) { + if (keys[i] == key) { + return i; + } + } + return (size_t)-1; +} + +/** Change pressed key. */ +void kb_change_key(kb_status_t *status, kb_key_action_t action, + kb_key_code_t key_code) +{ + size_t pos = find_key_index(status->pressed_keys, KB_MAX_KEYS_AT_ONCE, + key_code); + if (action == KB_KEY_DOWN) { + if (pos != (size_t)-1) { + return; + } + /* + * Find first free item in the array. + */ + size_t i; + for (i = 0; i < KB_MAX_KEYS_AT_ONCE; i++) { + if (status->pressed_keys[i] == 0) { + status->pressed_keys[i] = key_code; + return; + } + } + // TODO - handle buffer overflow + } else { + if (pos == (size_t)-1) { + return; + } + status->pressed_keys[pos] = 0; + } +} + +/** Process list of events. */ +void kb_process_events(kb_status_t *status, + kb_event_t *events, size_t count, + kb_on_status_change on_change) +{ + while (count-- > 0) { + if (events->normal_key) { + kb_change_key(status, events->action, + events->key_change); + } else { + kb_change_modifier(status, events->action, + events->modifier_change); + } + if (on_change) { + on_change(status); + } + events++; + } +} + +/** @} + */ Index: uspace/app/virtusbkbd/keys.h =================================================================== --- uspace/app/virtusbkbd/keys.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/virtusbkbd/keys.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,121 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup usbvirtkbd + * @{ + */ +/** @file + * @brief Keyboard keys related structures. + */ +#ifndef VUK_KEYS_H_ +#define VUK_KEYS_H_ + +#include +#include + +/** Maximum number of keys that can be pressed simultaneously. */ +#define KB_MAX_KEYS_AT_ONCE 6 + +/** Key code type. */ +typedef uint8_t kb_key_code_t; + +#define USB_HIDUT_KBD_KEY(name, usage_id, l, lc, l1, l2) \ + KB_KEY_##name = usage_id, +/** USB key code. */ +typedef enum { + #include +} key_code_t; + +/** Modifier type. */ +typedef uint8_t kb_modifier_t; +#define _KB_MOD(shift) (1 << (shift)) +#define KB_MOD_LEFT_CTRL _KB_MOD(0) +#define KB_MOD_LEFT_SHIFT _KB_MOD(1) +#define KB_MOD_LEFT_ALT _KB_MOD(2) +#define KB_MOD_LEFT_GUI _KB_MOD(3) +#define KB_MOD_RIGHT_CTRL _KB_MOD(4) +#define KB_MOD_RIGHT_SHIFT _KB_MOD(5) +#define KB_MOD_RIGHT_ALT _KB_MOD(6) +#define KB_MOD_RIGHT_GUI _KB_MOD(7) + +/** Base key action. */ +typedef enum { + KB_KEY_DOWN, + KB_KEY_UP +} kb_key_action_t; + +/** Keyboard status. */ +typedef struct { + /** Bitmap of pressed modifiers. */ + kb_modifier_t modifiers; + /** Array of currently pressed keys. */ + kb_key_code_t pressed_keys[KB_MAX_KEYS_AT_ONCE]; +} kb_status_t; + +/** Callback type for status change. */ +typedef void (*kb_on_status_change)(kb_status_t *); + + +void kb_init(kb_status_t *); +void kb_change_modifier(kb_status_t *, kb_key_action_t, kb_modifier_t); +void kb_change_key(kb_status_t *, kb_key_action_t, kb_key_code_t); + +/** Keyboard event. + * Use macros M_DOWN, M_UP, K_DOWN, K_UP, K_PRESS to generate list + * of them. + */ +typedef struct { + /** Key action. */ + kb_key_action_t action; + /** Switch whether action is about modifier or normal key. */ + bool normal_key; + /** Modifier change. */ + kb_modifier_t modifier_change; + /** Normal key change. */ + kb_key_code_t key_change; +} kb_event_t; + +#define M_DOWN(mod) \ + { KB_KEY_DOWN, false, (mod), 0 } +#define M_UP(mod) \ + { KB_KEY_UP, false, (mod), 0 } +#define K_DOWN(key) \ + { KB_KEY_DOWN, true, 0, (key) } +#define K_UP(key) \ + { KB_KEY_UP, true, 0, (key) } +#define K_PRESS(key) \ + K_DOWN(key), K_UP(key) + + +void kb_process_events(kb_status_t *, kb_event_t *, size_t, kb_on_status_change); + + +#endif +/** + * @} + */ Index: uspace/app/virtusbkbd/report.h =================================================================== --- uspace/app/virtusbkbd/report.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/virtusbkbd/report.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,85 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup usbvirtkbd + * @{ + */ +/** @file + * @brief HID Report Descriptor. + */ +#ifndef VUK_REPORT_H_ +#define VUK_REPORT_H_ + +#include "items.h" + +/** Use standard Usage Page. */ +#define STD_USAGE_PAGE(page) \ + ITEM_CREATE1(ITEM_GLOBAL, TAG_USAGE_PAGE, page) + +/** Usage with one byte usage ID. */ +#define USAGE1(usage_id) \ + ITEM_CREATE1(ITEM_LOCAL, TAG_USAGE, usage_id) + +/** Start a collection. */ +#define START_COLLECTION(collection) \ + ITEM_CREATE1(ITEM_MAIN, TAG_COLLECTION, collection) + +/** End a collection. */ +#define END_COLLECTION() \ + ITEM_CREATE0(ITEM_MAIN, TAG_END_COLLECTION) + + +#define USAGE_MINIMUM1(value) \ + ITEM_CREATE1(ITEM_LOCAL, TAG_USAGE_MINIMUM, value) + +#define USAGE_MAXIMUM1(value) \ + ITEM_CREATE1(ITEM_LOCAL, TAG_USAGE_MAXIMUM, value) + +#define LOGICAL_MINIMUM1(value) \ + ITEM_CREATE1(ITEM_GLOBAL, TAG_LOGICAL_MINIMUM, value) + +#define LOGICAL_MAXIMUM1(value) \ + ITEM_CREATE1(ITEM_GLOBAL, TAG_LOGICAL_MAXIMUM, value) + +#define REPORT_SIZE1(size) \ + ITEM_CREATE1(ITEM_GLOBAL, TAG_REPORT_SIZE, size) + +#define REPORT_COUNT1(count) \ + ITEM_CREATE1(ITEM_GLOBAL, TAG_REPORT_COUNT, count) + +#define INPUT(modifiers) \ + ITEM_CREATE1(ITEM_MAIN, TAG_INPUT, modifiers) + +#define OUTPUT(modifiers) \ + ITEM_CREATE1(ITEM_MAIN, TAG_OUTPUT, modifiers) + + +#endif +/** + * @} + */ Index: uspace/app/virtusbkbd/stdreq.c =================================================================== --- uspace/app/virtusbkbd/stdreq.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/virtusbkbd/stdreq.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,62 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup usbvirtkbd + * @{ + */ +/** + * @file + * @brief Keyboard configuration. + */ +#include +#include +#include "stdreq.h" +#include "kbdconfig.h" + +int stdreq_on_get_descriptor(struct usbvirt_device *dev, + usb_device_request_setup_packet_t *request, uint8_t *data) +{ + if (request->value_high == USB_DESCTYPE_HID_REPORT) { + /* + * For simplicity, always return the same + * report descriptor. + */ + int rc = dev->control_transfer_reply(dev, 0, + report_descriptor, report_descriptor_size); + + return rc; + } + + /* Let the framework handle all the rest. */ + return EFORWARD; +} + + + +/** @} + */ Index: uspace/app/virtusbkbd/stdreq.h =================================================================== --- uspace/app/virtusbkbd/stdreq.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/virtusbkbd/stdreq.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,46 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup usbvirtkbd + * @{ + */ +/** @file + * @brief Standard device request handlers. + */ +#ifndef VUK_STDREQ_H_ +#define VUK_STDREQ_H_ + +#include + +int stdreq_on_get_descriptor(usbvirt_device_t *, + usb_device_request_setup_packet_t *, uint8_t *); + +#endif +/** + * @} + */ Index: uspace/app/virtusbkbd/virtusbkbd.c =================================================================== --- uspace/app/virtusbkbd/virtusbkbd.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/app/virtusbkbd/virtusbkbd.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,287 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup usbvirtkbd + * @{ + */ +/** + * @file + * @brief Virtual USB keyboard. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include + +#include "kbdconfig.h" +#include "keys.h" +#include "stdreq.h" + +/** Pause between individual key-presses in seconds. */ +#define KEY_PRESS_DELAY 2 +#define NAME "virt-usb-kbd" + + +#define __QUOTEME(x) #x +#define _QUOTEME(x) __QUOTEME(x) + +#define VERBOSE_EXEC(cmd, fmt, ...) \ + (printf("%s: %s" fmt "\n", NAME, _QUOTEME(cmd), __VA_ARGS__), cmd(__VA_ARGS__)) + +kb_status_t status; + +static int on_incoming_data(struct usbvirt_device *dev, + usb_endpoint_t endpoint, void *buffer, size_t size) +{ + printf("%s: ignoring incomming data to endpoint %d\n", NAME, endpoint); + + return EOK; +} + + +/** Compares current and last status of pressed keys. + * + * @warning Has side-efect - changes status_last field. + * + * @param status_now Status now. + * @param status_last Last status. + * @param len Size of status. + * @return Whether they are the same. + */ +static bool keypress_check_with_last_request(uint8_t *status_now, + uint8_t *status_last, size_t len) +{ + bool same = true; + size_t i; + for (i = 0; i < len; i++) { + if (status_now[i] != status_last[i]) { + status_last[i] = status_now[i]; + same = false; + } + } + return same; +} + +static int on_request_for_data(struct usbvirt_device *dev, + usb_endpoint_t endpoint, void *buffer, size_t size, size_t *actual_size) +{ + static uint8_t last_data[2 + KB_MAX_KEYS_AT_ONCE]; + + if (size < 2 + KB_MAX_KEYS_AT_ONCE) { + return EINVAL; + } + + *actual_size = 2 + KB_MAX_KEYS_AT_ONCE; + + uint8_t data[2 + KB_MAX_KEYS_AT_ONCE]; + data[0] = status.modifiers; + data[1] = 0; + + size_t i; + for (i = 0; i < KB_MAX_KEYS_AT_ONCE; i++) { + data[2 + i] = status.pressed_keys[i]; + } + + if (keypress_check_with_last_request(data, last_data, + 2 + KB_MAX_KEYS_AT_ONCE)) { + *actual_size = 0; + return EOK; + } + + memcpy(buffer, &data, *actual_size); + + return EOK; +} + +static usbvirt_control_transfer_handler_t endpoint_zero_handlers[] = { + { + .request_type = USBVIRT_MAKE_CONTROL_REQUEST_TYPE( + USB_DIRECTION_IN, + USBVIRT_REQUEST_TYPE_STANDARD, + USBVIRT_REQUEST_RECIPIENT_DEVICE), + .request = USB_DEVREQ_GET_DESCRIPTOR, + .name = "GetDescriptor", + .callback = stdreq_on_get_descriptor + }, + { + .request_type = USBVIRT_MAKE_CONTROL_REQUEST_TYPE( + USB_DIRECTION_IN, + USBVIRT_REQUEST_TYPE_CLASS, + USBVIRT_REQUEST_RECIPIENT_DEVICE), + .request = USB_DEVREQ_GET_DESCRIPTOR, + .name = "GetDescriptor", + .callback = stdreq_on_get_descriptor + }, + USBVIRT_CONTROL_TRANSFER_HANDLER_LAST +}; + +/** Keyboard callbacks. + * We abuse the fact that static variables are zero-filled. + */ +static usbvirt_device_ops_t keyboard_ops = { + .control_transfer_handlers = endpoint_zero_handlers, + .on_data = on_incoming_data, + .on_data_request = on_request_for_data +}; + +usbvirt_device_configuration_extras_t extra_descriptors[] = { + { + .data = (uint8_t *) &std_interface_descriptor, + .length = sizeof(std_interface_descriptor) + }, + { + .data = (uint8_t *) &hid_descriptor, + .length = sizeof(hid_descriptor) + }, + { + .data = (uint8_t *) &endpoint_descriptor, + .length = sizeof(endpoint_descriptor) + } +}; + +/** Keyboard configuration. */ +usbvirt_device_configuration_t configuration = { + .descriptor = &std_configuration_descriptor, + .extra = extra_descriptors, + .extra_count = sizeof(extra_descriptors)/sizeof(extra_descriptors[0]) +}; + +/** Keyboard standard descriptors. */ +usbvirt_descriptors_t descriptors = { + .device = &std_device_descriptor, + .configuration = &configuration, + .configuration_count = 1, +}; + +/** Keyboard device. + * Rest of the items will be initialized later. + */ +static usbvirt_device_t keyboard_dev = { + .ops = &keyboard_ops, + .descriptors = &descriptors, + .lib_debug_level = 3, + .lib_debug_enabled_tags = USBVIRT_DEBUGTAG_ALL, + .name = "keyboard" +}; + + +static void fibril_sleep(size_t sec) +{ + while (sec-- > 0) { + async_usleep(1000*1000); + } +} + + +/** Callback when keyboard status changed. + * + * @param status Current keyboard status. + */ +static void on_keyboard_change(kb_status_t *status) +{ + printf("%s: Current keyboard status: %02hhx", NAME, status->modifiers); + size_t i; + for (i = 0; i < KB_MAX_KEYS_AT_ONCE; i++) { + printf(" 0x%02X", (int)status->pressed_keys[i]); + } + printf("\n"); + + fibril_sleep(KEY_PRESS_DELAY); +} + +/** Simulated keyboard events. */ +static kb_event_t keyboard_events[] = { + /* Switch to VT6 (Alt+F6) */ + M_DOWN(KB_MOD_LEFT_ALT), + K_PRESS(KB_KEY_F6), + M_UP(KB_MOD_LEFT_ALT), + /* Type the word 'Hello' */ + M_DOWN(KB_MOD_LEFT_SHIFT), + K_PRESS(KB_KEY_H), + M_UP(KB_MOD_LEFT_SHIFT), + K_PRESS(KB_KEY_E), + K_PRESS(KB_KEY_L), + K_PRESS(KB_KEY_L), + K_PRESS(KB_KEY_O) +}; +static size_t keyboard_events_count = + sizeof(keyboard_events)/sizeof(keyboard_events[0]); + + + +int main(int argc, char * argv[]) +{ + printf("Dump of report descriptor (%zu bytes):\n", report_descriptor_size); + size_t i; + for (i = 0; i < report_descriptor_size; i++) { + printf(" 0x%02X", report_descriptor[i]); + if (((i > 0) && (((i+1) % 10) == 0)) + || (i + 1 == report_descriptor_size)) { + printf("\n"); + } + } + + kb_init(&status); + + + int rc = usbvirt_connect(&keyboard_dev); + if (rc != EOK) { + printf("%s: Unable to start communication with VHCD (%s).\n", + NAME, str_error(rc)); + return rc; + } + + printf("%s: Simulating keyboard events...\n", NAME); + fibril_sleep(10); + //while (1) { + kb_process_events(&status, keyboard_events, keyboard_events_count, + on_keyboard_change); + //} + + printf("%s: Terminating...\n", NAME); + + usbvirt_disconnect(&keyboard_dev); + + return 0; +} + + +/** @} + */ Index: uspace/doc/doxygroups.h =================================================================== --- uspace/doc/doxygroups.h (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/doc/doxygroups.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -150,5 +150,5 @@ * @endcond */ - + /** * @defgroup emul Emulation Libraries @@ -165,2 +165,122 @@ * @ingroup emul */ + +/** + * @defgroup usb USB + * @ingroup uspace + * @brief USB support for HelenOS. + */ + /** + * @defgroup libusb USB library + * @ingroup usb + * @brief Library for creating USB devices drivers. + */ + + /** + * @defgroup usbvirt USB virtualization + * @ingroup usb + * @brief Support for virtual USB devices. + */ + + /** + * @defgroup libusbvirt USB virtualization library + * @ingroup usbvirt + * @brief Library for creating virtual USB devices. + */ + + /** + * @defgroup drvusbvhc Virtual USB host controller + * @ingroup usbvirt + * @brief Driver simulating work of USB host controller. + */ + + /** + * @defgroup usbvirthub Virtual USB hub + * @ingroup usbvirt + * @brief Extra virtual USB hub for virtual host controller. + * @details + * Some of the sources are shared with virtual host controller, + * see @ref drvusbvhc for the rest of the files. + */ + + /** + * @defgroup usbvirtkbd Virtual USB keybaord + * @ingroup usbvirt + * @brief Virtual USB keyboard for virtual host controller. + */ + + /** + * @defgroup usbinfo USB info application + * @ingroup usb + * @brief Application for querying USB devices. + * @details + * The intended usage of this application is to query new USB devices + * for their descriptors etc. to simplify driver writing. + */ + + /** + * @defgroup drvusbmid USB multi interface device driver + * @ingroup usb + * @brief USB multi interface device driver + * @details + * This driver serves as a mini hub (or bus) driver for devices + * that have the class defined at interface level (those devices + * usually have several interfaces). + * + * The term multi interface device driver (MID) was borrowed + * Solaris operating system. + */ + + /** + * @defgroup drvusbhub USB hub driver + * @ingroup usb + * @brief USB hub driver. + */ + + /** + * @defgroup drvusbhid USB HID driver + * @ingroup usb + * @brief USB driver for HID devices. + */ + + /** + * @defgroup drvusbmouse USB mouse driver + * @ingroup usb + * @brief USB driver for mouse with boot protocol. + */ + + /** + * @defgroup drvusbuhci UHCI driver + * @ingroup usb + * @brief Drivers for USB UHCI host controller and root hub. + */ + + /** + * @defgroup drvusbuhcirh UHCI root hub driver + * @ingroup drvusbuhci + * @brief Driver for UHCI complaint root hub. + */ + + /** + * @defgroup drvusbuhcihc UHCI host controller driver + * @ingroup drvusbuhci + * @brief Driver for UHCI complaint USB host controller. + */ + + /** + * @defgroup drvusbehci EHCI driver + * @ingroup usb + * @brief Driver for EHCI host controller. + */ + + /** + * @defgroup drvusbfallback USB fallback driver. + * @ingroup usb + * @brief Fallback driver for any USB device. + * @details + * The purpose of this driver is to simplify querying of unknown + * devices from within HelenOS (without a driver, no node at all + * may appear under /dev/devices). + */ + + Index: uspace/drv/ehci-hcd/Makefile =================================================================== --- uspace/drv/ehci-hcd/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ehci-hcd/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,39 @@ +# +# Copyright (c) 2011 Jan Vesely +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBS = $(LIBDRV_PREFIX)/libdrv.a $(LIBUSB_PREFIX)/libusb.a +EXTRA_CFLAGS += -I$(LIBDRV_PREFIX)/include -I$(LIBUSB_PREFIX)/include -I. +BINARY = ehci-hcd + +SOURCES = \ + hc_iface.c \ + main.c \ + pci.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/ehci-hcd/ehci-hcd.ma =================================================================== --- uspace/drv/ehci-hcd/ehci-hcd.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ehci-hcd/ehci-hcd.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,38 @@ +10 pci/ven=1002&dev=4345 +10 pci/ven=1002&dev=4386 +10 pci/ven=1002&dev=4396 +10 pci/ven=1022&dev=7463 +10 pci/ven=1022&dev=7808 +10 pci/ven=102f&dev=01b5 +10 pci/ven=10cf&dev=1415 +10 pci/ven=10de&dev=00e8 +10 pci/ven=10de&dev=055f +10 pci/ven=10de&dev=056a +10 pci/ven=10de&dev=077c +10 pci/ven=10de&dev=077e +10 pci/ven=10de&dev=0aa6 +10 pci/ven=10de&dev=0aa9 +10 pci/ven=10de&dev=0aaa +10 pci/ven=10de&dev=0d9d +10 pci/ven=1166&dev=0414 +10 pci/ven=1166&dev=0416 +10 pci/ven=1414&dev=5805 +10 pci/ven=1414&dev=5807 +10 pci/ven=15ad&dev=0770 +10 pci/ven=17a0&dev=8084 +10 pci/ven=8086&dev=24cd +10 pci/ven=8086&dev=24dd +10 pci/ven=8086&dev=265c +10 pci/ven=8086&dev=268c +10 pci/ven=8086&dev=27cc +10 pci/ven=8086&dev=2836 +10 pci/ven=8086&dev=283a +10 pci/ven=8086&dev=293a +10 pci/ven=8086&dev=293c +10 pci/ven=8086&dev=3a3a +10 pci/ven=8086&dev=3a3c +10 pci/ven=8086&dev=3a6a +10 pci/ven=8086&dev=3a6c +10 pci/ven=8086&dev=8117 +10 pci/ven=8086&dev=8807 +10 pci/ven=8086&dev=880f Index: uspace/drv/ehci-hcd/ehci.h =================================================================== --- uspace/drv/ehci-hcd/ehci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ehci-hcd/ehci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,48 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbehci + * @{ + */ +/** @file + * Common EHCI definitions. + */ +#ifndef DRV_EHCI_EHCI_H +#define DRV_EHCI_EHCI_H + +#include + +#define NAME "ehci-hcd" + +extern usbhc_iface_t ehci_hc_iface; + +#endif +/** + * @} + */ + Index: uspace/drv/ehci-hcd/hc_iface.c =================================================================== --- uspace/drv/ehci-hcd/hc_iface.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ehci-hcd/hc_iface.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,347 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbehci + * @{ + */ +/** @file + * USB-HC interface implementation. + */ +#include +#include +#include +#include +#include + +#include +#include +#include + +#include "ehci.h" + +#define UNSUPPORTED(methodname) \ + usb_log_warning("Unsupported interface method `%s()' in %s:%d.\n", \ + methodname, __FILE__, __LINE__) + +/** Reserve default address. + * + * This function may block the caller. + * + * @param[in] fun Device function the action was invoked on. + * @param[in] speed Speed of the device for which the default address is + * reserved. + * @return Error code. + */ +static int reserve_default_address(ddf_fun_t *fun, usb_speed_t speed) +{ + UNSUPPORTED("reserve_default_address"); + + return ENOTSUP; +} + +/** Release default address. + * + * @param[in] fun Device function the action was invoked on. + * @return Error code. + */ +static int release_default_address(ddf_fun_t *fun) +{ + UNSUPPORTED("release_default_address"); + + return ENOTSUP; +} + +/** Found free USB address. + * + * @param[in] fun Device function the action was invoked on. + * @param[in] speed Speed of the device that will get this address. + * @param[out] address Non-null pointer where to store the free address. + * @return Error code. + */ +static int request_address(ddf_fun_t *fun, usb_speed_t speed, + usb_address_t *address) +{ + UNSUPPORTED("request_address"); + + return ENOTSUP; +} + +/** Bind USB address with device devman handle. + * + * @param[in] fun Device function the action was invoked on. + * @param[in] address USB address of the device. + * @param[in] handle Devman handle of the device. + * @return Error code. + */ +static int bind_address(ddf_fun_t *fun, + usb_address_t address, devman_handle_t handle) +{ + UNSUPPORTED("bind_address"); + + return ENOTSUP; +} + +/** Release previously requested address. + * + * @param[in] fun Device function the action was invoked on. + * @param[in] address USB address to be released. + * @return Error code. + */ +static int release_address(ddf_fun_t *fun, usb_address_t address) +{ + UNSUPPORTED("release_address"); + + return ENOTSUP; +} + +/** Register endpoint for bandwidth reservation. + * + * @param[in] fun Device function the action was invoked on. + * @param[in] address USB address of the device. + * @param[in] endpoint Endpoint number. + * @param[in] transfer_type USB transfer type. + * @param[in] direction Endpoint data direction. + * @param[in] max_packet_size Max packet size of the endpoint. + * @param[in] interval Polling interval. + * @return Error code. + */ +static int register_endpoint(ddf_fun_t *fun, + usb_address_t address, usb_endpoint_t endpoint, + usb_transfer_type_t transfer_type, usb_direction_t direction, + size_t max_packet_size, unsigned int interval) +{ + UNSUPPORTED("register_endpoint"); + + return ENOTSUP; +} + +/** Unregister endpoint (free some bandwidth reservation). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] address USB address of the device. + * @param[in] endpoint Endpoint number. + * @param[in] direction Endpoint data direction. + * @return Error code. + */ +static int unregister_endpoint(ddf_fun_t *fun, usb_address_t address, + usb_endpoint_t endpoint, usb_direction_t direction) +{ + UNSUPPORTED("unregister_endpoint"); + + return ENOTSUP; +} + +/** Schedule interrupt out transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] data Data to be sent (in USB endianess, allocated and deallocated + * by the caller). + * @param[in] size Size of the @p data buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int interrupt_out(ddf_fun_t *fun, usb_target_t target, + size_t max_packet_size, void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + UNSUPPORTED("interrupt_out"); + + return ENOTSUP; +} + +/** Schedule interrupt in transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] data Buffer where to store the data (in USB endianess, + * allocated and deallocated by the caller). + * @param[in] size Size of the @p data buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int interrupt_in(ddf_fun_t *fun, usb_target_t target, + size_t max_packet_size, void *data, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + UNSUPPORTED("interrupt_in"); + + return ENOTSUP; +} + +/** Schedule bulk out transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] data Data to be sent (in USB endianess, allocated and deallocated + * by the caller). + * @param[in] size Size of the @p data buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int bulk_out(ddf_fun_t *fun, usb_target_t target, + size_t max_packet_size, void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + UNSUPPORTED("bulk_out"); + + return ENOTSUP; +} + +/** Schedule bulk in transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] data Buffer where to store the data (in USB endianess, + * allocated and deallocated by the caller). + * @param[in] size Size of the @p data buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int bulk_in(ddf_fun_t *fun, usb_target_t target, + size_t max_packet_size, void *data, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + UNSUPPORTED("bulk_in"); + + return ENOTSUP; +} + +/** Schedule control write transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] setup_packet Setup packet buffer (in USB endianess, allocated + * and deallocated by the caller). + * @param[in] setup_packet_size Size of @p setup_packet buffer in bytes. + * @param[in] data_buffer Data buffer (in USB endianess, allocated and + * deallocated by the caller). + * @param[in] data_buffer_size Size of @p data_buffer buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int control_write(ddf_fun_t *fun, usb_target_t target, + size_t max_packet_size, + void *setup_packet, size_t setup_packet_size, + void *data_buffer, size_t data_buffer_size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + UNSUPPORTED("control_write"); + + return ENOTSUP; +} + +/** Schedule control read transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] setup_packet Setup packet buffer (in USB endianess, allocated + * and deallocated by the caller). + * @param[in] setup_packet_size Size of @p setup_packet buffer in bytes. + * @param[in] data_buffer Buffer where to store the data (in USB endianess, + * allocated and deallocated by the caller). + * @param[in] data_buffer_size Size of @p data_buffer buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int control_read(ddf_fun_t *fun, usb_target_t target, + size_t max_packet_size, + void *setup_packet, size_t setup_packet_size, + void *data_buffer, size_t data_buffer_size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + UNSUPPORTED("control_read"); + + return ENOTSUP; +} + +/** Host controller interface implementation for EHCI. */ +usbhc_iface_t ehci_hc_iface = { + .reserve_default_address = reserve_default_address, + .release_default_address = release_default_address, + .request_address = request_address, + .bind_address = bind_address, + .release_address = release_address, + + .register_endpoint = register_endpoint, + .unregister_endpoint = unregister_endpoint, + + .interrupt_out = interrupt_out, + .interrupt_in = interrupt_in, + + .bulk_out = bulk_out, + .bulk_in = bulk_in, + + .control_write = control_write, + .control_read = control_read +}; + +/** + * @} + */ Index: uspace/drv/ehci-hcd/main.c =================================================================== --- uspace/drv/ehci-hcd/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ehci-hcd/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,126 @@ +/* + * Copyright (c) 2011 Jan Vesely + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbehci + * @{ + */ +/** @file + * Main routines of EHCI driver. + */ +#include +#include +#include +#include +#include + +#include +#include +#include + +#include "pci.h" +#include "ehci.h" + +static int ehci_add_device(ddf_dev_t *device); +/*----------------------------------------------------------------------------*/ +static driver_ops_t ehci_driver_ops = { + .add_device = ehci_add_device, +}; +/*----------------------------------------------------------------------------*/ +static driver_t ehci_driver = { + .name = NAME, + .driver_ops = &ehci_driver_ops +}; +static ddf_dev_ops_t hc_ops = { + .interfaces[USBHC_DEV_IFACE] = &ehci_hc_iface, +}; + +/*----------------------------------------------------------------------------*/ +/** Initializes a new ddf driver instance of EHCI hcd. + * + * @param[in] device DDF instance of the device to initialize. + * @return Error code. + */ +static int ehci_add_device(ddf_dev_t *device) +{ + assert(device); +#define CHECK_RET_RETURN(ret, message...) \ +if (ret != EOK) { \ + usb_log_error(message); \ + return ret; \ +} + + uintptr_t mem_reg_base = 0; + size_t mem_reg_size = 0; + int irq = 0; + + int ret = + pci_get_my_registers(device, &mem_reg_base, &mem_reg_size, &irq); + CHECK_RET_RETURN(ret, + "Failed(%d) to get memory addresses:.\n", ret, device->handle); + usb_log_info("Memory mapped regs at 0x%X (size %zu), IRQ %d.\n", + mem_reg_base, mem_reg_size, irq); + + ret = pci_disable_legacy(device); + CHECK_RET_RETURN(ret, + "Failed(%d) disable legacy USB: %s.\n", ret, str_error(ret)); + + ddf_fun_t *hc_fun = ddf_fun_create(device, fun_exposed, "ehci-hc"); + if (hc_fun == NULL) { + usb_log_error("Failed to create EHCI function.\n"); + return ENOMEM; + } + hc_fun->ops = &hc_ops; + ret = ddf_fun_bind(hc_fun); + + CHECK_RET_RETURN(ret, + "Failed to bind EHCI function: %s.\n", + str_error(ret)); + + usb_log_info("Controlling new EHCI device `%s' (handle %llu).\n", + device->name, device->handle); + + return EOK; +#undef CHECK_RET_RETURN +} +/*----------------------------------------------------------------------------*/ +/** Initializes global driver structures (NONE). + * + * @param[in] argc Nmber of arguments in argv vector (ignored). + * @param[in] argv Cmdline argument vector (ignored). + * @return Error code. + * + * Driver debug level is set here. + */ +int main(int argc, char *argv[]) +{ + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + return ddf_driver_main(&ehci_driver); +} +/** + * @} + */ Index: uspace/drv/ehci-hcd/pci.c =================================================================== --- uspace/drv/ehci-hcd/pci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ehci-hcd/pci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,315 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** + * @addtogroup drvusbehci + * @{ + */ +/** + * @file + * PCI related functions needed by the EHCI driver. + */ +#include +#include +#include +#include +#include +#include +#include + +#include +#include + +#include "pci.h" + +#define PAGE_SIZE_MASK 0xfffff000 + +#define HCC_PARAMS_OFFSET 0x8 +#define HCC_PARAMS_EECP_MASK 0xff +#define HCC_PARAMS_EECP_OFFSET 8 + +#define CMD_OFFSET 0x0 +#define CONFIGFLAG_OFFSET 0x40 + +#define USBCMD_RUN 1 + +#define USBLEGSUP_OFFSET 0 +#define USBLEGSUP_BIOS_CONTROL (1 << 16) +#define USBLEGSUP_OS_CONTROL (1 << 24) +#define USBLEGCTLSTS_OFFSET 4 + +#define DEFAULT_WAIT 10000 +#define WAIT_STEP 10 + +/** Get address of registers and IRQ for given device. + * + * @param[in] dev Device asking for the addresses. + * @param[out] mem_reg_address Base address of the memory range. + * @param[out] mem_reg_size Size of the memory range. + * @param[out] irq_no IRQ assigned to the device. + * @return Error code. + */ +int pci_get_my_registers(ddf_dev_t *dev, + uintptr_t *mem_reg_address, size_t *mem_reg_size, int *irq_no) +{ + assert(dev != NULL); + + int parent_phone = devman_parent_device_connect(dev->handle, + IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + + int rc; + + hw_resource_list_t hw_resources; + rc = hw_res_get_resource_list(parent_phone, &hw_resources); + if (rc != EOK) { + async_hangup(parent_phone); + return rc; + } + + uintptr_t mem_address = 0; + size_t mem_size = 0; + bool mem_found = false; + + int irq = 0; + bool irq_found = false; + + size_t i; + for (i = 0; i < hw_resources.count; i++) { + hw_resource_t *res = &hw_resources.resources[i]; + switch (res->type) + { + case INTERRUPT: + irq = res->res.interrupt.irq; + irq_found = true; + usb_log_debug2("Found interrupt: %d.\n", irq); + break; + + case MEM_RANGE: + if (res->res.mem_range.address != 0 + && res->res.mem_range.size != 0 ) { + mem_address = res->res.mem_range.address; + mem_size = res->res.mem_range.size; + usb_log_debug2("Found mem: %llx %zu.\n", + mem_address, mem_size); + mem_found = true; + } + default: + break; + } + } + + if (mem_found && irq_found) { + *mem_reg_address = mem_address; + *mem_reg_size = mem_size; + *irq_no = irq; + rc = EOK; + } else { + rc = ENOENT; + } + + async_hangup(parent_phone); + return rc; +} +/*----------------------------------------------------------------------------*/ +/** Calls the PCI driver with a request to enable interrupts + * + * @param[in] device Device asking for interrupts + * @return Error code. + */ +int pci_enable_interrupts(ddf_dev_t *device) +{ + int parent_phone = + devman_parent_device_connect(device->handle, IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + bool enabled = hw_res_enable_interrupt(parent_phone); + async_hangup(parent_phone); + return enabled ? EOK : EIO; +} +/*----------------------------------------------------------------------------*/ +/** Implements BIOS handoff routine as decribed in EHCI spec + * + * @param[in] device Device asking for interrupts + * @return Error code. + */ +int pci_disable_legacy(ddf_dev_t *device) +{ + assert(device); + int parent_phone = devman_parent_device_connect(device->handle, + IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + +#define CHECK_RET_HANGUP_RETURN(ret, message...) \ + if (ret != EOK) { \ + usb_log_error(message); \ + async_hangup(parent_phone); \ + return ret; \ + } else (void)0 + + + /* read register space BASE BAR */ + sysarg_t address = 0x10; + sysarg_t value; + + int ret = async_req_2_1(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), + IPC_M_CONFIG_SPACE_READ_32, address, &value); + CHECK_RET_HANGUP_RETURN(ret, "Failed(%d) to read PCI config space.\n", + ret); + usb_log_info("Register space BAR at %p:%x.\n", address, value); + + /* clear lower byte, it's not part of the BASE address */ + uintptr_t registers = (value & 0xffffff00); + usb_log_info("Memory registers BASE address:%p.\n", registers); + + /* if nothing setup the hc, we don't need to turn it off */ + if (registers == 0) + return ENOTSUP; + + /* map EHCI registers */ + void *regs = as_get_mappable_page(4096); + ret = physmem_map((void*)(registers & PAGE_SIZE_MASK), regs, 1, + AS_AREA_READ | AS_AREA_WRITE); + CHECK_RET_HANGUP_RETURN(ret, "Failed(%d) to map registers %p:%p.\n", + ret, regs, registers); + + /* calculate value of BASE */ + registers = (registers & 0xf00) | (uintptr_t)regs; + + const uint32_t hcc_params = + *(uint32_t*)(registers + HCC_PARAMS_OFFSET); + usb_log_debug("Value of hcc params register: %x.\n", hcc_params); + + /* Read value of EHCI Extended Capabilities Pointer + * (points to PCI config space) */ + uint32_t eecp = + (hcc_params >> HCC_PARAMS_EECP_OFFSET) & HCC_PARAMS_EECP_MASK; + usb_log_debug("Value of EECP: %x.\n", eecp); + + /* Read the second EEC. i.e. Legacy Support and Control register */ + /* TODO: Check capability type here */ + ret = async_req_2_1(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), + IPC_M_CONFIG_SPACE_READ_32, eecp + USBLEGCTLSTS_OFFSET, &value); + CHECK_RET_HANGUP_RETURN(ret, "Failed(%d) to read USBLEGCTLSTS.\n", ret); + usb_log_debug("USBLEGCTLSTS: %x.\n", value); + + /* Read the first EEC. i.e. Legacy Support register */ + /* TODO: Check capability type here */ + ret = async_req_2_1(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), + IPC_M_CONFIG_SPACE_READ_32, eecp + USBLEGSUP_OFFSET, &value); + CHECK_RET_HANGUP_RETURN(ret, "Failed(%d) to read USBLEGSUP.\n", ret); + usb_log_debug2("USBLEGSUP: %x.\n", value); + + /* Request control from firmware/BIOS, by writing 1 to highest byte. + * (OS Control semaphore)*/ + ret = async_req_3_0(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), + IPC_M_CONFIG_SPACE_WRITE_8, eecp + USBLEGSUP_OFFSET + 3, 1); + CHECK_RET_HANGUP_RETURN(ret, "Failed(%d) to request OS EHCI control.\n", + ret); + + size_t wait = 0; + /* Wait for BIOS to release control. */ + while ((wait < DEFAULT_WAIT) && (value & USBLEGSUP_BIOS_CONTROL)) { + async_usleep(WAIT_STEP); + ret = async_req_2_1(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), + IPC_M_CONFIG_SPACE_READ_32, eecp + USBLEGSUP_OFFSET, &value); + wait += WAIT_STEP; + } + + + if ((value & USBLEGSUP_BIOS_CONTROL) == 0) { + usb_log_info("BIOS released control after %d usec.\n", wait); + } else { + /* BIOS failed to hand over control, this should not happen. */ + usb_log_warning( "BIOS failed to release control after " + "%d usecs, force it.\n", wait); + ret = async_req_3_0(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), + IPC_M_CONFIG_SPACE_WRITE_32, eecp + USBLEGSUP_OFFSET, + USBLEGSUP_OS_CONTROL); + CHECK_RET_HANGUP_RETURN(ret, + "Failed(%d) to force OS EHCI control.\n", ret); + } + + /* Zero SMI enables in legacy control register. + * It would prevent pre-OS code from interfering. */ + ret = async_req_3_0(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), + IPC_M_CONFIG_SPACE_WRITE_32, eecp + USBLEGCTLSTS_OFFSET, 0); + CHECK_RET_HANGUP_RETURN(ret, "Failed(%d) zero USBLEGCTLSTS.\n", ret); + usb_log_debug("Zeroed USBLEGCTLSTS register.\n"); + + /* Read again Legacy Support and Control register */ + ret = async_req_2_1(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), + IPC_M_CONFIG_SPACE_READ_32, eecp + USBLEGCTLSTS_OFFSET, &value); + CHECK_RET_HANGUP_RETURN(ret, "Failed(%d) to read USBLEGCTLSTS.\n", ret); + usb_log_debug2("USBLEGCTLSTS: %x.\n", value); + + /* Read again Legacy Support register */ + ret = async_req_2_1(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), + IPC_M_CONFIG_SPACE_READ_32, eecp + USBLEGSUP_OFFSET, &value); + CHECK_RET_HANGUP_RETURN(ret, "Failed(%d) to read USBLEGSUP.\n", ret); + usb_log_debug2("USBLEGSUP: %x.\n", value); + + /* + * TURN OFF EHCI FOR NOW, DRIVER WILL REINITIALIZE IT + */ + + /* Get size of capability registers in memory space. */ + uint8_t operation_offset = *(uint8_t*)registers; + usb_log_debug("USBCMD offset: %d.\n", operation_offset); + + /* Zero USBCMD register. */ + volatile uint32_t *usbcmd = + (uint32_t*)((uint8_t*)registers + operation_offset + CMD_OFFSET); + volatile uint32_t *usbconfigured = + (uint32_t*)((uint8_t*)registers + operation_offset + + CONFIGFLAG_OFFSET); + usb_log_debug("USBCMD value: %x.\n", *usbcmd); + if (*usbcmd & USBCMD_RUN) { + *usbcmd = 0; + *usbconfigured = 0; + usb_log_info("EHCI turned off.\n"); + } else { + usb_log_info("EHCI was not running.\n"); + } + + async_hangup(parent_phone); + return ret; +#undef CHECK_RET_HANGUP_RETURN +} +/*----------------------------------------------------------------------------*/ +/** + * @} + */ + +/** + * @} + */ Index: uspace/drv/ehci-hcd/pci.h =================================================================== --- uspace/drv/ehci-hcd/pci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ehci-hcd/pci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,48 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbehci + * @{ + */ +/** @file + * PCI related functions needed by EHCI driver. + */ +#ifndef DRV_EHCI_PCI_H +#define DRV_EHCI_PCI_H + +#include + +int pci_get_my_registers(ddf_dev_t *, uintptr_t *, size_t *, int *); +int pci_enable_interrupts(ddf_dev_t *); +int pci_disable_legacy(ddf_dev_t *); + +#endif +/** + * @} + */ + Index: uspace/drv/ohci/Makefile =================================================================== --- uspace/drv/ohci/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,43 @@ +# +# Copyright (c) 2011 Jan Vesely +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBS = $(LIBDRV_PREFIX)/libdrv.a $(LIBUSB_PREFIX)/libusb.a +EXTRA_CFLAGS += -I$(LIBDRV_PREFIX)/include -I$(LIBUSB_PREFIX)/include -I. +BINARY = ohci + +SOURCES = \ + iface.c \ + batch.c \ + main.c \ + hc.c \ + ohci.c \ + root_hub.c \ + pci.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/ohci/batch.c =================================================================== --- uspace/drv/ohci/batch.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/batch.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,185 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * @brief OHCI driver USB transaction structure + */ +#include +#include + +#include +#include + +#include "batch.h" +#include "utils/malloc32.h" + +static void batch_call_in_and_dispose(usb_transfer_batch_t *instance); +static void batch_call_out_and_dispose(usb_transfer_batch_t *instance); + +#define DEFAULT_ERROR_COUNT 3 +usb_transfer_batch_t * batch_get( + ddf_fun_t *fun, + usb_target_t target, + usb_transfer_type_t transfer_type, + size_t max_packet_size, + usb_speed_t speed, + char *buffer, + size_t buffer_size, + char *setup_buffer, + size_t setup_size, + usbhc_iface_transfer_in_callback_t func_in, + usbhc_iface_transfer_out_callback_t func_out, + void *arg, + usb_device_keeper_t *manager + ) +{ +#define CHECK_NULL_DISPOSE_RETURN(ptr, message...) \ + if (ptr == NULL) { \ + usb_log_error(message); \ + if (instance) { \ + batch_dispose(instance); \ + } \ + return NULL; \ + } else (void)0 + + usb_transfer_batch_t *instance = malloc(sizeof(usb_transfer_batch_t)); + CHECK_NULL_DISPOSE_RETURN(instance, + "Failed to allocate batch instance.\n"); + usb_transfer_batch_init(instance, target, transfer_type, speed, max_packet_size, + buffer, NULL, buffer_size, NULL, setup_size, func_in, + func_out, arg, fun, NULL); + + if (buffer_size > 0) { + instance->transport_buffer = malloc32(buffer_size); + CHECK_NULL_DISPOSE_RETURN(instance->transport_buffer, + "Failed to allocate device accessible buffer.\n"); + } + + if (setup_size > 0) { + instance->setup_buffer = malloc32(setup_size); + CHECK_NULL_DISPOSE_RETURN(instance->setup_buffer, + "Failed to allocate device accessible setup buffer.\n"); + memcpy(instance->setup_buffer, setup_buffer, setup_size); + } + + + return instance; +} +/*----------------------------------------------------------------------------*/ +void batch_dispose(usb_transfer_batch_t *instance) +{ + assert(instance); + free32(instance->transport_buffer); + free32(instance->setup_buffer); + free(instance); +} +/*----------------------------------------------------------------------------*/ +void batch_control_write(usb_transfer_batch_t *instance) +{ + assert(instance); + /* We are data out, we are supposed to provide data */ + memcpy(instance->transport_buffer, instance->buffer, + instance->buffer_size); + instance->next_step = batch_call_out_and_dispose; + /* TODO: implement */ + usb_log_debug("Batch(%p) CONTROL WRITE initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +void batch_control_read(usb_transfer_batch_t *instance) +{ + assert(instance); + instance->next_step = batch_call_in_and_dispose; + /* TODO: implement */ + usb_log_debug("Batch(%p) CONTROL READ initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +void batch_interrupt_in(usb_transfer_batch_t *instance) +{ + assert(instance); + instance->direction = USB_DIRECTION_IN; + instance->next_step = batch_call_in_and_dispose; + /* TODO: implement */ + usb_log_debug("Batch(%p) INTERRUPT IN initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +void batch_interrupt_out(usb_transfer_batch_t *instance) +{ + assert(instance); + instance->direction = USB_DIRECTION_OUT; + /* We are data out, we are supposed to provide data */ + memcpy(instance->transport_buffer, instance->buffer, + instance->buffer_size); + instance->next_step = batch_call_out_and_dispose; + /* TODO: implement */ + usb_log_debug("Batch(%p) INTERRUPT OUT initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +void batch_bulk_in(usb_transfer_batch_t *instance) +{ + assert(instance); + instance->direction = USB_DIRECTION_IN; + instance->next_step = batch_call_in_and_dispose; + /* TODO: implement */ + usb_log_debug("Batch(%p) BULK IN initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +void batch_bulk_out(usb_transfer_batch_t *instance) +{ + assert(instance); + instance->direction = USB_DIRECTION_IN; + instance->next_step = batch_call_in_and_dispose; + /* TODO: implement */ + usb_log_debug("Batch(%p) BULK IN initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Helper function calls callback and correctly disposes of batch structure. + * + * @param[in] instance Batch structure to use. + */ +void batch_call_in_and_dispose(usb_transfer_batch_t *instance) +{ + assert(instance); + usb_transfer_batch_call_in(instance); + batch_dispose(instance); +} +/*----------------------------------------------------------------------------*/ +/** Helper function calls callback and correctly disposes of batch structure. + * + * @param[in] instance Batch structure to use. + */ +void batch_call_out_and_dispose(usb_transfer_batch_t *instance) +{ + assert(instance); + usb_transfer_batch_call_out(instance); + batch_dispose(instance); +} +/** + * @} + */ Index: uspace/drv/ohci/batch.h =================================================================== --- uspace/drv/ohci/batch.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/batch.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,75 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * @brief OHCI driver USB transaction structure + */ +#ifndef DRV_OHCI_BATCH_H +#define DRV_OHCI_BATCH_H + + +#include +#include +#include +#include + +usb_transfer_batch_t * batch_get( + ddf_fun_t *fun, + usb_target_t target, + usb_transfer_type_t transfer_type, + size_t max_packet_size, + usb_speed_t speed, + char *buffer, + size_t size, + char *setup_buffer, + size_t setup_size, + usbhc_iface_transfer_in_callback_t func_in, + usbhc_iface_transfer_out_callback_t func_out, + void *arg, + usb_device_keeper_t *manager + ); + +void batch_dispose(usb_transfer_batch_t *instance); + +void batch_control_write(usb_transfer_batch_t *instance); + +void batch_control_read(usb_transfer_batch_t *instance); + +void batch_interrupt_in(usb_transfer_batch_t *instance); + +void batch_interrupt_out(usb_transfer_batch_t *instance); + +void batch_bulk_in(usb_transfer_batch_t *instance); + +void batch_bulk_out(usb_transfer_batch_t *instance); +#endif +/** + * @} + */ Index: uspace/drv/ohci/hc.c =================================================================== --- uspace/drv/ohci/hc.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/hc.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,137 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbohcihc + * @{ + */ +/** @file + * @brief OHCI Host controller driver routines + */ +#include +#include +#include +#include + +#include +#include +#include +#include + +#include "hc.h" + +static int interrupt_emulator(hc_t *instance); +/*----------------------------------------------------------------------------*/ +int hc_register_hub(hc_t *instance, ddf_fun_t *hub_fun) +{ + assert(instance); + assert(hub_fun); + + usb_address_t hub_address = + device_keeper_get_free_address(&instance->manager, USB_SPEED_FULL); + instance->rh.address = hub_address; + usb_device_keeper_bind( + &instance->manager, hub_address, hub_fun->handle); + + char *match_str = NULL; + int ret = asprintf(&match_str, "usb&class=hub"); + ret = (match_str == NULL) ? ret : EOK; + if (ret < 0) { + usb_log_error("Failed to create root hub match-id string.\n"); + return ret; + } + + ret = ddf_fun_add_match_id(hub_fun, match_str, 100); + if (ret != EOK) { + usb_log_error("Failed add create root hub match-id.\n"); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +int hc_init(hc_t *instance, ddf_fun_t *fun, ddf_dev_t *dev, + uintptr_t regs, size_t reg_size, bool interrupts) +{ + assert(instance); + int ret = EOK; + + ret = pio_enable((void*)regs, reg_size, (void**)&instance->registers); + if (ret != EOK) { + usb_log_error("Failed to gain access to device registers.\n"); + return ret; + } + instance->ddf_instance = fun; + usb_device_keeper_init(&instance->manager); + + if (!interrupts) { + instance->interrupt_emulator = + fibril_create((int(*)(void*))interrupt_emulator, instance); + fibril_add_ready(instance->interrupt_emulator); + } + + rh_init(&instance->rh, dev, instance->registers); + + /* TODO: implement */ + return EOK; +} +/*----------------------------------------------------------------------------*/ +int hc_schedule(hc_t *instance, usb_transfer_batch_t *batch) +{ + assert(instance); + assert(batch); + if (batch->target.address == instance->rh.address) { + return rh_request(&instance->rh, batch); + } + /* TODO: implement */ + return ENOTSUP; +} +/*----------------------------------------------------------------------------*/ +void hc_interrupt(hc_t *instance, uint32_t status) +{ + assert(instance); + if (status == 0) + return; + if (status & IS_RHSC) + rh_interrupt(&instance->rh); + + /* TODO: Check for further interrupt causes */ + /* TODO: implement */ +} +/*----------------------------------------------------------------------------*/ +int interrupt_emulator(hc_t *instance) +{ + assert(instance); + usb_log_info("Started interrupt emulator.\n"); + while (1) { + uint32_t status = instance->registers->interrupt_status; + instance->registers->interrupt_status = status; + hc_interrupt(instance, status); + async_usleep(1000); + } + return EOK; +} +/** + * @} + */ Index: uspace/drv/ohci/hc.h =================================================================== --- uspace/drv/ohci/hc.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/hc.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,84 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * @brief OHCI host controller driver structure + */ +#ifndef DRV_OHCI_HC_H +#define DRV_OHCI_HC_H + +#include +#include +#include +#include + +#include +#include +#include + +#include "batch.h" +#include "ohci_regs.h" +#include "root_hub.h" + +typedef struct hc { + ohci_regs_t *registers; + usb_address_t rh_address; + rh_t rh; + ddf_fun_t *ddf_instance; + usb_device_keeper_t manager; + fid_t interrupt_emulator; +} hc_t; + +int hc_register_hub(hc_t *instance, ddf_fun_t *hub_fun); + +int hc_init(hc_t *instance, ddf_fun_t *fun, ddf_dev_t *dev, + uintptr_t regs, size_t reg_size, bool interrupts); + +int hc_schedule(hc_t *instance, usb_transfer_batch_t *batch); + +void hc_interrupt(hc_t *instance, uint32_t status); + +/** Safely dispose host controller internal structures + * + * @param[in] instance Host controller structure to use. + */ +static inline void hc_fini(hc_t *instance) { /* TODO: implement*/ }; + +/** Get and cast pointer to the driver data + * + * @param[in] fun DDF function pointer + * @return cast pointer to driver_data + */ +static inline hc_t * fun_to_hc(ddf_fun_t *fun) + { return (hc_t*)fun->driver_data; } +#endif +/** + * @} + */ Index: uspace/drv/ohci/iface.c =================================================================== --- uspace/drv/ohci/iface.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/iface.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,466 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * USB-HC interface implementation. + */ +#include +#include + +#include + +#include "iface.h" +#include "hc.h" + +#define UNSUPPORTED(methodname) \ + usb_log_warning("Unsupported interface method `%s()' in %s:%d.\n", \ + methodname, __FILE__, __LINE__) + +/** Reserve default address. + * + * This function may block the caller. + * + * @param[in] fun Device function the action was invoked on. + * @param[in] speed Speed of the device for which the default address is + * reserved. + * @return Error code. + */ +static int reserve_default_address(ddf_fun_t *fun, usb_speed_t speed) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_log_debug("Default address request with speed %d.\n", speed); + usb_device_keeper_reserve_default_address(&hc->manager, speed); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Release default address. + * + * @param[in] fun Device function the action was invoked on. + * @return Error code. + */ +static int release_default_address(ddf_fun_t *fun) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_log_debug("Default address release.\n"); + usb_device_keeper_release_default_address(&hc->manager); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Found free USB address. + * + * @param[in] fun Device function the action was invoked on. + * @param[in] speed Speed of the device that will get this address. + * @param[out] address Non-null pointer where to store the free address. + * @return Error code. + */ +static int request_address( + ddf_fun_t *fun, usb_speed_t speed, usb_address_t *address) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + assert(address); + + usb_log_debug("Address request with speed %d.\n", speed); + *address = device_keeper_get_free_address(&hc->manager, speed); + usb_log_debug("Address request with result: %d.\n", *address); + if (*address <= 0) + return *address; + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Bind USB address with device devman handle. + * + * @param[in] fun Device function the action was invoked on. + * @param[in] address USB address of the device. + * @param[in] handle Devman handle of the device. + * @return Error code. + */ +static int bind_address( + ddf_fun_t *fun, usb_address_t address, devman_handle_t handle) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_log_debug("Address bind %d-%d.\n", address, handle); + usb_device_keeper_bind(&hc->manager, address, handle); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Release previously requested address. + * + * @param[in] fun Device function the action was invoked on. + * @param[in] address USB address to be released. + * @return Error code. + */ +static int release_address(ddf_fun_t *fun, usb_address_t address) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_log_debug("Address release %d.\n", address); + usb_device_keeper_release(&hc->manager, address); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Register endpoint for bandwidth reservation. + * + * @param[in] fun Device function the action was invoked on. + * @param[in] address USB address of the device. + * @param[in] endpoint Endpoint number. + * @param[in] transfer_type USB transfer type. + * @param[in] direction Endpoint data direction. + * @param[in] max_packet_size Max packet size of the endpoint. + * @param[in] interval Polling interval. + * @return Error code. + */ +static int register_endpoint( + ddf_fun_t *fun, usb_address_t address, usb_endpoint_t endpoint, + usb_transfer_type_t transfer_type, usb_direction_t direction, + size_t max_packet_size, unsigned int interval) +{ + UNSUPPORTED("register_endpoint"); + + return ENOTSUP; +} +/*----------------------------------------------------------------------------*/ +/** Unregister endpoint (free some bandwidth reservation). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] address USB address of the device. + * @param[in] endpoint Endpoint number. + * @param[in] direction Endpoint data direction. + * @return Error code. + */ +static int unregister_endpoint( + ddf_fun_t *fun, usb_address_t address, + usb_endpoint_t endpoint, usb_direction_t direction) +{ + UNSUPPORTED("unregister_endpoint"); + + return ENOTSUP; +} +/*----------------------------------------------------------------------------*/ +/** Schedule interrupt out transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] data Data to be sent (in USB endianess, allocated and deallocated + * by the caller). + * @param[in] size Size of the @p data buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int interrupt_out( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, void *data, + size_t size, usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + + usb_log_debug("Interrupt OUT %d:%d %zu(%zu).\n", + target.address, target.endpoint, size, max_packet_size); + + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_INTERRUPT, max_packet_size, + speed, data, size, NULL, 0, NULL, callback, arg, &hc->manager); + if (!batch) + return ENOMEM; + batch_interrupt_out(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Schedule interrupt in transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] data Buffer where to store the data (in USB endianess, + * allocated and deallocated by the caller). + * @param[in] size Size of the @p data buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int interrupt_in( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, void *data, + size_t size, usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + usb_log_debug("Interrupt IN %d:%d %zu(%zu).\n", + target.address, target.endpoint, size, max_packet_size); + + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_INTERRUPT, max_packet_size, + speed, data, size, NULL, 0, callback, NULL, arg, &hc->manager); + if (!batch) + return ENOMEM; + batch_interrupt_in(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Schedule bulk out transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] data Data to be sent (in USB endianess, allocated and deallocated + * by the caller). + * @param[in] size Size of the @p data buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int bulk_out( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, void *data, + size_t size, usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + + usb_log_debug("Bulk OUT %d:%d %zu(%zu).\n", + target.address, target.endpoint, size, max_packet_size); + + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_BULK, max_packet_size, speed, + data, size, NULL, 0, NULL, callback, arg, &hc->manager); + if (!batch) + return ENOMEM; + batch_bulk_out(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Schedule bulk in transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] data Buffer where to store the data (in USB endianess, + * allocated and deallocated by the caller). + * @param[in] size Size of the @p data buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int bulk_in( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, void *data, + size_t size, usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + usb_log_debug("Bulk IN %d:%d %zu(%zu).\n", + target.address, target.endpoint, size, max_packet_size); + + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_BULK, max_packet_size, speed, + data, size, NULL, 0, callback, NULL, arg, &hc->manager); + if (!batch) + return ENOMEM; + batch_bulk_in(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Schedule control write transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] setup_packet Setup packet buffer (in USB endianess, allocated + * and deallocated by the caller). + * @param[in] setup_packet_size Size of @p setup_packet buffer in bytes. + * @param[in] data_buffer Data buffer (in USB endianess, allocated and + * deallocated by the caller). + * @param[in] data_buffer_size Size of @p data_buffer buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int control_write( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, + void *setup_data, size_t setup_size, void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + usb_log_debug("Control WRITE (%d) %d:%d %zu(%zu).\n", + speed, target.address, target.endpoint, size, max_packet_size); + + if (setup_size != 8) + return EINVAL; + + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_CONTROL, max_packet_size, + speed, data, size, setup_data, setup_size, NULL, callback, arg, + &hc->manager); + if (!batch) + return ENOMEM; + usb_device_keeper_reset_if_need(&hc->manager, target, setup_data); + batch_control_write(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Schedule control read transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] setup_packet Setup packet buffer (in USB endianess, allocated + * and deallocated by the caller). + * @param[in] setup_packet_size Size of @p setup_packet buffer in bytes. + * @param[in] data_buffer Buffer where to store the data (in USB endianess, + * allocated and deallocated by the caller). + * @param[in] data_buffer_size Size of @p data_buffer buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int control_read( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, + void *setup_data, size_t setup_size, void *data, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + + usb_log_debug("Control READ(%d) %d:%d %zu(%zu).\n", + speed, target.address, target.endpoint, size, max_packet_size); + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_CONTROL, max_packet_size, + speed, data, size, setup_data, setup_size, callback, NULL, arg, + &hc->manager); + if (!batch) + return ENOMEM; + batch_control_read(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Host controller interface implementation for OHCI. */ +usbhc_iface_t hc_iface = { + .reserve_default_address = reserve_default_address, + .release_default_address = release_default_address, + .request_address = request_address, + .bind_address = bind_address, + .release_address = release_address, + + .register_endpoint = register_endpoint, + .unregister_endpoint = unregister_endpoint, + + .interrupt_out = interrupt_out, + .interrupt_in = interrupt_in, + + .bulk_out = bulk_out, + .bulk_in = bulk_in, + + .control_write = control_write, + .control_read = control_read, +}; + +/** + * @} + */ Index: uspace/drv/ohci/iface.h =================================================================== --- uspace/drv/ohci/iface.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/iface.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,46 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * Common OHCI definitions. + */ +#ifndef DRV_OHCI_IFACE_H +#define DRV_OHCI_IFACE_H + +#include + +extern usbhc_iface_t hc_iface; + +#endif +/** + * @} + */ + Index: uspace/drv/ohci/main.c =================================================================== --- uspace/drv/ohci/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,100 @@ +/* + * Copyright (c) 2011 Jan Vesely + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * Main routines of OHCI driver. + */ +#include +#include +#include + +#include + +#include "ohci.h" + +#define NAME "ohci" + +static int ohci_add_device(ddf_dev_t *device); +/*----------------------------------------------------------------------------*/ +static driver_ops_t ohci_driver_ops = { + .add_device = ohci_add_device, +}; +/*----------------------------------------------------------------------------*/ +static driver_t ohci_driver = { + .name = NAME, + .driver_ops = &ohci_driver_ops +}; +/*----------------------------------------------------------------------------*/ +/** Initializes a new ddf driver instance of OHCI hcd. + * + * @param[in] device DDF instance of the device to initialize. + * @return Error code. + */ +int ohci_add_device(ddf_dev_t *device) +{ + usb_log_debug("ohci_add_device() called\n"); + assert(device); + ohci_t *ohci = malloc(sizeof(ohci_t)); + if (ohci == NULL) { + usb_log_error("Failed to allocate OHCI driver.\n"); + return ENOMEM; + } + + int ret = ohci_init(ohci, device); + if (ret != EOK) { + usb_log_error("Failed to initialize OHCI driver: %s.\n", + str_error(ret)); + return ret; + } + device->driver_data = ohci; + + usb_log_info("Controlling new OHCI device `%s'.\n", device->name); + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Initializes global driver structures (NONE). + * + * @param[in] argc Nmber of arguments in argv vector (ignored). + * @param[in] argv Cmdline argument vector (ignored). + * @return Error code. + * + * Driver debug level is set here. + */ +int main(int argc, char *argv[]) +{ + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + sleep(5); + return ddf_driver_main(&ohci_driver); +} +/** + * @} + */ Index: uspace/drv/ohci/ohci.c =================================================================== --- uspace/drv/ohci/ohci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/ohci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,225 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * @brief OHCI driver + */ +#include +#include +#include +#include +#include +#include +#include + +#include "ohci.h" +#include "iface.h" +#include "pci.h" + +/** IRQ handling callback, identifies device + * + * @param[in] dev DDF instance of the device to use. + * @param[in] iid (Unused). + * @param[in] call Pointer to the call that represents interrupt. + */ +static void irq_handler(ddf_dev_t *dev, ipc_callid_t iid, ipc_call_t *call) +{ + assert(dev); + hc_t *hc = &((ohci_t*)dev->driver_data)->hc; + uint16_t status = IPC_GET_ARG1(*call); + assert(hc); + hc_interrupt(hc, status); +} +/*----------------------------------------------------------------------------*/ +/** Get address of the device identified by handle. + * + * @param[in] dev DDF instance of the device to use. + * @param[in] iid (Unused). + * @param[in] call Pointer to the call that represents interrupt. + */ +static int usb_iface_get_address( + ddf_fun_t *fun, devman_handle_t handle, usb_address_t *address) +{ + assert(fun); + usb_device_keeper_t *manager = &((ohci_t*)fun->dev->driver_data)->hc.manager; + + usb_address_t addr = usb_device_keeper_find(manager, handle); + if (addr < 0) { + return addr; + } + + if (address != NULL) { + *address = addr; + } + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Gets handle of the respective hc (this device, hc function). + * + * @param[in] root_hub_fun Root hub function seeking hc handle. + * @param[out] handle Place to write the handle. + * @return Error code. + */ +static int usb_iface_get_hc_handle( + ddf_fun_t *fun, devman_handle_t *handle) +{ + assert(handle); + ddf_fun_t *hc_fun = ((ohci_t*)fun->dev->driver_data)->hc_fun; + assert(hc_fun != NULL); + + *handle = hc_fun->handle; + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** This iface is generic for both RH and HC. */ +static usb_iface_t usb_iface = { + .get_hc_handle = usb_iface_get_hc_handle, + .get_address = usb_iface_get_address +}; +/*----------------------------------------------------------------------------*/ +static ddf_dev_ops_t hc_ops = { + .interfaces[USBHC_DEV_IFACE] = &hc_iface, /* see iface.h/c */ +}; +/*----------------------------------------------------------------------------*/ +static ddf_dev_ops_t rh_ops = { + .interfaces[USB_DEV_IFACE] = &usb_iface, +}; +/*----------------------------------------------------------------------------*/ +/** Initialize hc and rh ddf structures and their respective drivers. + * + * @param[in] instance OHCI structure to use. + * @param[in] device DDF instance of the device to use. + * + * This function does all the preparatory work for hc and rh drivers: + * - gets device hw resources + * - disables OHCI legacy support + * - asks for interrupt + * - registers interrupt handler + */ +int ohci_init(ohci_t *instance, ddf_dev_t *device) +{ + assert(instance); + instance->hc_fun = NULL; + instance->rh_fun = NULL; +#define CHECK_RET_DEST_FUN_RETURN(ret, message...) \ +if (ret != EOK) { \ + usb_log_error(message); \ + if (instance->hc_fun) \ + ddf_fun_destroy(instance->hc_fun); \ + if (instance->rh_fun) \ + ddf_fun_destroy(instance->rh_fun); \ + return ret; \ +} + + uintptr_t mem_reg_base = 0; + size_t mem_reg_size = 0; + int irq = 0; + + int ret = + pci_get_my_registers(device, &mem_reg_base, &mem_reg_size, &irq); + CHECK_RET_DEST_FUN_RETURN(ret, + "Failed(%d) to get memory addresses:.\n", ret, device->handle); + usb_log_debug("Memory mapped regs at 0x%X (size %zu), IRQ %d.\n", + mem_reg_base, mem_reg_size, irq); + + ret = pci_disable_legacy(device); + CHECK_RET_DEST_FUN_RETURN(ret, + "Failed(%d) to disable legacy USB: %s.\n", ret, str_error(ret)); + + bool interrupts = false; +#ifdef CONFIG_USBHC_NO_INTERRUPTS + usb_log_warning("Interrupts disabled in OS config, " \ + "falling back to polling.\n"); +#else + ret = pci_enable_interrupts(device); + if (ret != EOK) { + usb_log_warning("Failed to enable interrupts: %s.\n", + str_error(ret)); + usb_log_info("HW interrupts not available, " \ + "falling back to polling.\n"); + } else { + usb_log_debug("Hw interrupts enabled.\n"); + interrupts = true; + } +#endif + + instance->hc_fun = ddf_fun_create(device, fun_exposed, "ohci-hc"); + ret = (instance->hc_fun == NULL) ? ENOMEM : EOK; + CHECK_RET_DEST_FUN_RETURN(ret, + "Failed(%d) to create HC function.\n", ret); + + ret = hc_init(&instance->hc, instance->hc_fun, device, + mem_reg_base, mem_reg_size, interrupts); + CHECK_RET_DEST_FUN_RETURN(ret, "Failed(%d) to init ohci-hcd.\n", ret); + instance->hc_fun->ops = &hc_ops; + instance->hc_fun->driver_data = &instance->hc; + ret = ddf_fun_bind(instance->hc_fun); + CHECK_RET_DEST_FUN_RETURN(ret, + "Failed(%d) to bind OHCI device function: %s.\n", + ret, str_error(ret)); +#undef CHECK_RET_HC_RETURN + +#define CHECK_RET_FINI_RETURN(ret, message...) \ +if (ret != EOK) { \ + usb_log_error(message); \ + if (instance->hc_fun) \ + ddf_fun_destroy(instance->hc_fun); \ + if (instance->rh_fun) \ + ddf_fun_destroy(instance->rh_fun); \ + hc_fini(&instance->hc); \ + return ret; \ +} + + /* It does no harm if we register this on polling */ + ret = register_interrupt_handler(device, irq, irq_handler, NULL); + CHECK_RET_FINI_RETURN(ret, + "Failed(%d) to register interrupt handler.\n", ret); + + instance->rh_fun = ddf_fun_create(device, fun_inner, "ohci-rh"); + ret = (instance->rh_fun == NULL) ? ENOMEM : EOK; + CHECK_RET_FINI_RETURN(ret, + "Failed(%d) to create root hub function.\n", ret); + + hc_register_hub(&instance->hc, instance->rh_fun); + + instance->rh_fun->ops = &rh_ops; + instance->rh_fun->driver_data = NULL; + ret = ddf_fun_bind(instance->rh_fun); + CHECK_RET_FINI_RETURN(ret, + "Failed(%d) to register OHCI root hub.\n", ret); + + return EOK; +#undef CHECK_RET_FINI_RETURN +} +/** + * @} + */ Index: uspace/drv/ohci/ohci.h =================================================================== --- uspace/drv/ohci/ohci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/ohci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,56 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * @brief OHCI driver main structure for both host controller and root-hub. + */ +#ifndef DRV_OHCI_OHCI_H +#define DRV_OHCI_OHCI_H +#include +#include + +#include "hc.h" +#include "root_hub.h" + +typedef struct ohci { + ddf_fun_t *hc_fun; + ddf_fun_t *rh_fun; + + hc_t hc; + rh_t rh; +} ohci_t; + +int ohci_init(ohci_t *instance, ddf_dev_t *device); + +#endif +/** + * @} + */ Index: uspace/drv/ohci/ohci.ma =================================================================== --- uspace/drv/ohci/ohci.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/ohci.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,1 @@ +10 pci/ven=106b&dev=003f Index: uspace/drv/ohci/ohci_regs.h =================================================================== --- uspace/drv/ohci/ohci_regs.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/ohci_regs.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,85 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbohcihc + * @{ + */ +/** @file + * @brief OHCI host controller register structure + */ +#ifndef DRV_OHCI_OHCI_REGS_H +#define DRV_OHCI_OHCI_REGS_H +#include + +typedef struct ohci_regs +{ + volatile uint32_t revision; + volatile uint32_t control; + volatile uint32_t command_status; + volatile uint32_t interrupt_status; +#define IS_SO (1 << 0) +#define IS_WDH (1 << 1) +#define IS_SF (1 << 2) +#define IS_RD (1 << 3) +#define IS_UE (1 << 4) +#define IS_FNO (1 << 5) +#define IS_RHSC (1 << 6) +#define IS_OC (1 << 30) + volatile uint32_t interupt_enable; +#define IE_SO (1 << 0) +#define IE_WDH (1 << 1) +#define IE_SF (1 << 2) +#define IE_RD (1 << 3) +#define IE_UE (1 << 4) +#define IE_FNO (1 << 5) +#define IE_RHSC (1 << 6) +#define IE_OC (1 << 30) +#define IE_MIE (1 << 31) + + volatile uint32_t interrupt_disable; + volatile uint32_t hcca; + volatile uint32_t period_corrent; + volatile uint32_t control_head; + volatile uint32_t control_current; + volatile uint32_t bulk_head; + volatile uint32_t bulk_current; + volatile uint32_t done_head; + volatile uint32_t fm_interval; + volatile uint32_t fm_remaining; + volatile uint32_t fm_number; + volatile uint32_t periodic_start; + volatile uint32_t ls_threshold; + volatile uint32_t rh_desc_a; + volatile uint32_t rh_desc_b; + volatile uint32_t rh_status; + volatile uint32_t rh_port_status[]; +} __attribute__((packed)) ohci_regs_t; +#endif +/** + * @} + */ Index: uspace/drv/ohci/pci.c =================================================================== --- uspace/drv/ohci/pci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/pci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,176 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** + * @addtogroup drvusbohci + * @{ + */ +/** + * @file + * PCI related functions needed by the OHCI driver. + */ +#include +#include +#include +#include +#include +#include +#include + +#include +#include + +#include "pci.h" + +#define PAGE_SIZE_MASK 0xfffff000 + +#define HCC_PARAMS_OFFSET 0x8 +#define HCC_PARAMS_EECP_MASK 0xff +#define HCC_PARAMS_EECP_OFFSET 8 + +#define CMD_OFFSET 0x0 +#define CONFIGFLAG_OFFSET 0x40 + +#define USBCMD_RUN 1 + +#define USBLEGSUP_OFFSET 0 +#define USBLEGSUP_BIOS_CONTROL (1 << 16) +#define USBLEGSUP_OS_CONTROL (1 << 24) +#define USBLEGCTLSTS_OFFSET 4 + +#define DEFAULT_WAIT 10000 +#define WAIT_STEP 10 + +/** Get address of registers and IRQ for given device. + * + * @param[in] dev Device asking for the addresses. + * @param[out] mem_reg_address Base address of the memory range. + * @param[out] mem_reg_size Size of the memory range. + * @param[out] irq_no IRQ assigned to the device. + * @return Error code. + */ +int pci_get_my_registers(ddf_dev_t *dev, + uintptr_t *mem_reg_address, size_t *mem_reg_size, int *irq_no) +{ + assert(dev != NULL); + + int parent_phone = devman_parent_device_connect(dev->handle, + IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + + int rc; + + hw_resource_list_t hw_resources; + rc = hw_res_get_resource_list(parent_phone, &hw_resources); + if (rc != EOK) { + async_hangup(parent_phone); + return rc; + } + + uintptr_t mem_address = 0; + size_t mem_size = 0; + bool mem_found = false; + + int irq = 0; + bool irq_found = false; + + size_t i; + for (i = 0; i < hw_resources.count; i++) { + hw_resource_t *res = &hw_resources.resources[i]; + switch (res->type) + { + case INTERRUPT: + irq = res->res.interrupt.irq; + irq_found = true; + usb_log_debug2("Found interrupt: %d.\n", irq); + break; + + case MEM_RANGE: + if (res->res.mem_range.address != 0 + && res->res.mem_range.size != 0 ) { + mem_address = res->res.mem_range.address; + mem_size = res->res.mem_range.size; + usb_log_debug2("Found mem: %llx %zu.\n", + mem_address, mem_size); + mem_found = true; + } + default: + break; + } + } + + if (mem_found && irq_found) { + *mem_reg_address = mem_address; + *mem_reg_size = mem_size; + *irq_no = irq; + rc = EOK; + } else { + rc = ENOENT; + } + + async_hangup(parent_phone); + return rc; +} +/*----------------------------------------------------------------------------*/ +/** Calls the PCI driver with a request to enable interrupts + * + * @param[in] device Device asking for interrupts + * @return Error code. + */ +int pci_enable_interrupts(ddf_dev_t *device) +{ + return ENOTSUP; + int parent_phone = + devman_parent_device_connect(device->handle, IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + bool enabled = hw_res_enable_interrupt(parent_phone); + async_hangup(parent_phone); + return enabled ? EOK : EIO; +} +/*----------------------------------------------------------------------------*/ +/** Implements BIOS handoff routine as decribed in OHCI spec + * + * @param[in] device Device asking for interrupts + * @return Error code. + */ +int pci_disable_legacy(ddf_dev_t *device) +{ + /* TODO: implement */ + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** + * @} + */ + +/** + * @} + */ Index: uspace/drv/ohci/pci.h =================================================================== --- uspace/drv/ohci/pci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/pci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,48 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * PCI related functions needed by OHCI driver. + */ +#ifndef DRV_OHCI_PCI_H +#define DRV_OHCI_PCI_H + +#include + +int pci_get_my_registers(ddf_dev_t *, uintptr_t *, size_t *, int *); +int pci_enable_interrupts(ddf_dev_t *); +int pci_disable_legacy(ddf_dev_t *); + +#endif +/** + * @} + */ + Index: uspace/drv/ohci/root_hub.c =================================================================== --- uspace/drv/ohci/root_hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/root_hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,675 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * @brief OHCI driver + */ +#include +#include +#include + +#include + +#include "root_hub.h" +#include "usb/classes/classes.h" +#include "usb/devdrv.h" +#include +#include + +/** + * standart device descriptor for ohci root hub + */ +static const usb_standard_device_descriptor_t ohci_rh_device_descriptor = +{ + .configuration_count = 1, + .descriptor_type = USB_DESCTYPE_DEVICE, + .device_class = USB_CLASS_HUB, + .device_protocol = 0, + .device_subclass = 0, + .device_version = 0, + .length = sizeof(usb_standard_device_descriptor_t), + /// \TODO this value is guessed + .max_packet_size = 8, + .vendor_id = 0x16db, + .product_id = 0x0001, + /// \TODO these values migt be different + .str_serial_number = 0, + .usb_spec_version = 0x110, +}; + +/** + * standart configuration descriptor with filled common values + * for ohci root hubs + */ +static const usb_standard_configuration_descriptor_t ohci_rh_conf_descriptor = +{ + /// \TODO some values are default or guessed + .attributes = 1<<7, + .configuration_number = 1, + .descriptor_type = USB_DESCTYPE_CONFIGURATION, + .interface_count = 1, + .length = sizeof(usb_standard_configuration_descriptor_t), + .max_power = 100, + .str_configuration = 0, +}; + +/** + * standart ohci root hub interface descriptor + */ +static const usb_standard_interface_descriptor_t ohci_rh_iface_descriptor = +{ + .alternate_setting = 0, + .descriptor_type = USB_DESCTYPE_INTERFACE, + .endpoint_count = 1, + .interface_class = USB_CLASS_HUB, + /// \TODO is this correct? + .interface_number = 1, + .interface_protocol = 0, + .interface_subclass = 0, + .length = sizeof(usb_standard_interface_descriptor_t), + .str_interface = 0, +}; + +/** + * standart ohci root hub endpoint descriptor + */ +static const usb_standard_endpoint_descriptor_t ohci_rh_ep_descriptor = +{ + .attributes = USB_TRANSFER_INTERRUPT, + .descriptor_type = USB_DESCTYPE_ENDPOINT, + .endpoint_address = 1 + (1<<7), + .length = sizeof(usb_standard_endpoint_descriptor_t), + .max_packet_size = 8, + .poll_interval = 255, +}; + +/** + * Create hub descriptor used in hub-driver <-> hub communication + * + * This means creating byt array from data in root hub registers. For more + * info see usb hub specification. + * + * @param instance root hub instance + * @param@out out_result pointer to resultant serialized descriptor + * @param@out out_size size of serialized descriptor + */ +static void usb_create_serialized_hub_descriptor(rh_t *instance, + uint8_t ** out_result, + size_t * out_size) { + //base size + size_t size = 7; + //variable size according to port count + size_t var_size = instance->port_count / 8 + + ((instance->port_count % 8 > 0) ? 1 : 0); + size += 2 * var_size; + uint8_t * result = (uint8_t*) malloc(size); + bzero(result,size); + //size + result[0] = size; + //descriptor type + result[1] = USB_DESCTYPE_HUB; + result[2] = instance->port_count; + uint32_t hub_desc_reg = instance->registers->rh_desc_a; + result[3] = + ((hub_desc_reg >> 8) %2) + + (((hub_desc_reg >> 9) %2) << 1) + + (((hub_desc_reg >> 10) %2) << 2) + + (((hub_desc_reg >> 11) %2) << 3) + + (((hub_desc_reg >> 12) %2) << 4); + result[4] = 0; + result[5] = /*descriptor->pwr_on_2_good_time*/ 50; + result[6] = 50; + + int port; + for (port = 1; port <= instance->port_count; ++port) { + result[7 + port/8] += + ((instance->registers->rh_desc_b >> port)%2) << (port%8); + } + size_t i; + for (i = 0; i < var_size; ++i) { + result[7 + var_size + i] = 255; + } + (*out_result) = result; + (*out_size) = size; +} + + +/** initialize hub descriptors + * + * Initialized are device and full configuration descriptor. These need to + * be initialized only once per hub. + * @instance root hub instance + */ +static void rh_init_descriptors(rh_t *instance){ + memcpy(&instance->descriptors.device, &ohci_rh_device_descriptor, + sizeof(ohci_rh_device_descriptor) + ); + usb_standard_configuration_descriptor_t descriptor; + memcpy(&descriptor,&ohci_rh_conf_descriptor, + sizeof(ohci_rh_conf_descriptor)); + uint8_t * hub_descriptor; + size_t hub_desc_size; + usb_create_serialized_hub_descriptor(instance, &hub_descriptor, + &hub_desc_size); + + descriptor.total_length = + sizeof(usb_standard_configuration_descriptor_t)+ + sizeof(usb_standard_endpoint_descriptor_t)+ + sizeof(usb_standard_interface_descriptor_t)+ + hub_desc_size; + + uint8_t * full_config_descriptor = + (uint8_t*) malloc(descriptor.total_length); + memcpy(full_config_descriptor, &descriptor, sizeof(descriptor)); + memcpy(full_config_descriptor + sizeof(descriptor), + &ohci_rh_iface_descriptor, sizeof(ohci_rh_iface_descriptor)); + memcpy(full_config_descriptor + sizeof(descriptor) + + sizeof(ohci_rh_iface_descriptor), + &ohci_rh_ep_descriptor, sizeof(ohci_rh_ep_descriptor)); + memcpy(full_config_descriptor + sizeof(descriptor) + + sizeof(ohci_rh_iface_descriptor) + + sizeof(ohci_rh_ep_descriptor), + hub_descriptor, hub_desc_size); + + instance->descriptors.configuration = full_config_descriptor; + instance->descriptors.configuration_size = descriptor.total_length; +} + +/** Root hub initialization + * @return Error code. + */ +int rh_init(rh_t *instance, ddf_dev_t *dev, ohci_regs_t *regs) +{ + assert(instance); + instance->address = -1; + instance->registers = regs; + instance->device = dev; + rh_init_descriptors(instance); + + + usb_log_info("OHCI root hub with %d ports.\n", regs->rh_desc_a & 0xff); + + //start generic usb hub driver + + /* TODO: implement */ + return EOK; +} +/*----------------------------------------------------------------------------*/ + +/** + * create answer to port status_request + * + * Copy content of corresponding port status register to answer buffer. + * + * @param instance root hub instance + * @param port port number, counted from 1 + * @param request structure containing both request and response information + * @return error code + */ +static int process_get_port_status_request(rh_t *instance, uint16_t port, + usb_transfer_batch_t * request){ + if(port<1 || port>instance->port_count) + return EINVAL; + uint32_t * uint32_buffer = (uint32_t*)request->buffer; + request->transfered_size = 4; + uint32_buffer[0] = instance->registers->rh_port_status[port -1]; + return EOK; +} + +/** + * create answer to port status_request + * + * Copy content of hub status register to answer buffer. + * + * @param instance root hub instance + * @param request structure containing both request and response information + * @return error code + */ +static int process_get_hub_status_request(rh_t *instance, + usb_transfer_batch_t * request){ + uint32_t * uint32_buffer = (uint32_t*)request->buffer; + //bits, 0,1,16,17 + request->transfered_size = 4; + uint32_t mask = 1 & (1<<1) & (1<<16) & (1<<17); + uint32_buffer[0] = mask & instance->registers->rh_status; + return EOK; + +} + + + +/** + * create answer to status request + * + * This might be either hub status or port status request. If neither, + * ENOTSUP is returned. + * @param instance root hub instance + * @param request structure containing both request and response information + * @return error code + */ +static int process_get_status_request(rh_t *instance, + usb_transfer_batch_t * request) +{ + size_t buffer_size = request->buffer_size; + usb_device_request_setup_packet_t * request_packet = + (usb_device_request_setup_packet_t*) + request->setup_buffer; + + usb_hub_bm_request_type_t request_type = request_packet->request_type; + if(buffer_size<4/*request_packet->length*/){///\TODO + usb_log_warning("requested more data than buffer size\n"); + return EINVAL; + } + + if(request_type == USB_HUB_REQ_TYPE_GET_HUB_STATUS) + return process_get_hub_status_request(instance, request); + if(request_type == USB_HUB_REQ_TYPE_GET_PORT_STATUS) + return process_get_port_status_request(instance, request_packet->index, + request); + return ENOTSUP; +} + +/** + * create answer to status interrupt consisting of change bitmap + * + * Result contains bitmap where bit 0 indicates change on hub and + * bit i indicates change on i`th port (i>0). For more info see + * Hub and Port status bitmap specification in USB specification. + * @param instance root hub instance + * @param@out buffer pointer to created interrupt mas + * @param@out buffer_size size of created interrupt mask + */ +static void create_interrupt_mask(rh_t *instance, void ** buffer, + size_t * buffer_size){ + int bit_count = instance->port_count + 1; + (*buffer_size) = (bit_count / 8) + (bit_count%8==0)?0:1; + (*buffer) = malloc(*buffer_size); + uint8_t * bitmap = (uint8_t*)(*buffer); + uint32_t mask = (1<<16) + (1<<17); + bzero(bitmap,(*buffer_size)); + if(instance->registers->rh_status & mask){ + bitmap[0] = 1; + } + int port; + mask = 0; + int i; + for(i=16;i<=20;++i) + mask += 1<port_count;++port){ + if(mask & instance->registers->rh_port_status[port-1]){ + bitmap[(port+1)/8] += 1<<(port%8); + } + } +} + +/** + * create answer to a descriptor request + * + * This might be a request for standard (configuration, device, endpoint or + * interface) or device specific (hub) descriptor. + * @param instance root hub instance + * @param request structure containing both request and response information + * @return error code + */ +static int process_get_descriptor_request(rh_t *instance, + usb_transfer_batch_t *request){ + usb_device_request_setup_packet_t * setup_request = + (usb_device_request_setup_packet_t*)request->setup_buffer; + size_t size; + const void * result_descriptor = NULL; + const uint16_t setup_request_value = setup_request->value_high; + //(setup_request->value_low << 8); + bool del = false; + switch (setup_request_value) + { + case USB_DESCTYPE_HUB: { + uint8_t * descriptor; + usb_create_serialized_hub_descriptor( + instance, &descriptor, &size); + result_descriptor = descriptor; + if(result_descriptor) del = true; + break; + } + case USB_DESCTYPE_DEVICE: { + usb_log_debug("USB_DESCTYPE_DEVICE\n"); + result_descriptor = &ohci_rh_device_descriptor; + size = sizeof(ohci_rh_device_descriptor); + break; + } + case USB_DESCTYPE_CONFIGURATION: { + usb_log_debug("USB_DESCTYPE_CONFIGURATION\n"); + result_descriptor = instance->descriptors.configuration; + size = instance->descriptors.configuration_size; + break; + } + case USB_DESCTYPE_INTERFACE: { + usb_log_debug("USB_DESCTYPE_INTERFACE\n"); + result_descriptor = &ohci_rh_iface_descriptor; + size = sizeof(ohci_rh_iface_descriptor); + break; + } + case USB_DESCTYPE_ENDPOINT: { + usb_log_debug("USB_DESCTYPE_ENDPOINT\n"); + result_descriptor = &ohci_rh_ep_descriptor; + size = sizeof(ohci_rh_ep_descriptor); + break; + } + default: { + usb_log_debug("USB_DESCTYPE_EINVAL %d \n",setup_request->value); + usb_log_debug("\ttype %d\n\trequest %d\n\tvalue %d\n\tindex %d\n\tlen %d\n ", + setup_request->request_type, + setup_request->request, + setup_request_value, + setup_request->index, + setup_request->length + ); + return EINVAL; + } + } + if(request->buffer_size < size){ + size = request->buffer_size; + } + request->transfered_size = size; + memcpy(request->transport_buffer,result_descriptor,size); + usb_log_debug("sent desctiptor: %s\n", + usb_debug_str_buffer((uint8_t*)request->transport_buffer,size,size)); + if (del) + free(result_descriptor); + return EOK; +} + +/** + * answer to get configuration request + * + * Root hub works independently on the configuration. + * @param instance root hub instance + * @param request structure containing both request and response information + * @return error code + */ +static int process_get_configuration_request(rh_t *instance, + usb_transfer_batch_t *request){ + //set and get configuration requests do not have any meaning, only dummy + //values are returned + if(request->buffer_size != 1) + return EINVAL; + request->buffer[0] = 1; + request->transfered_size = 1; + return EOK; +} + +/** + * process feature-enabling/disabling request on hub + * + * @param instance root hub instance + * @param feature feature selector + * @param enable enable or disable specified feature + * @return error code + */ +static int process_hub_feature_set_request(rh_t *instance, + uint16_t feature, bool enable){ + if(feature > USB_HUB_FEATURE_C_HUB_OVER_CURRENT) + return EINVAL; + instance->registers->rh_status = + enable ? + (instance->registers->rh_status | (1<registers->rh_status & (~(1< USB_HUB_FEATURE_C_PORT_RESET) + return EINVAL; + if(port<1 || port>instance->port_count) + return EINVAL; + instance->registers->rh_port_status[port - 1] = + enable ? + (instance->registers->rh_port_status[port - 1] | (1<registers->rh_port_status[port - 1] & (~(1<address = address; + return EOK; +} + +/** + * process one of requests that requere output data + * + * Request can be one of USB_DEVREQ_GET_STATUS, USB_DEVREQ_GET_DESCRIPTOR or + * USB_DEVREQ_GET_CONFIGURATION. + * @param instance root hub instance + * @param request structure containing both request and response information + * @return error code + */ +static int process_request_with_output(rh_t *instance, + usb_transfer_batch_t *request){ + usb_device_request_setup_packet_t * setup_request = + (usb_device_request_setup_packet_t*)request->setup_buffer; + if(setup_request->request == USB_DEVREQ_GET_STATUS){ + usb_log_debug("USB_DEVREQ_GET_STATUS\n"); + return process_get_status_request(instance, request); + } + if(setup_request->request == USB_DEVREQ_GET_DESCRIPTOR){ + usb_log_debug("USB_DEVREQ_GET_DESCRIPTOR\n"); + return process_get_descriptor_request(instance, request); + } + if(setup_request->request == USB_DEVREQ_GET_CONFIGURATION){ + usb_log_debug("USB_DEVREQ_GET_CONFIGURATION\n"); + return process_get_configuration_request(instance, request); + } + return ENOTSUP; +} + +/** + * process one of requests that carry input data + * + * Request can be one of USB_DEVREQ_SET_DESCRIPTOR or + * USB_DEVREQ_SET_CONFIGURATION. + * @param instance root hub instance + * @param request structure containing both request and response information + * @return error code + */ +static int process_request_with_input(rh_t *instance, + usb_transfer_batch_t *request){ + usb_device_request_setup_packet_t * setup_request = + (usb_device_request_setup_packet_t*)request->setup_buffer; + request->transfered_size = 0; + if(setup_request->request == USB_DEVREQ_SET_DESCRIPTOR){ + return ENOTSUP; + } + if(setup_request->request == USB_DEVREQ_SET_CONFIGURATION){ + //set and get configuration requests do not have any meaning, + //only dummy values are returned + return EOK; + } + return ENOTSUP; +} + +/** + * process one of requests that do not request nor carry additional data + * + * Request can be one of USB_DEVREQ_CLEAR_FEATURE, USB_DEVREQ_SET_FEATURE or + * USB_DEVREQ_SET_ADDRESS. + * @param instance root hub instance + * @param request structure containing both request and response information + * @return error code + */ +static int process_request_without_data(rh_t *instance, + usb_transfer_batch_t *request){ + usb_device_request_setup_packet_t * setup_request = + (usb_device_request_setup_packet_t*)request->setup_buffer; + request->transfered_size = 0; + if(setup_request->request == USB_DEVREQ_CLEAR_FEATURE + || setup_request->request == USB_DEVREQ_SET_FEATURE){ + if(setup_request->request_type == USB_HUB_REQ_TYPE_SET_HUB_FEATURE){ + usb_log_debug("USB_HUB_REQ_TYPE_SET_HUB_FEATURE\n"); + return process_hub_feature_set_request(instance, setup_request->value, + setup_request->request == USB_DEVREQ_SET_FEATURE); + } + if(setup_request->request_type == USB_HUB_REQ_TYPE_SET_PORT_FEATURE){ + usb_log_debug("USB_HUB_REQ_TYPE_SET_PORT_FEATURE\n"); + return process_port_feature_set_request(instance, setup_request->value, + setup_request->index, + setup_request->request == USB_DEVREQ_SET_FEATURE); + } + usb_log_debug("USB_HUB_REQ_TYPE_INVALID %d\n",setup_request->request_type); + return EINVAL; + } + if(setup_request->request == USB_DEVREQ_SET_ADDRESS){ + usb_log_debug("USB_DEVREQ_SET_ADDRESS\n"); + return process_address_set_request(instance, setup_request->value); + } + usb_log_debug("USB_DEVREQ_SET_ENOTSUP %d\n",setup_request->request_type); + return ENOTSUP; +} + +/** + * process hub control request + * + * If needed, writes answer into the request structure. + * Request can be one of + * USB_DEVREQ_GET_STATUS, + * USB_DEVREQ_GET_DESCRIPTOR, + * USB_DEVREQ_GET_CONFIGURATION, + * USB_DEVREQ_CLEAR_FEATURE, + * USB_DEVREQ_SET_FEATURE, + * USB_DEVREQ_SET_ADDRESS, + * USB_DEVREQ_SET_DESCRIPTOR or + * USB_DEVREQ_SET_CONFIGURATION. + * + * @param instance root hub instance + * @param request structure containing both request and response information + * @return error code + */ +static int process_ctrl_request(rh_t *instance, usb_transfer_batch_t *request){ + int opResult; + if (request->setup_buffer) { + if(sizeof(usb_device_request_setup_packet_t)>request->setup_size){ + usb_log_error("setup packet too small\n"); + return EINVAL; + } + usb_log_info("CTRL packet: %s.\n", + usb_debug_str_buffer((const uint8_t *)request->setup_buffer, 8, 8)); + usb_device_request_setup_packet_t * setup_request = + (usb_device_request_setup_packet_t*)request->setup_buffer; + if( + setup_request->request == USB_DEVREQ_GET_STATUS + || setup_request->request == USB_DEVREQ_GET_DESCRIPTOR + || setup_request->request == USB_DEVREQ_GET_CONFIGURATION + ){ + usb_log_debug("processing request with output\n"); + opResult = process_request_with_output(instance,request); + }else if( + setup_request->request == USB_DEVREQ_CLEAR_FEATURE + || setup_request->request == USB_DEVREQ_SET_FEATURE + || setup_request->request == USB_DEVREQ_SET_ADDRESS + ){ + usb_log_debug("processing request without additional data\n"); + opResult = process_request_without_data(instance,request); + }else if(setup_request->request == USB_DEVREQ_SET_DESCRIPTOR + || setup_request->request == USB_DEVREQ_SET_CONFIGURATION + ){ + usb_log_debug("processing request with input\n"); + opResult = process_request_with_input(instance,request); + }else{ + usb_log_warning("received unsuported request: %d\n", + setup_request->request + ); + opResult = ENOTSUP; + } + }else{ + usb_log_error("root hub received empty transaction?"); + opResult = EINVAL; + } + return opResult; +} + +/** + * process root hub request + * + * @param instance root hub instance + * @param request structure containing both request and response information + * @return error code + */ +int rh_request(rh_t *instance, usb_transfer_batch_t *request) +{ + assert(instance); + assert(request); + int opResult; + if(request->transfer_type == USB_TRANSFER_CONTROL){ + usb_log_info("Root hub got CONTROL packet\n"); + opResult = process_ctrl_request(instance,request); + }else if(request->transfer_type == USB_TRANSFER_INTERRUPT){ + usb_log_info("Root hub got INTERRUPT packet\n"); + void * buffer; + create_interrupt_mask(instance, &buffer, + &(request->transfered_size)); + memcpy(request->transport_buffer,buffer, request->transfered_size); + opResult = EOK; + }else{ + opResult = EINVAL; + } + usb_transfer_batch_finish(request, opResult); + return EOK; +} +/*----------------------------------------------------------------------------*/ + + +void rh_interrupt(rh_t *instance) +{ + usb_log_info("Whoa whoa wait, I`m not supposed to receive any interrupts, am I?\n"); + /* TODO: implement? */ +} +/** + * @} + */ Index: uspace/drv/ohci/root_hub.h =================================================================== --- uspace/drv/ohci/root_hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/root_hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,68 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * @brief OHCI driver + */ +#ifndef DRV_OHCI_ROOT_HUB_H +#define DRV_OHCI_ROOT_HUB_H + +#include +#include + +#include "ohci_regs.h" +#include "batch.h" + +/** + * ohci root hub representation + */ +typedef struct rh { + /** pointer to ohci driver registers */ + ohci_regs_t *registers; + /** usb address of the root hub */ + usb_address_t address; + /** ddf device information */ + ddf_dev_t *device; + /** hub port count */ + int port_count; + /** hubs descriptors */ + usb_device_descriptors_t descriptors; +} rh_t; + +int rh_init(rh_t *instance, ddf_dev_t *dev, ohci_regs_t *regs); + +int rh_request(rh_t *instance, usb_transfer_batch_t *request); + +void rh_interrupt(rh_t *instance); +#endif +/** + * @} + */ Index: uspace/drv/ohci/utils/malloc32.h =================================================================== --- uspace/drv/ohci/utils/malloc32.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/utils/malloc32.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,96 @@ +/* + * Copyright (c) 2010 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup usb + * @{ + */ +/** @file + * @brief UHCI driver + */ +#ifndef DRV_UHCI_TRANSLATOR_H +#define DRV_UHCI_TRANSLATOR_H + +#include +#include +#include +#include + +#define UHCI_STRCUTURES_ALIGNMENT 16 +#define UHCI_REQUIRED_PAGE_SIZE 4096 + +/** Get physical address translation + * + * @param[in] addr Virtual address to translate + * @return Physical address if exists, NULL otherwise. + */ +static inline uintptr_t addr_to_phys(void *addr) +{ + uintptr_t result; + int ret = as_get_physical_mapping(addr, &result); + + if (ret != EOK) + return 0; + return (result | ((uintptr_t)addr & 0xfff)); +} +/*----------------------------------------------------------------------------*/ +/** Physical mallocator simulator + * + * @param[in] size Size of the required memory space + * @return Address of the alligned and big enough memory place, NULL on failure. + */ +static inline void * malloc32(size_t size) + { return memalign(UHCI_STRCUTURES_ALIGNMENT, size); } +/*----------------------------------------------------------------------------*/ +/** Physical mallocator simulator + * + * @param[in] addr Address of the place allocated by malloc32 + */ +static inline void free32(void *addr) + { if (addr) free(addr); } +/*----------------------------------------------------------------------------*/ +/** Create 4KB page mapping + * + * @return Address of the mapped page, NULL on failure. + */ +static inline void * get_page(void) +{ + void * free_address = as_get_mappable_page(UHCI_REQUIRED_PAGE_SIZE); + assert(free_address); + if (free_address == 0) + return NULL; + void* ret = + as_area_create(free_address, UHCI_REQUIRED_PAGE_SIZE, + AS_AREA_READ | AS_AREA_WRITE); + if (ret != free_address) + return NULL; + return ret; +} + +#endif +/** + * @} + */ Index: uspace/drv/pciintel/pci.c =================================================================== --- uspace/drv/pciintel/pci.c (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/drv/pciintel/pci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -52,8 +52,13 @@ #include #include +#include +#include +#include +#include #include #include #include #include +#include #include "pci.h" @@ -84,7 +89,90 @@ static bool pciintel_enable_interrupt(ddf_fun_t *fnode) { - /* TODO */ - - return false; + /* This is an old ugly way, copied from ne2000 driver */ + assert(fnode); + pci_fun_t *dev_data = (pci_fun_t *) fnode->driver_data; + + sysarg_t apic; + sysarg_t i8259; + + int irc_phone = ENOTSUP; + + if (((sysinfo_get_value("apic", &apic) == EOK) && (apic)) + || ((sysinfo_get_value("i8259", &i8259) == EOK) && (i8259))) { + irc_phone = service_connect_blocking(SERVICE_IRC, 0, 0); + } + + if (irc_phone < 0) { + return false; + } + + size_t i; + for (i = 0; i < dev_data->hw_resources.count; i++) { + if (dev_data->hw_resources.resources[i].type == INTERRUPT) { + int irq = dev_data->hw_resources.resources[i].res.interrupt.irq; + int rc = async_req_1_0(irc_phone, IRC_ENABLE_INTERRUPT, irq); + if (rc != EOK) { + async_hangup(irc_phone); + return false; + } + } + } + + async_hangup(irc_phone); + return true; +} + +static int pci_config_space_write_32( + ddf_fun_t *fun, uint32_t address, uint32_t data) +{ + if (address > 252) + return EINVAL; + pci_conf_write_32(PCI_FUN(fun), address, data); + return EOK; +} + +static int pci_config_space_write_16( + ddf_fun_t *fun, uint32_t address, uint16_t data) +{ + if (address > 254) + return EINVAL; + pci_conf_write_16(PCI_FUN(fun), address, data); + return EOK; +} + +static int pci_config_space_write_8( + ddf_fun_t *fun, uint32_t address, uint8_t data) +{ + if (address > 255) + return EINVAL; + pci_conf_write_8(PCI_FUN(fun), address, data); + return EOK; +} + +static int pci_config_space_read_32( + ddf_fun_t *fun, uint32_t address, uint32_t *data) +{ + if (address > 252) + return EINVAL; + *data = pci_conf_read_32(PCI_FUN(fun), address); + return EOK; +} + +static int pci_config_space_read_16( + ddf_fun_t *fun, uint32_t address, uint16_t *data) +{ + if (address > 254) + return EINVAL; + *data = pci_conf_read_16(PCI_FUN(fun), address); + return EOK; +} + +static int pci_config_space_read_8( + ddf_fun_t *fun, uint32_t address, uint8_t *data) +{ + if (address > 255) + return EINVAL; + *data = pci_conf_read_8(PCI_FUN(fun), address); + return EOK; } @@ -94,5 +182,17 @@ }; -static ddf_dev_ops_t pci_fun_ops; +static pci_dev_iface_t pci_dev_ops = { + .config_space_read_8 = &pci_config_space_read_8, + .config_space_read_16 = &pci_config_space_read_16, + .config_space_read_32 = &pci_config_space_read_32, + .config_space_write_8 = &pci_config_space_write_8, + .config_space_write_16 = &pci_config_space_write_16, + .config_space_write_32 = &pci_config_space_write_32 +}; + +static ddf_dev_ops_t pci_fun_ops = { + .interfaces[HW_RES_DEV_IFACE] = &pciintel_hw_res_ops, + .interfaces[PCI_DEV_IFACE] = &pci_dev_ops +}; static int pci_add_device(ddf_dev_t *); @@ -288,9 +388,14 @@ /* Get the value of the BAR. */ val = pci_conf_read_32(fun, addr); + +#define IO_MASK (~0x3) +#define MEM_MASK (~0xf) io = (bool) (val & 1); if (io) { addrw64 = false; + mask = IO_MASK; } else { + mask = MEM_MASK; switch ((val >> 1) & 3) { case 0: @@ -308,5 +413,5 @@ /* Get the address mask. */ pci_conf_write_32(fun, addr, 0xffffffff); - mask = pci_conf_read_32(fun, addr); + mask &= pci_conf_read_32(fun, addr); /* Restore the original value. */ @@ -558,4 +663,5 @@ ddf_log_init(NAME, LVL_ERROR); pci_fun_ops.interfaces[HW_RES_DEV_IFACE] = &pciintel_hw_res_ops; + pci_fun_ops.interfaces[PCI_DEV_IFACE] = &pci_dev_ops; } @@ -629,5 +735,6 @@ size_t pci_bar_mask_to_size(uint32_t mask) { - return ((mask & 0xfffffff0) ^ 0xffffffff) + 1; + size_t size = mask & ~(mask - 1); + return size; } Index: uspace/drv/rootvirt/devices.def =================================================================== --- uspace/drv/rootvirt/devices.def (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/drv/rootvirt/devices.def (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -22,2 +22,9 @@ }, #endif +#ifdef CONFIG_RUN_VIRTUAL_USB_HC +/* Virtual USB host controller. */ +{ + .name = "usbhc", + .match_id = "usb&hc=vhc" +}, +#endif Index: uspace/drv/uhci-hcd/Makefile =================================================================== --- uspace/drv/uhci-hcd/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,46 @@ +# +# Copyright (c) 2010 Vojtech Horky +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBS = $(LIBDRV_PREFIX)/libdrv.a $(LIBUSB_PREFIX)/libusb.a +EXTRA_CFLAGS += -I$(LIBDRV_PREFIX)/include -I$(LIBUSB_PREFIX)/include -I. +BINARY = uhci-hcd + +SOURCES = \ + iface.c \ + main.c \ + transfer_list.c \ + uhci.c \ + hc.c \ + root_hub.c \ + hw_struct/transfer_descriptor.c \ + utils/slab.c \ + pci.c \ + batch.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/uhci-hcd/batch.c =================================================================== --- uspace/drv/uhci-hcd/batch.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/batch.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,462 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver USB transaction structure + */ +#include +#include + +#include +#include + +#include "batch.h" +#include "transfer_list.h" +#include "hw_struct/transfer_descriptor.h" +#include "utils/malloc32.h" + +#define DEFAULT_ERROR_COUNT 3 + +typedef struct uhci_batch { + qh_t *qh; + td_t *tds; + size_t transfers; + usb_device_keeper_t *manager; +} uhci_batch_t; + +static void batch_control(usb_transfer_batch_t *instance, + usb_packet_id data_stage, usb_packet_id status_stage); +static void batch_data(usb_transfer_batch_t *instance, usb_packet_id pid); +static void batch_call_in_and_dispose(usb_transfer_batch_t *instance); +static void batch_call_out_and_dispose(usb_transfer_batch_t *instance); + + +/** Allocate memory and initialize internal data structure. + * + * @param[in] fun DDF function to pass to callback. + * @param[in] target Device and endpoint target of the transaction. + * @param[in] transfer_type Interrupt, Control or Bulk. + * @param[in] max_packet_size maximum allowed size of data transfers. + * @param[in] speed Speed of the transaction. + * @param[in] buffer Data source/destination. + * @param[in] size Size of the buffer. + * @param[in] setup_buffer Setup data source (if not NULL) + * @param[in] setup_size Size of setup_buffer (should be always 8) + * @param[in] func_in function to call on inbound transaction completion + * @param[in] func_out function to call on outbound transaction completion + * @param[in] arg additional parameter to func_in or func_out + * @param[in] manager Pointer to toggle management structure. + * @return Valid pointer if all substructures were successfully created, + * NULL otherwise. + * + * Determines the number of needed transfers (TDs). Prepares a transport buffer + * (that is accessible by the hardware). Initializes parameters needed for the + * transaction and callback. + */ +usb_transfer_batch_t * batch_get(ddf_fun_t *fun, usb_target_t target, + usb_transfer_type_t transfer_type, size_t max_packet_size, + usb_speed_t speed, char *buffer, size_t buffer_size, + char* setup_buffer, size_t setup_size, + usbhc_iface_transfer_in_callback_t func_in, + usbhc_iface_transfer_out_callback_t func_out, void *arg, + usb_device_keeper_t *manager + ) +{ + assert(func_in == NULL || func_out == NULL); + assert(func_in != NULL || func_out != NULL); + +#define CHECK_NULL_DISPOSE_RETURN(ptr, message...) \ + if (ptr == NULL) { \ + usb_log_error(message); \ + if (instance) { \ + batch_dispose(instance); \ + } \ + return NULL; \ + } else (void)0 + + usb_transfer_batch_t *instance = malloc(sizeof(usb_transfer_batch_t)); + CHECK_NULL_DISPOSE_RETURN(instance, + "Failed to allocate batch instance.\n"); + usb_transfer_batch_init(instance, target, transfer_type, speed, max_packet_size, + buffer, NULL, buffer_size, NULL, setup_size, func_in, + func_out, arg, fun, NULL); + + + uhci_batch_t *data = malloc(sizeof(uhci_batch_t)); + CHECK_NULL_DISPOSE_RETURN(instance, + "Failed to allocate batch instance.\n"); + bzero(data, sizeof(uhci_batch_t)); + data->manager = manager; + instance->private_data = data; + + data->transfers = (buffer_size + max_packet_size - 1) / max_packet_size; + if (transfer_type == USB_TRANSFER_CONTROL) { + data->transfers += 2; + } + + data->tds = malloc32(sizeof(td_t) * data->transfers); + CHECK_NULL_DISPOSE_RETURN( + data->tds, "Failed to allocate transfer descriptors.\n"); + bzero(data->tds, sizeof(td_t) * data->transfers); + + data->qh = malloc32(sizeof(qh_t)); + CHECK_NULL_DISPOSE_RETURN(data->qh, + "Failed to allocate batch queue head.\n"); + qh_init(data->qh); + qh_set_element_td(data->qh, addr_to_phys(data->tds)); + + if (buffer_size > 0) { + instance->transport_buffer = malloc32(buffer_size); + CHECK_NULL_DISPOSE_RETURN(instance->transport_buffer, + "Failed to allocate device accessible buffer.\n"); + } + + if (setup_size > 0) { + instance->setup_buffer = malloc32(setup_size); + CHECK_NULL_DISPOSE_RETURN(instance->setup_buffer, + "Failed to allocate device accessible setup buffer.\n"); + memcpy(instance->setup_buffer, setup_buffer, setup_size); + } + + usb_log_debug("Batch(%p) %d:%d memory structures ready.\n", + instance, target.address, target.endpoint); + return instance; +} +/*----------------------------------------------------------------------------*/ +/** Check batch TDs for activity. + * + * @param[in] instance Batch structure to use. + * @return False, if there is an active TD, true otherwise. + * + * Walk all TDs. Stop with false if there is an active one (it is to be + * processed). Stop with true if an error is found. Return true if the last TS + * is reached. + */ +bool batch_is_complete(usb_transfer_batch_t *instance) +{ + assert(instance); + uhci_batch_t *data = instance->private_data; + assert(data); + + usb_log_debug2("Batch(%p) checking %d transfer(s) for completion.\n", + instance, data->transfers); + instance->transfered_size = 0; + size_t i = 0; + for (;i < data->transfers; ++i) { + if (td_is_active(&data->tds[i])) { + return false; + } + + instance->error = td_status(&data->tds[i]); + if (instance->error != EOK) { + usb_log_debug("Batch(%p) found error TD(%d):%x.\n", + instance, i, data->tds[i].status); + td_print_status(&data->tds[i]); + + usb_device_keeper_set_toggle(data->manager, + instance->target, instance->direction, + td_toggle(&data->tds[i])); + if (i > 0) + goto substract_ret; + return true; + } + + instance->transfered_size += td_act_size(&data->tds[i]); + if (td_is_short(&data->tds[i])) + goto substract_ret; + } +substract_ret: + instance->transfered_size -= instance->setup_size; + return true; +} +/*----------------------------------------------------------------------------*/ +/** Prepares control write transaction. + * + * @param[in] instance Batch structure to use. + * + * Uses genercir control function with pids OUT and IN. + */ +void batch_control_write(usb_transfer_batch_t *instance) +{ + assert(instance); + /* We are data out, we are supposed to provide data */ + memcpy(instance->transport_buffer, instance->buffer, + instance->buffer_size); + batch_control(instance, USB_PID_OUT, USB_PID_IN); + instance->next_step = batch_call_out_and_dispose; + usb_log_debug("Batch(%p) CONTROL WRITE initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepares control read transaction. + * + * @param[in] instance Batch structure to use. + * + * Uses generic control with pids IN and OUT. + */ +void batch_control_read(usb_transfer_batch_t *instance) +{ + assert(instance); + batch_control(instance, USB_PID_IN, USB_PID_OUT); + instance->next_step = batch_call_in_and_dispose; + usb_log_debug("Batch(%p) CONTROL READ initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare interrupt in transaction. + * + * @param[in] instance Batch structure to use. + * + * Data transaction with PID_IN. + */ +void batch_interrupt_in(usb_transfer_batch_t *instance) +{ + assert(instance); + instance->direction = USB_DIRECTION_IN; + batch_data(instance, USB_PID_IN); + instance->next_step = batch_call_in_and_dispose; + usb_log_debug("Batch(%p) INTERRUPT IN initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare interrupt out transaction. + * + * @param[in] instance Batch structure to use. + * + * Data transaction with PID_OUT. + */ +void batch_interrupt_out(usb_transfer_batch_t *instance) +{ + assert(instance); + instance->direction = USB_DIRECTION_OUT; + /* We are data out, we are supposed to provide data */ + memcpy(instance->transport_buffer, instance->buffer, + instance->buffer_size); + batch_data(instance, USB_PID_OUT); + instance->next_step = batch_call_out_and_dispose; + usb_log_debug("Batch(%p) INTERRUPT OUT initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare bulk in transaction. + * + * @param[in] instance Batch structure to use. + * + * Data transaction with PID_IN. + */ +void batch_bulk_in(usb_transfer_batch_t *instance) +{ + assert(instance); + batch_data(instance, USB_PID_IN); + instance->direction = USB_DIRECTION_IN; + instance->next_step = batch_call_in_and_dispose; + usb_log_debug("Batch(%p) BULK IN initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare bulk out transaction. + * + * @param[in] instance Batch structure to use. + * + * Data transaction with PID_OUT. + */ +void batch_bulk_out(usb_transfer_batch_t *instance) +{ + assert(instance); + instance->direction = USB_DIRECTION_OUT; + /* We are data out, we are supposed to provide data */ + memcpy(instance->transport_buffer, instance->buffer, + instance->buffer_size); + batch_data(instance, USB_PID_OUT); + instance->next_step = batch_call_out_and_dispose; + usb_log_debug("Batch(%p) BULK OUT initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare generic data transaction + * + * @param[in] instance Batch structure to use. + * @param[in] pid Pid to use for data transfers. + * + * Packets with alternating toggle bit and supplied pid value. + * The last transfer is marked with IOC flag. + */ +void batch_data(usb_transfer_batch_t *instance, usb_packet_id pid) +{ + assert(instance); + uhci_batch_t *data = instance->private_data; + assert(data); + + const bool low_speed = instance->speed == USB_SPEED_LOW; + int toggle = usb_device_keeper_get_toggle( + data->manager, instance->target, instance->direction); + assert(toggle == 0 || toggle == 1); + + size_t transfer = 0; + size_t remain_size = instance->buffer_size; + while (remain_size > 0) { + char *trans_data = + instance->transport_buffer + instance->buffer_size + - remain_size; + + const size_t packet_size = + (instance->max_packet_size > remain_size) ? + remain_size : instance->max_packet_size; + + td_t *next_transfer = (transfer + 1 < data->transfers) + ? &data->tds[transfer + 1] : NULL; + + assert(transfer < data->transfers); + assert(packet_size <= remain_size); + + td_init( + &data->tds[transfer], DEFAULT_ERROR_COUNT, packet_size, + toggle, false, low_speed, instance->target, pid, trans_data, + next_transfer); + + + toggle = 1 - toggle; + remain_size -= packet_size; + ++transfer; + } + td_set_ioc(&data->tds[transfer - 1]); + usb_device_keeper_set_toggle(data->manager, instance->target, + instance->direction, toggle); +} +/*----------------------------------------------------------------------------*/ +/** Prepare generic control transaction + * + * @param[in] instance Batch structure to use. + * @param[in] data_stage Pid to use for data transfers. + * @param[in] status_stage Pid to use for data transfers. + * + * Setup stage with toggle 0 and USB_PID_SETUP. + * Data stage with alternating toggle and pid supplied by parameter. + * Status stage with toggle 1 and pid supplied by parameter. + * The last transfer is marked with IOC. + */ +void batch_control(usb_transfer_batch_t *instance, + usb_packet_id data_stage, usb_packet_id status_stage) +{ + assert(instance); + uhci_batch_t *data = instance->private_data; + assert(data); + assert(data->transfers >= 2); + + const bool low_speed = instance->speed == USB_SPEED_LOW; + int toggle = 0; + /* setup stage */ + td_init( + data->tds, DEFAULT_ERROR_COUNT, instance->setup_size, toggle, false, + low_speed, instance->target, USB_PID_SETUP, instance->setup_buffer, + &data->tds[1]); + + /* data stage */ + size_t transfer = 1; + size_t remain_size = instance->buffer_size; + while (remain_size > 0) { + char *control_data = + instance->transport_buffer + instance->buffer_size + - remain_size; + + toggle = 1 - toggle; + + const size_t packet_size = + (instance->max_packet_size > remain_size) ? + remain_size : instance->max_packet_size; + + td_init( + &data->tds[transfer], DEFAULT_ERROR_COUNT, packet_size, + toggle, false, low_speed, instance->target, data_stage, + control_data, &data->tds[transfer + 1]); + + ++transfer; + assert(transfer < data->transfers); + assert(packet_size <= remain_size); + remain_size -= packet_size; + } + + /* status stage */ + assert(transfer == data->transfers - 1); + + td_init( + &data->tds[transfer], DEFAULT_ERROR_COUNT, 0, 1, false, low_speed, + instance->target, status_stage, NULL, NULL); + td_set_ioc(&data->tds[transfer]); + + usb_log_debug2("Control last TD status: %x.\n", + data->tds[transfer].status); +} +/*----------------------------------------------------------------------------*/ +qh_t * batch_qh(usb_transfer_batch_t *instance) +{ + assert(instance); + uhci_batch_t *data = instance->private_data; + assert(data); + return data->qh; +} +/*----------------------------------------------------------------------------*/ +/** Helper function calls callback and correctly disposes of batch structure. + * + * @param[in] instance Batch structure to use. + */ +void batch_call_in_and_dispose(usb_transfer_batch_t *instance) +{ + assert(instance); + usb_transfer_batch_call_in(instance); + batch_dispose(instance); +} +/*----------------------------------------------------------------------------*/ +/** Helper function calls callback and correctly disposes of batch structure. + * + * @param[in] instance Batch structure to use. + */ +void batch_call_out_and_dispose(usb_transfer_batch_t *instance) +{ + assert(instance); + usb_transfer_batch_call_out(instance); + batch_dispose(instance); +} +/*----------------------------------------------------------------------------*/ +/** Correctly dispose all used data structures. + * + * @param[in] instance Batch structure to use. + */ +void batch_dispose(usb_transfer_batch_t *instance) +{ + assert(instance); + uhci_batch_t *data = instance->private_data; + assert(data); + usb_log_debug("Batch(%p) disposing.\n", instance); + /* free32 is NULL safe */ + free32(data->tds); + free32(data->qh); + free32(instance->setup_buffer); + free32(instance->transport_buffer); + free(data); + free(instance); +} +/** + * @} + */ Index: uspace/drv/uhci-hcd/batch.h =================================================================== --- uspace/drv/uhci-hcd/batch.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/batch.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,82 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver USB transaction structure + */ +#ifndef DRV_UHCI_BATCH_H +#define DRV_UHCI_BATCH_H + +#include + +#include +#include +#include +#include + +#include "hw_struct/queue_head.h" + +usb_transfer_batch_t * batch_get( + ddf_fun_t *fun, + usb_target_t target, + usb_transfer_type_t transfer_type, + size_t max_packet_size, + usb_speed_t speed, + char *buffer, + size_t size, + char *setup_buffer, + size_t setup_size, + usbhc_iface_transfer_in_callback_t func_in, + usbhc_iface_transfer_out_callback_t func_out, + void *arg, + usb_device_keeper_t *manager + ); + +void batch_dispose(usb_transfer_batch_t *instance); + +bool batch_is_complete(usb_transfer_batch_t *instance); + +void batch_control_write(usb_transfer_batch_t *instance); + +void batch_control_read(usb_transfer_batch_t *instance); + +void batch_interrupt_in(usb_transfer_batch_t *instance); + +void batch_interrupt_out(usb_transfer_batch_t *instance); + +void batch_bulk_in(usb_transfer_batch_t *instance); + +void batch_bulk_out(usb_transfer_batch_t *instance); + +qh_t * batch_qh(usb_transfer_batch_t *instance); +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/hc.c =================================================================== --- uspace/drv/uhci-hcd/hc.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/hc.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,520 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI Host controller driver routines + */ +#include +#include +#include +#include + +#include +#include +#include +#include + +#include "hc.h" + +static irq_cmd_t uhci_cmds[] = { + { + .cmd = CMD_PIO_READ_16, + .addr = NULL, /* patched for every instance */ + .dstarg = 1 + }, + { + .cmd = CMD_PIO_WRITE_16, + .addr = NULL, /* pathed for every instance */ + .value = 0x1f + }, + { + .cmd = CMD_ACCEPT + } +}; +/*----------------------------------------------------------------------------*/ +static int hc_init_transfer_lists(hc_t *instance); +static int hc_init_mem_structures(hc_t *instance); +static void hc_init_hw(hc_t *instance); + +static int hc_interrupt_emulator(void *arg); +static int hc_debug_checker(void *arg); + +static bool usb_is_allowed( + bool low_speed, usb_transfer_type_t transfer, size_t size); +/*----------------------------------------------------------------------------*/ +/** Initialize UHCI hcd driver structure + * + * @param[in] instance Memory place to initialize. + * @param[in] fun DDF function. + * @param[in] regs Address of I/O control registers. + * @param[in] size Size of I/O control registers. + * @return Error code. + * @note Should be called only once on any structure. + * + * Initializes memory structures, starts up hw, and launches debugger and + * interrupt fibrils. + */ +int hc_init(hc_t *instance, ddf_fun_t *fun, + void *regs, size_t reg_size, bool interrupts) +{ + assert(reg_size >= sizeof(regs_t)); + int ret; + +#define CHECK_RET_DEST_FUN_RETURN(ret, message...) \ + if (ret != EOK) { \ + usb_log_error(message); \ + if (instance->ddf_instance) \ + ddf_fun_destroy(instance->ddf_instance); \ + return ret; \ + } else (void) 0 + + instance->hw_interrupts = interrupts; + instance->hw_failures = 0; + + /* Setup UHCI function. */ + instance->ddf_instance = fun; + + /* allow access to hc control registers */ + regs_t *io; + ret = pio_enable(regs, reg_size, (void**)&io); + CHECK_RET_DEST_FUN_RETURN(ret, + "Failed(%d) to gain access to registers at %p: %s.\n", + ret, str_error(ret), io); + instance->registers = io; + usb_log_debug("Device registers at %p(%u) accessible.\n", + io, reg_size); + + ret = hc_init_mem_structures(instance); + CHECK_RET_DEST_FUN_RETURN(ret, + "Failed to initialize UHCI memory structures.\n"); + + hc_init_hw(instance); + if (!interrupts) { + instance->cleaner = + fibril_create(hc_interrupt_emulator, instance); + fibril_add_ready(instance->cleaner); + } else { + /* TODO: enable interrupts here */ + } + + instance->debug_checker = + fibril_create(hc_debug_checker, instance); +// fibril_add_ready(instance->debug_checker); + + return EOK; +#undef CHECK_RET_DEST_FUN_RETURN +} +/*----------------------------------------------------------------------------*/ +/** Initialize UHCI hc hw resources. + * + * @param[in] instance UHCI structure to use. + * For magic values see UHCI Design Guide + */ +void hc_init_hw(hc_t *instance) +{ + assert(instance); + regs_t *registers = instance->registers; + + /* Reset everything, who knows what touched it before us */ + pio_write_16(®isters->usbcmd, UHCI_CMD_GLOBAL_RESET); + async_usleep(10000); /* 10ms according to USB spec */ + pio_write_16(®isters->usbcmd, 0); + + /* Reset hc, all states and counters */ + pio_write_16(®isters->usbcmd, UHCI_CMD_HCRESET); + do { async_usleep(10); } + while ((pio_read_16(®isters->usbcmd) & UHCI_CMD_HCRESET) != 0); + + /* Set frame to exactly 1ms */ + pio_write_8(®isters->sofmod, 64); + + /* Set frame list pointer */ + const uint32_t pa = addr_to_phys(instance->frame_list); + pio_write_32(®isters->flbaseadd, pa); + + if (instance->hw_interrupts) { + /* Enable all interrupts, but resume interrupt */ + pio_write_16(&instance->registers->usbintr, + UHCI_INTR_CRC | UHCI_INTR_COMPLETE | UHCI_INTR_SHORT_PACKET); + } + + uint16_t status = pio_read_16(®isters->usbcmd); + if (status != 0) + usb_log_warning("Previous command value: %x.\n", status); + + /* Start the hc with large(64B) packet FSBR */ + pio_write_16(®isters->usbcmd, + UHCI_CMD_RUN_STOP | UHCI_CMD_MAX_PACKET | UHCI_CMD_CONFIGURE); +} +/*----------------------------------------------------------------------------*/ +/** Initialize UHCI hc memory structures. + * + * @param[in] instance UHCI structure to use. + * @return Error code + * @note Should be called only once on any structure. + * + * Structures: + * - interrupt code (I/O addressses are customized per instance) + * - transfer lists (queue heads need to be accessible by the hw) + * - frame list page (needs to be one UHCI hw accessible 4K page) + */ +int hc_init_mem_structures(hc_t *instance) +{ + assert(instance); +#define CHECK_RET_DEST_CMDS_RETURN(ret, message...) \ + if (ret != EOK) { \ + usb_log_error(message); \ + if (instance->interrupt_code.cmds != NULL) \ + free(instance->interrupt_code.cmds); \ + return ret; \ + } else (void) 0 + + /* Init interrupt code */ + instance->interrupt_code.cmds = malloc(sizeof(uhci_cmds)); + int ret = (instance->interrupt_code.cmds == NULL) ? ENOMEM : EOK; + CHECK_RET_DEST_CMDS_RETURN(ret, + "Failed to allocate interrupt cmds space.\n"); + + { + irq_cmd_t *interrupt_commands = instance->interrupt_code.cmds; + memcpy(interrupt_commands, uhci_cmds, sizeof(uhci_cmds)); + interrupt_commands[0].addr = + (void*)&instance->registers->usbsts; + interrupt_commands[1].addr = + (void*)&instance->registers->usbsts; + instance->interrupt_code.cmdcount = + sizeof(uhci_cmds) / sizeof(irq_cmd_t); + } + + /* Init transfer lists */ + ret = hc_init_transfer_lists(instance); + CHECK_RET_DEST_CMDS_RETURN(ret, "Failed to init transfer lists.\n"); + usb_log_debug("Initialized transfer lists.\n"); + + /* Init USB frame list page*/ + instance->frame_list = get_page(); + ret = instance ? EOK : ENOMEM; + CHECK_RET_DEST_CMDS_RETURN(ret, "Failed to get frame list page.\n"); + usb_log_debug("Initialized frame list at %p.\n", instance->frame_list); + + /* Set all frames to point to the first queue head */ + const uint32_t queue = + instance->transfers_interrupt.queue_head_pa + | LINK_POINTER_QUEUE_HEAD_FLAG; + + unsigned i = 0; + for(; i < UHCI_FRAME_LIST_COUNT; ++i) { + instance->frame_list[i] = queue; + } + + /* Init device keeper*/ + usb_device_keeper_init(&instance->manager); + usb_log_debug("Initialized device manager.\n"); + + return EOK; +#undef CHECK_RET_DEST_CMDS_RETURN +} +/*----------------------------------------------------------------------------*/ +/** Initialize UHCI hc transfer lists. + * + * @param[in] instance UHCI structure to use. + * @return Error code + * @note Should be called only once on any structure. + * + * Initializes transfer lists and sets them in one chain to support proper + * USB scheduling. Sets pointer table for quick access. + */ +int hc_init_transfer_lists(hc_t *instance) +{ + assert(instance); +#define CHECK_RET_CLEAR_RETURN(ret, message...) \ + if (ret != EOK) { \ + usb_log_error(message); \ + transfer_list_fini(&instance->transfers_bulk_full); \ + transfer_list_fini(&instance->transfers_control_full); \ + transfer_list_fini(&instance->transfers_control_slow); \ + transfer_list_fini(&instance->transfers_interrupt); \ + return ret; \ + } else (void) 0 + + /* initialize TODO: check errors */ + int ret; + ret = transfer_list_init(&instance->transfers_bulk_full, "BULK_FULL"); + CHECK_RET_CLEAR_RETURN(ret, "Failed to init BULK list."); + + ret = transfer_list_init( + &instance->transfers_control_full, "CONTROL_FULL"); + CHECK_RET_CLEAR_RETURN(ret, "Failed to init CONTROL FULL list."); + + ret = transfer_list_init( + &instance->transfers_control_slow, "CONTROL_SLOW"); + CHECK_RET_CLEAR_RETURN(ret, "Failed to init CONTROL SLOW list."); + + ret = transfer_list_init(&instance->transfers_interrupt, "INTERRUPT"); + CHECK_RET_CLEAR_RETURN(ret, "Failed to init INTERRUPT list."); + + transfer_list_set_next(&instance->transfers_control_full, + &instance->transfers_bulk_full); + transfer_list_set_next(&instance->transfers_control_slow, + &instance->transfers_control_full); + transfer_list_set_next(&instance->transfers_interrupt, + &instance->transfers_control_slow); + + /*FSBR*/ +#ifdef FSBR + transfer_list_set_next(&instance->transfers_bulk_full, + &instance->transfers_control_full); +#endif + + /* Assign pointers to be used during scheduling */ + instance->transfers[USB_SPEED_FULL][USB_TRANSFER_INTERRUPT] = + &instance->transfers_interrupt; + instance->transfers[USB_SPEED_LOW][USB_TRANSFER_INTERRUPT] = + &instance->transfers_interrupt; + instance->transfers[USB_SPEED_FULL][USB_TRANSFER_CONTROL] = + &instance->transfers_control_full; + instance->transfers[USB_SPEED_LOW][USB_TRANSFER_CONTROL] = + &instance->transfers_control_slow; + instance->transfers[USB_SPEED_FULL][USB_TRANSFER_BULK] = + &instance->transfers_bulk_full; + + return EOK; +#undef CHECK_RET_CLEAR_RETURN +} +/*----------------------------------------------------------------------------*/ +/** Schedule batch for execution. + * + * @param[in] instance UHCI structure to use. + * @param[in] batch Transfer batch to schedule. + * @return Error code + * + * Checks for bandwidth availability and appends the batch to the proper queue. + */ +int hc_schedule(hc_t *instance, usb_transfer_batch_t *batch) +{ + assert(instance); + assert(batch); + const int low_speed = (batch->speed == USB_SPEED_LOW); + if (!usb_is_allowed( + low_speed, batch->transfer_type, batch->max_packet_size)) { + usb_log_warning( + "Invalid USB transfer specified %s SPEED %d %zu.\n", + low_speed ? "LOW" : "FULL" , batch->transfer_type, + batch->max_packet_size); + return ENOTSUP; + } + /* TODO: check available bandwidth here */ + + transfer_list_t *list = + instance->transfers[batch->speed][batch->transfer_type]; + assert(list); + if (batch->transfer_type == USB_TRANSFER_CONTROL) { + usb_device_keeper_use_control( + &instance->manager, batch->target.address); + } + transfer_list_add_batch(list, batch); + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Take action based on the interrupt cause. + * + * @param[in] instance UHCI structure to use. + * @param[in] status Value of the status register at the time of interrupt. + * + * Interrupt might indicate: + * - transaction completed, either by triggering IOC, SPD, or an error + * - some kind of device error + * - resume from suspend state (not implemented) + */ +void hc_interrupt(hc_t *instance, uint16_t status) +{ + assert(instance); + /* TODO: Resume interrupts are not supported */ + /* Lower 2 bits are transaction error and transaction complete */ + if (status & 0x3) { + LIST_INITIALIZE(done); + transfer_list_remove_finished( + &instance->transfers_interrupt, &done); + transfer_list_remove_finished( + &instance->transfers_control_slow, &done); + transfer_list_remove_finished( + &instance->transfers_control_full, &done); + transfer_list_remove_finished( + &instance->transfers_bulk_full, &done); + + while (!list_empty(&done)) { + link_t *item = done.next; + list_remove(item); + usb_transfer_batch_t *batch = + list_get_instance(item, usb_transfer_batch_t, link); + if (batch->transfer_type == USB_TRANSFER_CONTROL) { + usb_device_keeper_release_control( + &instance->manager, batch->target.address); + } + batch->next_step(batch); + } + } + /* bits 4 and 5 indicate hc error */ + if (status & 0x18) { + usb_log_error("UHCI hardware failure!.\n"); + ++instance->hw_failures; + transfer_list_abort_all(&instance->transfers_interrupt); + transfer_list_abort_all(&instance->transfers_control_slow); + transfer_list_abort_all(&instance->transfers_control_full); + transfer_list_abort_all(&instance->transfers_bulk_full); + + if (instance->hw_failures < UHCI_ALLOWED_HW_FAIL) { + /* reinitialize hw, this triggers virtual disconnect*/ + hc_init_hw(instance); + } else { + usb_log_fatal("Too many UHCI hardware failures!.\n"); + hc_fini(instance); + } + } +} +/*----------------------------------------------------------------------------*/ +/** Polling function, emulates interrupts. + * + * @param[in] arg UHCI hc structure to use. + * @return EOK (should never return) + */ +int hc_interrupt_emulator(void* arg) +{ + usb_log_debug("Started interrupt emulator.\n"); + hc_t *instance = (hc_t*)arg; + assert(instance); + + while (1) { + /* read and ack interrupts */ + uint16_t status = pio_read_16(&instance->registers->usbsts); + pio_write_16(&instance->registers->usbsts, 0x1f); + if (status != 0) + usb_log_debug2("UHCI status: %x.\n", status); + hc_interrupt(instance, status); + async_usleep(UHCI_CLEANER_TIMEOUT); + } + return EOK; +} +/*---------------------------------------------------------------------------*/ +/** Debug function, checks consistency of memory structures. + * + * @param[in] arg UHCI structure to use. + * @return EOK (should never return) + */ +int hc_debug_checker(void *arg) +{ + hc_t *instance = (hc_t*)arg; + assert(instance); + +#define QH(queue) \ + instance->transfers_##queue.queue_head + + while (1) { + const uint16_t cmd = pio_read_16(&instance->registers->usbcmd); + const uint16_t sts = pio_read_16(&instance->registers->usbsts); + const uint16_t intr = + pio_read_16(&instance->registers->usbintr); + + if (((cmd & UHCI_CMD_RUN_STOP) != 1) || (sts != 0)) { + usb_log_debug2("Command: %X Status: %X Intr: %x\n", + cmd, sts, intr); + } + + uintptr_t frame_list = + pio_read_32(&instance->registers->flbaseadd) & ~0xfff; + if (frame_list != addr_to_phys(instance->frame_list)) { + usb_log_debug("Framelist address: %p vs. %p.\n", + frame_list, addr_to_phys(instance->frame_list)); + } + + int frnum = pio_read_16(&instance->registers->frnum) & 0x3ff; + + uintptr_t expected_pa = instance->frame_list[frnum] + & LINK_POINTER_ADDRESS_MASK; + uintptr_t real_pa = addr_to_phys(QH(interrupt)); + if (expected_pa != real_pa) { + usb_log_debug("Interrupt QH: %p(frame: %d) vs. %p.\n", + expected_pa, frnum, real_pa); + } + + expected_pa = QH(interrupt)->next & LINK_POINTER_ADDRESS_MASK; + real_pa = addr_to_phys(QH(control_slow)); + if (expected_pa != real_pa) { + usb_log_debug("Control Slow QH: %p vs. %p.\n", + expected_pa, real_pa); + } + + expected_pa = QH(control_slow)->next & LINK_POINTER_ADDRESS_MASK; + real_pa = addr_to_phys(QH(control_full)); + if (expected_pa != real_pa) { + usb_log_debug("Control Full QH: %p vs. %p.\n", + expected_pa, real_pa); + } + + expected_pa = QH(control_full)->next & LINK_POINTER_ADDRESS_MASK; + real_pa = addr_to_phys(QH(bulk_full)); + if (expected_pa != real_pa ) { + usb_log_debug("Bulk QH: %p vs. %p.\n", + expected_pa, real_pa); + } + async_usleep(UHCI_DEBUGER_TIMEOUT); + } + return EOK; +#undef QH +} +/*----------------------------------------------------------------------------*/ +/** Check transfers for USB validity + * + * @param[in] low_speed Transfer speed. + * @param[in] transfer Transer type + * @param[in] size Size of data packets + * @return True if transaction is allowed by USB specs, false otherwise + */ +bool usb_is_allowed( + bool low_speed, usb_transfer_type_t transfer, size_t size) +{ + /* see USB specification chapter 5.5-5.8 for magic numbers used here */ + switch(transfer) + { + case USB_TRANSFER_ISOCHRONOUS: + return (!low_speed && size < 1024); + case USB_TRANSFER_INTERRUPT: + return size <= (low_speed ? 8 : 64); + case USB_TRANSFER_CONTROL: /* device specifies its own max size */ + return (size <= (low_speed ? 8 : 64)); + case USB_TRANSFER_BULK: /* device specifies its own max size */ + return (!low_speed && size <= 64); + } + return false; +} +/** + * @} + */ Index: uspace/drv/uhci-hcd/hc.h =================================================================== --- uspace/drv/uhci-hcd/hc.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/hc.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,131 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI host controller driver structure + */ +#ifndef DRV_UHCI_UHCI_HC_H +#define DRV_UHCI_UHCI_HC_H + +#include +#include +#include +#include + +#include +#include + +#include "batch.h" +#include "transfer_list.h" + +typedef struct uhci_regs { + uint16_t usbcmd; +#define UHCI_CMD_MAX_PACKET (1 << 7) +#define UHCI_CMD_CONFIGURE (1 << 6) +#define UHCI_CMD_DEBUG (1 << 5) +#define UHCI_CMD_FORCE_GLOBAL_RESUME (1 << 4) +#define UHCI_CMD_FORCE_GLOBAL_SUSPEND (1 << 3) +#define UHCI_CMD_GLOBAL_RESET (1 << 2) +#define UHCI_CMD_HCRESET (1 << 1) +#define UHCI_CMD_RUN_STOP (1 << 0) + + uint16_t usbsts; +#define UHCI_STATUS_HALTED (1 << 5) +#define UHCI_STATUS_PROCESS_ERROR (1 << 4) +#define UHCI_STATUS_SYSTEM_ERROR (1 << 3) +#define UHCI_STATUS_RESUME (1 << 2) +#define UHCI_STATUS_ERROR_INTERRUPT (1 << 1) +#define UHCI_STATUS_INTERRUPT (1 << 0) + + uint16_t usbintr; +#define UHCI_INTR_SHORT_PACKET (1 << 3) +#define UHCI_INTR_COMPLETE (1 << 2) +#define UHCI_INTR_RESUME (1 << 1) +#define UHCI_INTR_CRC (1 << 0) + + uint16_t frnum; + uint32_t flbaseadd; + uint8_t sofmod; +} regs_t; + +#define UHCI_FRAME_LIST_COUNT 1024 +#define UHCI_CLEANER_TIMEOUT 10000 +#define UHCI_DEBUGER_TIMEOUT 5000000 +#define UHCI_ALLOWED_HW_FAIL 5 + +typedef struct hc { + usb_device_keeper_t manager; + + regs_t *registers; + + link_pointer_t *frame_list; + + transfer_list_t transfers_bulk_full; + transfer_list_t transfers_control_full; + transfer_list_t transfers_control_slow; + transfer_list_t transfers_interrupt; + + transfer_list_t *transfers[2][4]; + + irq_code_t interrupt_code; + + fid_t cleaner; + fid_t debug_checker; + bool hw_interrupts; + unsigned hw_failures; + + ddf_fun_t *ddf_instance; +} hc_t; + +int hc_init(hc_t *instance, ddf_fun_t *fun, + void *regs, size_t reg_size, bool interupts); + +int hc_schedule(hc_t *instance, usb_transfer_batch_t *batch); + +void hc_interrupt(hc_t *instance, uint16_t status); + +/** Safely dispose host controller internal structures + * + * @param[in] instance Host controller structure to use. + */ +static inline void hc_fini(hc_t *instance) { /* TODO: implement*/ }; + +/** Get and cast pointer to the driver data + * + * @param[in] fun DDF function pointer + * @return cast pointer to driver_data + */ +static inline hc_t * fun_to_hc(ddf_fun_t *fun) + { return (hc_t*)fun->driver_data; } +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/hw_struct/link_pointer.h =================================================================== --- uspace/drv/uhci-hcd/hw_struct/link_pointer.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/hw_struct/link_pointer.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,61 @@ +/* + * Copyright (c) 2010 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver + */ +#ifndef DRV_UHCI_LINK_POINTER_H +#define DRV_UHCI_LINK_POINTER_H + +/* UHCI link pointer, used by many data structures */ +typedef uint32_t link_pointer_t; + +#define LINK_POINTER_TERMINATE_FLAG (1 << 0) +#define LINK_POINTER_QUEUE_HEAD_FLAG (1 << 1) +#define LINK_POINTER_ZERO_BIT_FLAG (1 << 2) +#define LINK_POINTER_VERTICAL_FLAG (1 << 2) +#define LINK_POINTER_RESERVED_FLAG (1 << 3) + +#define LINK_POINTER_ADDRESS_MASK 0xfffffff0 /* upper 28 bits */ + +#define LINK_POINTER_QH(address) \ + ((address & LINK_POINTER_ADDRESS_MASK) | LINK_POINTER_QUEUE_HEAD_FLAG) + +#define LINK_POINTER_TD(address) \ + (address & LINK_POINTER_ADDRESS_MASK) + +#define LINK_POINTER_TERM \ + ((link_pointer_t)LINK_POINTER_TERMINATE_FLAG) + +#endif +/** + * @} + */ + Index: uspace/drv/uhci-hcd/hw_struct/queue_head.h =================================================================== --- uspace/drv/uhci-hcd/hw_struct/queue_head.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/hw_struct/queue_head.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,118 @@ +/* + * Copyright (c) 2010 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drv usbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver + */ +#ifndef DRV_UHCI_QH_H +#define DRV_UHCI_QH_H + +/* libc */ +#include + +#include "link_pointer.h" +#include "utils/malloc32.h" + +typedef struct queue_head { + volatile link_pointer_t next; + volatile link_pointer_t element; +} __attribute__((packed)) qh_t; +/*----------------------------------------------------------------------------*/ +/** Initialize queue head structure + * + * @param[in] instance qh_t structure to initialize. + * + * Sets both pointer to terminal NULL. + */ +static inline void qh_init(qh_t *instance) +{ + assert(instance); + + instance->element = 0 | LINK_POINTER_TERMINATE_FLAG; + instance->next = 0 | LINK_POINTER_TERMINATE_FLAG; +} +/*----------------------------------------------------------------------------*/ +/** Set queue head next pointer + * + * @param[in] instance qh_t structure to use. + * @param[in] pa Physical address of the next queue head. + * + * Adds proper flag. If the pointer is NULL or terminal, sets next to terminal + * NULL. + */ +static inline void qh_set_next_qh(qh_t *instance, uint32_t pa) +{ + /* Address is valid and not terminal */ + if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) { + instance->next = LINK_POINTER_QH(pa); + } else { + instance->next = LINK_POINTER_TERM; + } +} +/*----------------------------------------------------------------------------*/ +/** Set queue head element pointer + * + * @param[in] instance qh_t structure to initialize. + * @param[in] pa Physical address of the next queue head. + * + * Adds proper flag. If the pointer is NULL or terminal, sets element + * to terminal NULL. + */ +static inline void qh_set_element_qh(qh_t *instance, uint32_t pa) +{ + /* Address is valid and not terminal */ + if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) { + instance->element = LINK_POINTER_QH(pa); + } else { + instance->element = LINK_POINTER_TERM; + } +} +/*----------------------------------------------------------------------------*/ +/** Set queue head element pointer + * + * @param[in] instance qh_t structure to initialize. + * @param[in] pa Physical address of the TD structure. + * + * Adds proper flag. If the pointer is NULL or terminal, sets element + * to terminal NULL. + */ +static inline void qh_set_element_td(qh_t *instance, uint32_t pa) +{ + if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) { + instance->element = LINK_POINTER_TD(pa); + } else { + instance->element = LINK_POINTER_TERM; + } +} + +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.c =================================================================== --- uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,173 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver + */ +#include +#include + +#include "transfer_descriptor.h" +#include "utils/malloc32.h" + +/** Initialize Transfer Descriptor + * + * @param[in] instance Memory place to initialize. + * @param[in] err_count Number of retries hc should attempt. + * @param[in] size Size of data source. + * @param[in] toggle Value of toggle bit. + * @param[in] iso True if TD represents Isochronous transfer. + * @param[in] low_speed Target device's speed. + * @param[in] target Address and endpoint receiving the transfer. + * @param[in] pid Packet identification (SETUP, IN or OUT). + * @param[in] buffer Source of data. + * @param[in] next Net TD in transaction. + * @return Error code. + * + * Uses a mix of supplied and default values. + * Implicit values: + * - all TDs have vertical flag set (makes transfers to endpoints atomic) + * - in the error field only active it is set + * - if the packet uses PID_IN and is not isochronous SPD is set + * + * Dumps 8 bytes of buffer if PID_SETUP is used. + */ +void td_init(td_t *instance, int err_count, size_t size, bool toggle, bool iso, + bool low_speed, usb_target_t target, usb_packet_id pid, void *buffer, + td_t *next) +{ + assert(instance); + assert(size < 1024); + assert((pid == USB_PID_SETUP) || (pid == USB_PID_IN) + || (pid == USB_PID_OUT)); + + const uint32_t next_pa = addr_to_phys(next); + assert((next_pa & LINK_POINTER_ADDRESS_MASK) == next_pa); + + instance->next = 0 + | LINK_POINTER_VERTICAL_FLAG + | (next_pa ? next_pa : LINK_POINTER_TERMINATE_FLAG); + + instance->status = 0 + | ((err_count & TD_STATUS_ERROR_COUNT_MASK) << TD_STATUS_ERROR_COUNT_POS) + | (low_speed ? TD_STATUS_LOW_SPEED_FLAG : 0) + | (iso ? TD_STATUS_ISOCHRONOUS_FLAG : 0) + | TD_STATUS_ERROR_ACTIVE; + + if (pid == USB_PID_IN && !iso) { + instance->status |= TD_STATUS_SPD_FLAG; + } + + instance->device = 0 + | (((size - 1) & TD_DEVICE_MAXLEN_MASK) << TD_DEVICE_MAXLEN_POS) + | (toggle ? TD_DEVICE_DATA_TOGGLE_ONE_FLAG : 0) + | ((target.address & TD_DEVICE_ADDRESS_MASK) << TD_DEVICE_ADDRESS_POS) + | ((target.endpoint & TD_DEVICE_ENDPOINT_MASK) << TD_DEVICE_ENDPOINT_POS) + | ((pid & TD_DEVICE_PID_MASK) << TD_DEVICE_PID_POS); + + instance->buffer_ptr = addr_to_phys(buffer); + + usb_log_debug2("Created TD(%p): %X:%X:%X:%X(%p).\n", + instance, instance->next, instance->status, instance->device, + instance->buffer_ptr, buffer); + td_print_status(instance); + if (pid == USB_PID_SETUP) { + usb_log_debug("SETUP BUFFER: %s\n", + usb_debug_str_buffer(buffer, 8, 8)); + } +} +/*----------------------------------------------------------------------------*/ +/** Convert TD status into standard error code + * + * @param[in] instance TD structure to use. + * @return Error code. + */ +int td_status(td_t *instance) +{ + assert(instance); + + /* this is hc internal error it should never be reported */ + if ((instance->status & TD_STATUS_ERROR_BIT_STUFF) != 0) + return EAGAIN; + + /* CRC or timeout error, like device not present or bad data, + * it won't be reported unless err count reached zero */ + if ((instance->status & TD_STATUS_ERROR_CRC) != 0) + return EBADCHECKSUM; + + /* hc does not end transaction on these, it should never be reported */ + if ((instance->status & TD_STATUS_ERROR_NAK) != 0) + return EAGAIN; + + /* buffer overrun or underrun */ + if ((instance->status & TD_STATUS_ERROR_BUFFER) != 0) + return ERANGE; + + /* device babble is something serious */ + if ((instance->status & TD_STATUS_ERROR_BABBLE) != 0) + return EIO; + + /* stall might represent err count reaching zero or stall response from + * the device, is err count reached zero, one of the above is reported*/ + if ((instance->status & TD_STATUS_ERROR_STALLED) != 0) + return ESTALL; + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Print values in status field (dw1) in a human readable way. + * + * @param[in] instance TD structure to use. + */ +void td_print_status(td_t *instance) +{ + assert(instance); + const uint32_t s = instance->status; + usb_log_debug2("TD(%p) status(%#x):%s %d,%s%s%s%s%s%s%s%s%s%s%s %d.\n", + instance, instance->status, + (s & TD_STATUS_SPD_FLAG) ? " SPD," : "", + (s >> TD_STATUS_ERROR_COUNT_POS) & TD_STATUS_ERROR_COUNT_MASK, + (s & TD_STATUS_LOW_SPEED_FLAG) ? " LOW SPEED," : "", + (s & TD_STATUS_ISOCHRONOUS_FLAG) ? " ISOCHRONOUS," : "", + (s & TD_STATUS_IOC_FLAG) ? " IOC," : "", + (s & TD_STATUS_ERROR_ACTIVE) ? " ACTIVE," : "", + (s & TD_STATUS_ERROR_STALLED) ? " STALLED," : "", + (s & TD_STATUS_ERROR_BUFFER) ? " BUFFER," : "", + (s & TD_STATUS_ERROR_BABBLE) ? " BABBLE," : "", + (s & TD_STATUS_ERROR_NAK) ? " NAK," : "", + (s & TD_STATUS_ERROR_CRC) ? " CRC/TIMEOUT," : "", + (s & TD_STATUS_ERROR_BIT_STUFF) ? " BIT_STUFF," : "", + (s & TD_STATUS_ERROR_RESERVED) ? " RESERVED," : "", + td_act_size(instance) + ); +} +/** + * @} + */ Index: uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.h =================================================================== --- uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,161 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver + */ +#ifndef DRV_UHCI_TRANSFER_DESCRIPTOR_H +#define DRV_UHCI_TRANSFER_DESCRIPTOR_H + +#include +#include + +#include "link_pointer.h" + +/** UHCI Transfer Descriptor */ +typedef struct transfer_descriptor { + link_pointer_t next; + + volatile uint32_t status; +#define TD_STATUS_RESERVED_MASK 0xc000f800 +#define TD_STATUS_SPD_FLAG ( 1 << 29 ) +#define TD_STATUS_ERROR_COUNT_POS ( 27 ) +#define TD_STATUS_ERROR_COUNT_MASK ( 0x3 ) +#define TD_STATUS_LOW_SPEED_FLAG ( 1 << 26 ) +#define TD_STATUS_ISOCHRONOUS_FLAG ( 1 << 25 ) +#define TD_STATUS_IOC_FLAG ( 1 << 24 ) + +#define TD_STATUS_ERROR_ACTIVE ( 1 << 23 ) +#define TD_STATUS_ERROR_STALLED ( 1 << 22 ) +#define TD_STATUS_ERROR_BUFFER ( 1 << 21 ) +#define TD_STATUS_ERROR_BABBLE ( 1 << 20 ) +#define TD_STATUS_ERROR_NAK ( 1 << 19 ) +#define TD_STATUS_ERROR_CRC ( 1 << 18 ) +#define TD_STATUS_ERROR_BIT_STUFF ( 1 << 17 ) +#define TD_STATUS_ERROR_RESERVED ( 1 << 16 ) +#define TD_STATUS_ERROR_POS 16 +#define TD_STATUS_ERROR_MASK ( 0xff ) + +#define TD_STATUS_ACTLEN_POS 0 +#define TD_STATUS_ACTLEN_MASK 0x7ff + + volatile uint32_t device; +#define TD_DEVICE_MAXLEN_POS 21 +#define TD_DEVICE_MAXLEN_MASK ( 0x7ff ) +#define TD_DEVICE_RESERVED_FLAG ( 1 << 20 ) +#define TD_DEVICE_DATA_TOGGLE_ONE_FLAG ( 1 << 19 ) +#define TD_DEVICE_ENDPOINT_POS 15 +#define TD_DEVICE_ENDPOINT_MASK ( 0xf ) +#define TD_DEVICE_ADDRESS_POS 8 +#define TD_DEVICE_ADDRESS_MASK ( 0x7f ) +#define TD_DEVICE_PID_POS 0 +#define TD_DEVICE_PID_MASK ( 0xff ) + + volatile uint32_t buffer_ptr; + + /* there is 16 bytes of data available here, according to UHCI + * Design guide, according to linux kernel the hardware does not care, + * it just needs to be aligned, we don't use it anyway + */ +} __attribute__((packed)) td_t; + + +void td_init(td_t *instance, int error_count, size_t size, bool toggle, + bool iso, bool low_speed, usb_target_t target, usb_packet_id pid, + void *buffer, td_t *next); + +int td_status(td_t *instance); + +void td_print_status(td_t *instance); +/*----------------------------------------------------------------------------*/ +/** Helper function for parsing actual size out of TD. + * + * @param[in] instance TD structure to use. + * @return Parsed actual size. + */ +static inline size_t td_act_size(td_t *instance) +{ + assert(instance); + const uint32_t s = instance->status; + return ((s >> TD_STATUS_ACTLEN_POS) + 1) & TD_STATUS_ACTLEN_MASK; +} +/*----------------------------------------------------------------------------*/ +/** Check whether less than max data were received on SPD marked transfer. + * + * @param[in] instance TD structure to use. + * @return True if data packet is short (less than max bytes and SPD set), + * false otherwise. + */ +static inline bool td_is_short(td_t *instance) +{ + const size_t act_size = td_act_size(instance); + const size_t max_size = + ((instance->device >> TD_DEVICE_MAXLEN_POS) + 1) + & TD_DEVICE_MAXLEN_MASK; + return + (instance->status | TD_STATUS_SPD_FLAG) && act_size < max_size; +} +/*----------------------------------------------------------------------------*/ +/** Helper function for parsing value of toggle bit. + * + * @param[in] instance TD structure to use. + * @return Toggle bit value. + */ +static inline int td_toggle(td_t *instance) +{ + assert(instance); + return (instance->device & TD_DEVICE_DATA_TOGGLE_ONE_FLAG) ? 1 : 0; +} +/*----------------------------------------------------------------------------*/ +/** Helper function for parsing value of active bit + * + * @param[in] instance TD structure to use. + * @return Active bit value. + */ +static inline bool td_is_active(td_t *instance) +{ + assert(instance); + return (instance->status & TD_STATUS_ERROR_ACTIVE) != 0; +} +/*----------------------------------------------------------------------------*/ +/** Helper function for setting IOC bit. + * + * @param[in] instance TD structure to use. + */ +static inline void td_set_ioc(td_t *instance) +{ + assert(instance); + instance->status |= TD_STATUS_IOC_FLAG; +} +/*----------------------------------------------------------------------------*/ +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/iface.c =================================================================== --- uspace/drv/uhci-hcd/iface.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/iface.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,378 @@ +/* + * Copyright (c) 2011 Vojtech Horky, Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver hc interface implementation + */ +#include +#include + +#include + +#include "iface.h" +#include "hc.h" + +/** Reserve default address interface function + * + * @param[in] fun DDF function that was called. + * @param[in] speed Speed to associate with the new default address. + * @return Error code. + */ +static int reserve_default_address(ddf_fun_t *fun, usb_speed_t speed) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_log_debug("Default address request with speed %d.\n", speed); + usb_device_keeper_reserve_default_address(&hc->manager, speed); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Release default address interface function + * + * @param[in] fun DDF function that was called. + * @return Error code. + */ +static int release_default_address(ddf_fun_t *fun) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_log_debug("Default address release.\n"); + usb_device_keeper_release_default_address(&hc->manager); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Request address interface function + * + * @param[in] fun DDF function that was called. + * @param[in] speed Speed to associate with the new default address. + * @param[out] address Place to write a new address. + * @return Error code. + */ +static int request_address( + ddf_fun_t *fun, usb_speed_t speed, usb_address_t *address) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + assert(address); + + usb_log_debug("Address request with speed %d.\n", speed); + *address = device_keeper_get_free_address(&hc->manager, speed); + usb_log_debug("Address request with result: %d.\n", *address); + if (*address <= 0) + return *address; + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Bind address interface function + * + * @param[in] fun DDF function that was called. + * @param[in] address Address of the device + * @param[in] handle Devman handle of the device driver. + * @return Error code. + */ +static int bind_address( + ddf_fun_t *fun, usb_address_t address, devman_handle_t handle) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_log_debug("Address bind %d-%d.\n", address, handle); + usb_device_keeper_bind(&hc->manager, address, handle); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Release address interface function + * + * @param[in] fun DDF function that was called. + * @param[in] address USB address to be released. + * @return Error code. + */ +static int release_address(ddf_fun_t *fun, usb_address_t address) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_log_debug("Address release %d.\n", address); + usb_device_keeper_release(&hc->manager, address); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Interrupt out transaction interface function + * + * @param[in] fun DDF function that was called. + * @param[in] target USB device to write to. + * @param[in] max_packet_size maximum size of data packet the device accepts + * @param[in] data Source of data. + * @param[in] size Size of data source. + * @param[in] callback Function to call on transaction completion + * @param[in] arg Additional for callback function. + * @return Error code. + */ +static int interrupt_out( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, void *data, + size_t size, usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + + usb_log_debug("Interrupt OUT %d:%d %zu(%zu).\n", + target.address, target.endpoint, size, max_packet_size); + + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_INTERRUPT, max_packet_size, + speed, data, size, NULL, 0, NULL, callback, arg, &hc->manager); + if (!batch) + return ENOMEM; + batch_interrupt_out(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Interrupt in transaction interface function + * + * @param[in] fun DDF function that was called. + * @param[in] target USB device to write to. + * @param[in] max_packet_size maximum size of data packet the device accepts + * @param[out] data Data destination. + * @param[in] size Size of data source. + * @param[in] callback Function to call on transaction completion + * @param[in] arg Additional for callback function. + * @return Error code. + */ +static int interrupt_in( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, void *data, + size_t size, usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + usb_log_debug("Interrupt IN %d:%d %zu(%zu).\n", + target.address, target.endpoint, size, max_packet_size); + + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_INTERRUPT, max_packet_size, + speed, data, size, NULL, 0, callback, NULL, arg, &hc->manager); + if (!batch) + return ENOMEM; + batch_interrupt_in(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Bulk out transaction interface function + * + * @param[in] fun DDF function that was called. + * @param[in] target USB device to write to. + * @param[in] max_packet_size maximum size of data packet the device accepts + * @param[in] data Source of data. + * @param[in] size Size of data source. + * @param[in] callback Function to call on transaction completion + * @param[in] arg Additional for callback function. + * @return Error code. + */ +static int bulk_out( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, void *data, + size_t size, usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + + usb_log_debug("Bulk OUT %d:%d %zu(%zu).\n", + target.address, target.endpoint, size, max_packet_size); + + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_BULK, max_packet_size, speed, + data, size, NULL, 0, NULL, callback, arg, &hc->manager); + if (!batch) + return ENOMEM; + batch_bulk_out(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Bulk in transaction interface function + * + * @param[in] fun DDF function that was called. + * @param[in] target USB device to write to. + * @param[in] max_packet_size maximum size of data packet the device accepts + * @param[out] data Data destination. + * @param[in] size Size of data source. + * @param[in] callback Function to call on transaction completion + * @param[in] arg Additional for callback function. + * @return Error code. + */ +static int bulk_in( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, void *data, + size_t size, usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + usb_log_debug("Bulk IN %d:%d %zu(%zu).\n", + target.address, target.endpoint, size, max_packet_size); + + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_BULK, max_packet_size, speed, + data, size, NULL, 0, callback, NULL, arg, &hc->manager); + if (!batch) + return ENOMEM; + batch_bulk_in(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Control write transaction interface function + * + * @param[in] fun DDF function that was called. + * @param[in] target USB device to write to. + * @param[in] max_packet_size maximum size of data packet the device accepts. + * @param[in] setup_data Data to send with SETUP transfer. + * @param[in] setup_size Size of data to send with SETUP transfer (always 8B). + * @param[in] data Source of data. + * @param[in] size Size of data source. + * @param[in] callback Function to call on transaction completion. + * @param[in] arg Additional for callback function. + * @return Error code. + */ +static int control_write( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, + void *setup_data, size_t setup_size, void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + usb_log_debug("Control WRITE (%d) %d:%d %zu(%zu).\n", + speed, target.address, target.endpoint, size, max_packet_size); + + if (setup_size != 8) + return EINVAL; + + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_CONTROL, max_packet_size, speed, + data, size, setup_data, setup_size, NULL, callback, arg, + &hc->manager); + if (!batch) + return ENOMEM; + usb_device_keeper_reset_if_need(&hc->manager, target, setup_data); + batch_control_write(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Control read transaction interface function + * + * @param[in] fun DDF function that was called. + * @param[in] target USB device to write to. + * @param[in] max_packet_size maximum size of data packet the device accepts. + * @param[in] setup_data Data to send with SETUP packet. + * @param[in] setup_size Size of data to send with SETUP packet (should be 8B). + * @param[out] data Source of data. + * @param[in] size Size of data source. + * @param[in] callback Function to call on transaction completion. + * @param[in] arg Additional for callback function. + * @return Error code. + */ +static int control_read( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, + void *setup_data, size_t setup_size, void *data, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + + usb_log_debug("Control READ(%d) %d:%d %zu(%zu).\n", + speed, target.address, target.endpoint, size, max_packet_size); + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_CONTROL, max_packet_size, speed, + data, size, setup_data, setup_size, callback, NULL, arg, + &hc->manager); + if (!batch) + return ENOMEM; + batch_control_read(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +usbhc_iface_t hc_iface = { + .reserve_default_address = reserve_default_address, + .release_default_address = release_default_address, + .request_address = request_address, + .bind_address = bind_address, + .release_address = release_address, + + .interrupt_out = interrupt_out, + .interrupt_in = interrupt_in, + + .bulk_out = bulk_out, + .bulk_in = bulk_in, + + .control_write = control_write, + .control_read = control_read, +}; +/** + * @} + */ Index: uspace/drv/uhci-hcd/iface.h =================================================================== --- uspace/drv/uhci-hcd/iface.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/iface.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,45 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver iface + */ +#ifndef DRV_UHCI_IFACE_H +#define DRV_UHCI_IFACE_H + +#include + +extern usbhc_iface_t hc_iface; + +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/main.c =================================================================== --- uspace/drv/uhci-hcd/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,104 @@ +/* + * Copyright (c) 2011 Vojtech Horky, Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver initialization + */ +#include +#include +#include + +#include +#include + +#include "iface.h" +#include "uhci.h" + +#define NAME "uhci-hcd" + +static int uhci_add_device(ddf_dev_t *device); +/*----------------------------------------------------------------------------*/ +static driver_ops_t uhci_driver_ops = { + .add_device = uhci_add_device, +}; +/*----------------------------------------------------------------------------*/ +static driver_t uhci_driver = { + .name = NAME, + .driver_ops = &uhci_driver_ops +}; +/*----------------------------------------------------------------------------*/ +/** Initialize a new ddf driver instance for uhci hc and hub. + * + * @param[in] device DDF instance of the device to initialize. + * @return Error code. + */ +int uhci_add_device(ddf_dev_t *device) +{ + usb_log_debug("uhci_add_device() called\n"); + assert(device); + uhci_t *uhci = malloc(sizeof(uhci_t)); + if (uhci == NULL) { + usb_log_error("Failed to allocate UHCI driver.\n"); + return ENOMEM; + } + + int ret = uhci_init(uhci, device); + if (ret != EOK) { + usb_log_error("Failed to initialize UHCI driver: %s.\n", + str_error(ret)); + return ret; + } + device->driver_data = uhci; + + usb_log_info("Controlling new UHCI device `%s'.\n", device->name); + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Initialize global driver structures (NONE). + * + * @param[in] argc Nmber of arguments in argv vector (ignored). + * @param[in] argv Cmdline argument vector (ignored). + * @return Error code. + * + * Driver debug level is set here. + */ +int main(int argc, char *argv[]) +{ + printf(NAME ": HelenOS UHCI driver.\n"); + + sleep(3); /* TODO: remove in final version */ + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + + return ddf_driver_main(&uhci_driver); +} +/** + * @} + */ Index: uspace/drv/uhci-hcd/pci.c =================================================================== --- uspace/drv/uhci-hcd/pci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/pci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,165 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** + * @addtogroup drvusbuhcihc + * @{ + */ +/** + * @file + * PCI related functions needed by the UHCI driver. + */ +#include +#include +#include +#include + +#include +#include + +#include "pci.h" + +/** Get address of registers and IRQ for given device. + * + * @param[in] dev Device asking for the addresses. + * @param[out] io_reg_address Base address of the I/O range. + * @param[out] io_reg_size Size of the I/O range. + * @param[out] irq_no IRQ assigned to the device. + * @return Error code. + */ +int pci_get_my_registers(ddf_dev_t *dev, + uintptr_t *io_reg_address, size_t *io_reg_size, + int *irq_no) +{ + assert(dev != NULL); + + int parent_phone = devman_parent_device_connect(dev->handle, + IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + + int rc; + hw_resource_list_t hw_resources; + rc = hw_res_get_resource_list(parent_phone, &hw_resources); + if (rc != EOK) { + goto leave; + } + + uintptr_t io_address = 0; + size_t io_size = 0; + bool io_found = false; + + int irq = 0; + bool irq_found = false; + + size_t i; + for (i = 0; i < hw_resources.count; i++) { + hw_resource_t *res = &hw_resources.resources[i]; + switch (res->type) + { + case INTERRUPT: + irq = res->res.interrupt.irq; + irq_found = true; + usb_log_debug2("Found interrupt: %d.\n", irq); + break; + + case IO_RANGE: + io_address = res->res.io_range.address; + io_size = res->res.io_range.size; + usb_log_debug2("Found io: %llx %zu.\n", + res->res.io_range.address, res->res.io_range.size); + io_found = true; + + default: + break; + } + } + + if (!io_found || !irq_found) { + rc = ENOENT; + goto leave; + } + + *io_reg_address = io_address; + *io_reg_size = io_size; + *irq_no = irq; + + rc = EOK; +leave: + async_hangup(parent_phone); + + return rc; +} +/*----------------------------------------------------------------------------*/ +/** Call the PCI driver with a request to enable interrupts + * + * @param[in] device Device asking for interrupts + * @return Error code. + */ +int pci_enable_interrupts(ddf_dev_t *device) +{ + int parent_phone = devman_parent_device_connect(device->handle, + IPC_FLAG_BLOCKING); + bool enabled = hw_res_enable_interrupt(parent_phone); + async_hangup(parent_phone); + return enabled ? EOK : EIO; +} +/*----------------------------------------------------------------------------*/ +/** Call the PCI driver with a request to clear legacy support register + * + * @param[in] device Device asking to disable interrupts + * @return Error code. + */ +int pci_disable_legacy(ddf_dev_t *device) +{ + assert(device); + int parent_phone = + devman_parent_device_connect(device->handle, IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + + /* See UHCI design guide for these values, + * write all WC bits in USB legacy register */ + sysarg_t address = 0xc0; + sysarg_t value = 0x8f00; + + int rc = async_req_3_0(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), + IPC_M_CONFIG_SPACE_WRITE_16, address, value); + async_hangup(parent_phone); + + return rc; +} +/*----------------------------------------------------------------------------*/ +/** + * @} + */ + +/** + * @} + */ Index: uspace/drv/uhci-hcd/pci.h =================================================================== --- uspace/drv/uhci-hcd/pci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/pci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,48 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver PCI helper functions + */ +#ifndef DRV_UHCI_PCI_H +#define DRV_UHCI_PCI_H + +#include + +int pci_get_my_registers(ddf_dev_t *, uintptr_t *, size_t *, int *); +int pci_enable_interrupts(ddf_dev_t *); +int pci_disable_legacy(ddf_dev_t *); + +#endif +/** + * @} + */ + Index: uspace/drv/uhci-hcd/root_hub.c =================================================================== --- uspace/drv/uhci-hcd/root_hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/root_hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,81 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhci + * @{ + */ +/** @file + * @brief UHCI driver + */ +#include +#include +#include +#include + +#include + +#include "root_hub.h" + +/** Root hub initialization + * @param[in] instance RH structure to initialize + * @param[in] fun DDF function representing UHCI root hub + * @param[in] reg_addr Address of root hub status and control registers. + * @param[in] reg_size Size of accessible address space. + * @return Error code. + */ +int rh_init(rh_t *instance, ddf_fun_t *fun, uintptr_t reg_addr, size_t reg_size) +{ + assert(fun); + + char *match_str = NULL; + int ret = asprintf(&match_str, "usb&uhci&root-hub"); + if (ret < 0) { + usb_log_error("Failed to create root hub match string.\n"); + return ENOMEM; + } + + ret = ddf_fun_add_match_id(fun, match_str, 100); + if (ret != EOK) { + usb_log_error("Failed(%d) to add root hub match id: %s\n", + ret, str_error(ret)); + return ret; + } + + hw_resource_list_t *resource_list = &instance->resource_list; + resource_list->count = 1; + resource_list->resources = &instance->io_regs; + assert(resource_list->resources); + instance->io_regs.type = IO_RANGE; + instance->io_regs.res.io_range.address = reg_addr; + instance->io_regs.res.io_range.size = reg_size; + instance->io_regs.res.io_range.endianness = LITTLE_ENDIAN; + + return EOK; +} +/** + * @} + */ Index: uspace/drv/uhci-hcd/root_hub.h =================================================================== --- uspace/drv/uhci-hcd/root_hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/root_hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,52 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbuhci + * @{ + */ +/** @file + * @brief UHCI driver + */ +#ifndef DRV_UHCI_UHCI_RH_H +#define DRV_UHCI_UHCI_RH_H + +#include +#include + +typedef struct rh { + hw_resource_list_t resource_list; + hw_resource_t io_regs; +} rh_t; + +int rh_init( + rh_t *instance, ddf_fun_t *fun, uintptr_t reg_addr, size_t reg_size); + +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/transfer_list.c =================================================================== --- uspace/drv/uhci-hcd/transfer_list.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/transfer_list.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,228 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver transfer list implementation + */ +#include +#include + +#include "transfer_list.h" + +static void transfer_list_remove_batch( + transfer_list_t *instance, usb_transfer_batch_t *batch); +/*----------------------------------------------------------------------------*/ +/** Initialize transfer list structures. + * + * @param[in] instance Memory place to use. + * @param[in] name Name of the new list. + * @return Error code + * + * Allocates memory for internal qh_t structure. + */ +int transfer_list_init(transfer_list_t *instance, const char *name) +{ + assert(instance); + instance->name = name; + instance->queue_head = malloc32(sizeof(qh_t)); + if (!instance->queue_head) { + usb_log_error("Failed to allocate queue head.\n"); + return ENOMEM; + } + instance->queue_head_pa = addr_to_phys(instance->queue_head); + usb_log_debug2("Transfer list %s setup with QH: %p(%p).\n", + name, instance->queue_head, instance->queue_head_pa); + + qh_init(instance->queue_head); + list_initialize(&instance->batch_list); + fibril_mutex_initialize(&instance->guard); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Set the next list in transfer list chain. + * + * @param[in] instance List to lead. + * @param[in] next List to append. + * @return Error code + * + * Does not check whether this replaces an existing list . + */ +void transfer_list_set_next(transfer_list_t *instance, transfer_list_t *next) +{ + assert(instance); + assert(next); + if (!instance->queue_head) + return; + /* Set both queue_head.next to point to the follower */ + qh_set_next_qh(instance->queue_head, next->queue_head_pa); +} +/*----------------------------------------------------------------------------*/ +/** Submit transfer batch to the list and queue. + * + * @param[in] instance List to use. + * @param[in] batch Transfer batch to submit. + * @return Error code + * + * The batch is added to the end of the list and queue. + */ +void transfer_list_add_batch( + transfer_list_t *instance, usb_transfer_batch_t *batch) +{ + assert(instance); + assert(batch); + usb_log_debug2("Queue %s: Adding batch(%p).\n", instance->name, batch); + + fibril_mutex_lock(&instance->guard); + + qh_t *last_qh = NULL; + /* Add to the hardware queue. */ + if (list_empty(&instance->batch_list)) { + /* There is nothing scheduled */ + last_qh = instance->queue_head; + } else { + /* There is something scheduled */ + usb_transfer_batch_t *last = list_get_instance( + instance->batch_list.prev, usb_transfer_batch_t, link); + last_qh = batch_qh(last); + } + const uint32_t pa = addr_to_phys(batch_qh(batch)); + assert((pa & LINK_POINTER_ADDRESS_MASK) == pa); + + /* keep link */ + batch_qh(batch)->next = last_qh->next; + qh_set_next_qh(last_qh, pa); + + asm volatile ("": : :"memory"); + + /* Add to the driver list */ + list_append(&batch->link, &instance->batch_list); + + usb_transfer_batch_t *first = list_get_instance( + instance->batch_list.next, usb_transfer_batch_t, link); + usb_log_debug("Batch(%p) added to queue %s, first is %p.\n", + batch, instance->name, first); + fibril_mutex_unlock(&instance->guard); +} +/*----------------------------------------------------------------------------*/ +/** Check list for finished batches. + * + * @param[in] instance List to use. + * @return Error code + * + * Creates a local list of finished batches and calls next_step on each and + * every one. This is safer because next_step may theoretically access + * this transfer list leading to the deadlock if its done inline. + */ +void transfer_list_remove_finished(transfer_list_t *instance, link_t *done) +{ + assert(instance); + assert(done); + + fibril_mutex_lock(&instance->guard); + link_t *current = instance->batch_list.next; + while (current != &instance->batch_list) { + link_t *next = current->next; + usb_transfer_batch_t *batch = + list_get_instance(current, usb_transfer_batch_t, link); + + if (batch_is_complete(batch)) { + /* Save for post-processing */ + transfer_list_remove_batch(instance, batch); + list_append(current, done); + } + current = next; + } + fibril_mutex_unlock(&instance->guard); + +} +/*----------------------------------------------------------------------------*/ +/** Walk the list and abort all batches. + * + * @param[in] instance List to use. + */ +void transfer_list_abort_all(transfer_list_t *instance) +{ + fibril_mutex_lock(&instance->guard); + while (!list_empty(&instance->batch_list)) { + link_t *current = instance->batch_list.next; + usb_transfer_batch_t *batch = + list_get_instance(current, usb_transfer_batch_t, link); + transfer_list_remove_batch(instance, batch); + usb_transfer_batch_finish(batch, EIO); + } + fibril_mutex_unlock(&instance->guard); +} +/*----------------------------------------------------------------------------*/ +/** Remove a transfer batch from the list and queue. + * + * @param[in] instance List to use. + * @param[in] batch Transfer batch to remove. + * @return Error code + * + * Does not lock the transfer list, caller is responsible for that. + */ +void transfer_list_remove_batch( + transfer_list_t *instance, usb_transfer_batch_t *batch) +{ + assert(instance); + assert(instance->queue_head); + assert(batch); + assert(batch_qh(batch)); + assert(fibril_mutex_is_locked(&instance->guard)); + + usb_log_debug2( + "Queue %s: removing batch(%p).\n", instance->name, batch); + + const char *qpos = NULL; + /* Remove from the hardware queue */ + if (instance->batch_list.next == &batch->link) { + /* I'm the first one here */ + assert((instance->queue_head->next & LINK_POINTER_ADDRESS_MASK) + == addr_to_phys(batch_qh(batch))); + instance->queue_head->next = batch_qh(batch)->next; + qpos = "FIRST"; + } else { + usb_transfer_batch_t *prev = + list_get_instance( + batch->link.prev, usb_transfer_batch_t, link); + assert((batch_qh(prev)->next & LINK_POINTER_ADDRESS_MASK) + == addr_to_phys(batch_qh(batch))); + batch_qh(prev)->next = batch_qh(batch)->next; + qpos = "NOT FIRST"; + } + asm volatile ("": : :"memory"); + /* Remove from the batch list */ + list_remove(&batch->link); + usb_log_debug("Batch(%p) removed (%s) from %s, next %x.\n", + batch, qpos, instance->name, batch_qh(batch)->next); +} +/** + * @} + */ Index: uspace/drv/uhci-hcd/transfer_list.h =================================================================== --- uspace/drv/uhci-hcd/transfer_list.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/transfer_list.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,75 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver transfer list structure + */ +#ifndef DRV_UHCI_TRANSFER_LIST_H +#define DRV_UHCI_TRANSFER_LIST_H + +#include + +#include "batch.h" +#include "hw_struct/queue_head.h" + +typedef struct transfer_list +{ + fibril_mutex_t guard; + qh_t *queue_head; + uint32_t queue_head_pa; + const char *name; + link_t batch_list; +} transfer_list_t; + +/** Dispose transfer list structures. + * + * @param[in] instance Memory place to use. + * + * Frees memory for internal qh_t structure. + */ +static inline void transfer_list_fini(transfer_list_t *instance) +{ + assert(instance); + free32(instance->queue_head); +} + +int transfer_list_init(transfer_list_t *instance, const char *name); + +void transfer_list_set_next(transfer_list_t *instance, transfer_list_t *next); + +void transfer_list_add_batch(transfer_list_t *instance, usb_transfer_batch_t *batch); + +void transfer_list_remove_finished(transfer_list_t *instance, link_t *done); + +void transfer_list_abort_all(transfer_list_t *instance); +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/transfers.c =================================================================== --- uspace/drv/uhci-hcd/transfers.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/transfers.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,160 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#include +#include + +#include "uhci.h" + +static int enqueue_transfer_out(device_t *dev, + usb_target_t target, usb_transfer_type_t transfer_type, + void *buffer, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + printf(NAME ": transfer OUT [%d.%d (%s); %zu]\n", + target.address, target.endpoint, + usb_str_transfer_type(transfer_type), + size); + + return ENOTSUP; +} + +static int enqueue_transfer_setup(device_t *dev, + usb_target_t target, usb_transfer_type_t transfer_type, + void *buffer, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + printf(NAME ": transfer SETUP [%d.%d (%s); %zu]\n", + target.address, target.endpoint, + usb_str_transfer_type(transfer_type), + size); + + return ENOTSUP; +} + +static int enqueue_transfer_in(device_t *dev, + usb_target_t target, usb_transfer_type_t transfer_type, + void *buffer, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + printf(NAME ": transfer IN [%d.%d (%s); %zu]\n", + target.address, target.endpoint, + usb_str_transfer_type(transfer_type), + size); + + return ENOTSUP; +} + + +static int get_address(device_t *dev, devman_handle_t handle, + usb_address_t *address) +{ + return ENOTSUP; +} + +static int interrupt_out(device_t *dev, usb_target_t target, + void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + return enqueue_transfer_out(dev, target, USB_TRANSFER_INTERRUPT, + data, size, + callback, arg); +} + +static int interrupt_in(device_t *dev, usb_target_t target, + void *data, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + return enqueue_transfer_in(dev, target, USB_TRANSFER_INTERRUPT, + data, size, + callback, arg); +} + +static int control_write_setup(device_t *dev, usb_target_t target, + void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + return enqueue_transfer_setup(dev, target, USB_TRANSFER_CONTROL, + data, size, + callback, arg); +} + +static int control_write_data(device_t *dev, usb_target_t target, + void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + return enqueue_transfer_out(dev, target, USB_TRANSFER_CONTROL, + data, size, + callback, arg); +} + +static int control_write_status(device_t *dev, usb_target_t target, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + return enqueue_transfer_in(dev, target, USB_TRANSFER_CONTROL, + NULL, 0, + callback, arg); +} + +static int control_read_setup(device_t *dev, usb_target_t target, + void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + return enqueue_transfer_setup(dev, target, USB_TRANSFER_CONTROL, + data, size, + callback, arg); +} + +static int control_read_data(device_t *dev, usb_target_t target, + void *data, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + return enqueue_transfer_in(dev, target, USB_TRANSFER_CONTROL, + data, size, + callback, arg); +} + +static int control_read_status(device_t *dev, usb_target_t target, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + return enqueue_transfer_out(dev, target, USB_TRANSFER_CONTROL, + NULL, 0, + callback, arg); +} + + +usbhc_iface_t uhci_iface = { + .tell_address = get_address, + .interrupt_out = interrupt_out, + .interrupt_in = interrupt_in, + .control_write_setup = control_write_setup, + .control_write_data = control_write_data, + .control_write_status = control_write_status, + .control_read_setup = control_read_setup, + .control_read_data = control_read_data, + .control_read_status = control_read_status +}; Index: uspace/drv/uhci-hcd/uhci-hcd.ma =================================================================== --- uspace/drv/uhci-hcd/uhci-hcd.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/uhci-hcd.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,21 @@ +10 pci/ven=8086&dev=7020 +10 pci/ven=8086&dev=7112 + +10 pci/ven=8086&dev=27c8 +10 pci/ven=8086&dev=27c9 +10 pci/ven=8086&dev=27ca +10 pci/ven=8086&dev=27cb + + +10 pci/ven=8086&dev=2830 +10 pci/ven=8086&dev=2831 +10 pci/ven=8086&dev=2832 +10 pci/ven=8086&dev=2834 +10 pci/ven=8086&dev=2835 + +10 pci/ven=8086&dev=2934 +10 pci/ven=8086&dev=2935 +10 pci/ven=8086&dev=2936 +10 pci/ven=8086&dev=2937 +10 pci/ven=8086&dev=2938 +10 pci/ven=8086&dev=2939 Index: uspace/drv/uhci-hcd/uhci.c =================================================================== --- uspace/drv/uhci-hcd/uhci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/uhci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,246 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbuhci + * @{ + */ +/** @file + * @brief UHCI driver + */ +#include +#include +#include +#include +#include +#include + +#include "uhci.h" +#include "iface.h" +#include "pci.h" + +/** IRQ handling callback, identifies device + * + * @param[in] dev DDF instance of the device to use. + * @param[in] iid (Unused). + * @param[in] call Pointer to the call that represents interrupt. + */ +static void irq_handler(ddf_dev_t *dev, ipc_callid_t iid, ipc_call_t *call) +{ + assert(dev); + hc_t *hc = &((uhci_t*)dev->driver_data)->hc; + uint16_t status = IPC_GET_ARG1(*call); + assert(hc); + hc_interrupt(hc, status); +} +/*----------------------------------------------------------------------------*/ +/** Get address of the device identified by handle. + * + * @param[in] dev DDF instance of the device to use. + * @param[in] iid (Unused). + * @param[in] call Pointer to the call that represents interrupt. + */ +static int usb_iface_get_address( + ddf_fun_t *fun, devman_handle_t handle, usb_address_t *address) +{ + assert(fun); + usb_device_keeper_t *manager = &((uhci_t*)fun->dev->driver_data)->hc.manager; + + usb_address_t addr = usb_device_keeper_find(manager, handle); + if (addr < 0) { + return addr; + } + + if (address != NULL) { + *address = addr; + } + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Gets handle of the respective hc (this or parent device). + * + * @param[in] root_hub_fun Root hub function seeking hc handle. + * @param[out] handle Place to write the handle. + * @return Error code. + */ +static int usb_iface_get_hc_handle( + ddf_fun_t *fun, devman_handle_t *handle) +{ + assert(handle); + ddf_fun_t *hc_fun = ((uhci_t*)fun->dev->driver_data)->hc_fun; + assert(hc_fun != NULL); + + *handle = hc_fun->handle; + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** This iface is generic for both RH and HC. */ +static usb_iface_t usb_iface = { + .get_hc_handle = usb_iface_get_hc_handle, + .get_address = usb_iface_get_address +}; +/*----------------------------------------------------------------------------*/ +static ddf_dev_ops_t hc_ops = { +// .interfaces[USB_DEV_IFACE] = &usb_iface, + .interfaces[USBHC_DEV_IFACE] = &hc_iface, /* see iface.h/c */ +}; +/*----------------------------------------------------------------------------*/ +/** Get root hub hw resources (I/O registers). + * + * @param[in] fun Root hub function. + * @return Pointer to the resource list used by the root hub. + */ +static hw_resource_list_t *get_resource_list(ddf_fun_t *fun) +{ + assert(fun); + return &((rh_t*)fun->driver_data)->resource_list; +} +/*----------------------------------------------------------------------------*/ +static hw_res_ops_t hw_res_iface = { + .get_resource_list = get_resource_list, + .enable_interrupt = NULL +}; +/*----------------------------------------------------------------------------*/ +static ddf_dev_ops_t rh_ops = { + .interfaces[USB_DEV_IFACE] = &usb_iface, + .interfaces[HW_RES_DEV_IFACE] = &hw_res_iface +}; +/*----------------------------------------------------------------------------*/ +/** Initialize hc and rh ddf structures and their respective drivers. + * + * @param[in] instance UHCI structure to use. + * @param[in] device DDF instance of the device to use. + * + * This function does all the preparatory work for hc and rh drivers: + * - gets device hw resources + * - disables UHCI legacy support + * - asks for interrupt + * - registers interrupt handler + */ +int uhci_init(uhci_t *instance, ddf_dev_t *device) +{ + assert(instance); + instance->hc_fun = NULL; + instance->rh_fun = NULL; +#define CHECK_RET_DEST_FUN_RETURN(ret, message...) \ +if (ret != EOK) { \ + usb_log_error(message); \ + if (instance->hc_fun) \ + ddf_fun_destroy(instance->hc_fun); \ + if (instance->rh_fun) \ + ddf_fun_destroy(instance->rh_fun); \ + return ret; \ +} + + uintptr_t io_reg_base = 0; + size_t io_reg_size = 0; + int irq = 0; + + int ret = + pci_get_my_registers(device, &io_reg_base, &io_reg_size, &irq); + CHECK_RET_DEST_FUN_RETURN(ret, + "Failed(%d) to get I/O addresses:.\n", ret, device->handle); + usb_log_debug("I/O regs at 0x%X (size %zu), IRQ %d.\n", + io_reg_base, io_reg_size, irq); + + ret = pci_disable_legacy(device); + CHECK_RET_DEST_FUN_RETURN(ret, + "Failed(%d) to disable legacy USB: %s.\n", ret, str_error(ret)); + + bool interrupts = false; +#ifdef CONFIG_USBHC_NO_INTERRUPTS + usb_log_warning("Interrupts disabled in OS config, " \ + "falling back to polling.\n"); +#else + ret = pci_enable_interrupts(device); + if (ret != EOK) { + usb_log_warning("Failed to enable interrupts: %s.\n", + str_error(ret)); + usb_log_info("HW interrupts not available, " \ + "falling back to polling.\n"); + } else { + usb_log_debug("Hw interrupts enabled.\n"); + interrupts = true; + } +#endif + + instance->hc_fun = ddf_fun_create(device, fun_exposed, "uhci-hc"); + ret = (instance->hc_fun == NULL) ? ENOMEM : EOK; + CHECK_RET_DEST_FUN_RETURN(ret, + "Failed(%d) to create HC function.\n", ret); + + ret = hc_init(&instance->hc, instance->hc_fun, + (void*)io_reg_base, io_reg_size, interrupts); + CHECK_RET_DEST_FUN_RETURN(ret, "Failed(%d) to init uhci-hcd.\n", ret); + instance->hc_fun->ops = &hc_ops; + instance->hc_fun->driver_data = &instance->hc; + ret = ddf_fun_bind(instance->hc_fun); + CHECK_RET_DEST_FUN_RETURN(ret, + "Failed(%d) to bind UHCI device function: %s.\n", + ret, str_error(ret)); +#undef CHECK_RET_HC_RETURN + +#define CHECK_RET_FINI_RETURN(ret, message...) \ +if (ret != EOK) { \ + usb_log_error(message); \ + if (instance->hc_fun) \ + ddf_fun_destroy(instance->hc_fun); \ + if (instance->rh_fun) \ + ddf_fun_destroy(instance->rh_fun); \ + hc_fini(&instance->hc); \ + return ret; \ +} + + /* It does no harm if we register this on polling */ + ret = register_interrupt_handler(device, irq, irq_handler, + &instance->hc.interrupt_code); + CHECK_RET_FINI_RETURN(ret, + "Failed(%d) to register interrupt handler.\n", ret); + + instance->rh_fun = ddf_fun_create(device, fun_inner, "uhci-rh"); + ret = (instance->rh_fun == NULL) ? ENOMEM : EOK; + CHECK_RET_FINI_RETURN(ret, + "Failed(%d) to create root hub function.\n", ret); + + ret = rh_init(&instance->rh, instance->rh_fun, + (uintptr_t)instance->hc.registers + 0x10, 4); + CHECK_RET_FINI_RETURN(ret, + "Failed(%d) to setup UHCI root hub.\n", ret); + + instance->rh_fun->ops = &rh_ops; + instance->rh_fun->driver_data = &instance->rh; + ret = ddf_fun_bind(instance->rh_fun); + CHECK_RET_FINI_RETURN(ret, + "Failed(%d) to register UHCI root hub.\n", ret); + + return EOK; +#undef CHECK_RET_FINI_RETURN +} +/** + * @} + */ Index: uspace/drv/uhci-hcd/uhci.h =================================================================== --- uspace/drv/uhci-hcd/uhci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/uhci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,56 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbuhci + * @{ + */ +/** @file + * @brief UHCI driver main structure for both host controller and root-hub. + */ +#ifndef DRV_UHCI_UHCI_H +#define DRV_UHCI_UHCI_H +#include +#include + +#include "hc.h" +#include "root_hub.h" + +typedef struct uhci { + ddf_fun_t *hc_fun; + ddf_fun_t *rh_fun; + + hc_t hc; + rh_t rh; +} uhci_t; + +int uhci_init(uhci_t *instance, ddf_dev_t *device); + +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/utils/malloc32.h =================================================================== --- uspace/drv/uhci-hcd/utils/malloc32.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/utils/malloc32.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,111 @@ +/* + * Copyright (c) 2010 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup usb + * @{ + */ +/** @file + * @brief UHCI driver + */ +#ifndef DRV_UHCI_TRANSLATOR_H +#define DRV_UHCI_TRANSLATOR_H + +#include +#include +#include +#include + +#include "slab.h" + +#define UHCI_STRCUTURES_ALIGNMENT 16 +#define UHCI_REQUIRED_PAGE_SIZE 4096 + + +/** Get physical address translation + * + * @param[in] addr Virtual address to translate + * @return Physical address if exists, NULL otherwise. + */ +static inline uintptr_t addr_to_phys(void *addr) +{ + if (addr == NULL) + return 0; + + uintptr_t result; + const int ret = as_get_physical_mapping(addr, &result); + assert(ret == EOK); + + if (ret != EOK) + return 0; + return (result | ((uintptr_t)addr & 0xfff)); +} +/*----------------------------------------------------------------------------*/ +/** Physical mallocator simulator + * + * @param[in] size Size of the required memory space + * @return Address of the alligned and big enough memory place, NULL on failure. + */ +static inline void * malloc32(size_t size) { + if (size <= SLAB_ELEMENT_SIZE) + return slab_malloc_g(); + assert(false); + return memalign(UHCI_STRCUTURES_ALIGNMENT, size); +} +/*----------------------------------------------------------------------------*/ +/** Physical mallocator simulator + * + * @param[in] addr Address of the place allocated by malloc32 + */ +static inline void free32(void *addr) { + if (!addr) + return; + if (slab_in_range_g(addr)) + return slab_free_g(addr); + free(addr); +} +/*----------------------------------------------------------------------------*/ +/** Create 4KB page mapping + * + * @return Address of the mapped page, NULL on failure. + */ +static inline void * get_page(void) +{ + void *free_address = as_get_mappable_page(UHCI_REQUIRED_PAGE_SIZE); + assert(free_address); /* TODO: remove this assert */ + if (free_address == 0) + return NULL; + void *ret = as_area_create(free_address, UHCI_REQUIRED_PAGE_SIZE, + AS_AREA_READ | AS_AREA_WRITE); + if (ret != free_address) + return NULL; + return ret; +} + +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/utils/slab.c =================================================================== --- uspace/drv/uhci-hcd/utils/slab.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/utils/slab.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,141 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup usb + * @{ + */ +/** @file + * @brief UHCI driver + */ +#include +#include +#include +#include + +#include "slab.h" + +#define SLAB_SIZE (PAGE_SIZE * 16) +#define SLAB_ELEMENT_COUNT (SLAB_SIZE / SLAB_ELEMENT_SIZE) + +typedef struct slab { + void *page; + bool slabs[SLAB_ELEMENT_COUNT]; + fibril_mutex_t guard; +} slab_t; + +static slab_t global_slab; + +static void * slab_malloc(slab_t *intance); +static bool slab_in_range(slab_t *intance, void *addr); +static void slab_free(slab_t *intance, void *addr); +/*----------------------------------------------------------------------------*/ +void * slab_malloc_g(void) +{ + return slab_malloc(&global_slab); +} +/*----------------------------------------------------------------------------*/ +void slab_free_g(void *addr) +{ + return slab_free(&global_slab, addr); +} +/*----------------------------------------------------------------------------*/ +bool slab_in_range_g(void *addr) +{ + return slab_in_range(&global_slab, addr); +} +/*----------------------------------------------------------------------------*/ +static void slab_init(slab_t *instance) +{ + static FIBRIL_MUTEX_INITIALIZE(init_mutex); + assert(instance); + fibril_mutex_lock(&init_mutex); + if (instance->page != NULL) { + /* already initialized */ + fibril_mutex_unlock(&init_mutex); + return; + } + fibril_mutex_initialize(&instance->guard); + size_t i = 0; + for (;i < SLAB_ELEMENT_COUNT; ++i) { + instance->slabs[i] = true; + } + instance->page = as_get_mappable_page(SLAB_SIZE); + if (instance->page != NULL) { + void* ret = + as_area_create(instance->page, SLAB_SIZE, AS_AREA_READ | AS_AREA_WRITE); + if (ret != instance->page) { + instance->page = NULL; + } + } + memset(instance->page, 0xa, SLAB_SIZE); + fibril_mutex_unlock(&init_mutex); + usb_log_debug2("SLAB initialized at %p.\n", instance->page); +} +/*----------------------------------------------------------------------------*/ +static void * slab_malloc(slab_t *instance) { + assert(instance); + if (instance->page == NULL) + slab_init(instance); + + fibril_mutex_lock(&instance->guard); + void *addr = NULL; + size_t i = 0; + for (; i < SLAB_ELEMENT_COUNT; ++i) { + if (instance->slabs[i]) { + instance->slabs[i] = false; + addr = (instance->page + (i * SLAB_ELEMENT_SIZE)); + break; + } + } + fibril_mutex_unlock(&instance->guard); + + return addr; +} +/*----------------------------------------------------------------------------*/ +static bool slab_in_range(slab_t *instance, void *addr) { + assert(instance); + bool in_range = (instance->page != NULL) && + (addr >= instance->page) && (addr < instance->page + SLAB_SIZE); + return in_range; +} +/*----------------------------------------------------------------------------*/ +static void slab_free(slab_t *instance, void *addr) +{ + assert(instance); + assert(slab_in_range(instance, addr)); + memset(addr, 0xa, SLAB_ELEMENT_SIZE); + + const size_t pos = (addr - instance->page) / SLAB_ELEMENT_SIZE; + + fibril_mutex_lock(&instance->guard); + assert(instance->slabs[pos] == false); + instance->slabs[pos] = true; + fibril_mutex_unlock(&instance->guard); +} +/** + * @} + */ Index: uspace/drv/uhci-hcd/utils/slab.h =================================================================== --- uspace/drv/uhci-hcd/utils/slab.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/utils/slab.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,50 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup usb + * @{ + */ +/** @file + * @brief UHCI driver + */ +#ifndef DRV_UHCI_SLAB_H +#define DRV_UHCI_SLAB_H + +#include + +#define SLAB_ELEMENT_SIZE 1024 + +void * slab_malloc_g(void); + +void slab_free_g(void *addr); + +bool slab_in_range_g(void *addr); + +#endif +/** + * @} + */ Index: uspace/drv/uhci-rhd/Makefile =================================================================== --- uspace/drv/uhci-rhd/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-rhd/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,39 @@ +# +# Copyright (c) 2010 Jan Vesely +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBS = $(LIBDRV_PREFIX)/libdrv.a $(LIBUSB_PREFIX)/libusb.a +EXTRA_CFLAGS += -I$(LIBDRV_PREFIX)/include -I$(LIBUSB_PREFIX)/include -I. +BINARY = uhci-rhd + +SOURCES = \ + main.c \ + port.c \ + root_hub.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/uhci-rhd/main.c =================================================================== --- uspace/drv/uhci-rhd/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-rhd/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,204 @@ +/* + * Copyright (c) 2011 Vojtech Horky, Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcirh + * @{ + */ +/** @file + * @brief UHCI root hub initialization routines + */ +#include +#include +#include +#include +#include +#include +#include +#include + +#include "root_hub.h" + +#define NAME "uhci-rhd" +static int hc_get_my_registers(ddf_dev_t *dev, + uintptr_t *io_reg_address, size_t *io_reg_size); +#if 0 +/*----------------------------------------------------------------------------*/ +static int usb_iface_get_hc_handle(ddf_fun_t *fun, devman_handle_t *handle) +{ + assert(fun); + assert(fun->driver_data); + assert(handle); + + *handle = ((uhci_root_hub_t*)fun->driver_data)->hc_handle; + + return EOK; +} +/*----------------------------------------------------------------------------*/ +static usb_iface_t uhci_rh_usb_iface = { + .get_hc_handle = usb_iface_get_hc_handle, + .get_address = usb_iface_get_address_hub_impl +}; +/*----------------------------------------------------------------------------*/ +static ddf_dev_ops_t uhci_rh_ops = { + .interfaces[USB_DEV_IFACE] = &uhci_rh_usb_iface, +}; +#endif +/*----------------------------------------------------------------------------*/ +/** Initialize a new ddf driver instance of UHCI root hub. + * + * @param[in] device DDF instance of the device to initialize. + * @return Error code. + */ +static int uhci_rh_add_device(ddf_dev_t *device) +{ + if (!device) + return ENOTSUP; + + usb_log_debug2("%s called device %d\n", __FUNCTION__, device->handle); + + //device->ops = &uhci_rh_ops; + uintptr_t io_regs = 0; + size_t io_size = 0; + + int ret = hc_get_my_registers(device, &io_regs, &io_size); + if (ret != EOK) { + usb_log_error("Failed to get registers from parent HC: %s.\n", + str_error(ret)); + } + usb_log_debug("I/O regs at %#X (size %zu).\n", io_regs, io_size); + + uhci_root_hub_t *rh = malloc(sizeof(uhci_root_hub_t)); + if (!rh) { + usb_log_error("Failed to allocate driver instance.\n"); + return ENOMEM; + } + + ret = uhci_root_hub_init(rh, (void*)io_regs, io_size, device); + if (ret != EOK) { + usb_log_error("Failed to initialize driver instance: %s.\n", + str_error(ret)); + free(rh); + return ret; + } + + device->driver_data = rh; + usb_log_info("Controlling root hub `%s' (%llu).\n", + device->name, device->handle); + return EOK; +} +/*----------------------------------------------------------------------------*/ +static driver_ops_t uhci_rh_driver_ops = { + .add_device = uhci_rh_add_device, +}; +/*----------------------------------------------------------------------------*/ +static driver_t uhci_rh_driver = { + .name = NAME, + .driver_ops = &uhci_rh_driver_ops +}; +/*----------------------------------------------------------------------------*/ +/** Initialize global driver structures (NONE). + * + * @param[in] argc Nmber of arguments in argv vector (ignored). + * @param[in] argv Cmdline argument vector (ignored). + * @return Error code. + * + * Driver debug level is set here. + */ +int main(int argc, char *argv[]) +{ + printf(NAME ": HelenOS UHCI root hub driver.\n"); + + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + + return ddf_driver_main(&uhci_rh_driver); +} +/*----------------------------------------------------------------------------*/ +/** Get address of I/O registers. + * + * @param[in] dev Device asking for the addresses. + * @param[out] io_reg_address Base address of the memory range. + * @param[out] io_reg_size Size of the memory range. + * @return Error code. + */ +int hc_get_my_registers( + ddf_dev_t *dev, uintptr_t *io_reg_address, size_t *io_reg_size) +{ + assert(dev != NULL); + + int parent_phone = devman_parent_device_connect(dev->handle, + IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + + int rc; + + hw_resource_list_t hw_resources; + rc = hw_res_get_resource_list(parent_phone, &hw_resources); + if (rc != EOK) { + goto leave; + } + + uintptr_t io_address = 0; + size_t io_size = 0; + bool io_found = false; + + size_t i; + for (i = 0; i < hw_resources.count; i++) { + hw_resource_t *res = &hw_resources.resources[i]; + switch (res->type) + { + case IO_RANGE: + io_address = (uintptr_t) res->res.io_range.address; + io_size = res->res.io_range.size; + io_found = true; + + default: + break; + } + } + + if (!io_found) { + rc = ENOENT; + goto leave; + } + + if (io_reg_address != NULL) { + *io_reg_address = io_address; + } + if (io_reg_size != NULL) { + *io_reg_size = io_size; + } + rc = EOK; + +leave: + async_hangup(parent_phone); + return rc; +} +/** + * @} + */ Index: uspace/drv/uhci-rhd/port.c =================================================================== --- uspace/drv/uhci-rhd/port.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-rhd/port.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,348 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcirh + * @{ + */ +/** @file + * @brief UHCI root hub port routines + */ +#include /* pio_read and pio_write */ +#include +#include +#include + +#include /* usb_address_t */ +#include +#include + +#include "port.h" + +static int uhci_port_new_device(uhci_port_t *port, usb_speed_t speed); +static int uhci_port_remove_device(uhci_port_t *port); +static int uhci_port_set_enabled(uhci_port_t *port, bool enabled); +static int uhci_port_check(void *port); +static int uhci_port_reset_enable(int portno, void *arg); +static void uhci_port_print_status( + uhci_port_t *port, const port_status_t value); + +/** Register reading helper function. + * + * @param[in] port Structure to use. + * @return Error code. (Always EOK) + */ +static inline port_status_t uhci_port_read_status(uhci_port_t *port) +{ + assert(port); + return pio_read_16(port->address); +} +/*----------------------------------------------------------------------------*/ +/** Register writing helper function. + * + * @param[in] port Structure to use. + * @param[in] value New register value. + * @return Error code. (Always EOK) + */ +static inline void uhci_port_write_status( + uhci_port_t *port, port_status_t value) +{ + assert(port); + pio_write_16(port->address, value); +} + +/*----------------------------------------------------------------------------*/ +/** Initialize UHCI root hub port instance. + * + * @param[in] port Memory structure to use. + * @param[in] addr Address of I/O register. + * @param[in] number Port number. + * @param[in] usec Polling interval. + * @param[in] rh Pointer to ddf instance fo the root hub driver. + * @return Error code. + * + * Creates and starts the polling fibril. + */ +int uhci_port_init(uhci_port_t *port, + port_status_t *address, unsigned number, unsigned usec, ddf_dev_t *rh) +{ + assert(port); + asprintf(&port->id_string, "Port (%p - %d)", port, number); + if (port->id_string == NULL) { + return ENOMEM; + } + + port->address = address; + port->number = number; + port->wait_period_usec = usec; + port->attached_device = 0; + port->rh = rh; + + int rc = usb_hc_connection_initialize_from_device( + &port->hc_connection, rh); + if (rc != EOK) { + usb_log_error("Failed to initialize connection to HC."); + return rc; + } + + port->checker = fibril_create(uhci_port_check, port); + if (port->checker == 0) { + usb_log_error("%s: failed to create polling fibril.", + port->id_string); + return ENOMEM; + } + + fibril_add_ready(port->checker); + usb_log_debug("%s: Started polling fibril(%x).\n", + port->id_string, port->checker); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Cleanup UHCI root hub port instance. + * + * @param[in] port Memory structure to use. + * + * Stops the polling fibril. + */ +void uhci_port_fini(uhci_port_t *port) +{ + assert(port); + free(port->id_string); + /* TODO: Kill fibril here */ + return; +} +/*----------------------------------------------------------------------------*/ +/** Periodically checks port status and reports new devices. + * + * @param[in] port Port structure to use. + * @return Error code. + */ +int uhci_port_check(void *port) +{ + uhci_port_t *instance = port; + assert(instance); + + while (1) { + async_usleep(instance->wait_period_usec); + + /* Read register value */ + port_status_t port_status = uhci_port_read_status(instance); + + /* Print the value if it's interesting */ + if (port_status & ~STATUS_ALWAYS_ONE) + uhci_port_print_status(instance, port_status); + + if ((port_status & STATUS_CONNECTED_CHANGED) == 0) + continue; + + usb_log_debug("%s: Connected change detected: %x.\n", + instance->id_string, port_status); + + int rc = + usb_hc_connection_open(&instance->hc_connection); + if (rc != EOK) { + usb_log_error("%s: Failed to connect to HC.", + instance->id_string); + continue; + } + + /* Remove any old device */ + if (instance->attached_device) { + usb_log_debug2("%s: Removing device.\n", + instance->id_string); + uhci_port_remove_device(instance); + } + + if ((port_status & STATUS_CONNECTED) != 0) { + /* New device */ + const usb_speed_t speed = + ((port_status & STATUS_LOW_SPEED) != 0) ? + USB_SPEED_LOW : USB_SPEED_FULL; + uhci_port_new_device(instance, speed); + } else { + /* Write one to WC bits, to ack changes */ + uhci_port_write_status(instance, port_status); + usb_log_debug("%s: status change ACK.\n", + instance->id_string); + } + + rc = usb_hc_connection_close(&instance->hc_connection); + if (rc != EOK) { + usb_log_error("%s: Failed to disconnect.", + instance->id_string); + } + } + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Callback for enabling port during adding a new device. + * + * @param portno Port number (unused). + * @param arg Pointer to uhci_port_t of port with the new device. + * @return Error code. + * + * Resets and enables the ub port. + */ +int uhci_port_reset_enable(int portno, void *arg) +{ + uhci_port_t *port = (uhci_port_t *) arg; + + usb_log_debug2("%s: new_device_enable_port.\n", port->id_string); + + /* + * The host then waits for at least 100 ms to allow completion of + * an insertion process and for power at the device to become stable. + */ + async_usleep(100000); + + /* + * Resets from root ports should be nominally 50ms + */ + { + usb_log_debug("%s: Reset Signal start.\n", port->id_string); + port_status_t port_status = uhci_port_read_status(port); + port_status |= STATUS_IN_RESET; + uhci_port_write_status(port, port_status); + async_usleep(50000); + port_status = uhci_port_read_status(port); + port_status &= ~STATUS_IN_RESET; + uhci_port_write_status(port, port_status); + usb_log_debug("%s: Reset Signal stop.\n", port->id_string); + } + + /* the reset recovery time 10ms */ + async_usleep(10000); + + /* Enable the port. */ + uhci_port_set_enabled(port, true); + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Initialize and report connected device. + * + * @param[in] port Port structure to use. + * @param[in] speed Detected speed. + * @return Error code. + * + * Uses libUSB function to do the actual work. + */ +int uhci_port_new_device(uhci_port_t *port, usb_speed_t speed) +{ + assert(port); + assert(usb_hc_connection_is_opened(&port->hc_connection)); + + usb_log_debug("%s: Detected new device.\n", port->id_string); + + usb_address_t dev_addr; + int rc = usb_hc_new_device_wrapper(port->rh, &port->hc_connection, + speed, uhci_port_reset_enable, port->number, port, + &dev_addr, &port->attached_device, NULL, NULL, NULL); + + if (rc != EOK) { + usb_log_error("%s: Failed(%d) to add device: %s.\n", + port->id_string, rc, str_error(rc)); + uhci_port_set_enabled(port, false); + return rc; + } + + usb_log_info("New device at port %u, address %d (handle %llu).\n", + port->number, dev_addr, port->attached_device); + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Remove device. + * + * @param[in] port Memory structure to use. + * @return Error code. + * + * Does not work, DDF does not support device removal. + * Does not even free used USB address (it would be dangerous if tis driver + * is still running). + */ +int uhci_port_remove_device(uhci_port_t *port) +{ + usb_log_error("%s: Don't know how to remove device %d.\n", + port->id_string, (unsigned int)port->attached_device); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Enable or disable root hub port. + * + * @param[in] port Port structure to use. + * @param[in] enabled Port status to set. + * @return Error code. (Always EOK) + */ +int uhci_port_set_enabled(uhci_port_t *port, bool enabled) +{ + assert(port); + + /* Read register value */ + port_status_t port_status = uhci_port_read_status(port); + + /* Set enabled bit */ + if (enabled) { + port_status |= STATUS_ENABLED; + } else { + port_status &= ~STATUS_ENABLED; + } + + /* Write new value. */ + uhci_port_write_status(port, port_status); + + usb_log_debug("%s: %sabled port.\n", + port->id_string, enabled ? "En" : "Dis"); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Print the port status value in a human friendly way + * + * @param[in] port Port structure to use. + * @param[in] value Port register value to print. + * @return Error code. (Always EOK) + */ +void uhci_port_print_status(uhci_port_t *port, const port_status_t value) +{ + assert(port); + usb_log_debug2("%s Port status(%#x):%s%s%s%s%s%s%s%s%s%s%s.\n", + port->id_string, value, + (value & STATUS_SUSPEND) ? " SUSPENDED," : "", + (value & STATUS_RESUME) ? " IN RESUME," : "", + (value & STATUS_IN_RESET) ? " IN RESET," : "", + (value & STATUS_LINE_D_MINUS) ? " VD-," : "", + (value & STATUS_LINE_D_PLUS) ? " VD+," : "", + (value & STATUS_LOW_SPEED) ? " LOWSPEED," : "", + (value & STATUS_ENABLED_CHANGED) ? " ENABLED-CHANGE," : "", + (value & STATUS_ENABLED) ? " ENABLED," : "", + (value & STATUS_CONNECTED_CHANGED) ? " CONNECTED-CHANGE," : "", + (value & STATUS_CONNECTED) ? " CONNECTED," : "", + (value & STATUS_ALWAYS_ONE) ? " ALWAYS ONE" : " ERROR: NO ALWAYS ONE" + ); +} +/** + * @} + */ Index: uspace/drv/uhci-rhd/port.h =================================================================== --- uspace/drv/uhci-rhd/port.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-rhd/port.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,77 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcirh + * @{ + */ +/** @file + * @brief UHCI root hub port routines + */ +#ifndef DRV_UHCI_PORT_H +#define DRV_UHCI_PORT_H + +#include +#include +#include +#include /* usb_hc_connection_t */ + +typedef uint16_t port_status_t; +#define STATUS_CONNECTED (1 << 0) +#define STATUS_CONNECTED_CHANGED (1 << 1) +#define STATUS_ENABLED (1 << 2) +#define STATUS_ENABLED_CHANGED (1 << 3) +#define STATUS_LINE_D_PLUS (1 << 4) +#define STATUS_LINE_D_MINUS (1 << 5) +#define STATUS_RESUME (1 << 6) +#define STATUS_ALWAYS_ONE (1 << 7) + +#define STATUS_LOW_SPEED (1 << 8) +#define STATUS_IN_RESET (1 << 9) +#define STATUS_SUSPEND (1 << 12) + +typedef struct uhci_port +{ + char *id_string; + port_status_t *address; + unsigned number; + unsigned wait_period_usec; + usb_hc_connection_t hc_connection; + ddf_dev_t *rh; + devman_handle_t attached_device; + fid_t checker; +} uhci_port_t; + +int uhci_port_init( + uhci_port_t *port, port_status_t *address, unsigned number, + unsigned usec, ddf_dev_t *rh); + +void uhci_port_fini(uhci_port_t *port); + +#endif +/** + * @} + */ Index: uspace/drv/uhci-rhd/root_hub.c =================================================================== --- uspace/drv/uhci-rhd/root_hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-rhd/root_hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,100 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcirh + * @{ + */ +/** @file + * @brief UHCI root hub driver + */ +#include +#include +#include + +#include "root_hub.h" + +/** Initialize UHCI root hub instance. + * + * @param[in] instance Driver memory structure to use. + * @param[in] addr Address of I/O registers. + * @param[in] size Size of available I/O space. + * @param[in] rh Pointer to ddf instance of the root hub driver. + * @return Error code. + */ +int uhci_root_hub_init( + uhci_root_hub_t *instance, void *addr, size_t size, ddf_dev_t *rh) +{ + assert(instance); + assert(rh); + int ret; + + /* Allow access to root hub port registers */ + assert(sizeof(port_status_t) * UHCI_ROOT_HUB_PORT_COUNT <= size); + port_status_t *regs; + ret = pio_enable(addr, size, (void**)®s); + if (ret < 0) { + usb_log_error( + "Failed(%d) to gain access to port registers at %p\n", + ret, regs); + return ret; + } + + /* Initialize root hub ports */ + unsigned i = 0; + for (; i < UHCI_ROOT_HUB_PORT_COUNT; ++i) { + /* NOTE: mind pointer arithmetics here */ + ret = uhci_port_init( + &instance->ports[i], regs + i, i, ROOT_HUB_WAIT_USEC, rh); + if (ret != EOK) { + unsigned j = 0; + for (;j < i; ++j) + uhci_port_fini(&instance->ports[j]); + return ret; + } + } + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Cleanup UHCI root hub instance. + * + * @param[in] instance Root hub structure to use. + * @return Error code. + */ +int uhci_root_hub_fini(uhci_root_hub_t* instance) +{ + assert(instance); + unsigned i = 0; + for (; i < UHCI_ROOT_HUB_PORT_COUNT; ++i) { + uhci_port_fini(&instance->ports[i]); + } + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** + * @} + */ Index: uspace/drv/uhci-rhd/root_hub.h =================================================================== --- uspace/drv/uhci-rhd/root_hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-rhd/root_hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,56 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcirh + * @{ + */ +/** @file + * @brief UHCI driver + */ +#ifndef DRV_UHCI_ROOT_HUB_H +#define DRV_UHCI_ROOT_HUB_H + +#include + +#include "port.h" + +#define UHCI_ROOT_HUB_PORT_COUNT 2 +#define ROOT_HUB_WAIT_USEC 5000000 /* 5 seconds */ + +typedef struct root_hub { + uhci_port_t ports[UHCI_ROOT_HUB_PORT_COUNT]; + devman_handle_t hc_handle; +} uhci_root_hub_t; + +int uhci_root_hub_init( + uhci_root_hub_t *instance, void *addr, size_t size, ddf_dev_t *rh); + +int uhci_root_hub_fini(uhci_root_hub_t *instance); +#endif +/** + * @} + */ Index: uspace/drv/uhci-rhd/uhci-rhd.ma =================================================================== --- uspace/drv/uhci-rhd/uhci-rhd.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-rhd/uhci-rhd.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,1 @@ +10 usb&uhci&root-hub Index: uspace/drv/usbflbk/Makefile =================================================================== --- uspace/drv/usbflbk/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbflbk/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,37 @@ +# +# Copyright (c) 2011 Vojtech Horky +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBS = $(LIBDRV_PREFIX)/libdrv.a $(LIBUSB_PREFIX)/libusb.a +EXTRA_CFLAGS += -I$(LIBDRV_PREFIX)/include -I$(LIBUSB_PREFIX)/include +BINARY = usbflbk + +SOURCES = \ + main.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/usbflbk/main.c =================================================================== --- uspace/drv/usbflbk/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbflbk/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,95 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbfallback + * @{ + */ +/** + * @file + * Main routines of USB fallback driver. + */ +#include +#include +#include +#include + +#define NAME "usbflbk" + +/** Callback when new device is attached and recognized by DDF. + * + * @param dev Representation of a generic DDF device. + * @return Error code. + */ +static int usbfallback_add_device(usb_device_t *dev) +{ + int rc; + const char *fun_name = "ctl"; + + ddf_fun_t *ctl_fun = ddf_fun_create(dev->ddf_dev, fun_exposed, + fun_name); + if (ctl_fun == NULL) { + usb_log_error("Failed to create control function.\n"); + return ENOMEM; + } + rc = ddf_fun_bind(ctl_fun); + if (rc != EOK) { + usb_log_error("Failed to bind control function: %s.\n", + str_error(rc)); + return rc; + } + + usb_log_info("Pretending to control %s `%s'" \ + " (node `%s', handle %llu).\n", + dev->interface_no < 0 ? "device" : "interface", + dev->ddf_dev->name, fun_name, dev->ddf_dev->handle); + + return EOK; +} + +/** USB fallback driver ops. */ +static usb_driver_ops_t usbfallback_driver_ops = { + .add_device = usbfallback_add_device, +}; + +/** USB fallback driver. */ +static usb_driver_t usbfallback_driver = { + .name = NAME, + .ops = &usbfallback_driver_ops, + .endpoints = NULL +}; + +int main(int argc, char *argv[]) +{ + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + + return usb_driver_main(&usbfallback_driver); +} + +/** + * @} + */ Index: uspace/drv/usbflbk/usbflbk.ma =================================================================== --- uspace/drv/usbflbk/usbflbk.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbflbk/usbflbk.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,2 @@ +10 usb&fallback +10 usb&interface&fallback Index: uspace/drv/usbhub/Makefile =================================================================== --- uspace/drv/usbhub/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbhub/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,40 @@ +# +# Copyright (c) 2010 Vojtech Horky +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBS = $(LIBDRV_PREFIX)/libdrv.a $(LIBUSB_PREFIX)/libusb.a +EXTRA_CFLAGS += -I$(LIBDRV_PREFIX)/include -I$(LIBUSB_PREFIX)/include +BINARY = usbhub + +SOURCES = \ + main.c \ + utils.c \ + usbhub.c \ + usblist.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/usbhub/main.c =================================================================== --- uspace/drv/usbhub/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbhub/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,86 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhub + * @{ + */ + +#include +#include +#include +#include + +#include +#include + +#include "usbhub.h" +#include "usbhub_private.h" + +/** Hub status-change endpoint description. + * + * For more information see section 11.15.1 of USB 1.1 specification. + */ +static usb_endpoint_description_t hub_status_change_endpoint_description = { + .transfer_type = USB_TRANSFER_INTERRUPT, + .direction = USB_DIRECTION_IN, + .interface_class = USB_CLASS_HUB, + .interface_subclass = 0, + .interface_protocol = 0, + .flags = 0 +}; + + +static usb_driver_ops_t usb_hub_driver_ops = { + .add_device = usb_hub_add_device +}; + +static usb_endpoint_description_t *usb_hub_endpoints[] = { + &hub_status_change_endpoint_description, + NULL +}; + +static usb_driver_t usb_hub_driver = { + .name = NAME, + .ops = &usb_hub_driver_ops, + .endpoints = usb_hub_endpoints +}; + + +int main(int argc, char *argv[]) +{ + printf(NAME ": HelenOS USB hub driver.\n"); + + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + + return usb_driver_main(&usb_hub_driver); +} + +/** + * @} + */ + Index: uspace/drv/usbhub/port_status.h =================================================================== --- uspace/drv/usbhub/port_status.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbhub/port_status.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,360 @@ +/* + * Copyright (c) 2010 Matus Dekanek + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbhub + * @{ + */ + +#ifndef HUB_PORT_STATUS_H +#define HUB_PORT_STATUS_H + +#include +#include +#include +#include "usbhub_private.h" + +/** + * structure holding port status and changes flags. + * should not be accessed directly, use supplied getter/setter methods. + * + * For more information refer to table 11-15 in + * "Universal Serial Bus Specification Revision 1.1" + * + */ +typedef uint32_t usb_port_status_t; + +/** + * set values in request to be it a port status request + * @param request + * @param port + */ +static inline void usb_hub_set_port_status_request( +usb_device_request_setup_packet_t * request, uint16_t port +){ + request->index = port; + request->request_type = USB_HUB_REQ_TYPE_GET_PORT_STATUS; + request->request = USB_HUB_REQUEST_GET_STATUS; + request->value = 0; + request->length = 4; +} + + +/** + * create request for usb hub port status + * @param port + * @return + */ +static inline usb_device_request_setup_packet_t * +usb_hub_create_port_status_request(uint16_t port){ + usb_device_request_setup_packet_t * result = + usb_new(usb_device_request_setup_packet_t); + usb_hub_set_port_status_request(result,port); + return result; +} + + +/** + * set the device request to be a port feature enable request + * @param request + * @param port + * @param feature_selector + */ +static inline void usb_hub_set_enable_port_feature_request( +usb_device_request_setup_packet_t * request, uint16_t port, + uint16_t feature_selector +){ + request->index = port; + request->request_type = USB_HUB_REQ_TYPE_SET_PORT_FEATURE; + request->request = USB_HUB_REQUEST_SET_FEATURE; + request->value = feature_selector; + request->length = 0; +} + + +/** + * set the device request to be a port enable request + * @param request + * @param port + */ +static inline void usb_hub_set_enable_port_request( +usb_device_request_setup_packet_t * request, uint16_t port +){ + request->index = port; + request->request_type = USB_HUB_REQ_TYPE_SET_PORT_FEATURE; + request->request = USB_HUB_REQUEST_SET_FEATURE; + request->value = USB_HUB_FEATURE_C_PORT_ENABLE; + request->length = 0; +} + +/** + * enable specified port + * @param port + * @return + */ +static inline usb_device_request_setup_packet_t * +usb_hub_create_enable_port_request(uint16_t port){ + usb_device_request_setup_packet_t * result = + usb_new(usb_device_request_setup_packet_t); + usb_hub_set_enable_port_request(result,port); + return result; +} + +/** + * set the device request to be a port disable request + * @param request + * @param port + */ +static inline void usb_hub_set_disable_port_request( +usb_device_request_setup_packet_t * request, uint16_t port +){ + request->index = port; + request->request_type = USB_HUB_REQ_TYPE_SET_PORT_FEATURE; + request->request = USB_HUB_REQUEST_SET_FEATURE; + request->value = USB_HUB_FEATURE_C_PORT_SUSPEND; + request->length = 0; +} + +/** + * disable specified port + * @param port + * @return + */ +static inline usb_device_request_setup_packet_t * +usb_hub_create_disable_port_request(uint16_t port){ + usb_device_request_setup_packet_t * result = + usb_new(usb_device_request_setup_packet_t); + usb_hub_set_disable_port_request(result,port); + return result; +} + +/** + * set the device request to be a port disable request + * @param request + * @param port + */ +static inline void usb_hub_set_reset_port_request( +usb_device_request_setup_packet_t * request, uint16_t port +){ + request->index = port; + request->request_type = USB_HUB_REQ_TYPE_SET_PORT_FEATURE; + request->request = USB_HUB_REQUEST_SET_FEATURE; + request->value = USB_HUB_FEATURE_PORT_RESET; + request->length = 0; +} + +/** + * disable specified port + * @param port + * @return + */ +static inline usb_device_request_setup_packet_t * +usb_hub_create_reset_port_request(uint16_t port){ + usb_device_request_setup_packet_t * result = + usb_new(usb_device_request_setup_packet_t); + usb_hub_set_reset_port_request(result,port); + return result; +} + +/** + * set the device request to be a port disable request + * @param request + * @param port + */ +static inline void usb_hub_set_power_port_request( +usb_device_request_setup_packet_t * request, uint16_t port +){ + request->index = port; + request->request_type = USB_HUB_REQ_TYPE_SET_PORT_FEATURE; + request->request = USB_HUB_REQUEST_SET_FEATURE; + request->value = USB_HUB_FEATURE_PORT_POWER; + request->length = 0; +} + +/** + * set the device request to be a port disable request + * @param request + * @param port + */ +static inline void usb_hub_unset_power_port_request( +usb_device_request_setup_packet_t * request, uint16_t port +){ + request->index = port; + request->request_type = USB_HUB_REQ_TYPE_SET_PORT_FEATURE; + request->request = USB_HUB_REQUEST_CLEAR_FEATURE; + request->value = USB_HUB_FEATURE_PORT_POWER; + request->length = 0; +} + + +/** get i`th bit of port status */ +static inline bool usb_port_get_bit(usb_port_status_t * status, int idx) +{ + return (((*status)>>(idx))%2); +} + +/** set i`th bit of port status */ +static inline void usb_port_set_bit( + usb_port_status_t * status, int idx, bool value) +{ + (*status) = value? + ((*status)|(1<<(idx))): + ((*status)&(~(1<<(idx)))); +} + +//device connnected on port +static inline bool usb_port_dev_connected(usb_port_status_t * status){ + return usb_port_get_bit(status,0); +} + +static inline void usb_port_set_dev_connected(usb_port_status_t * status,bool connected){ + usb_port_set_bit(status,0,connected); +} + +//port enabled +static inline bool usb_port_enabled(usb_port_status_t * status){ + return usb_port_get_bit(status,1); +} + +static inline void usb_port_set_enabled(usb_port_status_t * status,bool enabled){ + usb_port_set_bit(status,1,enabled); +} + +//port suspended +static inline bool usb_port_suspended(usb_port_status_t * status){ + return usb_port_get_bit(status,2); +} + +static inline void usb_port_set_suspended(usb_port_status_t * status,bool suspended){ + usb_port_set_bit(status,2,suspended); +} + +//over currect +static inline bool usb_port_over_current(usb_port_status_t * status){ + return usb_port_get_bit(status,3); +} + +static inline void usb_port_set_over_current(usb_port_status_t * status,bool value){ + usb_port_set_bit(status,3,value); +} + +//port reset +static inline bool usb_port_reset(usb_port_status_t * status){ + return usb_port_get_bit(status,4); +} + +static inline void usb_port_set_reset(usb_port_status_t * status,bool value){ + usb_port_set_bit(status,4,value); +} + +//powered +static inline bool usb_port_powered(usb_port_status_t * status){ + return usb_port_get_bit(status,8); +} + +static inline void usb_port_set_powered(usb_port_status_t * status,bool powered){ + usb_port_set_bit(status,8,powered); +} + +//low speed device attached +static inline bool usb_port_low_speed(usb_port_status_t * status){ + return usb_port_get_bit(status,9); +} + +static inline void usb_port_set_low_speed(usb_port_status_t * status,bool low_speed){ + usb_port_set_bit(status,9,low_speed); +} + +//low speed device attached +static inline bool usb_port_high_speed(usb_port_status_t * status){ + return usb_port_get_bit(status,10); +} + +static inline void usb_port_set_high_speed(usb_port_status_t * status,bool high_speed){ + usb_port_set_bit(status,10,high_speed); +} + +static inline usb_speed_t usb_port_speed(usb_port_status_t * status){ + if(usb_port_low_speed(status)) + return USB_SPEED_LOW; + if(usb_port_high_speed(status)) + return USB_SPEED_HIGH; + return USB_SPEED_FULL; +} + + +//connect change +static inline bool usb_port_connect_change(usb_port_status_t * status){ + return usb_port_get_bit(status,16); +} + +static inline void usb_port_set_connect_change(usb_port_status_t * status,bool change){ + usb_port_set_bit(status,16,change); +} + +//port enable change +static inline bool usb_port_enabled_change(usb_port_status_t * status){ + return usb_port_get_bit(status,17); +} + +static inline void usb_port_set_enabled_change(usb_port_status_t * status,bool change){ + usb_port_set_bit(status,17,change); +} + +//suspend change +static inline bool usb_port_suspend_change(usb_port_status_t * status){ + return usb_port_get_bit(status,18); +} + +static inline void usb_port_set_suspend_change(usb_port_status_t * status,bool change){ + usb_port_set_bit(status,18,change); +} + +//over current change +static inline bool usb_port_overcurrent_change(usb_port_status_t * status){ + return usb_port_get_bit(status,19); +} + +static inline void usb_port_set_overcurrent_change(usb_port_status_t * status,bool change){ + usb_port_set_bit(status,19,change); +} + +//reset change +static inline bool usb_port_reset_completed(usb_port_status_t * status){ + return usb_port_get_bit(status,20); +} + +static inline void usb_port_set_reset_completed(usb_port_status_t * status,bool completed){ + usb_port_set_bit(status,20,completed); +} + + + +#endif /* HUB_PORT_STATUS_H */ + +/** + * @} + */ Index: uspace/drv/usbhub/usbhub.c =================================================================== --- uspace/drv/usbhub/usbhub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbhub/usbhub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,696 @@ +/* + * Copyright (c) 2010 Matus Dekanek + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbhub + * @{ + */ +/** @file + * @brief usb hub main functionality + */ + +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include + +#include "usbhub.h" +#include "usbhub_private.h" +#include "port_status.h" +#include "usb/usb.h" +#include "usb/pipes.h" +#include "usb/classes/classes.h" + + +static void usb_hub_init_add_device(usb_hub_info_t * hub, uint16_t port, + usb_speed_t speed); + +static int usb_hub_trigger_connecting_non_removable_devices( + usb_hub_info_t * hub, usb_hub_descriptor_t * descriptor); + +/** + * control loop running in hub`s fibril + * + * Hub`s fibril periodically asks for changes on hub and if needded calls + * change handling routine. + * @warning currently hub driver asks for changes once a second + * @param hub_info_param hub representation pointer + * @return zero + */ +int usb_hub_control_loop(void * hub_info_param){ + usb_hub_info_t * hub_info = (usb_hub_info_t*)hub_info_param; + int errorCode = EOK; + + while(errorCode == EOK){ + async_usleep(1000 * 1000 * 10 );/// \TODO proper number once + errorCode = usb_hub_check_hub_changes(hub_info); + } + usb_log_error("something in ctrl loop went wrong, errno %d\n",errorCode); + + return 0; +} + + +//********************************************* +// +// hub driver code, initialization +// +//********************************************* + +/** + * create usb_hub_info_t structure + * + * Does only basic copying of known information into new structure. + * @param usb_dev usb device structure + * @return basic usb_hub_info_t structure + */ +static usb_hub_info_t * usb_hub_info_create(usb_device_t * usb_dev) { + usb_hub_info_t * result = usb_new(usb_hub_info_t); + if(!result) return NULL; + result->usb_device = usb_dev; + result->status_change_pipe = usb_dev->pipes[0].pipe; + result->control_pipe = &usb_dev->ctrl_pipe; + result->is_default_address_used = false; + return result; +} + +/** + * Load hub-specific information into hub_info structure and process if needed + * + * Particularly read port count and initialize structure holding port + * information. If there are non-removable devices, start initializing them. + * This function is hub-specific and should be run only after the hub is + * configured using usb_hub_set_configuration function. + * @param hub_info hub representation + * @return error code + */ +static int usb_hub_process_hub_specific_info(usb_hub_info_t * hub_info){ + // get hub descriptor + usb_log_debug("creating serialized descriptor\n"); + void * serialized_descriptor = malloc(USB_HUB_MAX_DESCRIPTOR_SIZE); + usb_hub_descriptor_t * descriptor; + + /* this was one fix of some bug, should not be needed anymore + * these lines allow to reset hub once more, it can be used as + * brute-force initialization for non-removable devices + int opResult = usb_request_set_configuration(&result->endpoints.control, 1); + if(opResult!=EOK){ + usb_log_error("could not set default configuration, errno %d",opResult); + return opResult; + } + */ + size_t received_size; + int opResult = usb_request_get_descriptor(&hub_info->usb_device->ctrl_pipe, + USB_REQUEST_TYPE_CLASS, USB_REQUEST_RECIPIENT_DEVICE, + USB_DESCTYPE_HUB, + 0, 0, serialized_descriptor, + USB_HUB_MAX_DESCRIPTOR_SIZE, &received_size); + + if (opResult != EOK) { + usb_log_error("failed when receiving hub descriptor, badcode = %d\n", + opResult); + free(serialized_descriptor); + return opResult; + } + usb_log_debug2("deserializing descriptor\n"); + descriptor = usb_deserialize_hub_desriptor(serialized_descriptor); + if(descriptor==NULL){ + usb_log_warning("could not deserialize descriptor \n"); + return opResult; + } + usb_log_debug("setting port count to %d\n",descriptor->ports_count); + hub_info->port_count = descriptor->ports_count; + hub_info->attached_devs = (usb_hc_attached_device_t*) + malloc((hub_info->port_count+1) * sizeof(usb_hc_attached_device_t)); + int i; + for(i=0;iport_count+1;++i){ + hub_info->attached_devs[i].handle=0; + hub_info->attached_devs[i].address=0; + } + //handle non-removable devices + usb_hub_trigger_connecting_non_removable_devices(hub_info, descriptor); + usb_log_debug2("freeing data\n"); + free(serialized_descriptor); + free(descriptor->devices_removable); + free(descriptor); + return EOK; +} +/** + * Set configuration of hub + * + * Check whether there is at least one configuration and sets the first one. + * This function should be run prior to running any hub-specific action. + * @param hub_info hub representation + * @return error code + */ +static int usb_hub_set_configuration(usb_hub_info_t * hub_info){ + //device descriptor + usb_standard_device_descriptor_t *std_descriptor + = &hub_info->usb_device->descriptors.device; + usb_log_debug("hub has %d configurations\n", + std_descriptor->configuration_count); + if(std_descriptor->configuration_count<1){ + usb_log_error("there are no configurations available\n"); + return EINVAL; + } + + usb_standard_configuration_descriptor_t *config_descriptor + = (usb_standard_configuration_descriptor_t *) + hub_info->usb_device->descriptors.configuration; + + /* Set configuration. */ + int opResult = usb_request_set_configuration( + &hub_info->usb_device->ctrl_pipe, + config_descriptor->configuration_number); + + if (opResult != EOK) { + usb_log_error("Failed to set hub configuration: %s.\n", + str_error(opResult)); + return opResult; + } + usb_log_debug("\tused configuration %d\n", + config_descriptor->configuration_number); + + return EOK; +} + +/** + * Initialize hub device driver fibril + * + * Creates hub representation and fibril that periodically checks hub`s status. + * Hub representation is passed to the fibril. + * @param usb_dev generic usb device information + * @return error code + */ +int usb_hub_add_device(usb_device_t * usb_dev){ + if(!usb_dev) return EINVAL; + usb_hub_info_t * hub_info = usb_hub_info_create(usb_dev); + //create hc connection + usb_log_debug("Initializing USB wire abstraction.\n"); + int opResult = usb_hc_connection_initialize_from_device( + &hub_info->connection, + hub_info->usb_device->ddf_dev); + if(opResult != EOK){ + usb_log_error("could not initialize connection to device, errno %d\n", + opResult); + free(hub_info); + return opResult; + } + + usb_pipe_start_session(hub_info->control_pipe); + //set hub configuration + opResult = usb_hub_set_configuration(hub_info); + if(opResult!=EOK){ + usb_log_error("could not set hub configuration, errno %d\n",opResult); + free(hub_info); + return opResult; + } + //get port count and create attached_devs + opResult = usb_hub_process_hub_specific_info(hub_info); + if(opResult!=EOK){ + usb_log_error("could not set hub configuration, errno %d\n",opResult); + free(hub_info); + return opResult; + } + usb_pipe_end_session(hub_info->control_pipe); + + + /// \TODO what is this? + usb_log_debug("Creating `hub' function.\n"); + ddf_fun_t *hub_fun = ddf_fun_create(hub_info->usb_device->ddf_dev, + fun_exposed, "hub"); + assert(hub_fun != NULL); + hub_fun->ops = NULL; + + int rc = ddf_fun_bind(hub_fun); + assert(rc == EOK); + rc = ddf_fun_add_to_class(hub_fun, "hub"); + assert(rc == EOK); + + //create fibril for the hub control loop + fid_t fid = fibril_create(usb_hub_control_loop, hub_info); + if (fid == 0) { + usb_log_error("failed to start monitoring fibril for new hub.\n"); + return ENOMEM; + } + fibril_add_ready(fid); + usb_log_debug("Hub fibril created.\n"); + + usb_log_info("Controlling hub `%s' (%d ports).\n", + hub_info->usb_device->ddf_dev->name, hub_info->port_count); + return EOK; +} + + +//********************************************* +// +// hub driver code, main loop and port handling +// +//********************************************* + +/** + * triggers actions to connect non0removable devices + * + * This will trigger operations leading to activated non-removable device. + * Control pipe of the hub must be open fo communication. + * @param hub hub representation + * @param descriptor usb hub descriptor + * @return error code + */ +static int usb_hub_trigger_connecting_non_removable_devices(usb_hub_info_t * hub, + usb_hub_descriptor_t * descriptor) +{ + usb_log_info("attaching non-removable devices(if any)\n"); + usb_device_request_setup_packet_t request; + int opResult; + size_t rcvd_size; + usb_port_status_t status; + uint8_t * non_removable_dev_bitmap = descriptor->devices_removable; + int port; + for(port=1;port<=descriptor->ports_count;++port){ + bool is_non_removable = + ((non_removable_dev_bitmap[port/8]) >> (port%8)) %2; + if(is_non_removable){ + usb_log_debug("non-removable device on port %d\n",port); + usb_hub_set_port_status_request(&request, port); + opResult = usb_pipe_control_read( + hub->control_pipe, + &request, sizeof(usb_device_request_setup_packet_t), + &status, 4, &rcvd_size + ); + if (opResult != EOK) { + usb_log_error("could not get port status of port %d errno:%d\n", + port, opResult); + return opResult; + } + //set the status change bit, so it will be noticed in driver loop + if(usb_port_dev_connected(&status)){ + usb_hub_set_enable_port_feature_request(&request, port, + USB_HUB_FEATURE_C_PORT_CONNECTION); + opResult = usb_pipe_control_read( + hub->control_pipe, + &request, sizeof(usb_device_request_setup_packet_t), + &status, 4, &rcvd_size + ); + if (opResult != EOK) { + usb_log_warning( + "could not set port change on port %d errno:%d\n", + port, opResult); + } + } + } + } + return EOK; +} + + +/** + * release default address used by given hub + * + * Also unsets hub->is_default_address_used. Convenience wrapper function. + * @note hub->connection MUST be open for communication + * @param hub hub representation + * @return error code + */ +static int usb_hub_release_default_address(usb_hub_info_t * hub){ + int opResult = usb_hc_release_default_address(&hub->connection); + if(opResult!=EOK){ + usb_log_error("could not release default address, errno %d\n",opResult); + return opResult; + } + hub->is_default_address_used = false; + return EOK; +} + +/** + * Reset the port with new device and reserve the default address. + * @param hub hub representation + * @param port port number, starting from 1 + * @param speed transfer speed of attached device, one of low, full or high + */ +static void usb_hub_init_add_device(usb_hub_info_t * hub, uint16_t port, + usb_speed_t speed) { + //if this hub already uses default address, it cannot request it once more + if(hub->is_default_address_used) return; + usb_log_debug("some connection changed\n"); + assert(hub->control_pipe->hc_phone); + int opResult = usb_hub_clear_port_feature(hub->control_pipe, + port, USB_HUB_FEATURE_C_PORT_CONNECTION); + if(opResult != EOK){ + usb_log_warning("could not clear port-change-connection flag\n"); + } + usb_device_request_setup_packet_t request; + + //get default address + opResult = usb_hc_reserve_default_address(&hub->connection, speed); + + if (opResult != EOK) { + usb_log_warning("cannot assign default address, it is probably used %d\n", + opResult); + return; + } + hub->is_default_address_used = true; + //reset port + usb_hub_set_reset_port_request(&request, port); + opResult = usb_pipe_control_write( + hub->control_pipe, + &request,sizeof(usb_device_request_setup_packet_t), + NULL, 0 + ); + if (opResult != EOK) { + usb_log_error("something went wrong when reseting a port %d\n",opResult); + usb_hub_release_default_address(hub); + } + return; +} + +/** + * Finalize adding new device after port reset + * + * Set device`s address and start it`s driver. + * @param hub hub representation + * @param port port number, starting from 1 + * @param speed transfer speed of attached device, one of low, full or high + */ +static void usb_hub_finalize_add_device( usb_hub_info_t * hub, + uint16_t port, usb_speed_t speed) { + + int opResult; + usb_log_debug("finalizing add device\n"); + opResult = usb_hub_clear_port_feature(hub->control_pipe, + port, USB_HUB_FEATURE_C_PORT_RESET); + + if (opResult != EOK) { + usb_log_error("failed to clear port reset feature\n"); + usb_hub_release_default_address(hub); + return; + } + //create connection to device + usb_pipe_t new_device_pipe; + usb_device_connection_t new_device_connection; + usb_device_connection_initialize_on_default_address( + &new_device_connection, + &hub->connection + ); + usb_pipe_initialize_default_control( + &new_device_pipe, + &new_device_connection); + usb_pipe_probe_default_control(&new_device_pipe); + + /* Request address from host controller. */ + usb_address_t new_device_address = usb_hc_request_address( + &hub->connection, + speed + ); + if (new_device_address < 0) { + usb_log_error("failed to get free USB address\n"); + opResult = new_device_address; + usb_hub_release_default_address(hub); + return; + } + usb_log_debug("setting new address %d\n",new_device_address); + //opResult = usb_drv_req_set_address(hc, USB_ADDRESS_DEFAULT, + // new_device_address); + usb_pipe_start_session(&new_device_pipe); + opResult = usb_request_set_address(&new_device_pipe,new_device_address); + usb_pipe_end_session(&new_device_pipe); + if (opResult != EOK) { + usb_log_error("could not set address for new device %d\n",opResult); + usb_hub_release_default_address(hub); + return; + } + + //opResult = usb_hub_release_default_address(hc); + opResult = usb_hub_release_default_address(hub); + if(opResult!=EOK){ + return; + } + + devman_handle_t child_handle; + //?? + opResult = usb_device_register_child_in_devman(new_device_address, + hub->connection.hc_handle, hub->usb_device->ddf_dev, &child_handle, + NULL, NULL, NULL); + + if (opResult != EOK) { + usb_log_error("could not start driver for new device %d\n",opResult); + return; + } + hub->attached_devs[port].handle = child_handle; + hub->attached_devs[port].address = new_device_address; + + //opResult = usb_drv_bind_address(hc, new_device_address, child_handle); + opResult = usb_hc_register_device( + &hub->connection, + &hub->attached_devs[port]); + if (opResult != EOK) { + usb_log_error("could not assign address of device in hcd %d\n",opResult); + return; + } + usb_log_info("Detected new device on `%s' (port %d), " \ + "address %d (handle %llu).\n", + hub->usb_device->ddf_dev->name, (int) port, + new_device_address, child_handle); +} + +/** + * routine called when a device on port has been removed + * + * If the device on port had default address, it releases default address. + * Otherwise does not do anything, because DDF does not allow to remove device + * from it`s device tree. + * @param hub hub representation + * @param port port number, starting from 1 + */ +static void usb_hub_removed_device( + usb_hub_info_t * hub,uint16_t port) { + + int opResult = usb_hub_clear_port_feature(hub->control_pipe, + port, USB_HUB_FEATURE_C_PORT_CONNECTION); + if(opResult != EOK){ + usb_log_warning("could not clear port-change-connection flag\n"); + } + /** \TODO remove device from device manager - not yet implemented in + * devide manager + */ + + //close address + if(hub->attached_devs[port].address!=0){ + /*uncomment this code to use it when DDF allows device removal + opResult = usb_hc_unregister_device( + &hub->connection, hub->attached_devs[port].address); + if(opResult != EOK) { + dprintf(USB_LOG_LEVEL_WARNING, "could not release address of " \ + "removed device: %d", opResult); + } + hub->attached_devs[port].address = 0; + hub->attached_devs[port].handle = 0; + */ + }else{ + usb_log_warning("this is strange, disconnected device had no address\n"); + //device was disconnected before it`s port was reset - return default address + usb_hub_release_default_address(hub); + } +} + + +/** + * Process over current condition on port. + * + * Turn off the power on the port. + * + * @param hub hub representation + * @param port port number, starting from 1 + */ +static void usb_hub_over_current( usb_hub_info_t * hub, + uint16_t port){ + int opResult; + opResult = usb_hub_clear_port_feature(hub->control_pipe, + port, USB_HUB_FEATURE_PORT_POWER); + if(opResult!=EOK){ + usb_log_error("cannot power off port %d; %d\n", + port, opResult); + } +} + +/** + * Process interrupts on given hub port + * + * Accepts connection, over current and port reset change. + * @param hub hub representation + * @param port port number, starting from 1 + */ +static void usb_hub_process_interrupt(usb_hub_info_t * hub, + uint16_t port) { + usb_log_debug("interrupt at port %d\n", port); + //determine type of change + usb_pipe_t *pipe = hub->control_pipe; + + int opResult; + + usb_port_status_t status; + size_t rcvd_size; + usb_device_request_setup_packet_t request; + //int opResult; + usb_hub_set_port_status_request(&request, port); + //endpoint 0 + + opResult = usb_pipe_control_read( + pipe, + &request, sizeof(usb_device_request_setup_packet_t), + &status, 4, &rcvd_size + ); + if (opResult != EOK) { + usb_log_error("could not get port status\n"); + return; + } + if (rcvd_size != sizeof (usb_port_status_t)) { + usb_log_error("received status has incorrect size\n"); + return; + } + //something connected/disconnected + if (usb_port_connect_change(&status)) { + if (usb_port_dev_connected(&status)) { + usb_log_debug("some connection changed\n"); + usb_hub_init_add_device(hub, port, usb_port_speed(&status)); + } else { + usb_hub_removed_device(hub, port); + } + } + //over current + if (usb_port_overcurrent_change(&status)) { + //check if it was not auto-resolved + if(usb_port_over_current(&status)){ + usb_hub_over_current(hub,port); + }else{ + usb_log_debug("over current condition was auto-resolved on port %d\n", + port); + } + } + //port reset + if (usb_port_reset_completed(&status)) { + usb_log_debug("port reset complete\n"); + if (usb_port_enabled(&status)) { + usb_hub_finalize_add_device(hub, port, usb_port_speed(&status)); + } else { + usb_log_warning("port reset, but port still not enabled\n"); + } + } + + usb_port_set_connect_change(&status, false); + usb_port_set_reset(&status, false); + usb_port_set_reset_completed(&status, false); + usb_port_set_dev_connected(&status, false); + if (status>>16) { + usb_log_info("there was some unsupported change on port %d: %X\n", + port,status); + + } +} + +/** + * check changes on hub + * + * Handles changes on each port with a status change. + * @param hub_info hub representation + * @return error code + */ +int usb_hub_check_hub_changes(usb_hub_info_t * hub_info){ + int opResult; + opResult = usb_pipe_start_session( + hub_info->status_change_pipe); + if(opResult != EOK){ + usb_log_error("could not initialize communication for hub; %d\n", + opResult); + return opResult; + } + + size_t port_count = hub_info->port_count; + + /// FIXME: count properly + size_t byte_length = ((port_count+1) / 8) + 1; + void *change_bitmap = malloc(byte_length); + size_t actual_size; + + /* + * Send the request. + */ + opResult = usb_pipe_read( + hub_info->status_change_pipe, + change_bitmap, byte_length, &actual_size + ); + + if (opResult != EOK) { + free(change_bitmap); + usb_log_warning("something went wrong while getting status of hub\n"); + usb_pipe_end_session(hub_info->status_change_pipe); + return opResult; + } + unsigned int port; + opResult = usb_pipe_start_session(hub_info->control_pipe); + if(opResult!=EOK){ + usb_log_error("could not start control pipe session %d\n", opResult); + usb_pipe_end_session(hub_info->status_change_pipe); + return opResult; + } + opResult = usb_hc_connection_open(&hub_info->connection); + if(opResult!=EOK){ + usb_log_error("could not start host controller session %d\n", + opResult); + usb_pipe_end_session(hub_info->control_pipe); + usb_pipe_end_session(hub_info->status_change_pipe); + return opResult; + } + + ///todo, opresult check, pre obe konekce + for (port = 1; port < port_count+1; ++port) { + bool interrupt = + (((uint8_t*) change_bitmap)[port / 8] >> (port % 8)) % 2; + if (interrupt) { + usb_hub_process_interrupt( + hub_info, port); + } + } + usb_hc_connection_close(&hub_info->connection); + usb_pipe_end_session(hub_info->control_pipe); + usb_pipe_end_session(hub_info->status_change_pipe); + free(change_bitmap); + return EOK; +} + + + +/** + * @} + */ Index: uspace/drv/usbhub/usbhub.h =================================================================== --- uspace/drv/usbhub/usbhub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbhub/usbhub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,108 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhub + * @{ + */ +/** @file + * @brief Hub driver. + */ +#ifndef DRV_USBHUB_USBHUB_H +#define DRV_USBHUB_USBHUB_H + +#include +#include +#include + +#define NAME "usbhub" + +#include + +#include +#include + + +/** Information about attached hub. */ +typedef struct { + /** Number of ports. */ + int port_count; + + /** attached device handles, for each port one */ + usb_hc_attached_device_t * attached_devs; + + /** connection to hcd */ + usb_hc_connection_t connection; + + /** default address is used indicator + * + * If default address is requested by this device, it cannot + * be requested by the same hub again, otherwise a deadlock will occur. + */ + bool is_default_address_used; + + /** convenience pointer to status change pipe + * + * Status change pipe is initialized in usb_device structure. This is + * pointer into this structure, so that it does not have to be + * searched again and again for the 'right pipe'. + */ + usb_pipe_t * status_change_pipe; + + /** convenience pointer to control pipe + * + * Control pipe is initialized in usb_device structure. This is + * pointer into this structure, so that it does not have to be + * searched again and again for the 'right pipe'. + */ + usb_pipe_t * control_pipe; + + /** generic usb device data*/ + usb_device_t * usb_device; +} usb_hub_info_t; + +/** + * function running the hub-controlling loop. + * @param hub_info_param hub info pointer + */ +int usb_hub_control_loop(void * hub_info_param); + +/** + * Check changes on specified hub + * @param hub_info_param pointer to usb_hub_info_t structure + * @return error code if there is problem when initializing communication with + * hub, EOK otherwise + */ +int usb_hub_check_hub_changes(usb_hub_info_t * hub_info_param); + + +int usb_hub_add_device(usb_device_t * usb_dev); + +#endif +/** + * @} + */ Index: uspace/drv/usbhub/usbhub.ma =================================================================== --- uspace/drv/usbhub/usbhub.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbhub/usbhub.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,2 @@ +10 usb&hub +10 usb&class=hub Index: uspace/drv/usbhub/usbhub_private.h =================================================================== --- uspace/drv/usbhub/usbhub_private.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbhub/usbhub_private.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,136 @@ +/* + * Copyright (c) 2010 Matus Dekanek + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhub + * @{ + */ +/** @file + * @brief Hub driver private definitions + */ + +#ifndef USBHUB_PRIVATE_H +#define USBHUB_PRIVATE_H + +#include "usbhub.h" +#include "usblist.h" + +#include +#include +#include +#include + +#include +#include +#include +#include + +//************ +// +// convenience define for malloc +// +//************ +#define usb_new(type) (type*)malloc(sizeof(type)) + + +/** + * Create hub structure instance + * + * Set the address and port count information most importantly. + * + * @param device + * @param hc host controller phone + * @return + */ +usb_hub_info_t * usb_create_hub_info(ddf_dev_t * device); + +/** + * Set the device request to be a get hub descriptor request. + * @warning the size is allways set to USB_HUB_MAX_DESCRIPTOR_SIZE + * @param request + * @param addr + */ +static inline void usb_hub_set_descriptor_request( +usb_device_request_setup_packet_t * request +){ + request->index = 0; + request->request_type = USB_HUB_REQ_TYPE_GET_DESCRIPTOR; + request->request = USB_HUB_REQUEST_GET_DESCRIPTOR; + request->value_high = USB_DESCTYPE_HUB; + request->value_low = 0; + request->length = USB_HUB_MAX_DESCRIPTOR_SIZE; +} + +/** + * Clear feature on hub port. + * + * @param hc Host controller telephone + * @param address Hub address + * @param port_index Port + * @param feature Feature selector + * @return Operation result + */ +static inline int usb_hub_clear_port_feature(usb_pipe_t *pipe, + int port_index, + usb_hub_class_feature_t feature) { + + usb_device_request_setup_packet_t clear_request = { + .request_type = USB_HUB_REQ_TYPE_CLEAR_PORT_FEATURE, + .request = USB_DEVREQ_CLEAR_FEATURE, + .length = 0, + .index = port_index + }; + clear_request.value = feature; + return usb_pipe_control_write(pipe, &clear_request, + sizeof(clear_request), NULL, 0); +} + +/** + * create uint8_t array with serialized descriptor + * + * @param descriptor + * @return newly created serializd descriptor pointer + */ +void * usb_serialize_hub_descriptor(usb_hub_descriptor_t * descriptor); + +/** + * create deserialized desriptor structure out of serialized descriptor + * + * The serialized descriptor must be proper usb hub descriptor, + * otherwise an eerror might occur. + * + * @param sdescriptor serialized descriptor + * @return newly created deserialized descriptor pointer + */ +usb_hub_descriptor_t * usb_deserialize_hub_desriptor(void * sdescriptor); + + +#endif /* USBHUB_PRIVATE_H */ + +/** + * @} + */ Index: uspace/drv/usbhub/usblist.c =================================================================== --- uspace/drv/usbhub/usblist.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbhub/usblist.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2010 Matus Dekanek + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbhub + * @{ + */ +/** @file + * @brief usblist implementation + */ +#include + +#include "usbhub_private.h" + + +usb_general_list_t * usb_lst_create(void) { + usb_general_list_t* result = usb_new(usb_general_list_t); + usb_lst_init(result); + return result; +} + +void usb_lst_init(usb_general_list_t * lst) { + lst->prev = lst; + lst->next = lst; + lst->data = NULL; +} + +void usb_lst_prepend(usb_general_list_t* item, void* data) { + usb_general_list_t* appended = usb_new(usb_general_list_t); + appended->data = data; + appended->next = item; + appended->prev = item->prev; + item->prev->next = appended; + item->prev = appended; +} + +void usb_lst_append(usb_general_list_t* item, void* data) { + usb_general_list_t* appended = usb_new(usb_general_list_t); + appended->data = data; + appended->next = item->next; + appended->prev = item; + item->next->prev = appended; + item->next = appended; +} + +void usb_lst_remove(usb_general_list_t* item) { + item->next->prev = item->prev; + item->prev->next = item->next; +} + + + +/** + * @} + */ + + Index: uspace/drv/usbhub/usblist.h =================================================================== --- uspace/drv/usbhub/usblist.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbhub/usblist.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,82 @@ +/* + * Copyright (c) 2010 Matus Dekanek + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhub + * @{ + */ +/** @file + * @brief HC driver and hub driver. + * + * My private list implementation; I did not like the original helenos list. + * This one does not depend on the structure of stored data and has + * much simpler and more straight-forward semantics. + */ +#ifndef USBLIST_H +#define USBLIST_H + +/** + * general list structure + */ +typedef struct usb_general_list{ + void * data; + struct usb_general_list * prev, * next; +} usb_general_list_t; + +/** create head of usb general list */ +usb_general_list_t * usb_lst_create(void); + +/** initialize head of usb general list */ +void usb_lst_init(usb_general_list_t * lst); + + +/** is the list empty? */ +static inline bool usb_lst_empty(usb_general_list_t * lst){ + return lst?(lst->next==lst):true; +} + +/** append data behind item */ +void usb_lst_append(usb_general_list_t * lst, void * data); + +/** prepend data beore item */ +void usb_lst_prepend(usb_general_list_t * lst, void * data); + +/** remove list item from list */ +void usb_lst_remove(usb_general_list_t * item); + +/** get data o specified type from list item */ +#define usb_lst_get_data(item, type) (type *) (item->data) + +/** get usb_hub_info_t data from list item */ +static inline usb_hub_info_t * usb_hub_lst_get_data(usb_general_list_t * item) { + return usb_lst_get_data(item,usb_hub_info_t); +} + +#endif /* USBLIST_H */ +/** + * @} + */ Index: uspace/drv/usbhub/utils.c =================================================================== --- uspace/drv/usbhub/utils.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbhub/utils.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,117 @@ +/* + * Copyright (c) 2010 Matus Dekanek + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhub + * @{ + */ +/** @file + * @brief various utilities + */ +#include +#include +#include + +#include +#include +#include + +#include "usbhub.h" +#include "usbhub_private.h" +#include "port_status.h" + + +size_t USB_HUB_MAX_DESCRIPTOR_SIZE = 71; + +//********************************************* +// +// various utils +// +//********************************************* + +//hub descriptor utils + +void * usb_serialize_hub_descriptor(usb_hub_descriptor_t * descriptor) { + //base size + size_t size = 7; + //variable size according to port count + size_t var_size = descriptor->ports_count / 8 + ((descriptor->ports_count % 8 > 0) ? 1 : 0); + size += 2 * var_size; + uint8_t * result = (uint8_t*) malloc(size); + //size + result[0] = size; + //descriptor type + result[1] = USB_DESCTYPE_HUB; + result[2] = descriptor->ports_count; + /// @fixme handling of endianness?? + result[3] = descriptor->hub_characteristics / 256; + result[4] = descriptor->hub_characteristics % 256; + result[5] = descriptor->pwr_on_2_good_time; + result[6] = descriptor->current_requirement; + + size_t i; + for (i = 0; i < var_size; ++i) { + result[7 + i] = descriptor->devices_removable[i]; + } + for (i = 0; i < var_size; ++i) { + result[7 + var_size + i] = 255; + } + return result; +} + +usb_hub_descriptor_t * usb_deserialize_hub_desriptor(void * serialized_descriptor) { + uint8_t * sdescriptor = (uint8_t*) serialized_descriptor; + + if (sdescriptor[1] != USB_DESCTYPE_HUB) { + usb_log_warning("trying to deserialize wrong descriptor %x\n",sdescriptor[1]); + return NULL; + } + + usb_hub_descriptor_t * result = usb_new(usb_hub_descriptor_t); + + + result->ports_count = sdescriptor[2]; + /// @fixme handling of endianness?? + result->hub_characteristics = sdescriptor[4] + 256 * sdescriptor[3]; + result->pwr_on_2_good_time = sdescriptor[5]; + result->current_requirement = sdescriptor[6]; + size_t var_size = result->ports_count / 8 + ((result->ports_count % 8 > 0) + ? 1 : 0); + result->devices_removable = (uint8_t*) malloc(var_size); + + size_t i; + for (i = 0; i < var_size; ++i) { + result->devices_removable[i] = sdescriptor[7 + i]; + } + return result; +} + + + +/** + * @} + */ Index: uspace/drv/usbkbd/Makefile =================================================================== --- uspace/drv/usbkbd/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,53 @@ +# +# Copyright (c) 2010-2011 Vojtech Horky +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBS = $(LIBDRV_PREFIX)/libdrv.a $(LIBUSB_PREFIX)/libusb.a +EXTRA_CFLAGS += -I$(LIBDRV_PREFIX)/include -I$(LIBUSB_PREFIX)/include -I. +BINARY = usbkbd + +STOLEN_LAYOUT_SOURCES = \ + layout/us_qwerty.c \ + layout/us_dvorak.c \ + layout/cz.c + +SOURCES = \ + main.c \ + conv.c \ + kbddev.c \ + kbdrepeat.c \ + $(STOLEN_LAYOUT_SOURCES) + +EXTRA_CLEAN = $(STOLEN_LAYOUT_SOURCES) + +SRV_KBD = $(USPACE_PREFIX)/srv/hid/kbd + +include $(USPACE_PREFIX)/Makefile.common + +layout/%.c: $(SRV_KBD)/layout/%.c + ln -sfn ../$< $@ Index: uspace/drv/usbkbd/conv.c =================================================================== --- uspace/drv/usbkbd/conv.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/conv.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,193 @@ +/* + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** @file + * USB scancode parser. + */ + +#include +#include +#include +#include +#include "conv.h" + +/** + * Mapping between USB HID key codes (from HID Usage Tables) and corresponding + * HelenOS key codes. + */ +static int scanmap_simple[255] = { + +// [0x29] = KC_BACKTICK, + +// [0x02] = KC_1, +// [0x03] = KC_2, + [0x04] = KC_A, + [0x05] = KC_B, + [0x06] = KC_C, + [0x07] = KC_D, + [0x08] = KC_E, + [0x09] = KC_F, + [0x0a] = KC_G, + [0x0b] = KC_H, + [0x0c] = KC_I, + [0x0d] = KC_J, + [0x0e] = KC_K, + [0x0f] = KC_L, + [0x10] = KC_M, + [0x11] = KC_N, + [0x12] = KC_O, + [0x13] = KC_P, + [0x14] = KC_Q, + [0x15] = KC_R, + [0x16] = KC_S, + [0x17] = KC_T, + [0x18] = KC_U, + [0x19] = KC_V, + [0x1a] = KC_W, + [0x1b] = KC_X, + [0x1c] = KC_Y, + [0x1d] = KC_Z, + + [0x1e] = KC_1, + [0x1f] = KC_2, + [0x20] = KC_3, + [0x21] = KC_4, + [0x22] = KC_5, + [0x23] = KC_6, + [0x24] = KC_7, + [0x25] = KC_8, + [0x26] = KC_9, + [0x27] = KC_0, + + [0x28] = KC_ENTER, + [0x29] = KC_ESCAPE, + [0x2a] = KC_BACKSPACE, + [0x2b] = KC_TAB, + [0x2c] = KC_SPACE, + + [0x2d] = KC_MINUS, // same as DASH? (- or _) + [0x2e] = KC_EQUALS, + [0x2f] = KC_LBRACKET, + [0x30] = KC_RBRACKET, + [0x31] = KC_BACKSLASH, + //[0x32] = KC_, // TODO: HASH??? maybe some as 0x31 - backslash + [0x33] = KC_SEMICOLON, + [0x34] = KC_QUOTE, // same as APOSTROPHE? (') + [0x35] = KC_BACKTICK, // same as GRAVE ACCENT?? (`) + [0x36] = KC_COMMA, + [0x37] = KC_PERIOD, + [0x38] = KC_SLASH, + + [0x39] = KC_CAPS_LOCK, + + [0x3a] = KC_F1, + [0x3b] = KC_F2, + [0x3c] = KC_F3, + [0x3d] = KC_F4, + [0x3e] = KC_F5, + [0x3f] = KC_F6, + [0x40] = KC_F7, + [0x41] = KC_F8, + [0x42] = KC_F9, + [0x43] = KC_F10, + [0x44] = KC_F11, + [0x45] = KC_F12, + + [0x46] = KC_PRTSCR, + [0x47] = KC_SCROLL_LOCK, + [0x48] = KC_PAUSE, + [0x49] = KC_INSERT, + [0x4a] = KC_HOME, + [0x4b] = KC_PAGE_UP, + [0x4c] = KC_DELETE, + [0x4d] = KC_END, + [0x4e] = KC_PAGE_DOWN, + [0x4f] = KC_RIGHT, + [0x50] = KC_LEFT, + [0x51] = KC_DOWN, + [0x52] = KC_UP, + + //[0x64] = // some funny key + + [0xe0] = KC_LCTRL, + [0xe1] = KC_LSHIFT, + [0xe2] = KC_LALT, + //[0xe3] = KC_L // TODO: left GUI + [0xe4] = KC_RCTRL, + [0xe5] = KC_RSHIFT, + [0xe6] = KC_RALT, + //[0xe7] = KC_R // TODO: right GUI + + [0x53] = KC_NUM_LOCK, + [0x54] = KC_NSLASH, + [0x55] = KC_NTIMES, + [0x56] = KC_NMINUS, + [0x57] = KC_NPLUS, + [0x58] = KC_NENTER, + [0x59] = KC_N1, + [0x5a] = KC_N2, + [0x5b] = KC_N3, + [0x5c] = KC_N4, + [0x5d] = KC_N5, + [0x5e] = KC_N6, + [0x5f] = KC_N7, + [0x60] = KC_N8, + [0x61] = KC_N9, + [0x62] = KC_N0, + [0x63] = KC_NPERIOD + +}; + +/** + * Translate USB HID key codes (from HID Usage Tables) to generic key codes + * recognized by HelenOS. + * + * @param scancode USB HID key code (from HID Usage Tables). + * + * @retval HelenOS key code corresponding to the given USB HID key code. + */ +unsigned int usbhid_parse_scancode(int scancode) +{ + unsigned int key; + int *map = scanmap_simple; + size_t map_length = sizeof(scanmap_simple) / sizeof(int); + + if ((scancode < 0) || ((size_t) scancode >= map_length)) + return -1; + + key = map[scancode]; + + return key; +} + +/** + * @} + */ Index: uspace/drv/usbkbd/conv.h =================================================================== --- uspace/drv/usbkbd/conv.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/conv.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,45 @@ +/* + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** @file + * USB scancode parser. + */ + +#ifndef USB_KBD_CONV_H_ +#define USB_KBD_CONV_H_ + +unsigned int usbhid_parse_scancode(int scancode); + +#endif /* USB_KBD_CONV_H_ */ + +/** + * @} + */ Index: uspace/drv/usbkbd/kbd.h =================================================================== --- uspace/drv/usbkbd/kbd.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/kbd.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,5 @@ +/* + * Dummy file because of shared layout sources. + * + * Do not delete. + */ Index: uspace/drv/usbkbd/kbddev.c =================================================================== --- uspace/drv/usbkbd/kbddev.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/kbddev.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,936 @@ +/* + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** + * @file + * USB HID keyboard device structure and API. + */ + +#include +#include +#include + +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +#include "kbddev.h" + +#include "layout.h" +#include "conv.h" +#include "kbdrepeat.h" + +/*----------------------------------------------------------------------------*/ +/** Default modifiers when the keyboard is initialized. */ +static const unsigned DEFAULT_ACTIVE_MODS = KM_NUM_LOCK; + +///** Boot protocol report size (key part). */ +//static const size_t BOOTP_REPORT_SIZE = 6; + +///** Boot protocol total report size. */ +//static const size_t BOOTP_BUFFER_SIZE = 8; + +///** Boot protocol output report size. */ +//static const size_t BOOTP_BUFFER_OUT_SIZE = 1; + +///** Boot protocol error key code. */ +//static const uint8_t BOOTP_ERROR_ROLLOVER = 1; +static const uint8_t ERROR_ROLLOVER = 1; + +/** Default idle rate for keyboards. */ +static const uint8_t IDLE_RATE = 0; + +/** Delay before a pressed key starts auto-repeating. */ +static const unsigned int DEFAULT_DELAY_BEFORE_FIRST_REPEAT = 500 * 1000; + +/** Delay between two repeats of a pressed key when auto-repeating. */ +static const unsigned int DEFAULT_REPEAT_DELAY = 50 * 1000; + +/*----------------------------------------------------------------------------*/ + +/** Keyboard polling endpoint description for boot protocol class. */ +static usb_endpoint_description_t boot_poll_endpoint_description = { + .transfer_type = USB_TRANSFER_INTERRUPT, + .direction = USB_DIRECTION_IN, + .interface_class = USB_CLASS_HID, + .interface_subclass = USB_HID_SUBCLASS_BOOT, + .interface_protocol = USB_HID_PROTOCOL_KEYBOARD, + .flags = 0 +}; + +/* Array of endpoints expected on the device, NULL terminated. */ +usb_endpoint_description_t + *usb_kbd_endpoints[USB_KBD_POLL_EP_COUNT + 1] = { + &boot_poll_endpoint_description, + NULL +}; + +/*----------------------------------------------------------------------------*/ + +enum { + BOOT_REPORT_DESCRIPTOR_SIZE = 63 +}; + +static const uint8_t BOOT_REPORT_DESCRIPTOR[BOOT_REPORT_DESCRIPTOR_SIZE] = { + 0x05, 0x01, // Usage Page (Generic Desktop), + 0x09, 0x06, // Usage (Keyboard), + 0xA1, 0x01, // Collection (Application), + 0x75, 0x01, // Report Size (1), + 0x95, 0x08, // Report Count (8), + 0x05, 0x07, // Usage Page (Key Codes); + 0x19, 0xE0, // Usage Minimum (224), + 0x29, 0xE7, // Usage Maximum (231), + 0x15, 0x00, // Logical Minimum (0), + 0x25, 0x01, // Logical Maximum (1), + 0x81, 0x02, // Input (Data, Variable, Absolute), ; Modifier byte + 0x95, 0x01, // Report Count (1), + 0x75, 0x08, // Report Size (8), + 0x81, 0x01, // Input (Constant), ; Reserved byte + 0x95, 0x05, // Report Count (5), + 0x75, 0x01, // Report Size (1), + 0x05, 0x08, // Usage Page (Page# for LEDs), + 0x19, 0x01, // Usage Minimum (1), + 0x29, 0x05, // Usage Maxmimum (5), + 0x91, 0x02, // Output (Data, Variable, Absolute), ; LED report + 0x95, 0x01, // Report Count (1), + 0x75, 0x03, // Report Size (3), + 0x91, 0x01, // Output (Constant), ; LED report padding + 0x95, 0x06, // Report Count (6), + 0x75, 0x08, // Report Size (8), + 0x15, 0x00, // Logical Minimum (0), + 0x25, 0xff, // Logical Maximum (255), + 0x05, 0x07, // Usage Page (Key Codes), + 0x19, 0x00, // Usage Minimum (0), + 0x29, 0xff, // Usage Maximum (255), + 0x81, 0x00, // Input (Data, Array), ; Key arrays (6 bytes) + 0xC0 // End Collection + +}; + +/*----------------------------------------------------------------------------*/ + +typedef enum usb_kbd_flags { + USB_KBD_STATUS_UNINITIALIZED = 0, + USB_KBD_STATUS_INITIALIZED = 1, + USB_KBD_STATUS_TO_DESTROY = -1 +} usb_kbd_flags; + +/*----------------------------------------------------------------------------*/ +/* Keyboard layouts */ +/*----------------------------------------------------------------------------*/ + +#define NUM_LAYOUTS 3 + +/** Keyboard layout map. */ +static layout_op_t *layout[NUM_LAYOUTS] = { + &us_qwerty_op, + &us_dvorak_op, + &cz_op +}; + +static int active_layout = 0; + +/*----------------------------------------------------------------------------*/ +/* Modifier constants */ +/*----------------------------------------------------------------------------*/ +/** Mapping of USB modifier key codes to generic modifier key codes. */ +static const keycode_t usbhid_modifiers_keycodes[USB_HID_MOD_COUNT] = { + KC_LCTRL, /* USB_HID_MOD_LCTRL */ + KC_LSHIFT, /* USB_HID_MOD_LSHIFT */ + KC_LALT, /* USB_HID_MOD_LALT */ + 0, /* USB_HID_MOD_LGUI */ + KC_RCTRL, /* USB_HID_MOD_RCTRL */ + KC_RSHIFT, /* USB_HID_MOD_RSHIFT */ + KC_RALT, /* USB_HID_MOD_RALT */ + 0, /* USB_HID_MOD_RGUI */ +}; + +typedef enum usbhid_lock_code { + USB_KBD_LOCK_NUM = 0x53, + USB_KBD_LOCK_CAPS = 0x39, + USB_KBD_LOCK_SCROLL = 0x47, + USB_KBD_LOCK_COUNT = 3 +} usbhid_lock_code; + +static const usbhid_lock_code usbhid_lock_codes[USB_KBD_LOCK_COUNT] = { + USB_KBD_LOCK_NUM, + USB_KBD_LOCK_CAPS, + USB_KBD_LOCK_SCROLL +}; + +/*----------------------------------------------------------------------------*/ +/* IPC method handler */ +/*----------------------------------------------------------------------------*/ + +static void default_connection_handler(ddf_fun_t *, ipc_callid_t, ipc_call_t *); +ddf_dev_ops_t keyboard_ops = { + .default_handler = default_connection_handler +}; + +/** + * Default handler for IPC methods not handled by DDF. + * + * Currently recognizes only one method (IPC_M_CONNECT_TO_ME), in which case it + * assumes the caller is the console and thus it stores IPC phone to it for + * later use by the driver to notify about key events. + * + * @param fun Device function handling the call. + * @param icallid Call id. + * @param icall Call data. + */ +void default_connection_handler(ddf_fun_t *fun, + ipc_callid_t icallid, ipc_call_t *icall) +{ + sysarg_t method = IPC_GET_IMETHOD(*icall); + + usb_kbd_t *kbd_dev = (usb_kbd_t *)fun->driver_data; + assert(kbd_dev != NULL); + + if (method == IPC_M_CONNECT_TO_ME) { + int callback = IPC_GET_ARG5(*icall); + + if (kbd_dev->console_phone != -1) { + async_answer_0(icallid, ELIMIT); + return; + } + + kbd_dev->console_phone = callback; + async_answer_0(icallid, EOK); + return; + } + + async_answer_0(icallid, EINVAL); +} + +/*----------------------------------------------------------------------------*/ +/* Key processing functions */ +/*----------------------------------------------------------------------------*/ +/** + * Handles turning of LED lights on and off. + * + * In case of USB keyboards, the LEDs are handled in the driver, not in the + * device. When there should be a change (lock key was pressed), the driver + * uses a Set_Report request sent to the device to set the state of the LEDs. + * + * This functions sets the LED lights according to current settings of modifiers + * kept in the keyboard device structure. + * + * @param kbd_dev Keyboard device structure. + */ +static void usb_kbd_set_led(usb_kbd_t *kbd_dev) +{ + unsigned i = 0; + + /* Reset the LED data. */ + memset(kbd_dev->led_data, 0, kbd_dev->led_output_size * sizeof(int32_t)); + + if ((kbd_dev->mods & KM_NUM_LOCK) && (i < kbd_dev->led_output_size)) { + kbd_dev->led_data[i++] = USB_HID_LED_NUM_LOCK; + } + + if ((kbd_dev->mods & KM_CAPS_LOCK) && (i < kbd_dev->led_output_size)) { + kbd_dev->led_data[i++] = USB_HID_LED_CAPS_LOCK; + } + + if ((kbd_dev->mods & KM_SCROLL_LOCK) + && (i < kbd_dev->led_output_size)) { + kbd_dev->led_data[i++] = USB_HID_LED_SCROLL_LOCK; + } + + // TODO: COMPOSE and KANA + + usb_log_debug("Creating output report.\n"); + + int rc = usb_hid_report_output_translate(kbd_dev->parser, + kbd_dev->led_path, USB_HID_PATH_COMPARE_END, kbd_dev->output_buffer, + kbd_dev->output_size, kbd_dev->led_data, kbd_dev->led_output_size); + + if (rc != EOK) { + usb_log_warning("Error translating LED output to output report" + ".\n"); + return; + } + + usb_log_debug("Output report buffer: %s\n", + usb_debug_str_buffer(kbd_dev->output_buffer, kbd_dev->output_size, + 0)); + + usbhid_req_set_report(&kbd_dev->usb_dev->ctrl_pipe, + kbd_dev->usb_dev->interface_no, USB_HID_REPORT_TYPE_OUTPUT, + kbd_dev->output_buffer, kbd_dev->output_size); +} + +/*----------------------------------------------------------------------------*/ +/** + * Processes key events. + * + * @note This function was copied from AT keyboard driver and modified to suit + * USB keyboard. + * + * @note Lock keys are not sent to the console, as they are completely handled + * in the driver. It may, however, be required later that the driver + * sends also these keys to application (otherwise it cannot use those + * keys at all). + * + * @param kbd_dev Keyboard device structure. + * @param type Type of the event (press / release). Recognized values: + * KEY_PRESS, KEY_RELEASE + * @param key Key code of the key according to HID Usage Tables. + */ +void usb_kbd_push_ev(usb_kbd_t *kbd_dev, int type, unsigned int key) +{ + console_event_t ev; + unsigned mod_mask; + + /* + * These parts are copy-pasted from the AT keyboard driver. + * + * They definitely require some refactoring, but will keep it for later + * when the console and keyboard system is changed in HelenOS. + */ + switch (key) { + case KC_LCTRL: mod_mask = KM_LCTRL; break; + case KC_RCTRL: mod_mask = KM_RCTRL; break; + case KC_LSHIFT: mod_mask = KM_LSHIFT; break; + case KC_RSHIFT: mod_mask = KM_RSHIFT; break; + case KC_LALT: mod_mask = KM_LALT; break; + case KC_RALT: mod_mask = KM_RALT; break; + default: mod_mask = 0; break; + } + + if (mod_mask != 0) { + if (type == KEY_PRESS) + kbd_dev->mods = kbd_dev->mods | mod_mask; + else + kbd_dev->mods = kbd_dev->mods & ~mod_mask; + } + + switch (key) { + case KC_CAPS_LOCK: mod_mask = KM_CAPS_LOCK; break; + case KC_NUM_LOCK: mod_mask = KM_NUM_LOCK; break; + case KC_SCROLL_LOCK: mod_mask = KM_SCROLL_LOCK; break; + default: mod_mask = 0; break; + } + + if (mod_mask != 0) { + if (type == KEY_PRESS) { + /* + * Only change lock state on transition from released + * to pressed. This prevents autorepeat from messing + * up the lock state. + */ + unsigned int locks_old = kbd_dev->lock_keys; + + kbd_dev->mods = + kbd_dev->mods ^ (mod_mask & ~kbd_dev->lock_keys); + kbd_dev->lock_keys = kbd_dev->lock_keys | mod_mask; + + /* Update keyboard lock indicator lights. */ + if (kbd_dev->lock_keys != locks_old) { + usb_kbd_set_led(kbd_dev); + } + } else { + kbd_dev->lock_keys = kbd_dev->lock_keys & ~mod_mask; + } + } + + if (key == KC_CAPS_LOCK || key == KC_NUM_LOCK || key == KC_SCROLL_LOCK) { + // do not send anything to the console, this is our business + return; + } + + if (type == KEY_PRESS && (kbd_dev->mods & KM_LCTRL) && key == KC_F1) { + active_layout = 0; + layout[active_layout]->reset(); + return; + } + + if (type == KEY_PRESS && (kbd_dev->mods & KM_LCTRL) && key == KC_F2) { + active_layout = 1; + layout[active_layout]->reset(); + return; + } + + if (type == KEY_PRESS && (kbd_dev->mods & KM_LCTRL) && key == KC_F3) { + active_layout = 2; + layout[active_layout]->reset(); + return; + } + + ev.type = type; + ev.key = key; + ev.mods = kbd_dev->mods; + + ev.c = layout[active_layout]->parse_ev(&ev); + + usb_log_debug2("Sending key %d to the console\n", ev.key); + if (kbd_dev->console_phone < 0) { + usb_log_warning( + "Connection to console not ready, key discarded.\n"); + return; + } + + async_msg_4(kbd_dev->console_phone, KBD_EVENT, ev.type, ev.key, + ev.mods, ev.c); +} + +/*----------------------------------------------------------------------------*/ + +static inline int usb_kbd_is_lock(unsigned int key_code) +{ + return (key_code == KC_NUM_LOCK + || key_code == KC_SCROLL_LOCK + || key_code == KC_CAPS_LOCK); +} + +/*----------------------------------------------------------------------------*/ +/** + * Checks if some keys were pressed or released and generates key events. + * + * An event is created only when key is pressed or released. Besides handling + * the events (usb_kbd_push_ev()), the auto-repeat fibril is notified about + * key presses and releases (see usb_kbd_repeat_start() and + * usb_kbd_repeat_stop()). + * + * @param kbd_dev Keyboard device structure. + * @param key_codes Parsed keyboard report - codes of currently pressed keys + * according to HID Usage Tables. + * @param count Number of key codes in report (size of the report). + * + * @sa usb_kbd_push_ev(), usb_kbd_repeat_start(), usb_kbd_repeat_stop() + */ +static void usb_kbd_check_key_changes(usb_kbd_t *kbd_dev, + const uint8_t *key_codes, size_t count) +{ + unsigned int key; + unsigned int i, j; + + /* + * First of all, check if the kbd have reported phantom state. + * + * As there is no way to distinguish keys from modifiers, we do not have + * a way to check that 'all keys report Error Rollover'. We thus check + * if there is at least one such error and in such case we ignore the + * whole input report. + */ + i = 0; + while (i < count && key_codes[i] != ERROR_ROLLOVER) { + ++i; + } + if (i != count) { + usb_log_debug("Phantom state occured.\n"); + // phantom state, do nothing + return; + } + + /* TODO: quite dummy right now, think of better implementation */ + assert(count == kbd_dev->key_count); + + /* + * 1) Key releases + */ + for (j = 0; j < count; ++j) { + // try to find the old key in the new key list + i = 0; + while (i < kbd_dev->key_count + && key_codes[i] != kbd_dev->keys[j]) { + ++i; + } + + if (i == count) { + // not found, i.e. the key was released + key = usbhid_parse_scancode(kbd_dev->keys[j]); + if (!usb_kbd_is_lock(key)) { + usb_kbd_repeat_stop(kbd_dev, key); + } + usb_kbd_push_ev(kbd_dev, KEY_RELEASE, key); + usb_log_debug2("Key released: %d\n", key); + } else { + // found, nothing happens + } + } + + /* + * 1) Key presses + */ + for (i = 0; i < kbd_dev->key_count; ++i) { + // try to find the new key in the old key list + j = 0; + while (j < count && kbd_dev->keys[j] != key_codes[i]) { + ++j; + } + + if (j == count) { + // not found, i.e. new key pressed + key = usbhid_parse_scancode(key_codes[i]); + usb_log_debug2("Key pressed: %d (keycode: %d)\n", key, + key_codes[i]); + usb_kbd_push_ev(kbd_dev, KEY_PRESS, key); + if (!usb_kbd_is_lock(key)) { + usb_kbd_repeat_start(kbd_dev, key); + } + } else { + // found, nothing happens + } + } + + memcpy(kbd_dev->keys, key_codes, count); + + usb_log_debug("New stored keycodes: %s\n", + usb_debug_str_buffer(kbd_dev->keys, kbd_dev->key_count, 0)); +} + +/*----------------------------------------------------------------------------*/ +/* Callbacks for parser */ +/*----------------------------------------------------------------------------*/ +/** + * Callback function for the HID report parser. + * + * This function is called by the HID report parser with the parsed report. + * The parsed report is used to check if any events occured (key was pressed or + * released, modifier was pressed or released). + * + * @param key_codes Parsed keyboard report - codes of currently pressed keys + * according to HID Usage Tables. + * @param count Number of key codes in report (size of the report). + * @param modifiers Bitmap of modifiers (Ctrl, Alt, Shift, GUI). + * @param arg User-specified argument. Expects pointer to the keyboard device + * structure representing the keyboard. + * + * @sa usb_kbd_check_key_changes(), usb_kbd_check_modifier_changes() + */ +static void usb_kbd_process_keycodes(const uint8_t *key_codes, size_t count, + uint8_t modifiers, void *arg) +{ + if (arg == NULL) { + usb_log_warning("Missing argument in callback " + "usbhid_process_keycodes().\n"); + return; + } + + usb_kbd_t *kbd_dev = (usb_kbd_t *)arg; + assert(kbd_dev != NULL); + + usb_log_debug("Got keys from parser: %s\n", + usb_debug_str_buffer(key_codes, count, 0)); + + if (count != kbd_dev->key_count) { + usb_log_warning("Number of received keycodes (%d) differs from" + " expected number (%d).\n", count, kbd_dev->key_count); + return; + } + + ///usb_kbd_check_modifier_changes(kbd_dev, key_codes, count); + usb_kbd_check_key_changes(kbd_dev, key_codes, count); +} + +/*----------------------------------------------------------------------------*/ +/* General kbd functions */ +/*----------------------------------------------------------------------------*/ +/** + * Processes data received from the device in form of report. + * + * This function uses the HID report parser to translate the data received from + * the device into generic USB HID key codes and into generic modifiers bitmap. + * The parser then calls the given callback (usb_kbd_process_keycodes()). + * + * @note Currently, only the boot protocol is supported. + * + * @param kbd_dev Keyboard device structure (must be initialized). + * @param buffer Data from the keyboard (i.e. the report). + * @param actual_size Size of the data from keyboard (report size) in bytes. + * + * @sa usb_kbd_process_keycodes(), usb_hid_boot_keyboard_input_report(), + * usb_hid_parse_report(). + */ +static void usb_kbd_process_data(usb_kbd_t *kbd_dev, + uint8_t *buffer, size_t actual_size) +{ + assert(kbd_dev->initialized == USB_KBD_STATUS_INITIALIZED); + assert(kbd_dev->parser != NULL); + + usb_hid_report_in_callbacks_t *callbacks = + (usb_hid_report_in_callbacks_t *)malloc( + sizeof(usb_hid_report_in_callbacks_t)); + + callbacks->keyboard = usb_kbd_process_keycodes; + + usb_log_debug("Calling usb_hid_parse_report() with " + "buffer %s\n", usb_debug_str_buffer(buffer, actual_size, 0)); + +// int rc = usb_hid_boot_keyboard_input_report(buffer, actual_size, +// callbacks, kbd_dev); + usb_hid_report_path_t *path = usb_hid_report_path(); + usb_hid_report_path_append_item(path, USB_HIDUT_PAGE_KEYBOARD, 0); + + int rc = usb_hid_parse_report(kbd_dev->parser, buffer, + actual_size, path, USB_HID_PATH_COMPARE_STRICT, callbacks, kbd_dev); + + usb_hid_report_path_free (path); + + if (rc != EOK) { + usb_log_warning("Error in usb_hid_boot_keyboard_input_report():" + "%s\n", str_error(rc)); + } +} + +/*----------------------------------------------------------------------------*/ +/* HID/KBD structure manipulation */ +/*----------------------------------------------------------------------------*/ + +static void usb_kbd_mark_unusable(usb_kbd_t *kbd_dev) +{ + kbd_dev->initialized = USB_KBD_STATUS_TO_DESTROY; +} + + +/*----------------------------------------------------------------------------*/ +/* API functions */ +/*----------------------------------------------------------------------------*/ +/** + * Creates a new USB/HID keyboard structure. + * + * The structure returned by this function is not initialized. Use + * usb_kbd_init() to initialize it prior to polling. + * + * @return New uninitialized structure for representing a USB/HID keyboard or + * NULL if not successful (memory error). + */ +usb_kbd_t *usb_kbd_new(void) +{ + usb_kbd_t *kbd_dev = + (usb_kbd_t *)malloc(sizeof(usb_kbd_t)); + + if (kbd_dev == NULL) { + usb_log_fatal("No memory!\n"); + return NULL; + } + + memset(kbd_dev, 0, sizeof(usb_kbd_t)); + + kbd_dev->parser = (usb_hid_report_parser_t *)(malloc(sizeof( + usb_hid_report_parser_t))); + if (kbd_dev->parser == NULL) { + usb_log_fatal("No memory!\n"); + free(kbd_dev); + return NULL; + } + + kbd_dev->console_phone = -1; + kbd_dev->initialized = USB_KBD_STATUS_UNINITIALIZED; + + return kbd_dev; +} + +/*----------------------------------------------------------------------------*/ +/** + * Initialization of the USB/HID keyboard structure. + * + * This functions initializes required structures from the device's descriptors. + * + * During initialization, the keyboard is switched into boot protocol, the idle + * rate is set to 0 (infinity), resulting in the keyboard only reporting event + * when a key is pressed or released. Finally, the LED lights are turned on + * according to the default setup of lock keys. + * + * @note By default, the keyboards is initialized with Num Lock turned on and + * other locks turned off. + * + * @param kbd_dev Keyboard device structure to be initialized. + * @param dev DDF device structure of the keyboard. + * + * @retval EOK if successful. + * @retval EINVAL if some parameter is not given. + * @return Other value inherited from function usbhid_dev_init(). + */ +int usb_kbd_init(usb_kbd_t *kbd_dev, usb_device_t *dev) +{ + int rc; + + usb_log_debug("Initializing HID/KBD structure...\n"); + + if (kbd_dev == NULL) { + usb_log_error("Failed to init keyboard structure: no structure" + " given.\n"); + return EINVAL; + } + + if (dev == NULL) { + usb_log_error("Failed to init keyboard structure: no USB device" + " given.\n"); + return EINVAL; + } + + if (kbd_dev->initialized == USB_KBD_STATUS_INITIALIZED) { + usb_log_warning("Keyboard structure already initialized.\n"); + return EINVAL; + } + + /* TODO: does not work! */ + if (!dev->pipes[USB_KBD_POLL_EP_NO].present) { + usb_log_warning("Required endpoint not found - probably not " + "a supported device.\n"); + return ENOTSUP; + } + + /* The USB device should already be initialized, save it in structure */ + kbd_dev->usb_dev = dev; + + /* Initialize the report parser. */ + rc = usb_hid_parser_init(kbd_dev->parser); + if (rc != EOK) { + usb_log_error("Failed to initialize report parser.\n"); + return rc; + } + + /* Get the report descriptor and parse it. */ + rc = usb_hid_process_report_descriptor(kbd_dev->usb_dev, + kbd_dev->parser); + if (rc != EOK) { + usb_log_warning("Could not process report descriptor, " + "falling back to boot protocol.\n"); + rc = usb_hid_parse_report_descriptor(kbd_dev->parser, + BOOT_REPORT_DESCRIPTOR, BOOT_REPORT_DESCRIPTOR_SIZE); + if (rc != EOK) { + usb_log_error("Failed to parse boot report descriptor:" + " %s.\n", str_error(rc)); + return rc; + } + + rc = usbhid_req_set_protocol(&kbd_dev->usb_dev->ctrl_pipe, + kbd_dev->usb_dev->interface_no, USB_HID_PROTOCOL_BOOT); + + if (rc != EOK) { + usb_log_warning("Failed to set boot protocol to the " + "device: %s\n", str_error(rc)); + return rc; + } + } + + /* + * TODO: make more general + */ + usb_hid_report_path_t *path = usb_hid_report_path(); + usb_hid_report_path_append_item(path, USB_HIDUT_PAGE_KEYBOARD, 0); + kbd_dev->key_count = usb_hid_report_input_length( + kbd_dev->parser, path, USB_HID_PATH_COMPARE_STRICT); + usb_hid_report_path_free (path); + + usb_log_debug("Size of the input report: %zu\n", kbd_dev->key_count); + + kbd_dev->keys = (uint8_t *)calloc(kbd_dev->key_count, sizeof(uint8_t)); + + if (kbd_dev->keys == NULL) { + usb_log_fatal("No memory!\n"); + return ENOMEM; + } + + /* + * Output report + */ + kbd_dev->output_size = 0; + kbd_dev->output_buffer = usb_hid_report_output(kbd_dev->parser, + &kbd_dev->output_size); + if (kbd_dev->output_buffer == NULL) { + usb_log_warning("Error creating output report buffer.\n"); + free(kbd_dev->keys); + return ENOMEM; /* TODO: other error code */ + } + + usb_log_debug("Output buffer size: %zu\n", kbd_dev->output_size); + + kbd_dev->led_path = usb_hid_report_path(); + usb_hid_report_path_append_item( + kbd_dev->led_path, USB_HIDUT_PAGE_LED, 0); + + kbd_dev->led_output_size = usb_hid_report_output_size(kbd_dev->parser, + kbd_dev->led_path, USB_HID_PATH_COMPARE_END); + + usb_log_debug("Output report size (in items): %zu\n", + kbd_dev->led_output_size); + + kbd_dev->led_data = (int32_t *)calloc( + kbd_dev->led_output_size, sizeof(int32_t)); + + if (kbd_dev->led_data == NULL) { + usb_log_warning("Error creating buffer for LED output report." + "\n"); + free(kbd_dev->keys); + usb_hid_report_output_free(kbd_dev->output_buffer); + return ENOMEM; + } + + /* + * Modifiers and locks + */ + kbd_dev->modifiers = 0; + kbd_dev->mods = DEFAULT_ACTIVE_MODS; + kbd_dev->lock_keys = 0; + + /* + * Autorepeat + */ + kbd_dev->repeat.key_new = 0; + kbd_dev->repeat.key_repeated = 0; + kbd_dev->repeat.delay_before = DEFAULT_DELAY_BEFORE_FIRST_REPEAT; + kbd_dev->repeat.delay_between = DEFAULT_REPEAT_DELAY; + + kbd_dev->repeat_mtx = (fibril_mutex_t *)( + malloc(sizeof(fibril_mutex_t))); + if (kbd_dev->repeat_mtx == NULL) { + usb_log_fatal("No memory!\n"); + free(kbd_dev->keys); + return ENOMEM; + } + + fibril_mutex_initialize(kbd_dev->repeat_mtx); + + /* + * Set LEDs according to initial setup. + * Set Idle rate + */ + usb_kbd_set_led(kbd_dev); + + usbhid_req_set_idle(&kbd_dev->usb_dev->ctrl_pipe, + kbd_dev->usb_dev->interface_no, IDLE_RATE); + + kbd_dev->initialized = USB_KBD_STATUS_INITIALIZED; + usb_log_debug("HID/KBD device structure initialized.\n"); + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +bool usb_kbd_polling_callback(usb_device_t *dev, uint8_t *buffer, + size_t buffer_size, void *arg) +{ + if (dev == NULL || buffer == NULL || arg == NULL) { + // do not continue polling (???) + return false; + } + + usb_kbd_t *kbd_dev = (usb_kbd_t *)arg; + + // TODO: add return value from this function + usb_kbd_process_data(kbd_dev, buffer, buffer_size); + + return true; +} + +/*----------------------------------------------------------------------------*/ + +void usb_kbd_polling_ended_callback(usb_device_t *dev, bool reason, + void *arg) +{ + if (dev == NULL || arg == NULL) { + return; + } + + usb_kbd_t *kbd = (usb_kbd_t *)arg; + + usb_kbd_mark_unusable(kbd); +} + +/*----------------------------------------------------------------------------*/ + +int usb_kbd_is_initialized(const usb_kbd_t *kbd_dev) +{ + return (kbd_dev->initialized == USB_KBD_STATUS_INITIALIZED); +} + +/*----------------------------------------------------------------------------*/ + +int usb_kbd_is_ready_to_destroy(const usb_kbd_t *kbd_dev) +{ + return (kbd_dev->initialized == USB_KBD_STATUS_TO_DESTROY); +} + +/*----------------------------------------------------------------------------*/ +/** + * Properly destroys the USB/HID keyboard structure. + * + * @param kbd_dev Pointer to the structure to be destroyed. + */ +void usb_kbd_free(usb_kbd_t **kbd_dev) +{ + if (kbd_dev == NULL || *kbd_dev == NULL) { + return; + } + + // hangup phone to the console + async_hangup((*kbd_dev)->console_phone); + +// if ((*kbd_dev)->hid_dev != NULL) { +// usbhid_dev_free(&(*kbd_dev)->hid_dev); +// assert((*kbd_dev)->hid_dev == NULL); +// } + + if ((*kbd_dev)->repeat_mtx != NULL) { + /* TODO: replace by some check and wait */ + assert(!fibril_mutex_is_locked((*kbd_dev)->repeat_mtx)); + free((*kbd_dev)->repeat_mtx); + } + + // destroy the parser + if ((*kbd_dev)->parser != NULL) { + usb_hid_free_report_parser((*kbd_dev)->parser); + } + + // free the output buffer + usb_hid_report_output_free((*kbd_dev)->output_buffer); + + /* TODO: what about the USB device structure?? */ + + free(*kbd_dev); + *kbd_dev = NULL; +} + +/** + * @} + */ Index: uspace/drv/usbkbd/kbddev.h =================================================================== --- uspace/drv/usbkbd/kbddev.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/kbddev.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,154 @@ +/* + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** @file + * USB HID keyboard device structure and API. + */ + +#ifndef USB_KBDDEV_H_ +#define USB_KBDDEV_H_ + +#include + +#include + +#include +#include +#include +#include +#include + +#include "kbdrepeat.h" + +/*----------------------------------------------------------------------------*/ +/** + * USB/HID keyboard device type. + * + * Holds a reference to generic USB/HID device structure and keyboard-specific + * data, such as currently pressed keys, modifiers and lock keys. + * + * Also holds a IPC phone to the console (since there is now no other way to + * communicate with it). + * + * @note Storing active lock keys in this structure results in their setting + * being device-specific. + */ +typedef struct usb_kbd_t { + /** Structure holding generic USB device information. */ + //usbhid_dev_t *hid_dev; + usb_device_t *usb_dev; + + /** Currently pressed keys (not translated to key codes). */ + uint8_t *keys; + /** Count of stored keys (i.e. number of keys in the report). */ + size_t key_count; + /** Currently pressed modifiers (bitmap). */ + uint8_t modifiers; + + /** Currently active modifiers including locks. Sent to the console. */ + unsigned mods; + + /** Currently active lock keys. */ + unsigned lock_keys; + + /** IPC phone to the console device (for sending key events). */ + int console_phone; + + /** Information for auto-repeat of keys. */ + usb_kbd_repeat_t repeat; + + /** Mutex for accessing the information about auto-repeat. */ + fibril_mutex_t *repeat_mtx; + + /** Report descriptor. */ + uint8_t *report_desc; + + /** Report descriptor size. */ + size_t report_desc_size; + + uint8_t *output_buffer; + + size_t output_size; + + size_t led_output_size; + + usb_hid_report_path_t *led_path; + + int32_t *led_data; + + /** HID Report parser. */ + usb_hid_report_parser_t *parser; + + /** State of the structure (for checking before use). + * + * 0 - not initialized + * 1 - initialized + * -1 - ready for destroying + */ + int initialized; +} usb_kbd_t; + +/*----------------------------------------------------------------------------*/ + +enum { + USB_KBD_POLL_EP_NO = 0, + USB_KBD_POLL_EP_COUNT = 1 +}; + +usb_endpoint_description_t *usb_kbd_endpoints[USB_KBD_POLL_EP_COUNT + 1]; + +ddf_dev_ops_t keyboard_ops; + +/*----------------------------------------------------------------------------*/ + +usb_kbd_t *usb_kbd_new(void); + +int usb_kbd_init(usb_kbd_t *kbd_dev, usb_device_t *dev); + +bool usb_kbd_polling_callback(usb_device_t *dev, uint8_t *buffer, + size_t buffer_size, void *arg); + +void usb_kbd_polling_ended_callback(usb_device_t *dev, bool reason, + void *arg); + +int usb_kbd_is_initialized(const usb_kbd_t *kbd_dev); + +int usb_kbd_is_ready_to_destroy(const usb_kbd_t *kbd_dev); + +void usb_kbd_free(usb_kbd_t **kbd_dev); + +void usb_kbd_push_ev(usb_kbd_t *kbd_dev, int type, unsigned int key); + +#endif /* USB_KBDDEV_H_ */ + +/** + * @} + */ Index: uspace/drv/usbkbd/kbdrepeat.c =================================================================== --- uspace/drv/usbkbd/kbdrepeat.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/kbdrepeat.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,185 @@ +/* + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** + * @file + * USB HID keyboard autorepeat facilities + */ + +#include +#include +#include +#include + +#include + +#include "kbdrepeat.h" +#include "kbddev.h" + + +/** Delay between auto-repeat state checks when no key is being repeated. */ +static unsigned int CHECK_DELAY = 10000; + +/*----------------------------------------------------------------------------*/ +/** + * Main loop handling the auto-repeat of keys. + * + * This functions periodically checks if there is some key to be auto-repeated. + * + * If a new key is to be repeated, it uses the delay before first repeat stored + * in the keyboard structure to wait until the key has to start repeating. + * + * If the same key is still pressed, it uses the delay between repeats stored + * in the keyboard structure to wait until the key should be repeated. + * + * If the currently repeated key is not pressed any more ( + * usb_kbd_repeat_stop() was called), it stops repeating it and starts + * checking again. + * + * @note For accessing the keyboard device auto-repeat information a fibril + * mutex (repeat_mtx) from the @a kbd structure is used. + * + * @param kbd Keyboard device structure. + */ +static void usb_kbd_repeat_loop(usb_kbd_t *kbd) +{ + unsigned int delay = 0; + + usb_log_debug("Starting autorepeat loop.\n"); + + while (true) { + // check if the kbd structure is usable + if (!usb_kbd_is_initialized(kbd)) { + if (usb_kbd_is_ready_to_destroy(kbd)) { + usb_kbd_free(&kbd); + assert(kbd == NULL); + } + return; + } + + fibril_mutex_lock(kbd->repeat_mtx); + + if (kbd->repeat.key_new > 0) { + if (kbd->repeat.key_new == kbd->repeat.key_repeated) { + usb_log_debug2("Repeating key: %u.\n", + kbd->repeat.key_repeated); + usb_kbd_push_ev(kbd, KEY_PRESS, + kbd->repeat.key_repeated); + delay = kbd->repeat.delay_between; + } else { + usb_log_debug("New key to repeat: %u.\n", + kbd->repeat.key_new); + kbd->repeat.key_repeated = kbd->repeat.key_new; + delay = kbd->repeat.delay_before; + } + } else { + if (kbd->repeat.key_repeated > 0) { + usb_log_debug("Stopping to repeat key: %u.\n", + kbd->repeat.key_repeated); + kbd->repeat.key_repeated = 0; + } + delay = CHECK_DELAY; + } + fibril_mutex_unlock(kbd->repeat_mtx); + + async_usleep(delay); + } +} + +/*----------------------------------------------------------------------------*/ +/** + * Main routine to be executed by a fibril for handling auto-repeat. + * + * Starts the loop for checking changes in auto-repeat. + * + * @param arg User-specified argument. Expects pointer to the keyboard device + * structure representing the keyboard. + * + * @retval EOK if the routine has finished. + * @retval EINVAL if no argument is supplied. + */ +int usb_kbd_repeat_fibril(void *arg) +{ + usb_log_debug("Autorepeat fibril spawned.\n"); + + if (arg == NULL) { + usb_log_error("No device!\n"); + return EINVAL; + } + + usb_kbd_t *kbd = (usb_kbd_t *)arg; + + usb_kbd_repeat_loop(kbd); + + return EOK; +} + +/*----------------------------------------------------------------------------*/ +/** + * Start repeating particular key. + * + * @note Only one key is repeated at any time, so calling this function + * effectively cancels auto-repeat of the current repeated key (if any) + * and 'schedules' another key for auto-repeat. + * + * @param kbd Keyboard device structure. + * @param key Key to start repeating. + */ +void usb_kbd_repeat_start(usb_kbd_t *kbd, unsigned int key) +{ + fibril_mutex_lock(kbd->repeat_mtx); + kbd->repeat.key_new = key; + fibril_mutex_unlock(kbd->repeat_mtx); +} + +/*----------------------------------------------------------------------------*/ +/** + * Stop repeating particular key. + * + * @note Only one key is repeated at any time, but this function may be called + * even with key that is not currently repeated (in that case nothing + * happens). + * + * @param kbd Keyboard device structure. + * @param key Key to stop repeating. + */ +void usb_kbd_repeat_stop(usb_kbd_t *kbd, unsigned int key) +{ + fibril_mutex_lock(kbd->repeat_mtx); + if (key == kbd->repeat.key_new) { + kbd->repeat.key_new = 0; + } + fibril_mutex_unlock(kbd->repeat_mtx); +} + +/** + * @} + */ Index: uspace/drv/usbkbd/kbdrepeat.h =================================================================== --- uspace/drv/usbkbd/kbdrepeat.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/kbdrepeat.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,68 @@ +/* + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** @file + * USB HID keyboard autorepeat facilities + */ + +#ifndef USB_KBDREPEAT_H_ +#define USB_KBDREPEAT_H_ + +struct usb_kbd_t; + +/*----------------------------------------------------------------------------*/ +/** + * Structure for keeping information needed for auto-repeat of keys. + */ +typedef struct { + /** Last pressed key. */ + unsigned int key_new; + /** Key to be repeated. */ + unsigned int key_repeated; + /** Delay before first repeat in microseconds. */ + unsigned int delay_before; + /** Delay between repeats in microseconds. */ + unsigned int delay_between; +} usb_kbd_repeat_t; + +/*----------------------------------------------------------------------------*/ + +int usb_kbd_repeat_fibril(void *arg); + +void usb_kbd_repeat_start(struct usb_kbd_t *kbd, unsigned int key); + +void usb_kbd_repeat_stop(struct usb_kbd_t *kbd, unsigned int key); + +#endif /* USB_KBDREPEAT_H_ */ + +/** + * @} + */ Index: uspace/drv/usbkbd/layout.h =================================================================== --- uspace/drv/usbkbd/layout.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/layout.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,57 @@ +/* + * Copyright (c) 2009 Jiri Svoboda + * Copyright (c) 2011 Lubos Slovak + * (copied from /uspace/srv/hid/kbd/include/layout.h) + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** @file + * Keyboard layout. + */ + +#ifndef USB_KBD_LAYOUT_H_ +#define USB_KBD_LAYOUT_H_ + +#include +#include + +typedef struct { + void (*reset)(void); + wchar_t (*parse_ev)(console_event_t *); +} layout_op_t; + +extern layout_op_t us_qwerty_op; +extern layout_op_t us_dvorak_op; +extern layout_op_t cz_op; + +#endif + +/** + * @} + */ Index: uspace/drv/usbkbd/main.c =================================================================== --- uspace/drv/usbkbd/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,264 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** + * @file + * Main routines of USB HID driver. + */ + +#include +#include +#include +#include + +#include + +#include "kbddev.h" +#include "kbdrepeat.h" + +/*----------------------------------------------------------------------------*/ + +#define NAME "usbkbd" + +/** + * Function for adding a new device of type USB/HID/keyboard. + * + * This functions initializes required structures from the device's descriptors + * and starts new fibril for polling the keyboard for events and another one for + * handling auto-repeat of keys. + * + * During initialization, the keyboard is switched into boot protocol, the idle + * rate is set to 0 (infinity), resulting in the keyboard only reporting event + * when a key is pressed or released. Finally, the LED lights are turned on + * according to the default setup of lock keys. + * + * @note By default, the keyboards is initialized with Num Lock turned on and + * other locks turned off. + * @note Currently supports only boot-protocol keyboards. + * + * @param dev Device to add. + * + * @retval EOK if successful. + * @retval ENOMEM if there + * @return Other error code inherited from one of functions usb_kbd_init(), + * ddf_fun_bind() and ddf_fun_add_to_class(). + * + * @sa usb_kbd_fibril(), usb_kbd_repeat_fibril() + */ +static int usbhid_try_add_device(usb_device_t *dev) +{ + /* Create the function exposed under /dev/devices. */ + ddf_fun_t *kbd_fun = ddf_fun_create(dev->ddf_dev, fun_exposed, + "keyboard"); + if (kbd_fun == NULL) { + usb_log_error("Could not create DDF function node.\n"); + return ENOMEM; + } + + /* + * Initialize device (get and process descriptors, get address, etc.) + */ + usb_log_debug("Initializing USB/HID KBD device...\n"); + + usb_kbd_t *kbd_dev = usb_kbd_new(); + if (kbd_dev == NULL) { + usb_log_error("Error while creating USB/HID KBD device " + "structure.\n"); + ddf_fun_destroy(kbd_fun); + return ENOMEM; // TODO: some other code?? + } + + int rc = usb_kbd_init(kbd_dev, dev); + + if (rc != EOK) { + usb_log_error("Failed to initialize USB/HID KBD device.\n"); + ddf_fun_destroy(kbd_fun); + usb_kbd_free(&kbd_dev); + return rc; + } + + usb_log_debug("USB/HID KBD device structure initialized.\n"); + + /* + * Store the initialized keyboard device and keyboard ops + * to the DDF function. + */ + kbd_fun->driver_data = kbd_dev; + kbd_fun->ops = &keyboard_ops; + + rc = ddf_fun_bind(kbd_fun); + if (rc != EOK) { + usb_log_error("Could not bind DDF function: %s.\n", + str_error(rc)); + // TODO: Can / should I destroy the DDF function? + ddf_fun_destroy(kbd_fun); + usb_kbd_free(&kbd_dev); + return rc; + } + + rc = ddf_fun_add_to_class(kbd_fun, "keyboard"); + if (rc != EOK) { + usb_log_error( + "Could not add DDF function to class 'keyboard': %s.\n", + str_error(rc)); + // TODO: Can / should I destroy the DDF function? + ddf_fun_destroy(kbd_fun); + usb_kbd_free(&kbd_dev); + return rc; + } + + /* + * Create new fibril for handling this keyboard + */ + //fid_t fid = fibril_create(usb_kbd_fibril, kbd_dev); + + /* Start automated polling function. + * This will create a separate fibril that will query the device + * for the data continuously + */ + rc = usb_device_auto_poll(dev, + /* Index of the polling pipe. */ + USB_KBD_POLL_EP_NO, + /* Callback when data arrives. */ + usb_kbd_polling_callback, + /* How much data to request. */ + dev->pipes[USB_KBD_POLL_EP_NO].pipe->max_packet_size, + /* Callback when the polling ends. */ + usb_kbd_polling_ended_callback, + /* Custom argument. */ + kbd_dev); + + + if (rc != EOK) { + usb_log_error("Failed to start polling fibril for `%s'.\n", + dev->ddf_dev->name); + return rc; + } + //fibril_add_ready(fid); + + /* + * Create new fibril for auto-repeat + */ + fid_t fid = fibril_create(usb_kbd_repeat_fibril, kbd_dev); + if (fid == 0) { + usb_log_error("Failed to start fibril for KBD auto-repeat"); + return ENOMEM; + } + fibril_add_ready(fid); + + (void)keyboard_ops; + + /* + * Hurrah, device is initialized. + */ + return EOK; +} + +/*----------------------------------------------------------------------------*/ +/** + * Callback for passing a new device to the driver. + * + * @note Currently, only boot-protocol keyboards are supported by this driver. + * + * @param dev Structure representing the new device. + * + * @retval EOK if successful. + * @retval EREFUSED if the device is not supported. + */ +static int usbhid_add_device(usb_device_t *dev) +{ + usb_log_debug("usbhid_add_device()\n"); + + if (dev->interface_no < 0) { + usb_log_warning("Device is not a supported keyboard.\n"); + usb_log_error("Failed to add HID device: endpoint not found." + "\n"); + return ENOTSUP; + } + + int rc = usbhid_try_add_device(dev); + + if (rc != EOK) { + usb_log_warning("Device is not a supported keyboard.\n"); + usb_log_error("Failed to add HID device: %s.\n", + str_error(rc)); + return rc; + } + + usb_log_info("Keyboard `%s' ready to use.\n", dev->ddf_dev->name); + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +/* Currently, the framework supports only device adding. Once the framework + * supports unplug, more callbacks will be added. */ +static usb_driver_ops_t usbhid_driver_ops = { + .add_device = usbhid_add_device, +}; + + +/* The driver itself. */ +static usb_driver_t usbhid_driver = { + .name = NAME, + .ops = &usbhid_driver_ops, + .endpoints = usb_kbd_endpoints +}; + +/*----------------------------------------------------------------------------*/ + +//static driver_ops_t kbd_driver_ops = { +// .add_device = usbhid_add_device, +//}; + +///*----------------------------------------------------------------------------*/ + +//static driver_t kbd_driver = { +// .name = NAME, +// .driver_ops = &kbd_driver_ops +//}; + +/*----------------------------------------------------------------------------*/ + +int main(int argc, char *argv[]) +{ + printf(NAME ": HelenOS USB HID driver.\n"); + + usb_log_enable(USB_LOG_LEVEL_DEBUG, NAME); + + return usb_driver_main(&usbhid_driver); +} + +/** + * @} + */ Index: uspace/drv/usbkbd/usbkbd.ma =================================================================== --- uspace/drv/usbkbd/usbkbd.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/usbkbd.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,2 @@ +100 usb&interface&class=HID&subclass=0x01&protocol=0x01 +10 usb&interface&class=HID Index: uspace/drv/usbmid/Makefile =================================================================== --- uspace/drv/usbmid/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmid/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,40 @@ +# +# Copyright (c) 2011 Vojtech Horky +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBS = $(LIBDRV_PREFIX)/libdrv.a $(LIBUSB_PREFIX)/libusb.a +EXTRA_CFLAGS += -I$(LIBDRV_PREFIX)/include -I$(LIBUSB_PREFIX)/include +BINARY = usbmid + +SOURCES = \ + dump.c \ + explore.c \ + main.c \ + usbmid.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/usbmid/dump.c =================================================================== --- uspace/drv/usbmid/dump.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmid/dump.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,120 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmid + * @{ + */ +/** + * @file + * Dumping and debugging functions. + */ +#include +#include +#include +#include +#include +#include +#include "usbmid.h" + +/** Dump found descriptor. + * + * @param data Descriptor data. + * @param depth Nesting depth. + */ +static void dump_tree_descriptor(uint8_t *data, size_t depth) +{ + if (data == NULL) { + return; + } + int type = (int) *(data + 1); + if (type == USB_DESCTYPE_INTERFACE) { + usb_standard_interface_descriptor_t *descriptor + = (usb_standard_interface_descriptor_t *) data; + usb_log_info("Found interface: %s (0x%02x/0x%02x/0x%02x).\n", + usb_str_class(descriptor->interface_class), + (int) descriptor->interface_class, + (int) descriptor->interface_subclass, + (int) descriptor->interface_protocol); + } +} + +/** Dump tree of descriptors. + * + * @param parser Descriptor parser. + * @param data Descriptor parser data. + * @param root Pointer to current root. + * @param depth Nesting depth. + */ +static void dump_tree_internal(usb_dp_parser_t *parser, usb_dp_parser_data_t *data, + uint8_t *root, size_t depth) +{ + if (root == NULL) { + return; + } + dump_tree_descriptor(root, depth); + uint8_t *child = usb_dp_get_nested_descriptor(parser, data, root); + do { + dump_tree_internal(parser, data, child, depth + 1); + child = usb_dp_get_sibling_descriptor(parser, data, root, child); + } while (child != NULL); +} + +/** Dump descriptor tree. + * + * @param parser Descriptor parser. + * @param data Descriptor parser data. + */ +static void dump_tree(usb_dp_parser_t *parser, usb_dp_parser_data_t *data) +{ + uint8_t *ptr = data->data; + dump_tree_internal(parser, data, ptr, 0); +} + +/** Dump given descriptors. + * + * @param descriptors Descriptors buffer (typically full config descriptor). + * @param length Size of @p descriptors buffer in bytes. + */ +void usbmid_dump_descriptors(uint8_t *descriptors, size_t length) +{ + usb_dp_parser_data_t data = { + .data = descriptors, + .size = length, + .arg = NULL + }; + + usb_dp_parser_t parser = { + .nesting = usb_dp_standard_descriptor_nesting + }; + + dump_tree(&parser, &data); +} + +/** + * @} + */ Index: uspace/drv/usbmid/explore.c =================================================================== --- uspace/drv/usbmid/explore.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmid/explore.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,204 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmid + * @{ + */ +/** + * @file + * Exploration of available interfaces in the USB device. + */ +#include +#include +#include +#include +#include +#include +#include +#include "usbmid.h" + +/** Operations of the device itself. */ +static ddf_dev_ops_t mid_device_ops = { + .interfaces[USB_DEV_IFACE] = &usb_iface_hub_impl +}; + +/** Find starting indexes of all interface descriptors in a configuration. + * + * @param config_descriptor Full configuration descriptor. + * @param config_descriptor_size Size of @p config_descriptor in bytes. + * @param interface_positions Array where to store indexes of interfaces. + * @param interface_count Size of @p interface_positions array. + * @return Number of found interfaces. + * @retval (size_t)-1 Error occured. + */ +static size_t find_interface_descriptors(uint8_t *config_descriptor, + size_t config_descriptor_size, + size_t *interface_positions, size_t interface_count) +{ + if (interface_count == 0) { + return (size_t) -1; + } + + usb_dp_parser_data_t data = { + .data = config_descriptor, + .size = config_descriptor_size, + .arg = NULL + }; + + usb_dp_parser_t parser = { + .nesting = usb_dp_standard_descriptor_nesting + }; + + uint8_t *interface = usb_dp_get_nested_descriptor(&parser, &data, + data.data); + if (interface == NULL) { + return (size_t) -1; + } + if (interface[1] != USB_DESCTYPE_INTERFACE) { + return (size_t) -1; + } + + size_t found_interfaces = 0; + interface_positions[found_interfaces] = interface - config_descriptor; + found_interfaces++; + + while (interface != NULL) { + interface = usb_dp_get_sibling_descriptor(&parser, &data, + data.data, interface); + if ((interface != NULL) + && (found_interfaces < interface_count) + && (interface[1] == USB_DESCTYPE_INTERFACE)) { + interface_positions[found_interfaces] + = interface - config_descriptor; + found_interfaces++; + } + } + + return found_interfaces; +} + +/** Explore MID device. + * + * We expect that @p dev is initialized and session on control pipe is + * started. + * + * @param dev Device to be explored. + * @return Whether to accept this device from devman. + */ +bool usbmid_explore_device(usb_device_t *dev) +{ + int rc; + + int dev_class = dev->descriptors.device.device_class; + if (dev_class != USB_CLASS_USE_INTERFACE) { + usb_log_warning( + "Device class: %d (%s), but expected class 0.\n", + dev_class, usb_str_class(dev_class)); + usb_log_error("Not multi interface device, refusing.\n"); + return false; + } + + /* Short cuts to save on typing ;-). */ + uint8_t *config_descriptor_raw = dev->descriptors.configuration; + size_t config_descriptor_size = dev->descriptors.configuration_size; + usb_standard_configuration_descriptor_t *config_descriptor = + (usb_standard_configuration_descriptor_t *) config_descriptor_raw; + + size_t *interface_descriptors + = malloc(sizeof(size_t) * config_descriptor->interface_count); + if (interface_descriptors == NULL) { + usb_log_error("Out of memory (wanted %zuB).\n", + sizeof(size_t) * config_descriptor->interface_count); + free(config_descriptor_raw); + return false; + } + size_t interface_descriptors_count + = find_interface_descriptors( + config_descriptor_raw, config_descriptor_size, + interface_descriptors, config_descriptor->interface_count); + + if (interface_descriptors_count == (size_t) -1) { + usb_log_error("Problem parsing configuration descriptor.\n"); + free(interface_descriptors); + return false; + } + + /* Select the first configuration */ + rc = usb_request_set_configuration(&dev->ctrl_pipe, + config_descriptor->configuration_number); + if (rc != EOK) { + usb_log_error("Failed to set device configuration: %s.\n", + str_error(rc)); + free(interface_descriptors); + return false; + } + + + /* Create control function */ + ddf_fun_t *ctl_fun = ddf_fun_create(dev->ddf_dev, fun_exposed, "ctl"); + if (ctl_fun == NULL) { + usb_log_error("Failed to create control function.\n"); + free(interface_descriptors); + return false; + } + + ctl_fun->ops = &mid_device_ops; + + rc = ddf_fun_bind(ctl_fun); + if (rc != EOK) { + usb_log_error("Failed to bind control function: %s.\n", + str_error(rc)); + free(interface_descriptors); + return false; + } + + /* Spawn interface children */ + size_t i; + for (i = 0; i < interface_descriptors_count; i++) { + usb_standard_interface_descriptor_t *interface + = (usb_standard_interface_descriptor_t *) + (config_descriptor_raw + interface_descriptors[i]); + usb_log_debug2("Interface descriptor at index %zu (type %d).\n", + interface_descriptors[i], (int) interface->descriptor_type); + usb_log_info("Creating child for interface %d (%s).\n", + (int) interface->interface_number, + usb_str_class(interface->interface_class)); + rc = usbmid_spawn_interface_child(dev, &dev->descriptors.device, + interface); + if (rc != EOK) { + usb_log_error("Failed to create interface child: %s.\n", + str_error(rc)); + } + } + + return true; +} + +/** + * @} + */ Index: uspace/drv/usbmid/main.c =================================================================== --- uspace/drv/usbmid/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmid/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,102 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmid + * @{ + */ +/** + * @file + * Main routines of USB multi interface device driver. + */ +#include +#include +#include +#include +#include +#include +#include + +#include "usbmid.h" + +/** Callback when new MID device is attached to the host. + * + * @param gen_dev Generic DDF device representing the new device. + * @return Error code. + */ +static int usbmid_add_device(usb_device_t *dev) +{ + usb_log_info("Taking care of new MID `%s'.\n", dev->ddf_dev->name); + + int rc; + + rc = usb_pipe_start_session(&dev->ctrl_pipe); + if (rc != EOK) { + usb_log_error("Failed to start session on control pipe: %s.\n", + str_error(rc)); + return rc; + } + + bool accept = usbmid_explore_device(dev); + + rc = usb_pipe_end_session(&dev->ctrl_pipe); + if (rc != EOK) { + usb_log_warning("Failed to end session on control pipe: %s.\n", + str_error(rc)); + } + + if (!accept) { + return ENOTSUP; + } + + return EOK; +} + +/** USB MID driver ops. */ +static usb_driver_ops_t mid_driver_ops = { + .add_device = usbmid_add_device, +}; + +/** USB MID driver. */ +static usb_driver_t mid_driver = { + .name = NAME, + .ops = &mid_driver_ops, + .endpoints = NULL +}; + +int main(int argc, char *argv[]) +{ + printf(NAME ": USB multi interface device driver.\n"); + + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + + return usb_driver_main(&mid_driver); +} + +/** + * @} + */ Index: uspace/drv/usbmid/usbmid.c =================================================================== --- uspace/drv/usbmid/usbmid.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmid/usbmid.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,183 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmid + * @{ + */ +/** + * @file + * Helper functions. + */ +#include +#include +#include +#include +#include +#include +#include +#include +#include "usbmid.h" + +/** Callback for DDF USB interface. */ +static int usb_iface_get_address_impl(ddf_fun_t *fun, devman_handle_t handle, + usb_address_t *address) +{ + return usb_iface_get_address_hub_impl(fun, handle, address); +} + +/** Callback for DDF USB interface. */ +static int usb_iface_get_interface_impl(ddf_fun_t *fun, devman_handle_t handle, + int *iface_no) +{ + assert(fun); + + usbmid_interface_t *iface = fun->driver_data; + assert(iface); + + if (iface_no != NULL) { + *iface_no = iface->interface_no; + } + + return EOK; +} + +/** DDF interface of the child - interface function. */ +static usb_iface_t child_usb_iface = { + .get_hc_handle = usb_iface_get_hc_handle_hub_child_impl, + .get_address = usb_iface_get_address_impl, + .get_interface = usb_iface_get_interface_impl +}; + +/** Operations for children - interface functions. */ +static ddf_dev_ops_t child_device_ops = { + .interfaces[USB_DEV_IFACE] = &child_usb_iface +}; + +/** Create new interface for USB MID device. + * + * @param fun Backing generic DDF device function (representing interface). + * @param iface_no Interface number. + * @return New interface. + * @retval NULL Error occured. + */ +usbmid_interface_t *usbmid_interface_create(ddf_fun_t *fun, int iface_no) +{ + usbmid_interface_t *iface = malloc(sizeof(usbmid_interface_t)); + if (iface == NULL) { + usb_log_error("Out of memory (wanted %zuB).\n", + sizeof(usbmid_interface_t)); + return NULL; + } + + iface->fun = fun; + iface->interface_no = iface_no; + + return iface; +} + + +/** Spawn new child device from one interface. + * + * @param parent Parent MID device. + * @param device_descriptor Device descriptor. + * @param interface_descriptor Interface descriptor. + * @return Error code. + */ +int usbmid_spawn_interface_child(usb_device_t *parent, + const usb_standard_device_descriptor_t *device_descriptor, + const usb_standard_interface_descriptor_t *interface_descriptor) +{ + ddf_fun_t *child = NULL; + char *child_name = NULL; + usbmid_interface_t *child_as_interface = NULL; + int rc; + + /* + * Name is class name followed by interface number. + * The interface number shall provide uniqueness while the + * class name something humanly understandable. + */ + rc = asprintf(&child_name, "%s%d", + usb_str_class(interface_descriptor->interface_class), + (int) interface_descriptor->interface_number); + if (rc < 0) { + goto error_leave; + } + + /* Create the device. */ + child = ddf_fun_create(parent->ddf_dev, fun_inner, child_name); + if (child == NULL) { + rc = ENOMEM; + goto error_leave; + } + + + + child_as_interface = usbmid_interface_create(child, + (int) interface_descriptor->interface_number); + if (child_as_interface == NULL) { + rc = ENOMEM; + goto error_leave; + } + + child->driver_data = child_as_interface; + child->ops = &child_device_ops; + + rc = usb_device_create_match_ids_from_interface(device_descriptor, + interface_descriptor, + &child->match_ids); + if (rc != EOK) { + goto error_leave; + } + + rc = ddf_fun_bind(child); + if (rc != EOK) { + goto error_leave; + } + + return EOK; + +error_leave: + if (child != NULL) { + child->name = NULL; + /* This takes care of match_id deallocation as well. */ + ddf_fun_destroy(child); + } + if (child_name != NULL) { + free(child_name); + } + if (child_as_interface != NULL) { + free(child_as_interface); + } + + return rc; +} + +/** + * @} + */ Index: uspace/drv/usbmid/usbmid.h =================================================================== --- uspace/drv/usbmid/usbmid.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmid/usbmid.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,66 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmid + * @{ + */ +/** @file + * Common definitions. + */ + +#ifndef USBMID_H_ +#define USBMID_H_ + +#include +#include +#include +#include +#include + +#define NAME "usbmid" + +/** Container for single interface in a MID device. */ +typedef struct { + /** Function container. */ + ddf_fun_t *fun; + + /** Interface number. */ + int interface_no; +} usbmid_interface_t; + +usbmid_interface_t *usbmid_interface_create(ddf_fun_t *, int); +bool usbmid_explore_device(usb_device_t *); +int usbmid_spawn_interface_child(usb_device_t *, + const usb_standard_device_descriptor_t *, + const usb_standard_interface_descriptor_t *); +void usbmid_dump_descriptors(uint8_t *, size_t); + +#endif +/** + * @} + */ Index: uspace/drv/usbmid/usbmid.ma =================================================================== --- uspace/drv/usbmid/usbmid.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmid/usbmid.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,1 @@ +100 usb&mid Index: uspace/drv/usbmouse/Makefile =================================================================== --- uspace/drv/usbmouse/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmouse/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,40 @@ +# +# Copyright (c) 2011 Vojtech Horky +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBS = $(LIBDRV_PREFIX)/libdrv.a $(LIBUSB_PREFIX)/libusb.a +EXTRA_CFLAGS += -I$(LIBDRV_PREFIX)/include -I$(LIBUSB_PREFIX)/include -I. + +BINARY = usbmouse + +SOURCES = \ + init.c \ + main.c \ + mouse.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/usbmouse/init.c =================================================================== --- uspace/drv/usbmouse/init.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmouse/init.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,160 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmouse + * @{ + */ +/** + * @file + * Initialization routines for USB mouse driver. + */ +#include "mouse.h" +#include +#include +#include +#include +#include + +/** Mouse polling endpoint description for boot protocol subclass. */ +usb_endpoint_description_t poll_endpoint_description = { + .transfer_type = USB_TRANSFER_INTERRUPT, + .direction = USB_DIRECTION_IN, + .interface_class = USB_CLASS_HID, + .interface_subclass = USB_HID_SUBCLASS_BOOT, + .interface_protocol = USB_HID_PROTOCOL_MOUSE, + .flags = 0 +}; + +static void default_connection_handler(ddf_fun_t *, ipc_callid_t, ipc_call_t *); +/** Device ops for USB mouse. */ +static ddf_dev_ops_t mouse_ops = { + .default_handler = default_connection_handler +}; + +/** Default handler for IPC methods not handled by DDF. + * + * @param fun Device function handling the call. + * @param icallid Call id. + * @param icall Call data. + */ +void default_connection_handler(ddf_fun_t *fun, + ipc_callid_t icallid, ipc_call_t *icall) +{ + sysarg_t method = IPC_GET_IMETHOD(*icall); + + usb_mouse_t *mouse = (usb_mouse_t *) fun->driver_data; + assert(mouse != NULL); + + if (method == IPC_M_CONNECT_TO_ME) { + int callback = IPC_GET_ARG5(*icall); + + if (mouse->console_phone != -1) { + async_answer_0(icallid, ELIMIT); + return; + } + + mouse->console_phone = callback; + async_answer_0(icallid, EOK); + return; + } + + async_answer_0(icallid, EINVAL); +} + +/** Create USB mouse device. + * + * The mouse device is stored into dev->driver_data. + * + * @param dev Generic device. + * @return Error code. + */ +int usb_mouse_create(usb_device_t *dev) +{ + usb_mouse_t *mouse = malloc(sizeof(usb_mouse_t)); + if (mouse == NULL) { + return ENOMEM; + } + mouse->dev = dev; + mouse->console_phone = -1; + + int rc; + + /* Create DDF function. */ + mouse->mouse_fun = ddf_fun_create(dev->ddf_dev, fun_exposed, "mouse"); + if (mouse->mouse_fun == NULL) { + rc = ENOMEM; + goto leave; + } + + mouse->mouse_fun->ops = &mouse_ops; + + rc = ddf_fun_bind(mouse->mouse_fun); + if (rc != EOK) { + goto leave; + } + + /* Add the function to mouse class. */ + rc = ddf_fun_add_to_class(mouse->mouse_fun, "mouse"); + if (rc != EOK) { + goto leave; + } + + /* Open the control pipe. */ + rc = usb_pipe_start_session(&dev->ctrl_pipe); + if (rc != EOK) { + goto leave; + } + + /* Set the boot protocol. */ + rc = usb_control_request_set(&dev->ctrl_pipe, + USB_REQUEST_TYPE_CLASS, USB_REQUEST_RECIPIENT_INTERFACE, + USB_HIDREQ_SET_PROTOCOL, USB_HID_PROTOCOL_BOOT, dev->interface_no, + NULL, 0); + if (rc != EOK) { + goto leave; + } + + /* Close the control pipe (ignore errors). */ + usb_pipe_end_session(&dev->ctrl_pipe); + + + /* Everything allright. */ + dev->driver_data = mouse; + mouse->mouse_fun->driver_data = mouse; + + return EOK; + +leave: + free(mouse); + + return rc; +} + +/** + * @} + */ Index: uspace/drv/usbmouse/main.c =================================================================== --- uspace/drv/usbmouse/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmouse/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,99 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmouse + * @{ + */ +/** + * @file + * Main routines of USB boot protocol mouse driver. + */ +#include "mouse.h" +#include +#include +#include + +/** Callback when new mouse device is attached and recognised by DDF. + * + * @param dev Representation of a generic DDF device. + * @return Error code. + */ +static int usbmouse_add_device(usb_device_t *dev) +{ + int rc = usb_mouse_create(dev); + if (rc != EOK) { + usb_log_error("Failed to initialize device driver: %s.\n", + str_error(rc)); + return rc; + } + + usb_log_debug("Polling pipe at endpoint %d.\n", dev->pipes[0].pipe->endpoint_no); + + rc = usb_device_auto_poll(dev, 0, + usb_mouse_polling_callback, dev->pipes[0].pipe->max_packet_size, + usb_mouse_polling_ended_callback, dev->driver_data); + + if (rc != EOK) { + usb_log_error("Failed to start polling fibril: %s.\n", + str_error(rc)); + return rc; + } + + usb_log_info("controlling new mouse (handle %llu).\n", + dev->ddf_dev->handle); + + return EOK; +} + +/** USB mouse driver ops. */ +static usb_driver_ops_t mouse_driver_ops = { + .add_device = usbmouse_add_device, +}; + +static usb_endpoint_description_t *endpoints[] = { + &poll_endpoint_description, + NULL +}; + +/** USB mouse driver. */ +static usb_driver_t mouse_driver = { + .name = NAME, + .ops = &mouse_driver_ops, + .endpoints = endpoints +}; + +int main(int argc, char *argv[]) +{ + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + + return usb_driver_main(&mouse_driver); +} + +/** + * @} + */ Index: uspace/drv/usbmouse/mouse.c =================================================================== --- uspace/drv/usbmouse/mouse.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmouse/mouse.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,123 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmouse + * @{ + */ +/** + * @file + * Actual handling of USB mouse protocol. + */ +#include "mouse.h" +#include +#include +#include +#include + +/** Mouse polling callback. + * + * @param dev Device that is being polled. + * @param buffer Data buffer. + * @param buffer_size Buffer size in bytes. + * @param arg Custom argument - points to usb_mouse_t. + * @return Always true. + */ +bool usb_mouse_polling_callback(usb_device_t *dev, + uint8_t *buffer, size_t buffer_size, void *arg) +{ + usb_mouse_t *mouse = (usb_mouse_t *) arg; + + usb_log_debug2("got buffer: %s.\n", + usb_debug_str_buffer(buffer, buffer_size, 0)); + + uint8_t butt = buffer[0]; + char str_buttons[4] = { + butt & 1 ? '#' : '.', + butt & 2 ? '#' : '.', + butt & 4 ? '#' : '.', + 0 + }; + + int shift_x = ((int) buffer[1]) - 127; + int shift_y = ((int) buffer[2]) - 127; + int wheel = ((int) buffer[3]) - 127; + + if (buffer[1] == 0) { + shift_x = 0; + } + if (buffer[2] == 0) { + shift_y = 0; + } + if (buffer[3] == 0) { + wheel = 0; + } + + if (mouse->console_phone >= 0) { + if ((shift_x != 0) || (shift_y != 0)) { + /* FIXME: guessed for QEMU */ + async_req_2_0(mouse->console_phone, + MEVENT_MOVE, + - shift_x / 10, - shift_y / 10); + } + if (butt) { + /* FIXME: proper button clicking. */ + async_req_2_0(mouse->console_phone, + MEVENT_BUTTON, 1, 1); + async_req_2_0(mouse->console_phone, + MEVENT_BUTTON, 1, 0); + } + } + + usb_log_debug("buttons=%s dX=%+3d dY=%+3d wheel=%+3d\n", + str_buttons, shift_x, shift_y, wheel); + + /* Guess. */ + async_usleep(1000); + + return true; +} + +/** Callback when polling is terminated. + * + * @param dev Device where the polling terminated. + * @param recurring_errors Whether the polling was terminated due to + * recurring errors. + * @param arg Custom argument - points to usb_mouse_t. + */ +void usb_mouse_polling_ended_callback(usb_device_t *dev, + bool recurring_errors, void *arg) +{ + usb_mouse_t *mouse = (usb_mouse_t *) arg; + + async_hangup(mouse->console_phone); + mouse->console_phone = -1; +} + +/** + * @} + */ Index: uspace/drv/usbmouse/mouse.h =================================================================== --- uspace/drv/usbmouse/mouse.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmouse/mouse.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,69 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmouse + * @{ + */ +/** + * @file + * Common definitions for USB mouse driver. + */ +#ifndef USBMOUSE_MOUSE_H_ +#define USBMOUSE_MOUSE_H_ + +#include +#include +#include + +#define NAME "usbmouse" + +/** Container for USB mouse device. */ +typedef struct { + /** Generic device container. */ + usb_device_t *dev; + /** Function representing the device. */ + ddf_fun_t *mouse_fun; + /** Polling interval in microseconds. */ + suseconds_t poll_interval_us; + /** IPC phone to console (consumer). */ + int console_phone; +} usb_mouse_t; + +#define POLL_PIPE(dev) ((dev)->pipes[0].pipe) + +extern usb_endpoint_description_t poll_endpoint_description; + +int usb_mouse_create(usb_device_t *); + +bool usb_mouse_polling_callback(usb_device_t *, uint8_t *, size_t, void *); +void usb_mouse_polling_ended_callback(usb_device_t *, bool, void *); + +#endif +/** + * @} + */ Index: uspace/drv/usbmouse/usbmouse.ma =================================================================== --- uspace/drv/usbmouse/usbmouse.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmouse/usbmouse.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,1 @@ +100 usb&interface&class=HID&subclass=0x01&protocol=0x02 Index: uspace/drv/vhc/Makefile =================================================================== --- uspace/drv/vhc/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,51 @@ +# +# Copyright (c) 2010 Vojtech Horky +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBS = \ + $(LIBUSB_PREFIX)/libusb.a \ + $(LIBUSBVIRT_PREFIX)/libusbvirt.a \ + $(LIBDRV_PREFIX)/libdrv.a +EXTRA_CFLAGS += \ + -I$(LIBUSBVIRT_PREFIX)/include \ + -I$(LIBUSB_PREFIX)/include \ + -I$(LIBDRV_PREFIX)/include +BINARY = vhc + +SOURCES = \ + hub/hub.c \ + hub/virthub.c \ + hub/virthubops.c \ + conndev.c \ + connhost.c \ + devices.c \ + hc.c \ + hcd.c \ + hub.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/vhc/conn.h =================================================================== --- uspace/drv/vhc/conn.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/conn.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,60 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Connection handling of incoming calls. + */ +#ifndef VHCD_CONN_H_ +#define VHCD_CONN_H_ + +#include +#include +#include +#include "vhcd.h" +#include "devices.h" + +void connection_handler_host(sysarg_t); + +extern usbhc_iface_t vhc_iface; +extern usb_iface_t vhc_usb_iface; +extern usb_iface_t rh_usb_iface; + +void address_init(void); + + +void default_connection_handler(ddf_fun_t *, ipc_callid_t, ipc_call_t *); +void on_client_close(ddf_fun_t *); + + +#endif +/** + * @} + */ Index: uspace/drv/vhc/conndev.c =================================================================== --- uspace/drv/vhc/conndev.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/conndev.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,131 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Connection handling of calls from virtual device (implementation). + */ + +#include +#include +#include + +#include "conn.h" +#include "hc.h" +#include "hub.h" + +#define DEVICE_NAME_MAXLENGTH 32 + +static int get_device_name(int phone, char *buffer, size_t len) +{ + ipc_call_t answer_data; + sysarg_t answer_rc; + aid_t req; + int rc; + + req = async_send_0(phone, + IPC_M_USBVIRT_GET_NAME, + &answer_data); + + rc = async_data_read_start(phone, buffer, len); + if (rc != EOK) { + async_wait_for(req, NULL); + return EINVAL; + } + + async_wait_for(req, &answer_rc); + rc = (int)answer_rc; + + if (IPC_GET_ARG1(answer_data) < len) { + len = IPC_GET_ARG1(answer_data); + } else { + len--; + } + buffer[len] = 0; + + return rc; +} + +/** Default handler for IPC methods not handled by DDF. + * + * @param fun Device handling the call. + * @param icallid Call id. + * @param icall Call data. + */ +void default_connection_handler(ddf_fun_t *fun, + ipc_callid_t icallid, ipc_call_t *icall) +{ + sysarg_t method = IPC_GET_IMETHOD(*icall); + + if (method == IPC_M_CONNECT_TO_ME) { + int callback = IPC_GET_ARG5(*icall); + virtdev_connection_t *dev + = virtdev_add_device(callback, (sysarg_t)fibril_get_id()); + if (!dev) { + async_answer_0(icallid, EEXISTS); + async_hangup(callback); + return; + } + async_answer_0(icallid, EOK); + + char devname[DEVICE_NAME_MAXLENGTH + 1]; + int rc = get_device_name(callback, devname, DEVICE_NAME_MAXLENGTH); + + usb_log_info("New virtual device `%s' (id = %x).\n", + rc == EOK ? devname : "", dev->id); + + return; + } + + async_answer_0(icallid, EINVAL); +} + +/** Callback for DDF when client disconnects. + * + * @param fun Device function the client was connected to. + */ +void on_client_close(ddf_fun_t *fun) +{ + /* + * Maybe a virtual device is being unplugged. + */ + virtdev_connection_t *dev = virtdev_find((sysarg_t)fibril_get_id()); + if (dev == NULL) { + return; + } + + usb_log_info("Virtual device disconnected (id = %x).\n", dev->id); + virtdev_destroy_device(dev); +} + + +/** + * @} + */ Index: uspace/drv/vhc/connhost.c =================================================================== --- uspace/drv/vhc/connhost.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/connhost.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,420 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Connection handling of calls from host (implementation). + */ +#include +#include +#include +#include +#include + +#include "vhcd.h" +#include "conn.h" +#include "hc.h" + + +typedef struct { + usb_direction_t direction; + usbhc_iface_transfer_out_callback_t out_callback; + usbhc_iface_transfer_in_callback_t in_callback; + ddf_fun_t *fun; + size_t reported_size; + void *arg; +} transfer_info_t; + +typedef struct { + usb_direction_t direction; + usb_target_t target; + usbhc_iface_transfer_out_callback_t out_callback; + usbhc_iface_transfer_in_callback_t in_callback; + ddf_fun_t *fun; + void *arg; + void *data_buffer; + size_t data_buffer_size; +} control_transfer_info_t; + +static void universal_callback(void *buffer, size_t size, + int outcome, void *arg) +{ + transfer_info_t *transfer = (transfer_info_t *) arg; + + if (transfer->reported_size != (size_t) -1) { + size = transfer->reported_size; + } + + switch (transfer->direction) { + case USB_DIRECTION_IN: + transfer->in_callback(transfer->fun, + outcome, size, + transfer->arg); + break; + case USB_DIRECTION_OUT: + transfer->out_callback(transfer->fun, + outcome, + transfer->arg); + break; + default: + assert(false && "unreachable"); + break; + } + + free(transfer); +} + +static transfer_info_t *create_transfer_info(ddf_fun_t *fun, + usb_direction_t direction, void *arg) +{ + transfer_info_t *transfer = malloc(sizeof(transfer_info_t)); + + transfer->direction = direction; + transfer->in_callback = NULL; + transfer->out_callback = NULL; + transfer->arg = arg; + transfer->fun = fun; + transfer->reported_size = (size_t) -1; + + return transfer; +} + +static void control_abort_prematurely(control_transfer_info_t *transfer, + size_t size, int outcome) +{ + switch (transfer->direction) { + case USB_DIRECTION_IN: + transfer->in_callback(transfer->fun, + outcome, size, + transfer->arg); + break; + case USB_DIRECTION_OUT: + transfer->out_callback(transfer->fun, + outcome, + transfer->arg); + break; + default: + assert(false && "unreachable"); + break; + } +} + +static void control_callback_two(void *buffer, size_t size, + int outcome, void *arg) +{ + control_transfer_info_t *ctrl_transfer = (control_transfer_info_t *) arg; + + if (outcome != EOK) { + control_abort_prematurely(ctrl_transfer, outcome, size); + free(ctrl_transfer); + return; + } + + transfer_info_t *transfer = create_transfer_info(ctrl_transfer->fun, + ctrl_transfer->direction, ctrl_transfer->arg); + transfer->out_callback = ctrl_transfer->out_callback; + transfer->in_callback = ctrl_transfer->in_callback; + transfer->reported_size = size; + + switch (ctrl_transfer->direction) { + case USB_DIRECTION_IN: + hc_add_transaction_to_device(false, ctrl_transfer->target, + USB_TRANSFER_CONTROL, + NULL, 0, + universal_callback, transfer); + break; + case USB_DIRECTION_OUT: + hc_add_transaction_from_device(ctrl_transfer->target, + USB_TRANSFER_CONTROL, + NULL, 0, + universal_callback, transfer); + break; + default: + assert(false && "unreachable"); + break; + } + + free(ctrl_transfer); +} + +static void control_callback_one(void *buffer, size_t size, + int outcome, void *arg) +{ + control_transfer_info_t *transfer = (control_transfer_info_t *) arg; + + if (outcome != EOK) { + control_abort_prematurely(transfer, outcome, size); + free(transfer); + return; + } + + switch (transfer->direction) { + case USB_DIRECTION_IN: + hc_add_transaction_from_device(transfer->target, + USB_TRANSFER_CONTROL, + transfer->data_buffer, transfer->data_buffer_size, + control_callback_two, transfer); + break; + case USB_DIRECTION_OUT: + hc_add_transaction_to_device(false, transfer->target, + USB_TRANSFER_CONTROL, + transfer->data_buffer, transfer->data_buffer_size, + control_callback_two, transfer); + break; + default: + assert(false && "unreachable"); + break; + } +} + +static control_transfer_info_t *create_control_transfer_info(ddf_fun_t *fun, + usb_direction_t direction, usb_target_t target, + void *data_buffer, size_t data_buffer_size, + void *arg) +{ + control_transfer_info_t *transfer + = malloc(sizeof(control_transfer_info_t)); + + transfer->direction = direction; + transfer->target = target; + transfer->in_callback = NULL; + transfer->out_callback = NULL; + transfer->arg = arg; + transfer->fun = fun; + transfer->data_buffer = data_buffer; + transfer->data_buffer_size = data_buffer_size; + + return transfer; +} + +static int enqueue_transfer_out(ddf_fun_t *fun, + usb_target_t target, usb_transfer_type_t transfer_type, + void *buffer, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + usb_log_debug2("Transfer OUT [%d.%d (%s); %zu].\n", + target.address, target.endpoint, + usb_str_transfer_type(transfer_type), + size); + + transfer_info_t *transfer + = create_transfer_info(fun, USB_DIRECTION_OUT, arg); + transfer->out_callback = callback; + + hc_add_transaction_to_device(false, target, transfer_type, buffer, size, + universal_callback, transfer); + + return EOK; +} + +static int enqueue_transfer_in(ddf_fun_t *fun, + usb_target_t target, usb_transfer_type_t transfer_type, + void *buffer, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + usb_log_debug2("Transfer IN [%d.%d (%s); %zu].\n", + target.address, target.endpoint, + usb_str_transfer_type(transfer_type), + size); + + transfer_info_t *transfer + = create_transfer_info(fun, USB_DIRECTION_IN, arg); + transfer->in_callback = callback; + + hc_add_transaction_from_device(target, transfer_type, buffer, size, + universal_callback, transfer); + + return EOK; +} + + +static int interrupt_out(ddf_fun_t *fun, usb_target_t target, + size_t max_packet_size, + void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + return enqueue_transfer_out(fun, target, USB_TRANSFER_INTERRUPT, + data, size, + callback, arg); +} + +static int interrupt_in(ddf_fun_t *fun, usb_target_t target, + size_t max_packet_size, + void *data, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + return enqueue_transfer_in(fun, target, USB_TRANSFER_INTERRUPT, + data, size, + callback, arg); +} + +static int control_write(ddf_fun_t *fun, usb_target_t target, + size_t max_packet_size, + void *setup_packet, size_t setup_packet_size, + void *data, size_t data_size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + control_transfer_info_t *transfer + = create_control_transfer_info(fun, USB_DIRECTION_OUT, target, + data, data_size, arg); + transfer->out_callback = callback; + + hc_add_transaction_to_device(true, target, USB_TRANSFER_CONTROL, + setup_packet, setup_packet_size, + control_callback_one, transfer); + + return EOK; +} + +static int control_read(ddf_fun_t *fun, usb_target_t target, + size_t max_packet_size, + void *setup_packet, size_t setup_packet_size, + void *data, size_t data_size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + control_transfer_info_t *transfer + = create_control_transfer_info(fun, USB_DIRECTION_IN, target, + data, data_size, arg); + transfer->in_callback = callback; + + hc_add_transaction_to_device(true, target, USB_TRANSFER_CONTROL, + setup_packet, setup_packet_size, + control_callback_one, transfer); + + return EOK; +} + +static usb_address_keeping_t addresses; + +static int tell_address(ddf_fun_t *fun, devman_handle_t handle, + usb_address_t *address) +{ + usb_log_debug("tell_address(fun \"%s\", handle %zu)\n", + fun->name, (size_t) fun->handle); + usb_address_t addr = usb_address_keeping_find(&addresses, handle); + if (addr < 0) { + return addr; + } + + *address = addr; + return EOK; +} + +static int reserve_default_address(ddf_fun_t *fun, usb_speed_t ignored) +{ + usb_address_keeping_reserve_default(&addresses); + return EOK; +} + +static int release_default_address(ddf_fun_t *fun) +{ + usb_address_keeping_release_default(&addresses); + return EOK; +} + +static int request_address(ddf_fun_t *fun, usb_speed_t ignored, + usb_address_t *address) +{ + usb_address_t addr = usb_address_keeping_request(&addresses); + if (addr < 0) { + return (int)addr; + } + + *address = addr; + return EOK; +} + +static int release_address(ddf_fun_t *fun, usb_address_t address) +{ + return usb_address_keeping_release(&addresses, address); +} + +static int bind_address(ddf_fun_t *fun, usb_address_t address, + devman_handle_t handle) +{ + usb_address_keeping_devman_bind(&addresses, address, handle); + return EOK; +} + +static int usb_iface_get_hc_handle_rh_impl(ddf_fun_t *root_hub_fun, + devman_handle_t *handle) +{ + ddf_fun_t *hc_fun = root_hub_fun->driver_data; + assert(hc_fun != NULL); + + *handle = hc_fun->handle; + + usb_log_debug("usb_iface_get_hc_handle_rh_impl returns %zu\n", *handle); + + return EOK; +} + +static int tell_address_rh(ddf_fun_t *root_hub_fun, devman_handle_t handle, + usb_address_t *address) +{ + ddf_fun_t *hc_fun = root_hub_fun->driver_data; + assert(hc_fun != NULL); + + return tell_address(hc_fun, root_hub_fun->handle, address); +} + +void address_init(void) +{ + usb_address_keeping_init(&addresses, 50); +} + +usbhc_iface_t vhc_iface = { + .reserve_default_address = reserve_default_address, + .release_default_address = release_default_address, + .request_address = request_address, + .bind_address = bind_address, + .release_address = release_address, + + .interrupt_out = interrupt_out, + .interrupt_in = interrupt_in, + + .control_write = control_write, + .control_read = control_read +}; + +usb_iface_t vhc_usb_iface = { + .get_hc_handle = usb_iface_get_hc_handle_hc_impl, + .get_address = tell_address +}; + +usb_iface_t rh_usb_iface = { + .get_hc_handle = usb_iface_get_hc_handle_rh_impl, + .get_address = tell_address_rh +}; + + +/** + * @} + */ Index: uspace/drv/vhc/devices.c =================================================================== --- uspace/drv/vhc/devices.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/devices.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,235 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Virtual device management (implementation). + */ + +#include +#include +#include +#include +#include +#include +#include + +#include + +#include "devices.h" +#include "hub.h" +#include "hub/virthub.h" +#include "vhcd.h" + +#define list_foreach(pos, head) \ + for (pos = (head)->next; pos != (head); \ + pos = pos->next) + +static LIST_INITIALIZE(devices); + +/** Create virtual device. + * + * @param phone Callback phone. + * @param id Device id. + * @return New device. + * @retval NULL Out of memory. + */ +virtdev_connection_t *virtdev_add_device(int phone, sysarg_t id) +{ + virtdev_connection_t *dev = (virtdev_connection_t *) + malloc(sizeof(virtdev_connection_t)); + if (dev == NULL) { + return NULL; + } + + dev->phone = phone; + dev->id = id; + list_append(&dev->link, &devices); + + virthub_connect_device(&virtual_hub_device, dev); + + return dev; +} + +/** Find virtual device by id. + * + * @param id Device id. + * @return Device with given id. + * @retval NULL No such device. + */ +virtdev_connection_t *virtdev_find(sysarg_t id) +{ + link_t *pos; + list_foreach(pos, &devices) { + virtdev_connection_t *dev + = list_get_instance(pos, virtdev_connection_t, link); + if (dev->id == id) { + return dev; + } + } + + return NULL; +} + +/** Destroy virtual device. + */ +void virtdev_destroy_device(virtdev_connection_t *dev) +{ + virthub_disconnect_device(&virtual_hub_device, dev); + list_remove(&dev->link); + free(dev); +} + +/** Send data to all connected devices. + * + * @param transaction Transaction to be sent over the bus. + */ +int virtdev_send_to_all(transaction_t *transaction) +{ + /* For easier debugging. */ + switch (transaction->type) { + case USBVIRT_TRANSACTION_SETUP: + case USBVIRT_TRANSACTION_OUT: + transaction->actual_len = transaction->len; + break; + case USBVIRT_TRANSACTION_IN: + transaction->actual_len = 0; + break; + default: + assert(false && "unreachable branch in switch()"); + } + int outcome = EBADCHECKSUM; + + link_t *pos; + list_foreach(pos, &devices) { + virtdev_connection_t *dev + = list_get_instance(pos, virtdev_connection_t, link); + + if (!virthub_is_device_enabled(&virtual_hub_device, dev)) { + continue; + } + + ipc_call_t answer_data; + sysarg_t answer_rc; + aid_t req; + int rc = EOK; + int method = IPC_M_USBVIRT_TRANSACTION_SETUP; + + switch (transaction->type) { + case USBVIRT_TRANSACTION_SETUP: + method = IPC_M_USBVIRT_TRANSACTION_SETUP; + break; + case USBVIRT_TRANSACTION_IN: + method = IPC_M_USBVIRT_TRANSACTION_IN; + break; + case USBVIRT_TRANSACTION_OUT: + method = IPC_M_USBVIRT_TRANSACTION_OUT; + break; + } + + req = async_send_3(dev->phone, + method, + transaction->target.address, + transaction->target.endpoint, + transaction->len, + &answer_data); + + if (transaction->len > 0) { + if (transaction->type == USBVIRT_TRANSACTION_IN) { + rc = async_data_read_start(dev->phone, + transaction->buffer, transaction->len); + } else { + rc = async_data_write_start(dev->phone, + transaction->buffer, transaction->len); + } + } + + if (rc != EOK) { + async_wait_for(req, NULL); + } else { + async_wait_for(req, &answer_rc); + transaction->actual_len = IPC_GET_ARG1(answer_data); + rc = (int)answer_rc; + } + + /* + * If at least one device was able to accept this + * transaction and process it, we can announce success. + */ + if (rc == EOK) { + outcome = EOK; + } + } + + /* + * Send the data to the virtual hub as well + * (if the address matches). + */ + if (virtual_hub_device.address == transaction->target.address) { + size_t tmp; + usb_log_debug2("Sending `%s' transaction to hub.\n", + usbvirt_str_transaction_type(transaction->type)); + switch (transaction->type) { + case USBVIRT_TRANSACTION_SETUP: + virtual_hub_device.transaction_setup( + &virtual_hub_device, + transaction->target.endpoint, + transaction->buffer, transaction->len); + break; + + case USBVIRT_TRANSACTION_IN: + virtual_hub_device.transaction_in( + &virtual_hub_device, + transaction->target.endpoint, + transaction->buffer, transaction->len, + &tmp); + transaction->actual_len = tmp; + break; + + case USBVIRT_TRANSACTION_OUT: + virtual_hub_device.transaction_out( + &virtual_hub_device, + transaction->target.endpoint, + transaction->buffer, transaction->len); + break; + } + outcome = EOK; + } + + /* + * TODO: maybe screw some transactions to get more + * real-life image. + */ + return outcome; +} + +/** + * @} + */ Index: uspace/drv/vhc/devices.h =================================================================== --- uspace/drv/vhc/devices.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/devices.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,61 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Virtual device management. + */ +#ifndef VHCD_DEVICES_H_ +#define VHCD_DEVICES_H_ + +#include +#include + +#include "hc.h" + +/** Connected virtual device. */ +typedef struct { + /** Phone used when sending data to device. */ + int phone; + /** Unique identification. */ + sysarg_t id; + /** Linked-list handle. */ + link_t link; +} virtdev_connection_t; + +virtdev_connection_t *virtdev_add_device(int, sysarg_t); +virtdev_connection_t *virtdev_find(sysarg_t); +void virtdev_destroy_device(virtdev_connection_t *); +int virtdev_send_to_all(transaction_t *); + +#endif +/** + * @} + */ Index: uspace/drv/vhc/hc.c =================================================================== --- uspace/drv/vhc/hc.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/hc.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,209 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Virtual HC (implementation). + */ + +#include +#include +#include +#include +#include +#include +#include + +#include + +#include "vhcd.h" +#include "hc.h" +#include "devices.h" +#include "hub.h" + +#define USLEEP_BASE (0 * 5 * 1000) + +#define USLEEP_VAR 50 + +#define SHORTENING_VAR 15 + +#define PROB_OUTCOME_BABBLE 5 +#define PROB_OUTCOME_CRCERROR 7 + +#define PROB_TEST(var, new_value, prob, number) \ + do { \ + if (((number) % (prob)) == 0) { \ + var = (new_value); \ + } \ + } while (0) + +static link_t transaction_list; + +#define TRANSACTION_FORMAT "T[%d.%d %s/%s (%d)]" +#define TRANSACTION_PRINTF(t) \ + (t).target.address, (t).target.endpoint, \ + usb_str_transfer_type((t).transfer_type), \ + usbvirt_str_transaction_type((t).type), \ + (int)(t).len + +#define transaction_get_instance(lnk) \ + list_get_instance(lnk, transaction_t, link) + +#define HUB_STATUS_MAX_LEN (HUB_PORT_COUNT + 64) + +static inline unsigned int pseudo_random(unsigned int *seed) +{ + *seed = ((*seed) * 873511) % 22348977 + 7; + return ((*seed) >> 8); +} + +/** Call transaction callback. + * Calling this callback informs the backend that transaction was processed. + */ +static void process_transaction_with_outcome(transaction_t * transaction, + int outcome) +{ + usb_log_debug2("Transaction " TRANSACTION_FORMAT " done: %s.\n", + TRANSACTION_PRINTF(*transaction), + str_error(outcome)); + + transaction->callback(transaction->buffer, transaction->actual_len, + outcome, transaction->callback_arg); +} + +/** Host controller manager main function. + */ +static int hc_manager_fibril(void *arg) +{ + list_initialize(&transaction_list); + + static unsigned int seed = 4573; + + usb_log_info("Transaction processor ready.\n"); + + while (true) { + async_usleep(USLEEP_BASE + (pseudo_random(&seed) % USLEEP_VAR)); + + if (list_empty(&transaction_list)) { + continue; + } + + char ports[HUB_STATUS_MAX_LEN + 1]; + virthub_get_status(&virtual_hub_device, ports, HUB_STATUS_MAX_LEN); + + link_t *first_transaction_link = transaction_list.next; + transaction_t *transaction + = transaction_get_instance(first_transaction_link); + list_remove(first_transaction_link); + + usb_log_debug("Processing " TRANSACTION_FORMAT " [%s].\n", + TRANSACTION_PRINTF(*transaction), ports); + + int outcome; + outcome = virtdev_send_to_all(transaction); + + process_transaction_with_outcome(transaction, outcome); + + free(transaction); + } + + assert(false && "unreachable"); + return EOK; +} + +void hc_manager(void) +{ + fid_t fid = fibril_create(hc_manager_fibril, NULL); + if (fid == 0) { + usb_log_fatal("Failed to start HC manager fibril.\n"); + return; + } + fibril_add_ready(fid); +} + +/** Create new transaction + */ +static transaction_t *transaction_create(usbvirt_transaction_type_t type, + usb_target_t target, usb_transfer_type_t transfer_type, + void * buffer, size_t len, + hc_transaction_done_callback_t callback, void * arg) +{ + transaction_t * transaction = malloc(sizeof(transaction_t)); + + list_initialize(&transaction->link); + transaction->type = type; + transaction->transfer_type = transfer_type; + transaction->target = target; + transaction->buffer = buffer; + transaction->len = len; + transaction->actual_len = len; + transaction->callback = callback; + transaction->callback_arg = arg; + + return transaction; +} + +static void hc_add_transaction(transaction_t *transaction) +{ + usb_log_debug("Adding transaction " TRANSACTION_FORMAT ".\n", + TRANSACTION_PRINTF(*transaction)); + list_append(&transaction->link, &transaction_list); +} + +/** Add transaction directioned towards the device. + */ +void hc_add_transaction_to_device(bool setup, usb_target_t target, + usb_transfer_type_t transfer_type, + void * buffer, size_t len, + hc_transaction_done_callback_t callback, void * arg) +{ + transaction_t *transaction = transaction_create( + setup ? USBVIRT_TRANSACTION_SETUP : USBVIRT_TRANSACTION_OUT, + target, transfer_type, + buffer, len, callback, arg); + hc_add_transaction(transaction); +} + +/** Add transaction directioned from the device. + */ +void hc_add_transaction_from_device(usb_target_t target, + usb_transfer_type_t transfer_type, + void * buffer, size_t len, + hc_transaction_done_callback_t callback, void * arg) +{ + transaction_t *transaction = transaction_create(USBVIRT_TRANSACTION_IN, + target, transfer_type, + buffer, len, callback, arg); + hc_add_transaction(transaction); +} + +/** + * @} + */ Index: uspace/drv/vhc/hc.h =================================================================== --- uspace/drv/vhc/hc.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/hc.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,91 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Virtual HC. + */ +#ifndef VHCD_HC_H_ +#define VHCD_HC_H_ + +#include +#include + +/** Callback after transaction is sent to USB. + * + * @param buffer Transaction data buffer. + * @param size Transaction data size. + * @param outcome Transaction outcome. + * @param arg Custom argument. + */ +typedef void (*hc_transaction_done_callback_t)(void *buffer, size_t size, + int outcome, void *arg); + +/** Pending transaction details. */ +typedef struct { + /** Linked-list link. */ + link_t link; + /** Transaction type. */ + usbvirt_transaction_type_t type; + /** Transfer type. */ + usb_transfer_type_t transfer_type; + /** Device address. */ + usb_target_t target; + /** Direction of the transaction. */ + usb_direction_t direction; + /** Transaction data buffer. */ + void * buffer; + /** Transaction data length. */ + size_t len; + /** Data length actually transfered. */ + size_t actual_len; + /** Callback after transaction is done. */ + hc_transaction_done_callback_t callback; + /** Argument to the callback. */ + void * callback_arg; +} transaction_t; + +void hc_manager(void); + +void hc_add_transaction_to_device(bool setup, + usb_target_t target, usb_transfer_type_t transfer_type, + void * buffer, size_t len, + hc_transaction_done_callback_t callback, void * arg); + +void hc_add_transaction_from_device( + usb_target_t target, usb_transfer_type_t transfer_type, + void * buffer, size_t len, + hc_transaction_done_callback_t callback, void * arg); + + +#endif +/** + * @} + */ Index: uspace/drv/vhc/hcd.c =================================================================== --- uspace/drv/vhc/hcd.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/hcd.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,147 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Virtual host controller driver. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include "vhcd.h" +#include "hc.h" +#include "devices.h" +#include "hub.h" +#include "conn.h" + +static ddf_dev_ops_t vhc_ops = { + .interfaces[USBHC_DEV_IFACE] = &vhc_iface, + .interfaces[USB_DEV_IFACE] = &vhc_usb_iface, + .close = on_client_close, + .default_handler = default_connection_handler +}; + +static int vhc_add_device(ddf_dev_t *dev) +{ + static int vhc_count = 0; + int rc; + + /* + * Currently, we know how to simulate only single HC. + */ + if (vhc_count > 0) { + return ELIMIT; + } + + /* + * Create exposed function representing the host controller + * itself. + */ + ddf_fun_t *hc = ddf_fun_create(dev, fun_exposed, "hc"); + if (hc == NULL) { + usb_log_fatal("Failed to create device function.\n"); + return ENOMEM; + } + + hc->ops = &vhc_ops; + + rc = ddf_fun_bind(hc); + if (rc != EOK) { + usb_log_fatal("Failed to bind HC function: %s.\n", + str_error(rc)); + return rc; + } + + ddf_fun_add_to_class(hc, "usbhc"); + + /* + * Initialize our hub and announce its presence. + */ + virtual_hub_device_init(hc); + + usb_log_info("Virtual USB host controller ready (dev %zu, hc %zu).\n", + (size_t) dev->handle, (size_t) hc->handle); + + return EOK; +} + +static driver_ops_t vhc_driver_ops = { + .add_device = vhc_add_device, +}; + +static driver_t vhc_driver = { + .name = NAME, + .driver_ops = &vhc_driver_ops +}; + + +int main(int argc, char * argv[]) +{ + /* + * Temporary workaround. Wait a little bit to be the last driver + * in devman output. + */ + //sleep(5); + + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + + printf(NAME ": virtual USB host controller driver.\n"); + + /* + * Initialize address management. + */ + address_init(); + + /* + * Run the transfer scheduler. + */ + hc_manager(); + + /* + * We are also a driver within devman framework. + */ + return ddf_driver_main(&vhc_driver); +} + + +/** + * @} + */ Index: uspace/drv/vhc/hub.c =================================================================== --- uspace/drv/vhc/hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,131 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Virtual USB hub. + */ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "hub.h" +#include "hub/virthub.h" +#include "vhcd.h" +#include "conn.h" + +usbvirt_device_t virtual_hub_device; +static ddf_dev_ops_t rh_ops = { + .interfaces[USB_DEV_IFACE] = &rh_usb_iface, +}; + +static int hub_register_in_devman_fibril(void *arg); + +void virtual_hub_device_init(ddf_fun_t *hc_dev) +{ + virthub_init(&virtual_hub_device); + + /* + * We need to register the root hub. + * This must be done in separate fibril because the device + * we are connecting to are ourselves and we cannot connect + * before leaving the add_device() function. + */ + fid_t root_hub_registration + = fibril_create(hub_register_in_devman_fibril, hc_dev); + if (root_hub_registration == 0) { + usb_log_fatal("Failed to create hub registration fibril.\n"); + return; + } + + fibril_add_ready(root_hub_registration); +} + +static int pretend_port_rest(int unused, void *unused2) +{ + return EOK; +} + +/** Register root hub in devman. + * + * @param arg Host controller device (type device_t *). + * @return Error code. + */ +int hub_register_in_devman_fibril(void *arg) +{ + ddf_fun_t *hc_dev = (ddf_fun_t *) arg; + + /* + * Wait until parent device is properly initialized. + */ + int phone; + do { + phone = devman_device_connect(hc_dev->handle, 0); + } while (phone < 0); + async_hangup(phone); + + int rc; + + usb_hc_connection_t hc_conn; + rc = usb_hc_connection_initialize(&hc_conn, hc_dev->handle); + assert(rc == EOK); + + rc = usb_hc_connection_open(&hc_conn); + assert(rc == EOK); + + ddf_fun_t *hub_dev; + rc = usb_hc_new_device_wrapper(hc_dev->dev, &hc_conn, + USB_SPEED_FULL, + pretend_port_rest, 0, NULL, + NULL, NULL, &rh_ops, hc_dev, &hub_dev); + if (rc != EOK) { + usb_log_fatal("Failed to create root hub: %s.\n", + str_error(rc)); + } + + usb_hc_connection_close(&hc_conn); + + usb_log_info("Created root hub function (handle %zu).\n", + (size_t) hub_dev->handle); + + return 0; +} + + +/** + * @} + */ Index: uspace/drv/vhc/hub.h =================================================================== --- uspace/drv/vhc/hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,52 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Virtual USB hub. + */ +#ifndef VHCD_HUB_H_ +#define VHCD_HUB_H_ + +#include +#include + +#include "devices.h" +#include "hub/hub.h" +#include "hub/virthub.h" + +extern usbvirt_device_t virtual_hub_device; + +void virtual_hub_device_init(ddf_fun_t *); + +#endif +/** + * @} + */ Index: uspace/drv/vhc/hub/hub.c =================================================================== --- uspace/drv/vhc/hub/hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/hub/hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,511 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Representation of an USB hub (implementation). + */ +#include +#include +#include +#include +#include +#include +#include +#include + +#include "hub.h" + + +/** Produce a byte from bit values. + */ +#define MAKE_BYTE(b0, b1, b2, b3, b4, b5, b6, b7) \ + (( \ + ((b0) << 0) \ + | ((b1) << 1) \ + | ((b2) << 2) \ + | ((b3) << 3) \ + | ((b4) << 4) \ + | ((b5) << 5) \ + | ((b6) << 6) \ + | ((b7) << 7) \ + )) + +/* Static functions. */ +static hub_port_t *get_hub_port(hub_t *, size_t); +static void set_port_status_change(hub_port_t *, hub_status_change_t); +static void clear_port_status_change(hub_port_t *, uint16_t); +static int set_port_state_delayed_fibril(void *); +static void set_port_state_delayed(hub_t *, size_t, suseconds_t, + hub_port_state_t, hub_port_state_t); + +/** Convert hub port state to a char. */ +char hub_port_state_to_char(hub_port_state_t state) { + switch (state) { + case HUB_PORT_STATE_NOT_CONFIGURED: + return '-'; + case HUB_PORT_STATE_POWERED_OFF: + return 'O'; + case HUB_PORT_STATE_DISCONNECTED: + return 'X'; + case HUB_PORT_STATE_DISABLED: + return 'D'; + case HUB_PORT_STATE_RESETTING: + return 'R'; + case HUB_PORT_STATE_ENABLED: + return 'E'; + case HUB_PORT_STATE_SUSPENDED: + return 'S'; + case HUB_PORT_STATE_RESUMING: + return 'F'; + default: + return '?'; + } +} + +/** Initialize single hub port. + * + * @param port Port to be initialized. + * @param index Port index (one based). + */ +static void hub_init_port(hub_port_t *port, size_t index) +{ + port->connected_device = NULL; + port->index = index; + port->state = HUB_PORT_STATE_NOT_CONFIGURED; + port->status_change = 0; +} + +/** Initialize the hub. + * + * @param hub Hub to be initialized. + */ +void hub_init(hub_t *hub) +{ + size_t i; + for (i = 0; i < HUB_PORT_COUNT; i++) { + hub_init_port(&hub->ports[i], i + 1); + } + hub->custom_data = NULL; + fibril_mutex_initialize(&hub->guard); +} + +/** Connect a device to the hub. + * + * @param hub Hub to connect device to. + * @param device Device to be connected. + * @return Index of port the device was connected to. + * @retval -1 No free port available. + */ +size_t hub_connect_device(hub_t *hub, void *device) +{ + size_t i; + for (i = 0; i < HUB_PORT_COUNT; i++) { + hub_port_t *port = &hub->ports[i]; + + if (port->connected_device != NULL) { + continue; + } + + port->connected_device = device; + + /* + * TODO: + * If the hub was configured, we can normally + * announce the plug-in. + * Otherwise, we will wait until hub is configured + * and announce changes in single burst. + */ + //if (port->state == HUB_PORT_STATE_DISCONNECTED) { + port->state = HUB_PORT_STATE_DISABLED; + set_port_status_change(port, HUB_STATUS_C_PORT_CONNECTION); + //} + + return i; + } + + return (size_t) -1; +} + +/** Disconnects a device from a hub. + * + * @param hub Hub the device was connected to. + * @param device Device to be disconnected. + * @return Error code. + */ +int hub_disconnect_device(hub_t *hub, void *device) +{ + size_t index = hub_find_device(hub, device); + if (index == (size_t) -1) { + return ENOENT; + } + + hub_port_t *port = &hub->ports[index]; + + port->connected_device = NULL; + port->state = HUB_PORT_STATE_DISCONNECTED; + set_port_status_change(port, HUB_STATUS_C_PORT_CONNECTION); + + return EOK; +} + +/** Find port device is connected to. + * + * @param hub Hub in question. + * @param device Device in question. + * @return Port index (zero based). + * @retval -1 Device is not connected. + */ +size_t hub_find_device(hub_t *hub, void *device) +{ + size_t i; + for (i = 0; i < HUB_PORT_COUNT; i++) { + hub_port_t *port = &hub->ports[i]; + + if (port->connected_device == device) { + return i; + } + } + + return -1; +} + +/** Acquire exclusive access to the hub. + * + * @param hub Hub in question. + */ +void hub_acquire(hub_t *hub) +{ + fibril_mutex_lock(&hub->guard); +} + +/** Give up exclusive access to the hub. + * + * @param hub Hub in question. + */ +void hub_release(hub_t *hub) +{ + fibril_mutex_unlock(&hub->guard); +} + +/** Change port state. + * + * @param hub Hub the port belongs to. + * @param port_index Port index (zero based). + * @param state New port state. + */ +void hub_set_port_state(hub_t *hub, size_t port_index, hub_port_state_t state) +{ + hub_port_t *port = get_hub_port(hub, port_index); + if (port == NULL) { + return; + } + + switch (state) { + case HUB_PORT_STATE_POWERED_OFF: + clear_port_status_change(port, HUB_STATUS_C_PORT_CONNECTION); + clear_port_status_change(port, HUB_STATUS_C_PORT_ENABLE); + clear_port_status_change(port, HUB_STATUS_C_PORT_RESET); + break; + case HUB_PORT_STATE_RESUMING: + set_port_state_delayed(hub, port_index, + 10, state, HUB_PORT_STATE_ENABLED); + break; + case HUB_PORT_STATE_RESETTING: + set_port_state_delayed(hub, port_index, + 10, state, HUB_PORT_STATE_ENABLED); + break; + case HUB_PORT_STATE_ENABLED: + if (port->state == HUB_PORT_STATE_RESETTING) { + set_port_status_change(port, HUB_STATUS_C_PORT_RESET); + } + break; + default: + break; + } + + port->state = state; +} + +/** Change state of all ports. + * + * @param hub Hub in question. + * @param state New state for all ports. + */ +void hub_set_port_state_all(hub_t *hub, hub_port_state_t state) +{ + size_t i; + for (i = 0; i < HUB_PORT_COUNT; i++) { + hub_set_port_state(hub, i, state); + } +} + +/** Get port state. + * + * @param hub Hub the port belongs to. + * @param port_index Port index (zero based). + * @return Port state. + */ +hub_port_state_t hub_get_port_state(hub_t *hub, size_t port_index) +{ + hub_port_t *port = get_hub_port(hub, port_index); + if (port == NULL) { + return HUB_PORT_STATE_UNKNOWN; + } + + return port->state; +} + +/** Clear port status change bit. + * + * @param hub Hub the port belongs to. + * @param port_index Port index (zero based). + * @param change Change to be cleared. + */ +void hub_clear_port_status_change(hub_t *hub, size_t port_index, + hub_status_change_t change) +{ + hub_port_t *port = get_hub_port(hub, port_index); + if (port == NULL) { + return; + } + + clear_port_status_change(port, change); +} + +/** Get port status change bits. + * + * @param hub Hub the port belongs to. + * @param port_index Port index (zero based). + * @return Port status change bitmap in standard format. + */ +uint16_t hub_get_port_status_change(hub_t *hub, size_t port_index) +{ + hub_port_t *port = get_hub_port(hub, port_index); + if (port == NULL) { + return 0; + } + + return port->status_change; +} + +/** Get port status bits. + * + * @param hub Hub the port belongs to. + * @param port_index Port index (zero based). + * @return Port status bitmap in standard format. + */ +uint32_t hub_get_port_status(hub_t *hub, size_t port_index) +{ + hub_port_t *port = get_hub_port(hub, port_index); + if (port == NULL) { + return 0; + } + + uint32_t status; + status = MAKE_BYTE( + /* Current connect status. */ + port->connected_device == NULL ? 0 : 1, + /* Port enabled/disabled. */ + port->state == HUB_PORT_STATE_ENABLED ? 1 : 0, + /* Suspend. */ + (port->state == HUB_PORT_STATE_SUSPENDED) + || (port->state == HUB_PORT_STATE_RESUMING) ? 1 : 0, + /* Over-current. */ + 0, + /* Reset. */ + port->state == HUB_PORT_STATE_RESETTING ? 1 : 0, + /* Reserved. */ + 0, 0, 0) + + | (MAKE_BYTE( + /* Port power. */ + port->state == HUB_PORT_STATE_POWERED_OFF ? 0 : 1, + /* Full-speed device. */ + 0, + /* Reserved. */ + 0, 0, 0, 0, 0, 0 + )) << 8; + + status |= (port->status_change << 16); + + return status; +} + +/** Create hub status change bitmap. + * + * @warning This function assumes that the whole bitmap fits into 8 bits. + * + * @param hub Hub in question. + * @return Hub status change bitmap. + */ +uint8_t hub_get_status_change_bitmap(hub_t *hub) +{ + uint8_t change_map = 0; + + size_t i; + for (i = 0; i < HUB_PORT_COUNT; i++) { + hub_port_t *port = &hub->ports[i]; + + if (port->status_change != 0) { + change_map |= (1 << port->index); + } + } + + return change_map; +} + + +/* + * + * STATIC (HELPER) FUNCTIONS + * + */ + +/** Find a port in a hub. + * + * @param hub Hub in question. + * @param port Port index (zero based). + * @return Port structure. + * @retval NULL Invalid port index. + */ +static hub_port_t *get_hub_port(hub_t *hub, size_t port) +{ + if (port >= HUB_PORT_COUNT) { + return NULL; + } + + return &hub->ports[port]; +} + +/** Adds a port status change to a port. + * + * @param port The port with status change. + * @param change Change to be added to the status. + */ +static void set_port_status_change(hub_port_t *port, + hub_status_change_t change) +{ + assert(port != NULL); + port->status_change |= change; +} + +/** Clears a port status change on a port. + * + * @param port The port with status change. + * @param change Change to be removed from the status. + */ +static void clear_port_status_change(hub_port_t *port, + uint16_t change) +{ + assert(port != NULL); + port->status_change &= (~change); +} + +/** Structure for automatic (delayed) port state change. */ +struct delay_port_state_change { + /** Delay in microseconds. */ + suseconds_t delay; + /** Old state of the port. */ + hub_port_state_t old_state; + /** New state of the port. */ + hub_port_state_t new_state; + /** Port index (zero based). */ + size_t port; + /** Hub. */ + hub_t *hub; +}; + +/** Fibril responsible for delayed port state change. + * + * @param arg Pointer to delay_port_state_change. + * @return Always EOK. + */ +static int set_port_state_delayed_fibril(void *arg) +{ + struct delay_port_state_change *change + = (struct delay_port_state_change *) arg; + + async_usleep(change->delay); + + hub_acquire(change->hub); + + hub_port_t *port = get_hub_port(change->hub, change->port); + assert(port != NULL); + + if (port->state == change->old_state) { + hub_set_port_state(change->hub, change->port, + change->new_state); + } + + hub_release(change->hub); + + free(change); + + return EOK; +} + +/** Change port state with a delay. + * + * @warning If the port state changes during the waiting phase, the state + * is not changed. + * + * @param hub Hub in question. + * @param port_index Port index (zero based). + * @param delay_time_ms Delay time in miliseconds. + * @param old_state Old (current) state of the port. + * @param new_state New state of the port. + */ +static void set_port_state_delayed(hub_t *hub, size_t port_index, + suseconds_t delay_time_ms, + hub_port_state_t old_state, hub_port_state_t new_state) +{ + struct delay_port_state_change *change + = malloc(sizeof(struct delay_port_state_change)); + + change->hub = hub; + change->port = port_index; + change->delay = delay_time_ms * 1000; + change->old_state = old_state; + change->new_state = new_state; + fid_t fibril = fibril_create(set_port_state_delayed_fibril, change); + if (fibril == 0) { + printf("Failed to create fibril\n"); + free(change); + return; + } + fibril_add_ready(fibril); +} + + + +/** + * @} + */ Index: uspace/drv/vhc/hub/hub.h =================================================================== --- uspace/drv/vhc/hub/hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/hub/hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,114 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Representation of an USB hub. + */ +#ifndef VHC_HUB_HUB_H_ +#define VHC_HUB_HUB_H_ + +#include + +#ifndef HUB_PORT_COUNT +#define HUB_PORT_COUNT 2 +#endif +#define BITS2BYTES(bits) (bits ? ((((bits)-1)>>3)+1) : 0) + +/** Hub port internal state. + * Some states (e.g. port over current) are not covered as they are not + * simulated at all. + */ +typedef enum { + HUB_PORT_STATE_UNKNOWN, + HUB_PORT_STATE_NOT_CONFIGURED, + HUB_PORT_STATE_POWERED_OFF, + HUB_PORT_STATE_DISCONNECTED, + HUB_PORT_STATE_DISABLED, + HUB_PORT_STATE_RESETTING, + HUB_PORT_STATE_ENABLED, + HUB_PORT_STATE_SUSPENDED, + HUB_PORT_STATE_RESUMING, + /* HUB_PORT_STATE_, */ +} hub_port_state_t; + +char hub_port_state_to_char(hub_port_state_t); + +/** Hub status change mask bits. */ +typedef enum { + HUB_STATUS_C_PORT_CONNECTION = (1 << 0), + HUB_STATUS_C_PORT_ENABLE = (1 << 1), + HUB_STATUS_C_PORT_SUSPEND = (1 << 2), + HUB_STATUS_C_PORT_OVER_CURRENT = (1 << 3), + HUB_STATUS_C_PORT_RESET = (1 << 4), + /* HUB_STATUS_C_ = (1 << ), */ +} hub_status_change_t; + +/** Hub port information. */ +typedef struct { + /** Custom pointer to connected device. */ + void *connected_device; + /** Port index (one based). */ + size_t index; + /** Port state. */ + hub_port_state_t state; + /** Status change bitmap. */ + uint16_t status_change; +} hub_port_t; + +/** Hub device type. */ +typedef struct { + /** Hub ports. */ + hub_port_t ports[HUB_PORT_COUNT]; + /** Custom hub data. */ + void *custom_data; + /** Access guard to the whole hub. */ + fibril_mutex_t guard; +} hub_t; + +void hub_init(hub_t *); +size_t hub_connect_device(hub_t *, void *); +int hub_disconnect_device(hub_t *, void *); +size_t hub_find_device(hub_t *, void *); +void hub_acquire(hub_t *); +void hub_release(hub_t *); +void hub_set_port_state(hub_t *, size_t, hub_port_state_t); +void hub_set_port_state_all(hub_t *, hub_port_state_t); +hub_port_state_t hub_get_port_state(hub_t *, size_t); +void hub_clear_port_status_change(hub_t *, size_t, hub_status_change_t); +uint16_t hub_get_port_status_change(hub_t *, size_t); +uint32_t hub_get_port_status(hub_t *, size_t); +uint8_t hub_get_status_change_bitmap(hub_t *); + + +#endif +/** + * @} + */ Index: uspace/drv/vhc/hub/virthub.c =================================================================== --- uspace/drv/vhc/hub/virthub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/hub/virthub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,271 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief + */ +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "virthub.h" +#include "hub.h" + + +/** Standard device descriptor. */ +usb_standard_device_descriptor_t std_device_descriptor = { + .length = sizeof(usb_standard_device_descriptor_t), + .descriptor_type = USB_DESCTYPE_DEVICE, + .usb_spec_version = 0x110, + .device_class = USB_CLASS_HUB, + .device_subclass = 0, + .device_protocol = 0, + .max_packet_size = 64, + .configuration_count = 1 +}; + +/** Standard interface descriptor. */ +usb_standard_interface_descriptor_t std_interface_descriptor = { + .length = sizeof(usb_standard_interface_descriptor_t), + .descriptor_type = USB_DESCTYPE_INTERFACE, + .interface_number = 0, + .alternate_setting = 0, + .endpoint_count = 1, + .interface_class = USB_CLASS_HUB, + .interface_subclass = 0, + .interface_protocol = 0, + .str_interface = 0 +}; + +/** Hub descriptor. */ +hub_descriptor_t hub_descriptor = { + .length = sizeof(hub_descriptor_t), + .type = USB_DESCTYPE_HUB, + .port_count = HUB_PORT_COUNT, + .characteristics = 0, + .power_on_warm_up = 50, /* Huh? */ + .max_current = 100, /* Huh again. */ + .removable_device = { 0 }, + .port_power = { 0xFF } +}; + +/** Endpoint descriptor. */ +usb_standard_endpoint_descriptor_t endpoint_descriptor = { + .length = sizeof(usb_standard_endpoint_descriptor_t), + .descriptor_type = USB_DESCTYPE_ENDPOINT, + .endpoint_address = HUB_STATUS_CHANGE_PIPE | 128, + .attributes = USB_TRANSFER_INTERRUPT, + .max_packet_size = 8, + .poll_interval = 0xFF +}; + +/** Standard configuration descriptor. */ +usb_standard_configuration_descriptor_t std_configuration_descriptor = { + .length = sizeof(usb_standard_configuration_descriptor_t), + .descriptor_type = USB_DESCTYPE_CONFIGURATION, + .total_length = + sizeof(usb_standard_configuration_descriptor_t) + + sizeof(std_interface_descriptor) + + sizeof(hub_descriptor) + + sizeof(endpoint_descriptor) + , + .interface_count = 1, + .configuration_number = HUB_CONFIGURATION_ID, + .str_configuration = 0, + .attributes = 128, /* denotes bus-powered device */ + .max_power = 50 +}; + +/** All hub configuration descriptors. */ +static usbvirt_device_configuration_extras_t extra_descriptors[] = { + { + .data = (uint8_t *) &std_interface_descriptor, + .length = sizeof(std_interface_descriptor) + }, + { + .data = (uint8_t *) &hub_descriptor, + .length = sizeof(hub_descriptor) + }, + { + .data = (uint8_t *) &endpoint_descriptor, + .length = sizeof(endpoint_descriptor) + } +}; + +/** Hub configuration. */ +usbvirt_device_configuration_t configuration = { + .descriptor = &std_configuration_descriptor, + .extra = extra_descriptors, + .extra_count = sizeof(extra_descriptors)/sizeof(extra_descriptors[0]) +}; + +/** Hub standard descriptors. */ +usbvirt_descriptors_t descriptors = { + .device = &std_device_descriptor, + .configuration = &configuration, + .configuration_count = 1, +}; + +/** Initializes virtual hub device. + * + * @param dev Virtual USB device backend. + * @return Error code. + */ +int virthub_init(usbvirt_device_t *dev) +{ + if (dev == NULL) { + return EBADMEM; + } + dev->ops = &hub_ops; + dev->descriptors = &descriptors; + dev->lib_debug_level = 0; + dev->lib_debug_enabled_tags = USBVIRT_DEBUGTAG_ALL; + + hub_t *hub = malloc(sizeof(hub_t)); + if (hub == NULL) { + return ENOMEM; + } + + hub_init(hub); + dev->device_data = hub; + + int rc; +#ifdef STANDALONE_HUB + dev->name = "hub"; + rc = usbvirt_connect(dev); +#else + rc = usbvirt_connect_local(dev); +#endif + + return rc; +} + +/** Connect a device to a virtual hub. + * + * @param dev Virtual device representing the hub. + * @param conn Device to be connected. + * @return Port device was connected to. + */ +int virthub_connect_device(usbvirt_device_t *dev, virtdev_connection_t *conn) +{ + assert(dev != NULL); + assert(conn != NULL); + + hub_t *hub = (hub_t *) dev->device_data; + + hub_acquire(hub); + size_t port = hub_connect_device(hub, conn); + hub_release(hub); + + return port; +} + +/** Disconnect a device from a virtual hub. + * + * @param dev Virtual device representing the hub. + * @param conn Device to be disconnected. + * @return Error code. + */ +int virthub_disconnect_device(usbvirt_device_t *dev, virtdev_connection_t *conn) +{ + assert(dev != NULL); + assert(conn != NULL); + + hub_t *hub = (hub_t *) dev->device_data; + + hub_acquire(hub); + hub_disconnect_device(hub, conn); + hub_release(hub); + + return ENOTSUP; +} + +/** Whether trafic is propagated to given device. + * + * @param dev Virtual device representing the hub. + * @param conn Connected device. + * @return Whether port is signalling to the device. + */ +bool virthub_is_device_enabled(usbvirt_device_t *dev, virtdev_connection_t *conn) +{ + assert(dev != NULL); + assert(conn != NULL); + + hub_t *hub = (hub_t *) dev->device_data; + + hub_acquire(hub); + + hub_port_state_t state = HUB_PORT_STATE_UNKNOWN; + size_t port = hub_find_device(hub, conn); + if (port != (size_t) -1) { + state = hub_get_port_state(hub, port); + } + hub_release(hub); + + return state == HUB_PORT_STATE_ENABLED; +} + +/** Format status of a virtual hub. + * + * @param dev Virtual device representing the hub. + * @param[out] status Hub status information. + * @param[in] len Size of the @p status buffer. + */ +void virthub_get_status(usbvirt_device_t *dev, char *status, size_t len) +{ + assert(dev != NULL); + if (len == 0) { + return; + } + + hub_t *hub = (hub_t *) dev->device_data; + + char port_status[HUB_PORT_COUNT + 1]; + + size_t i; + for (i = 0; i < HUB_PORT_COUNT; i++) { + port_status[i] = hub_port_state_to_char( + hub_get_port_state(hub, i)); + } + port_status[HUB_PORT_COUNT] = 0; + + snprintf(status, len, "vhub:%s", port_status); +} + +/** + * @} + */ Index: uspace/drv/vhc/hub/virthub.h =================================================================== --- uspace/drv/vhc/hub/virthub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/hub/virthub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,90 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief USB hub as a virtual USB device. + */ +#ifndef VHC_HUB_VIRTHUB_H_ +#define VHC_HUB_VIRTHUB_H_ + +#include +#include "hub.h" + +#ifdef STANDALONE_HUB +#define virtdev_connection_t int +#else +#include "../devices.h" +#endif + +/** Endpoint number for status change pipe. */ +#define HUB_STATUS_CHANGE_PIPE 1 +/** Configuration value for hub configuration. */ +#define HUB_CONFIGURATION_ID 1 + + +/** Hub descriptor. + */ +typedef struct { + /** Size of this descriptor in bytes. */ + uint8_t length; + /** Descriptor type (USB_DESCTYPE_HUB). */ + uint8_t type; + /** Number of downstream ports. */ + uint8_t port_count; + /** Hub characteristics. */ + uint16_t characteristics; + /** Time from power-on to stabilized current. + * Expressed in 2ms unit. + */ + uint8_t power_on_warm_up; + /** Maximum current (in mA). */ + uint8_t max_current; + /** Whether device at given port is removable. */ + uint8_t removable_device[BITS2BYTES(HUB_PORT_COUNT+1)]; + /** Port power control. + * This is USB1.0 compatibility field, all bits must be 1. + */ + uint8_t port_power[BITS2BYTES(HUB_PORT_COUNT+1)]; +} __attribute__ ((packed)) hub_descriptor_t; + +extern usbvirt_device_ops_t hub_ops; +extern hub_descriptor_t hub_descriptor; + +int virthub_init(usbvirt_device_t *); +int virthub_connect_device(usbvirt_device_t *, virtdev_connection_t *); +int virthub_disconnect_device(usbvirt_device_t *, virtdev_connection_t *); +bool virthub_is_device_enabled(usbvirt_device_t *, virtdev_connection_t *); +void virthub_get_status(usbvirt_device_t *, char *, size_t); + +#endif +/** + * @} + */ Index: uspace/drv/vhc/hub/virthubops.c =================================================================== --- uspace/drv/vhc/hub/virthubops.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/hub/virthubops.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,433 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Virtual USB hub operations. + */ +#include +#include +#include "virthub.h" +#include "hub.h" + +/** Callback when device changes states. */ +static void on_state_change(struct usbvirt_device *dev, + usbvirt_device_state_t old_state, usbvirt_device_state_t new_state) +{ + hub_t *hub = (hub_t *)dev->device_data; + + hub_acquire(hub); + + switch (new_state) { + case USBVIRT_STATE_CONFIGURED: + hub_set_port_state_all(hub, HUB_PORT_STATE_POWERED_OFF); + break; + case USBVIRT_STATE_ADDRESS: + hub_set_port_state_all(hub, HUB_PORT_STATE_NOT_CONFIGURED); + break; + default: + break; + } + + hub_release(hub); +} + +/** Callback for data request. */ +static int req_on_data(struct usbvirt_device *dev, + usb_endpoint_t endpoint, + void *buffer, size_t size, size_t *actual_size) +{ + if (endpoint != HUB_STATUS_CHANGE_PIPE) { + return EINVAL; + } + + hub_t *hub = (hub_t *)dev->device_data; + + hub_acquire(hub); + + uint8_t change_map = hub_get_status_change_bitmap(hub); + + uint8_t *b = (uint8_t *) buffer; + if (size > 0) { + *b = change_map; + *actual_size = 1; + } + + hub_release(hub); + + return EOK; +} + +/** Handle ClearHubFeature request. + * + * @param dev Virtual device representing the hub. + * @param request The SETUP packet of the control request. + * @param data Extra data (when DATA stage present). + * @return Error code. + */ +static int req_clear_hub_feature(usbvirt_device_t *dev, + usb_device_request_setup_packet_t *request, + uint8_t *data) +{ + return ENOTSUP; +} + +/** Handle ClearPortFeature request. + * + * @param dev Virtual device representing the hub. + * @param request The SETUP packet of the control request. + * @param data Extra data (when DATA stage present). + * @return Error code. + */ +static int req_clear_port_feature(usbvirt_device_t *dev, + usb_device_request_setup_packet_t *request, + uint8_t *data) +{ + int rc; + size_t port = request->index - 1; + usb_hub_class_feature_t feature = request->value; + hub_t *hub = (hub_t *) dev->device_data; + + hub_acquire(hub); + + hub_port_state_t port_state = hub_get_port_state(hub, port); + + switch (feature) { + case USB_HUB_FEATURE_PORT_ENABLE: + if ((port_state != HUB_PORT_STATE_NOT_CONFIGURED) + && (port_state != HUB_PORT_STATE_POWERED_OFF)) { + hub_set_port_state(hub, port, HUB_PORT_STATE_DISABLED); + } + rc = EOK; + break; + + case USB_HUB_FEATURE_PORT_SUSPEND: + if (port_state != HUB_PORT_STATE_SUSPENDED) { + rc = EOK; + break; + } + hub_set_port_state(hub, port, HUB_PORT_STATE_RESUMING); + rc = EOK; + break; + + case USB_HUB_FEATURE_PORT_POWER: + if (port_state != HUB_PORT_STATE_NOT_CONFIGURED) { + hub_set_port_state(hub, port, HUB_PORT_STATE_POWERED_OFF); + } + rc = EOK; + break; + + case USB_HUB_FEATURE_C_PORT_CONNECTION: + hub_clear_port_status_change(hub, port, HUB_STATUS_C_PORT_CONNECTION); + rc = EOK; + break; + + case USB_HUB_FEATURE_C_PORT_ENABLE: + hub_clear_port_status_change(hub, port, HUB_STATUS_C_PORT_ENABLE); + rc = EOK; + break; + + case USB_HUB_FEATURE_C_PORT_SUSPEND: + hub_clear_port_status_change(hub, port, HUB_STATUS_C_PORT_SUSPEND); + rc = EOK; + break; + + case USB_HUB_FEATURE_C_PORT_OVER_CURRENT: + hub_clear_port_status_change(hub, port, HUB_STATUS_C_PORT_OVER_CURRENT); + rc = EOK; + break; + + case USB_HUB_FEATURE_C_PORT_RESET: + hub_clear_port_status_change(hub, port, HUB_STATUS_C_PORT_RESET); + rc = EOK; + break; + + default: + rc = ENOTSUP; + break; + } + + hub_release(hub); + + return rc; +} + +/** Handle GetBusState request. + * + * @param dev Virtual device representing the hub. + * @param request The SETUP packet of the control request. + * @param data Extra data (when DATA stage present). + * @return Error code. + */ +static int req_get_bus_state(usbvirt_device_t *dev, + usb_device_request_setup_packet_t *request, + uint8_t *data) +{ + return ENOTSUP; +} + +/** Handle GetDescriptor request. + * + * @param dev Virtual device representing the hub. + * @param request The SETUP packet of the control request. + * @param data Extra data (when DATA stage present). + * @return Error code. + */ +static int req_get_descriptor(usbvirt_device_t *dev, + usb_device_request_setup_packet_t *request, + uint8_t *data) +{ + if (request->value_high == USB_DESCTYPE_HUB) { + int rc = dev->control_transfer_reply(dev, 0, + &hub_descriptor, hub_descriptor.length); + + return rc; + } + /* Let the framework handle all the rest. */ + return EFORWARD; +} + +/** Handle GetHubStatus request. + * + * @param dev Virtual device representing the hub. + * @param request The SETUP packet of the control request. + * @param data Extra data (when DATA stage present). + * @return Error code. + */ +static int req_get_hub_status(usbvirt_device_t *dev, + usb_device_request_setup_packet_t *request, + uint8_t *data) +{ + uint32_t hub_status = 0; + + return dev->control_transfer_reply(dev, 0, + &hub_status, sizeof(hub_status)); +} + +/** Handle GetPortStatus request. + * + * @param dev Virtual device representing the hub. + * @param request The SETUP packet of the control request. + * @param data Extra data (when DATA stage present). + * @return Error code. + */ +static int req_get_port_status(usbvirt_device_t *dev, + usb_device_request_setup_packet_t *request, + uint8_t *data) +{ + hub_t *hub = (hub_t *) dev->device_data; + + hub_acquire(hub); + + uint32_t status = hub_get_port_status(hub, request->index - 1); + + hub_release(hub); + + return dev->control_transfer_reply(dev, 0, &status, 4); +} + +/** Handle SetHubFeature request. + * + * @param dev Virtual device representing the hub. + * @param request The SETUP packet of the control request. + * @param data Extra data (when DATA stage present). + * @return Error code. + */ +static int req_set_hub_feature(usbvirt_device_t *dev, + usb_device_request_setup_packet_t *request, + uint8_t *data) +{ + return ENOTSUP; +} + +/** Handle SetPortFeature request. + * + * @param dev Virtual device representing the hub. + * @param request The SETUP packet of the control request. + * @param data Extra data (when DATA stage present). + * @return Error code. + */ +static int req_set_port_feature(usbvirt_device_t *dev, + usb_device_request_setup_packet_t *request, + uint8_t *data) +{ + int rc; + size_t port = request->index - 1; + usb_hub_class_feature_t feature = request->value; + hub_t *hub = (hub_t *) dev->device_data; + + hub_acquire(hub); + + hub_port_state_t port_state = hub_get_port_state(hub, port); + + switch (feature) { + case USB_HUB_FEATURE_PORT_RESET: + if (port_state != HUB_PORT_STATE_POWERED_OFF) { + hub_set_port_state(hub, port, HUB_PORT_STATE_RESETTING); + } + rc = EOK; + break; + + case USB_HUB_FEATURE_PORT_SUSPEND: + if (port_state == HUB_PORT_STATE_ENABLED) { + hub_set_port_state(hub, port, HUB_PORT_STATE_SUSPENDED); + } + rc = EOK; + break; + + case USB_HUB_FEATURE_PORT_POWER: + if (port_state == HUB_PORT_STATE_POWERED_OFF) { + hub_set_port_state(hub, port, HUB_PORT_STATE_DISCONNECTED); + } + rc = EOK; + break; + + default: + break; + } + + hub_release(hub); + + return rc; +} + + +/** IN class request. */ +#define CLASS_REQ_IN(recipient) \ + USBVIRT_MAKE_CONTROL_REQUEST_TYPE(USB_DIRECTION_IN, \ + USBVIRT_REQUEST_TYPE_CLASS, recipient) +/** OUT class request. */ +#define CLASS_REQ_OUT(recipient) \ + USBVIRT_MAKE_CONTROL_REQUEST_TYPE(USB_DIRECTION_OUT, \ + USBVIRT_REQUEST_TYPE_CLASS, recipient) + +/** Recipient: other. */ +#define REC_OTHER USBVIRT_REQUEST_RECIPIENT_OTHER +/** Recipient: device. */ +#define REC_DEVICE USBVIRT_REQUEST_RECIPIENT_DEVICE +/** Direction: in. */ +#define DIR_IN USB_DIRECTION_IN +/** Direction: out. */ +#define DIR_OUT USB_DIRECTION_OUT + +/** Create a class request. + * + * @param direction Request direction. + * @param recipient Request recipient. + * @param req Request code. + */ +#define CLASS_REQ(direction, recipient, req) \ + .request_type = USBVIRT_MAKE_CONTROL_REQUEST_TYPE(direction, \ + USBVIRT_REQUEST_TYPE_CLASS, recipient), \ + .request = req + +/** Create a standard request. + * + * @param direction Request direction. + * @param recipient Request recipient. + * @param req Request code. + */ +#define STD_REQ(direction, recipient, req) \ + .request_type = USBVIRT_MAKE_CONTROL_REQUEST_TYPE(direction, \ + USBVIRT_REQUEST_TYPE_STANDARD, recipient), \ + .request = req + +/** Hub operations on control endpoint zero. */ +static usbvirt_control_transfer_handler_t endpoint_zero_handlers[] = { + { + STD_REQ(DIR_IN, REC_DEVICE, USB_DEVREQ_GET_DESCRIPTOR), + .name = "GetDescriptor", + .callback = req_get_descriptor + }, + { + CLASS_REQ(DIR_IN, REC_DEVICE, USB_DEVREQ_GET_DESCRIPTOR), + .name = "GetDescriptor", + .callback = req_get_descriptor + }, + { + CLASS_REQ(DIR_IN, REC_OTHER, USB_HUB_REQUEST_GET_STATUS), + .name = "GetPortStatus", + .callback = req_get_port_status + }, + { + CLASS_REQ(DIR_OUT, REC_DEVICE, USB_HUB_REQUEST_CLEAR_FEATURE), + .name = "ClearHubFeature", + .callback = req_clear_hub_feature + }, + { + CLASS_REQ(DIR_OUT, REC_OTHER, USB_HUB_REQUEST_CLEAR_FEATURE), + .name = "ClearPortFeature", + .callback = req_clear_port_feature + }, + { + CLASS_REQ(DIR_IN, REC_OTHER, USB_HUB_REQUEST_GET_STATE), + .name = "GetBusState", + .callback = req_get_bus_state + }, + { + CLASS_REQ(DIR_IN, REC_DEVICE, USB_HUB_REQUEST_GET_DESCRIPTOR), + .name = "GetHubDescriptor", + .callback = req_get_descriptor + }, + { + CLASS_REQ(DIR_IN, REC_DEVICE, USB_HUB_REQUEST_GET_STATUS), + .name = "GetHubStatus", + .callback = req_get_hub_status + }, + { + CLASS_REQ(DIR_IN, REC_OTHER, USB_HUB_REQUEST_GET_STATUS), + .name = "GetPortStatus", + .callback = req_get_port_status + }, + { + CLASS_REQ(DIR_OUT, REC_DEVICE, USB_HUB_REQUEST_SET_FEATURE), + .name = "SetHubFeature", + .callback = req_set_hub_feature + }, + { + CLASS_REQ(DIR_OUT, REC_OTHER, USB_HUB_REQUEST_SET_FEATURE), + .name = "SetPortFeature", + .callback = req_set_port_feature + }, + USBVIRT_CONTROL_TRANSFER_HANDLER_LAST +}; + + +/** Hub operations. */ +usbvirt_device_ops_t hub_ops = { + .control_transfer_handlers = endpoint_zero_handlers, + .on_data = NULL, + .on_data_request = req_on_data, + .on_state_change = on_state_change, +}; + +/** + * @} + */ Index: uspace/drv/vhc/vhc.ma =================================================================== --- uspace/drv/vhc/vhc.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/vhc.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,2 @@ +10 usb&hc=vhc + Index: uspace/drv/vhc/vhcd.h =================================================================== --- uspace/drv/vhc/vhcd.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/vhcd.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,54 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Virtual USB host controller common definitions. + */ +#ifndef VHCD_VHCD_H_ +#define VHCD_VHCD_H_ + +#include + +#define NAME "vhc" +#define NAME_DEV "hcd-virt-dev" +#define NAMESPACE "usb" + +#define DEVMAP_PATH_HC NAMESPACE "/" NAME +#define DEVMAP_PATH_DEV NAMESPACE "/" NAME_DEV + +//#define dprintf(level, format, ...) +// usb_dprintf(NAME, (level), format "\n", ##__VA_ARGS__) +//void dprintf_inval_call(int, ipc_call_t, sysarg_t); + +#endif +/** + * @} + */ Index: uspace/lib/c/Makefile =================================================================== --- uspace/lib/c/Makefile (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/lib/c/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -65,4 +65,5 @@ generic/str.c \ generic/str_error.c \ + generic/l18n/langs.c \ generic/fibril.c \ generic/fibril_synch.c \ Index: uspace/lib/c/generic/as.c =================================================================== --- uspace/lib/c/generic/as.c (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/lib/c/generic/as.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -35,4 +35,5 @@ #include #include +#include #include #include @@ -114,4 +115,30 @@ } +/** Find mapping to physical address. + * + * @param address Virtual address in question (virtual). + * @param[out] frame Frame address (physical). + * @return Error code. + * @retval EOK No error, @p frame holds the translation. + * @retval ENOENT Mapping not found. + */ +int as_get_physical_mapping(void *address, uintptr_t *frame) +{ + uintptr_t tmp_frame; + uintptr_t virt = (uintptr_t) address; + + int rc = (int) __SYSCALL2(SYS_PAGE_FIND_MAPPING, + (sysarg_t) virt, (sysarg_t) &tmp_frame); + if (rc != EOK) { + return rc; + } + + if (frame != NULL) { + *frame = tmp_frame; + } + + return EOK; +} + /** @} */ Index: uspace/lib/c/generic/async.c =================================================================== --- uspace/lib/c/generic/async.c (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/lib/c/generic/async.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -1567,4 +1567,18 @@ } +/** Start IPC_M_DATA_READ using the async framework. + * + * @param phoneid Phone that will be used to contact the receiving side. + * @param dst Address of the beginning of the destination buffer. + * @param size Size of the destination buffer (in bytes). + * @param dataptr Storage of call data (arg 2 holds actual data size). + * @return Hash of the sent message or 0 on error. + */ +aid_t async_data_read(int phoneid, void *dst, size_t size, ipc_call_t *dataptr) +{ + return async_send_2(phoneid, IPC_M_DATA_READ, (sysarg_t) dst, + (sysarg_t) size, dataptr); +} + /** Wrapper for IPC_M_DATA_READ calls using the async framework. * Index: uspace/lib/c/generic/l18n/langs.c =================================================================== --- uspace/lib/c/generic/l18n/langs.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/c/generic/l18n/langs.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,76 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libc + * @{ + */ +/** @file + * Language and locale ids. + */ + +#include +#include +#include + +#define UNKNOWN_LOCALE_LEN 64 + +static fibril_local char unknown_locale[UNKNOWN_LOCALE_LEN]; + +/** Get string representation of a given locale. + * + * @param locale The locale. + * @return Name of the locale. + */ +const char *str_l18_win_locale(l18_win_locales_t locale) +{ + /* + * Static array with names might be better but it would be + * way too big. + */ + switch (locale) { + case L18N_WIN_LOCALE_AFRIKAANS: + return "Afrikaans"; + case L18N_WIN_LOCALE_CZECH: + return "Czech"; + case L18N_WIN_LOCALE_ENGLISH_UNITED_STATES: + return "English (US)"; + case L18N_WIN_LOCALE_SLOVAK: + return "Slovak"; + case L18N_WIN_LOCALE_SPANISH_TRADITIONAL: + return "Spanish (traditional)"; + case L18N_WIN_LOCALE_ZULU: + return "Zulu"; + } + + snprintf(unknown_locale, UNKNOWN_LOCALE_LEN, "Unknown locale 0x%04d", + (int) locale); + return unknown_locale; +} + +/** @} + */ Index: uspace/lib/c/generic/malloc.c =================================================================== --- uspace/lib/c/generic/malloc.c (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/lib/c/generic/malloc.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -240,5 +240,5 @@ size_t asize = ALIGN_UP(size, PAGE_SIZE); - astart = as_area_create(astart, asize, AS_AREA_WRITE | AS_AREA_READ); + astart = as_area_create(astart, asize, AS_AREA_WRITE | AS_AREA_READ | AS_AREA_CACHEABLE); if (astart == (void *) -1) return false; Index: uspace/lib/c/generic/str_error.c =================================================================== --- uspace/lib/c/generic/str_error.c (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/lib/c/generic/str_error.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -33,4 +33,5 @@ */ +#include #include #include @@ -63,10 +64,24 @@ static fibril_local char noerr[NOERR_LEN]; -const char *str_error(const int errno) +const char *str_error(const int e) { - if ((errno <= 0) && (errno >= MIN_ERRNO)) - return err_desc[-errno]; + if ((e <= 0) && (e >= MIN_ERRNO)) + return err_desc[-e]; - snprintf(noerr, NOERR_LEN, "Unkown error code %d", errno); + /* Ad hoc descriptions of error codes interesting for USB. */ + switch (e) { + case EBADCHECKSUM: + return "Bad checksum"; + case ESTALL: + return "Operation stalled"; + case EAGAIN: + return "Resource temporarily unavailable"; + case EEMPTY: + return "Resource is empty"; + default: + break; + } + + snprintf(noerr, NOERR_LEN, "Unkown error code %d", e); return noerr; } Index: uspace/lib/c/include/as.h =================================================================== --- uspace/lib/c/include/as.h (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/lib/c/include/as.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -60,4 +60,5 @@ extern void *set_maxheapsize(size_t mhs); extern void * as_get_mappable_page(size_t sz); +extern int as_get_physical_mapping(void *address, uintptr_t *frame); #endif Index: uspace/lib/c/include/async.h =================================================================== --- uspace/lib/c/include/async.h (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/lib/c/include/async.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -340,4 +340,5 @@ (arg4), (answer)) +extern aid_t async_data_read(int, void *, size_t, ipc_call_t *); extern int async_data_read_start(int, void *, size_t); extern bool async_data_read_receive(ipc_callid_t *, size_t *); Index: uspace/lib/c/include/errno.h =================================================================== --- uspace/lib/c/include/errno.h (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/lib/c/include/errno.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -56,4 +56,13 @@ #define EMLINK (-266) +/** Bad checksum. */ +#define EBADCHECKSUM (-300) + +/** USB: stalled operation. */ +#define ESTALL (-301) + +/** Empty resource (no data). */ +#define EEMPTY (-302) + /** An API function is called while another blocking function is in progress. */ #define EINPROGRESS (-10036) Index: uspace/lib/c/include/ipc/dev_iface.h =================================================================== --- uspace/lib/c/include/ipc/dev_iface.h (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/lib/c/include/ipc/dev_iface.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -37,4 +37,13 @@ HW_RES_DEV_IFACE = 0, CHAR_DEV_IFACE, + + /** Interface provided by any PCI device. */ + PCI_DEV_IFACE, + + /** Interface provided by any USB device. */ + USB_DEV_IFACE, + /** Interface provided by USB host controller. */ + USBHC_DEV_IFACE, + DEV_IFACE_MAX } dev_inferface_idx_t; @@ -48,4 +57,14 @@ DEV_IFACE_ID(DEV_FIRST_CUSTOM_METHOD_IDX) +/* + * The first argument is actually method (as the "real" method is used + * for indexing into interfaces. + */ + +#define DEV_IPC_GET_ARG1(call) IPC_GET_ARG2((call)) +#define DEV_IPC_GET_ARG2(call) IPC_GET_ARG3((call)) +#define DEV_IPC_GET_ARG3(call) IPC_GET_ARG4((call)) +#define DEV_IPC_GET_ARG4(call) IPC_GET_ARG5((call)) + #endif Index: uspace/lib/c/include/ipc/kbd.h =================================================================== --- uspace/lib/c/include/ipc/kbd.h (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/lib/c/include/ipc/kbd.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -39,7 +39,8 @@ #include +#include typedef enum { - KBD_YIELD = IPC_FIRST_USER_METHOD, + KBD_YIELD = DEV_FIRST_CUSTOM_METHOD, KBD_RECLAIM } kbd_request_t; Index: uspace/lib/c/include/l18n/langs.h =================================================================== --- uspace/lib/c/include/l18n/langs.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/c/include/l18n/langs.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,64 @@ +/* + * Copyright (c) 2005 Jakub Jermar + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libc + * @{ + */ +/** @file + * Language and locale ids. + */ + +#ifndef LIBC_L18N_LANGS_H_ +#define LIBC_L18N_LANGS_H_ + +/** Windows locale IDs. + * Codes taken from + * Developing International Software For Windows 95 and Windows NT + * by Nadine Kano (Microsoft Press). + * FIXME: add missing codes. + */ +typedef enum { + L18N_WIN_LOCALE_AFRIKAANS = 0x0436, + /* ... */ + L18N_WIN_LOCALE_CZECH = 0x0405, + /* ... */ + L18N_WIN_LOCALE_ENGLISH_UNITED_STATES = 0x0409, + /* ... */ + L18N_WIN_LOCALE_SLOVAK = 0x041B, + /* ... */ + L18N_WIN_LOCALE_SPANISH_TRADITIONAL = 0x040A, + /* ... */ + L18N_WIN_LOCALE_ZULU = 0x0435 +} l18_win_locales_t; + +const char *str_l18_win_locale(l18_win_locales_t); + +#endif + +/** @} + */ Index: uspace/lib/drv/Makefile =================================================================== --- uspace/lib/drv/Makefile (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/lib/drv/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -29,5 +29,5 @@ USPACE_PREFIX = ../.. -EXTRA_CFLAGS = -Iinclude +EXTRA_CFLAGS = -Iinclude -I$(LIBUSB_PREFIX)/include LIBRARY = libdrv @@ -35,7 +35,10 @@ generic/driver.c \ generic/dev_iface.c \ + generic/remote_char_dev.c \ generic/log.c \ generic/remote_hw_res.c \ - generic/remote_char_dev.c + generic/remote_usb.c \ + generic/remote_pci.c \ + generic/remote_usbhc.c include $(USPACE_PREFIX)/Makefile.common Index: uspace/lib/drv/generic/dev_iface.c =================================================================== --- uspace/lib/drv/generic/dev_iface.c (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/lib/drv/generic/dev_iface.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -41,9 +41,15 @@ #include "remote_hw_res.h" #include "remote_char_dev.h" +#include "remote_usb.h" +#include "remote_usbhc.h" +#include "remote_pci.h" static iface_dipatch_table_t remote_ifaces = { .ifaces = { &remote_hw_res_iface, - &remote_char_dev_iface + &remote_char_dev_iface, + &remote_pci_iface, + &remote_usb_iface, + &remote_usbhc_iface } }; Index: uspace/lib/drv/generic/remote_pci.c =================================================================== --- uspace/lib/drv/generic/remote_pci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/drv/generic/remote_pci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,179 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libdrv + * @{ + */ +/** @file + */ +#include +#include +#include + +#include "pci_dev_iface.h" +#include "ddf/driver.h" + +static void remote_config_space_read_8(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_config_space_read_16(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_config_space_read_32(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); + +static void remote_config_space_write_8(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_config_space_write_16(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_config_space_write_32(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); + +/** Remote USB interface operations. */ +static remote_iface_func_ptr_t remote_pci_iface_ops [] = { + remote_config_space_read_8, + remote_config_space_read_16, + remote_config_space_read_32, + + remote_config_space_write_8, + remote_config_space_write_16, + remote_config_space_write_32 +}; + +/** Remote USB interface structure. + */ +remote_iface_t remote_pci_iface = { + .method_count = sizeof(remote_pci_iface_ops) / + sizeof(remote_pci_iface_ops[0]), + .methods = remote_pci_iface_ops +}; + +void remote_config_space_read_8(ddf_fun_t *fun, void *iface, ipc_callid_t callid, ipc_call_t *call) +{ + assert(iface); + pci_dev_iface_t *pci_iface = (pci_dev_iface_t *)iface; + if (pci_iface->config_space_read_8 == NULL) { + async_answer_0(callid, ENOTSUP); + return; + } + uint32_t address = DEV_IPC_GET_ARG1(*call); + uint8_t value; + int ret = pci_iface->config_space_read_8(fun, address, &value); + if (ret != EOK) { + async_answer_0(callid, ret); + } else { + async_answer_1(callid, EOK, value); + } +} + +void remote_config_space_read_16(ddf_fun_t *fun, void *iface, ipc_callid_t callid, ipc_call_t *call) +{ + assert(iface); + pci_dev_iface_t *pci_iface = (pci_dev_iface_t *)iface; + if (pci_iface->config_space_read_16 == NULL) { + async_answer_0(callid, ENOTSUP); + return; + } + uint32_t address = DEV_IPC_GET_ARG1(*call); + uint16_t value; + int ret = pci_iface->config_space_read_16(fun, address, &value); + if (ret != EOK) { + async_answer_0(callid, ret); + } else { + async_answer_1(callid, EOK, value); + } +} +void remote_config_space_read_32(ddf_fun_t *fun, void *iface, ipc_callid_t callid, ipc_call_t *call) +{ + assert(iface); + pci_dev_iface_t *pci_iface = (pci_dev_iface_t *)iface; + if (pci_iface->config_space_read_32 == NULL) { + async_answer_0(callid, ENOTSUP); + return; + } + uint32_t address = DEV_IPC_GET_ARG1(*call); + uint32_t value; + int ret = pci_iface->config_space_read_32(fun, address, &value); + if (ret != EOK) { + async_answer_0(callid, ret); + } else { + async_answer_1(callid, EOK, value); + } +} + +void remote_config_space_write_8(ddf_fun_t *fun, void *iface, ipc_callid_t callid, ipc_call_t *call) +{ + assert(iface); + pci_dev_iface_t *pci_iface = (pci_dev_iface_t *)iface; + if (pci_iface->config_space_write_8 == NULL) { + async_answer_0(callid, ENOTSUP); + return; + } + uint32_t address = DEV_IPC_GET_ARG1(*call); + uint8_t value = DEV_IPC_GET_ARG2(*call); + int ret = pci_iface->config_space_write_8(fun, address, value); + if (ret != EOK) { + async_answer_0(callid, ret); + } else { + async_answer_0(callid, EOK); + } +} + +void remote_config_space_write_16(ddf_fun_t *fun, void *iface, ipc_callid_t callid, ipc_call_t *call) +{ + assert(iface); + pci_dev_iface_t *pci_iface = (pci_dev_iface_t *)iface; + if (pci_iface->config_space_write_16 == NULL) { + async_answer_0(callid, ENOTSUP); + return; + } + uint32_t address = DEV_IPC_GET_ARG1(*call); + uint16_t value = DEV_IPC_GET_ARG2(*call); + int ret = pci_iface->config_space_write_16(fun, address, value); + if (ret != EOK) { + async_answer_0(callid, ret); + } else { + async_answer_0(callid, EOK); + } +} + +void remote_config_space_write_32(ddf_fun_t *fun, void *iface, ipc_callid_t callid, ipc_call_t *call) +{ + assert(iface); + pci_dev_iface_t *pci_iface = (pci_dev_iface_t *)iface; + if (pci_iface->config_space_write_32 == NULL) { + async_answer_0(callid, ENOTSUP); + return; + } + uint32_t address = DEV_IPC_GET_ARG1(*call); + uint32_t value = DEV_IPC_GET_ARG2(*call); + int ret = pci_iface->config_space_write_32(fun, address, value); + if (ret != EOK) { + async_answer_0(callid, ret); + } else { + async_answer_0(callid, EOK); + } +} + + +/** + * @} + */ + Index: uspace/lib/drv/generic/remote_usb.c =================================================================== --- uspace/lib/drv/generic/remote_usb.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/drv/generic/remote_usb.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,128 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libdrv + * @{ + */ +/** @file + */ + +#include +#include + +#include "usb_iface.h" +#include "ddf/driver.h" + + +static void remote_usb_get_address(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usb_get_interface(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usb_get_hc_handle(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); +//static void remote_usb(device_t *, void *, ipc_callid_t, ipc_call_t *); + +/** Remote USB interface operations. */ +static remote_iface_func_ptr_t remote_usb_iface_ops [] = { + remote_usb_get_address, + remote_usb_get_interface, + remote_usb_get_hc_handle +}; + +/** Remote USB interface structure. + */ +remote_iface_t remote_usb_iface = { + .method_count = sizeof(remote_usb_iface_ops) / + sizeof(remote_usb_iface_ops[0]), + .methods = remote_usb_iface_ops +}; + + +void remote_usb_get_address(ddf_fun_t *fun, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usb_iface_t *usb_iface = (usb_iface_t *) iface; + + if (usb_iface->get_address == NULL) { + async_answer_0(callid, ENOTSUP); + return; + } + + devman_handle_t handle = DEV_IPC_GET_ARG1(*call); + + usb_address_t address; + int rc = usb_iface->get_address(fun, handle, &address); + if (rc != EOK) { + async_answer_0(callid, rc); + } else { + async_answer_1(callid, EOK, address); + } +} + +void remote_usb_get_interface(ddf_fun_t *fun, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usb_iface_t *usb_iface = (usb_iface_t *) iface; + + if (usb_iface->get_interface == NULL) { + async_answer_0(callid, ENOTSUP); + return; + } + + devman_handle_t handle = DEV_IPC_GET_ARG1(*call); + + int iface_no; + int rc = usb_iface->get_interface(fun, handle, &iface_no); + if (rc != EOK) { + async_answer_0(callid, rc); + } else { + async_answer_1(callid, EOK, iface_no); + } +} + +void remote_usb_get_hc_handle(ddf_fun_t *fun, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usb_iface_t *usb_iface = (usb_iface_t *) iface; + + if (usb_iface->get_hc_handle == NULL) { + async_answer_0(callid, ENOTSUP); + return; + } + + devman_handle_t handle; + int rc = usb_iface->get_hc_handle(fun, &handle); + if (rc != EOK) { + async_answer_0(callid, rc); + } + + async_answer_1(callid, EOK, (sysarg_t) handle); +} + + + +/** + * @} + */ Index: uspace/lib/drv/generic/remote_usbhc.c =================================================================== --- uspace/lib/drv/generic/remote_usbhc.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/drv/generic/remote_usbhc.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,585 @@ +/* + * Copyright (c) 2010-2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libdrv + * @{ + */ +/** @file + */ + +#include +#include +#include + +#include "usbhc_iface.h" +#include "ddf/driver.h" + +#define USB_MAX_PAYLOAD_SIZE 1020 +#define HACK_MAX_PACKET_SIZE 8 +#define HACK_MAX_PACKET_SIZE_INTERRUPT_IN 4 + +static void remote_usbhc_interrupt_out(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_interrupt_in(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_bulk_out(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_bulk_in(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_control_write(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_control_read(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_reserve_default_address(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_release_default_address(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_request_address(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_bind_address(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_release_address(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_register_endpoint(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); +static void remote_usbhc_unregister_endpoint(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); +//static void remote_usbhc(ddf_fun_t *, void *, ipc_callid_t, ipc_call_t *); + +/** Remote USB host controller interface operations. */ +static remote_iface_func_ptr_t remote_usbhc_iface_ops [] = { + remote_usbhc_reserve_default_address, + remote_usbhc_release_default_address, + + remote_usbhc_request_address, + remote_usbhc_bind_address, + remote_usbhc_release_address, + + remote_usbhc_interrupt_out, + remote_usbhc_interrupt_in, + + remote_usbhc_bulk_out, + remote_usbhc_bulk_in, + + remote_usbhc_control_write, + remote_usbhc_control_read, + + remote_usbhc_register_endpoint, + remote_usbhc_unregister_endpoint +}; + +/** Remote USB host controller interface structure. + */ +remote_iface_t remote_usbhc_iface = { + .method_count = sizeof(remote_usbhc_iface_ops) / + sizeof(remote_usbhc_iface_ops[0]), + .methods = remote_usbhc_iface_ops +}; + +typedef struct { + ipc_callid_t caller; + ipc_callid_t data_caller; + void *buffer; + void *setup_packet; + size_t size; +} async_transaction_t; + +static void async_transaction_destroy(async_transaction_t *trans) +{ + if (trans == NULL) { + return; + } + + if (trans->setup_packet != NULL) { + free(trans->setup_packet); + } + if (trans->buffer != NULL) { + free(trans->buffer); + } + + free(trans); +} + +static async_transaction_t *async_transaction_create(ipc_callid_t caller) +{ + async_transaction_t *trans = malloc(sizeof(async_transaction_t)); + if (trans == NULL) { + return NULL; + } + + trans->caller = caller; + trans->data_caller = 0; + trans->buffer = NULL; + trans->setup_packet = NULL; + trans->size = 0; + + return trans; +} + +void remote_usbhc_reserve_default_address(ddf_fun_t *fun, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + + if (!usb_iface->reserve_default_address) { + async_answer_0(callid, ENOTSUP); + return; + } + + usb_speed_t speed = DEV_IPC_GET_ARG1(*call); + + int rc = usb_iface->reserve_default_address(fun, speed); + + async_answer_0(callid, rc); +} + +void remote_usbhc_release_default_address(ddf_fun_t *fun, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + + if (!usb_iface->release_default_address) { + async_answer_0(callid, ENOTSUP); + return; + } + + int rc = usb_iface->release_default_address(fun); + + async_answer_0(callid, rc); +} + +void remote_usbhc_request_address(ddf_fun_t *fun, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + + if (!usb_iface->request_address) { + async_answer_0(callid, ENOTSUP); + return; + } + + usb_speed_t speed = DEV_IPC_GET_ARG1(*call); + + usb_address_t address; + int rc = usb_iface->request_address(fun, speed, &address); + if (rc != EOK) { + async_answer_0(callid, rc); + } else { + async_answer_1(callid, EOK, (sysarg_t) address); + } +} + +void remote_usbhc_bind_address(ddf_fun_t *fun, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + + if (!usb_iface->bind_address) { + async_answer_0(callid, ENOTSUP); + return; + } + + usb_address_t address = (usb_address_t) DEV_IPC_GET_ARG1(*call); + devman_handle_t handle = (devman_handle_t) DEV_IPC_GET_ARG2(*call); + + int rc = usb_iface->bind_address(fun, address, handle); + + async_answer_0(callid, rc); +} + +void remote_usbhc_release_address(ddf_fun_t *fun, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + + if (!usb_iface->release_address) { + async_answer_0(callid, ENOTSUP); + return; + } + + usb_address_t address = (usb_address_t) DEV_IPC_GET_ARG1(*call); + + int rc = usb_iface->release_address(fun, address); + + async_answer_0(callid, rc); +} + + +static void callback_out(ddf_fun_t *fun, + int outcome, void *arg) +{ + async_transaction_t *trans = (async_transaction_t *)arg; + + async_answer_0(trans->caller, outcome); + + async_transaction_destroy(trans); +} + +static void callback_in(ddf_fun_t *fun, + int outcome, size_t actual_size, void *arg) +{ + async_transaction_t *trans = (async_transaction_t *)arg; + + if (outcome != EOK) { + async_answer_0(trans->caller, outcome); + if (trans->data_caller) { + async_answer_0(trans->data_caller, EINTR); + } + async_transaction_destroy(trans); + return; + } + + trans->size = actual_size; + + if (trans->data_caller) { + async_data_read_finalize(trans->data_caller, + trans->buffer, actual_size); + } + + async_answer_0(trans->caller, EOK); + + async_transaction_destroy(trans); +} + +/** Process an outgoing transfer (both OUT and SETUP). + * + * @param device Target device. + * @param callid Initiating caller. + * @param call Initiating call. + * @param transfer_func Transfer function (might be NULL). + */ +static void remote_usbhc_out_transfer(ddf_fun_t *fun, + ipc_callid_t callid, ipc_call_t *call, + usbhc_iface_transfer_out_t transfer_func) +{ + if (!transfer_func) { + async_answer_0(callid, ENOTSUP); + return; + } + + size_t max_packet_size = DEV_IPC_GET_ARG3(*call); + usb_target_t target = { + .address = DEV_IPC_GET_ARG1(*call), + .endpoint = DEV_IPC_GET_ARG2(*call) + }; + + size_t len = 0; + void *buffer = NULL; + + int rc = async_data_write_accept(&buffer, false, + 1, USB_MAX_PAYLOAD_SIZE, + 0, &len); + + if (rc != EOK) { + async_answer_0(callid, rc); + return; + } + + async_transaction_t *trans = async_transaction_create(callid); + if (trans == NULL) { + if (buffer != NULL) { + free(buffer); + } + async_answer_0(callid, ENOMEM); + return; + } + + trans->buffer = buffer; + trans->size = len; + + rc = transfer_func(fun, target, max_packet_size, + buffer, len, + callback_out, trans); + + if (rc != EOK) { + async_answer_0(callid, rc); + async_transaction_destroy(trans); + } +} + +/** Process an incoming transfer. + * + * @param device Target device. + * @param callid Initiating caller. + * @param call Initiating call. + * @param transfer_func Transfer function (might be NULL). + */ +static void remote_usbhc_in_transfer(ddf_fun_t *fun, + ipc_callid_t callid, ipc_call_t *call, + usbhc_iface_transfer_in_t transfer_func) +{ + if (!transfer_func) { + async_answer_0(callid, ENOTSUP); + return; + } + + size_t max_packet_size = DEV_IPC_GET_ARG3(*call); + usb_target_t target = { + .address = DEV_IPC_GET_ARG1(*call), + .endpoint = DEV_IPC_GET_ARG2(*call) + }; + + size_t len; + ipc_callid_t data_callid; + if (!async_data_read_receive(&data_callid, &len)) { + async_answer_0(callid, EPARTY); + return; + } + + async_transaction_t *trans = async_transaction_create(callid); + if (trans == NULL) { + async_answer_0(callid, ENOMEM); + return; + } + trans->data_caller = data_callid; + trans->buffer = malloc(len); + trans->size = len; + + int rc = transfer_func(fun, target, max_packet_size, + trans->buffer, len, + callback_in, trans); + + if (rc != EOK) { + async_answer_0(callid, rc); + async_transaction_destroy(trans); + } +} + +void remote_usbhc_interrupt_out(ddf_fun_t *fun, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + assert(usb_iface != NULL); + + return remote_usbhc_out_transfer(fun, callid, call, + usb_iface->interrupt_out); +} + +void remote_usbhc_interrupt_in(ddf_fun_t *fun, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + assert(usb_iface != NULL); + + return remote_usbhc_in_transfer(fun, callid, call, + usb_iface->interrupt_in); +} + +void remote_usbhc_bulk_out(ddf_fun_t *fun, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + assert(usb_iface != NULL); + + return remote_usbhc_out_transfer(fun, callid, call, + usb_iface->bulk_out); +} + +void remote_usbhc_bulk_in(ddf_fun_t *fun, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + assert(usb_iface != NULL); + + return remote_usbhc_in_transfer(fun, callid, call, + usb_iface->bulk_in); +} + +void remote_usbhc_control_write(ddf_fun_t *fun, void *iface, +ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + assert(usb_iface != NULL); + + if (!usb_iface->control_write) { + async_answer_0(callid, ENOTSUP); + return; + } + + usb_target_t target = { + .address = DEV_IPC_GET_ARG1(*call), + .endpoint = DEV_IPC_GET_ARG2(*call) + }; + size_t data_buffer_len = DEV_IPC_GET_ARG3(*call); + size_t max_packet_size = DEV_IPC_GET_ARG4(*call); + + int rc; + + void *setup_packet = NULL; + void *data_buffer = NULL; + size_t setup_packet_len = 0; + + rc = async_data_write_accept(&setup_packet, false, + 1, USB_MAX_PAYLOAD_SIZE, 0, &setup_packet_len); + if (rc != EOK) { + async_answer_0(callid, rc); + return; + } + + if (data_buffer_len > 0) { + rc = async_data_write_accept(&data_buffer, false, + 1, USB_MAX_PAYLOAD_SIZE, 0, &data_buffer_len); + if (rc != EOK) { + async_answer_0(callid, rc); + free(setup_packet); + return; + } + } + + async_transaction_t *trans = async_transaction_create(callid); + if (trans == NULL) { + async_answer_0(callid, ENOMEM); + free(setup_packet); + free(data_buffer); + return; + } + trans->setup_packet = setup_packet; + trans->buffer = data_buffer; + trans->size = data_buffer_len; + + rc = usb_iface->control_write(fun, target, max_packet_size, + setup_packet, setup_packet_len, + data_buffer, data_buffer_len, + callback_out, trans); + + if (rc != EOK) { + async_answer_0(callid, rc); + async_transaction_destroy(trans); + } +} + + +void remote_usbhc_control_read(ddf_fun_t *fun, void *iface, +ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + assert(usb_iface != NULL); + + if (!usb_iface->control_read) { + async_answer_0(callid, ENOTSUP); + return; + } + + usb_target_t target = { + .address = DEV_IPC_GET_ARG1(*call), + .endpoint = DEV_IPC_GET_ARG2(*call) + }; + size_t max_packet_size = DEV_IPC_GET_ARG3(*call); + + int rc; + + void *setup_packet = NULL; + size_t setup_packet_len = 0; + size_t data_len = 0; + + rc = async_data_write_accept(&setup_packet, false, + 1, USB_MAX_PAYLOAD_SIZE, 0, &setup_packet_len); + if (rc != EOK) { + async_answer_0(callid, rc); + return; + } + + ipc_callid_t data_callid; + if (!async_data_read_receive(&data_callid, &data_len)) { + async_answer_0(callid, EPARTY); + free(setup_packet); + return; + } + + async_transaction_t *trans = async_transaction_create(callid); + if (trans == NULL) { + async_answer_0(callid, ENOMEM); + free(setup_packet); + return; + } + trans->data_caller = data_callid; + trans->setup_packet = setup_packet; + trans->size = data_len; + trans->buffer = malloc(data_len); + if (trans->buffer == NULL) { + async_answer_0(callid, ENOMEM); + async_transaction_destroy(trans); + return; + } + + rc = usb_iface->control_read(fun, target, max_packet_size, + setup_packet, setup_packet_len, + trans->buffer, trans->size, + callback_in, trans); + + if (rc != EOK) { + async_answer_0(callid, rc); + async_transaction_destroy(trans); + } +} + + +void remote_usbhc_register_endpoint(ddf_fun_t *fun, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + + if (!usb_iface->register_endpoint) { + async_answer_0(callid, ENOTSUP); + return; + } + +#define INIT_FROM_HIGH_DATA(type, var, arg_no) \ + type var = (type) DEV_IPC_GET_ARG##arg_no(*call) / 256 +#define INIT_FROM_LOW_DATA(type, var, arg_no) \ + type var = (type) DEV_IPC_GET_ARG##arg_no(*call) % 256 + + INIT_FROM_HIGH_DATA(usb_address_t, address, 1); + INIT_FROM_LOW_DATA(usb_endpoint_t, endpoint, 1); + INIT_FROM_HIGH_DATA(usb_transfer_type_t, transfer_type, 2); + INIT_FROM_LOW_DATA(usb_direction_t, direction, 2); + +#undef INIT_FROM_HIGH_DATA +#undef INIT_FROM_LOW_DATA + + size_t max_packet_size = (size_t) DEV_IPC_GET_ARG3(*call); + unsigned int interval = (unsigned int) DEV_IPC_GET_ARG4(*call); + + int rc = usb_iface->register_endpoint(fun, address, endpoint, + transfer_type, direction, max_packet_size, interval); + + async_answer_0(callid, rc); +} + + +void remote_usbhc_unregister_endpoint(ddf_fun_t *fun, void *iface, + ipc_callid_t callid, ipc_call_t *call) +{ + usbhc_iface_t *usb_iface = (usbhc_iface_t *) iface; + + if (!usb_iface->unregister_endpoint) { + async_answer_0(callid, ENOTSUP); + return; + } + + usb_address_t address = (usb_address_t) DEV_IPC_GET_ARG1(*call); + usb_endpoint_t endpoint = (usb_endpoint_t) DEV_IPC_GET_ARG2(*call); + usb_direction_t direction = (usb_direction_t) DEV_IPC_GET_ARG3(*call); + + int rc = usb_iface->unregister_endpoint(fun, + address, endpoint, direction); + + async_answer_0(callid, rc); +} + + +/** + * @} + */ Index: uspace/lib/drv/include/pci_dev_iface.h =================================================================== --- uspace/lib/drv/include/pci_dev_iface.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/drv/include/pci_dev_iface.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,68 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libdrv + * @addtogroup usb + * @{ + */ +/** @file + * @brief PCI device interface definition. + */ + +#ifndef LIBDRV_PCI_DEV_IFACE_H_ +#define LIBDRV_PCI_DEV_IFACE_H_ + +#include "ddf/driver.h" + +typedef enum { + IPC_M_CONFIG_SPACE_READ_8, + IPC_M_CONFIG_SPACE_READ_16, + IPC_M_CONFIG_SPACE_READ_32, + + IPC_M_CONFIG_SPACE_WRITE_8, + IPC_M_CONFIG_SPACE_WRITE_16, + IPC_M_CONFIG_SPACE_WRITE_32 +} pci_dev_iface_funcs_t; + +/** PCI device communication interface. */ +typedef struct { + int (*config_space_read_8)(ddf_fun_t *, uint32_t address, uint8_t *data); + int (*config_space_read_16)(ddf_fun_t *, uint32_t address, uint16_t *data); + int (*config_space_read_32)(ddf_fun_t *, uint32_t address, uint32_t *data); + + int (*config_space_write_8)(ddf_fun_t *, uint32_t address, uint8_t data); + int (*config_space_write_16)(ddf_fun_t *, uint32_t address, uint16_t data); + int (*config_space_write_32)(ddf_fun_t *, uint32_t address, uint32_t data); +} pci_dev_iface_t; + + +#endif +/** + * @} + */ + Index: uspace/lib/drv/include/remote_pci.h =================================================================== --- uspace/lib/drv/include/remote_pci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/drv/include/remote_pci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,45 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libdrv + * @{ + */ +/** @file + */ + +#ifndef LIBDRV_REMOTE_PCI_H_ +#define LIBDRV_REMOTE_PCI_H_ + +remote_iface_t remote_pci_iface; + +#endif + +/** + * @} + */ + Index: uspace/lib/drv/include/remote_usb.h =================================================================== --- uspace/lib/drv/include/remote_usb.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/drv/include/remote_usb.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libdrv + * @{ + */ +/** @file + */ + +#ifndef LIBDRV_REMOTE_USB_H_ +#define LIBDRV_REMOTE_USB_H_ + +remote_iface_t remote_usb_iface; + +#endif + +/** + * @} + */ Index: uspace/lib/drv/include/remote_usbhc.h =================================================================== --- uspace/lib/drv/include/remote_usbhc.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/drv/include/remote_usbhc.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,44 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libdrv + * @{ + */ +/** @file + */ + +#ifndef LIBDRV_REMOTE_USBHC_H_ +#define LIBDRV_REMOTE_USBHC_H_ + +remote_iface_t remote_usbhc_iface; + +#endif + +/** + * @} + */ Index: uspace/lib/drv/include/usb_iface.h =================================================================== --- uspace/lib/drv/include/usb_iface.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/drv/include/usb_iface.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,86 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libdrv + * @addtogroup usb + * @{ + */ +/** @file + * @brief USB interface definition. + */ + +#ifndef LIBDRV_USB_IFACE_H_ +#define LIBDRV_USB_IFACE_H_ + +#include "ddf/driver.h" +#include +typedef enum { + /** Tell USB address assigned to device. + * Parameters: + * - devman handle id + * Answer: + * - EINVAL - unknown handle or handle not managed by this driver + * - ENOTSUP - operation not supported (shall not happen) + * - arbitrary error code if returned by remote implementation + * - EOK - handle found, first parameter contains the USB address + */ + IPC_M_USB_GET_ADDRESS, + + /** Tell interface number given device can use. + * Parameters + * - devman handle id of the device + * Answer: + * - ENOTSUP - operation not supported (can also mean any interface) + * - EOK - operation okay, first parameter contains interface number + */ + IPC_M_USB_GET_INTERFACE, + + /** Tell devman handle of device host controller. + * Parameters: + * - none + * Answer: + * - EOK - request processed without errors + * - ENOTSUP - this indicates invalid USB driver + * Parameters of the answer: + * - devman handle of HC caller is physically connected to + */ + IPC_M_USB_GET_HOST_CONTROLLER_HANDLE +} usb_iface_funcs_t; + +/** USB device communication interface. */ +typedef struct { + int (*get_address)(ddf_fun_t *, devman_handle_t, usb_address_t *); + int (*get_interface)(ddf_fun_t *, devman_handle_t, int *); + int (*get_hc_handle)(ddf_fun_t *, devman_handle_t *); +} usb_iface_t; + + +#endif +/** + * @} + */ Index: uspace/lib/drv/include/usbhc_iface.h =================================================================== --- uspace/lib/drv/include/usbhc_iface.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/drv/include/usbhc_iface.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,250 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libdrv + * @addtogroup usb + * @{ + */ +/** @file + * @brief USB host controller interface definition. + */ + +#ifndef LIBDRV_USBHC_IFACE_H_ +#define LIBDRV_USBHC_IFACE_H_ + +#include "ddf/driver.h" +#include +#include + + +/** IPC methods for communication with HC through DDF interface. + * + * Notes for async methods: + * + * Methods for sending data to device (OUT transactions) + * - e.g. IPC_M_USBHC_INTERRUPT_OUT - + * always use the same semantics: + * - first, IPC call with given method is made + * - argument #1 is target address + * - argument #2 is target endpoint + * - argument #3 is max packet size of the endpoint + * - this call is immediately followed by IPC data write (from caller) + * - the initial call (and the whole transaction) is answer after the + * transaction is scheduled by the HC and acknowledged by the device + * or immediately after error is detected + * - the answer carries only the error code + * + * Methods for retrieving data from device (IN transactions) + * - e.g. IPC_M_USBHC_INTERRUPT_IN - + * also use the same semantics: + * - first, IPC call with given method is made + * - argument #1 is target address + * - argument #2 is target endpoint + * - argument #3 is max packet size of the endpoint + * - this call is immediately followed by IPC data read (async version) + * - the call is not answered until the device returns some data (or until + * error occurs) + * + * Some special methods (NO-DATA transactions) do not send any data. These + * might behave as both OUT or IN transactions because communication parts + * where actual buffers are exchanged are omitted. + ** + * For all these methods, wrap functions exists. Important rule: functions + * for IN transactions have (as parameters) buffers where retrieved data + * will be stored. These buffers must be already allocated and shall not be + * touch until the transaction is completed + * (e.g. not before calling usb_wait_for() with appropriate handle). + * OUT transactions buffers can be freed immediately after call is dispatched + * (i.e. after return from wrapping function). + * + */ +typedef enum { + /** Reserve usage of default address. + * This call informs the host controller that the caller will be + * using default USB address. It is duty of the HC driver to ensure + * that only single entity will have it reserved. + * The address is returned via IPC_M_USBHC_RELEASE_DEFAULT_ADDRESS. + * The caller can start using the address after receiving EOK + * answer. + */ + IPC_M_USBHC_RESERVE_DEFAULT_ADDRESS, + + /** Release usage of default address. + * @see IPC_M_USBHC_RESERVE_DEFAULT_ADDRESS + */ + IPC_M_USBHC_RELEASE_DEFAULT_ADDRESS, + + /** Asks for address assignment by host controller. + * Answer: + * - ELIMIT - host controller run out of address + * - EOK - address assigned + * Answer arguments: + * - assigned address + * + * The address must be released by via IPC_M_USBHC_RELEASE_ADDRESS. + */ + IPC_M_USBHC_REQUEST_ADDRESS, + + /** Bind USB address with devman handle. + * Parameters: + * - USB address + * - devman handle + * Answer: + * - EOK - address binded + * - ENOENT - address is not in use + */ + IPC_M_USBHC_BIND_ADDRESS, + + /** Release address in use. + * Arguments: + * - address to be released + * Answer: + * - ENOENT - address not in use + * - EPERM - trying to release default USB address + */ + IPC_M_USBHC_RELEASE_ADDRESS, + + + /** Send interrupt data to device. + * See explanation at usb_iface_funcs_t (OUT transaction). + */ + IPC_M_USBHC_INTERRUPT_OUT, + + /** Get interrupt data from device. + * See explanation at usb_iface_funcs_t (IN transaction). + */ + IPC_M_USBHC_INTERRUPT_IN, + + /** Send bulk data to device. + * See explanation at usb_iface_funcs_t (OUT transaction). + */ + IPC_M_USBHC_BULK_OUT, + + /** Get bulk data from device. + * See explanation at usb_iface_funcs_t (IN transaction). + */ + IPC_M_USBHC_BULK_IN, + + /** Issue control WRITE transfer. + * See explanation at usb_iface_funcs_t (OUT transaction) for + * call parameters. + * This call is immediately followed by two IPC data writes + * from the caller (setup packet and actual data). + */ + IPC_M_USBHC_CONTROL_WRITE, + + /** Issue control READ transfer. + * See explanation at usb_iface_funcs_t (IN transaction) for + * call parameters. + * This call is immediately followed by IPC data write from the caller + * (setup packet) and IPC data read (buffer that was read). + */ + IPC_M_USBHC_CONTROL_READ, + + /** Register endpoint attributes at host controller. + * This is used to reserve portion of USB bandwidth. + * Parameters: + * - USB address + endpoint number (ADDR * 256 + EP) + * - transfer type + direction (TYPE * 256 + DIR) + * - maximum packet size + * - interval (in milliseconds) + * Answer: + * - EOK - reservation successful + * - ELIMIT - not enough bandwidth to satisfy the request + */ + IPC_M_USBHC_REGISTER_ENDPOINT, + + /** Revert endpoint registration. + * Parameters: + * - USB address + * - endpoint number + * - data direction + * Answer: + * - EOK - endpoint unregistered + * - ENOENT - unknown endpoint + */ + IPC_M_USBHC_UNREGISTER_ENDPOINT +} usbhc_iface_funcs_t; + +/** Callback for outgoing transfer. */ +typedef void (*usbhc_iface_transfer_out_callback_t)(ddf_fun_t *, + int, void *); + +/** Callback for incoming transfer. */ +typedef void (*usbhc_iface_transfer_in_callback_t)(ddf_fun_t *, + int, size_t, void *); + + +/** Out transfer processing function prototype. */ +typedef int (*usbhc_iface_transfer_out_t)(ddf_fun_t *, usb_target_t, size_t, + void *, size_t, + usbhc_iface_transfer_out_callback_t, void *); + +/** Setup transfer processing function prototype. @deprecated */ +typedef usbhc_iface_transfer_out_t usbhc_iface_transfer_setup_t; + +/** In transfer processing function prototype. */ +typedef int (*usbhc_iface_transfer_in_t)(ddf_fun_t *, usb_target_t, size_t, + void *, size_t, + usbhc_iface_transfer_in_callback_t, void *); + +/** USB host controller communication interface. */ +typedef struct { + int (*reserve_default_address)(ddf_fun_t *, usb_speed_t); + int (*release_default_address)(ddf_fun_t *); + int (*request_address)(ddf_fun_t *, usb_speed_t, usb_address_t *); + int (*bind_address)(ddf_fun_t *, usb_address_t, devman_handle_t); + int (*release_address)(ddf_fun_t *, usb_address_t); + + int (*register_endpoint)(ddf_fun_t *, usb_address_t, usb_endpoint_t, + usb_transfer_type_t, usb_direction_t, size_t, unsigned int); + int (*unregister_endpoint)(ddf_fun_t *, usb_address_t, usb_endpoint_t, + usb_direction_t); + + usbhc_iface_transfer_out_t interrupt_out; + usbhc_iface_transfer_in_t interrupt_in; + + usbhc_iface_transfer_out_t bulk_out; + usbhc_iface_transfer_in_t bulk_in; + + int (*control_write)(ddf_fun_t *, usb_target_t, + size_t, + void *, size_t, void *, size_t, + usbhc_iface_transfer_out_callback_t, void *); + + int (*control_read)(ddf_fun_t *, usb_target_t, + size_t, + void *, size_t, void *, size_t, + usbhc_iface_transfer_in_callback_t, void *); +} usbhc_iface_t; + + +#endif +/** + * @} + */ Index: uspace/lib/usb/Makefile =================================================================== --- uspace/lib/usb/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,57 @@ +# +# Copyright (c) 2010 Vojtech Horky +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBRARY = libusb +LIBS = $(LIBDRV_PREFIX)/libdrv.a +EXTRA_CFLAGS += -I$(LIBDRV_PREFIX)/include -Iinclude + +SOURCES = \ + src/addrkeep.c \ + src/class.c \ + src/ddfiface.c \ + src/debug.c \ + src/devdrv.c \ + src/devpoll.c \ + src/dp.c \ + src/dump.c \ + src/hidparser.c \ + src/hub.c \ + src/pipes.c \ + src/pipesinit.c \ + src/pipesio.c \ + src/recognise.c \ + src/request.c \ + src/usb.c \ + src/usbdevice.c \ + src/hidreq.c \ + src/hidreport.c \ + src/host/device_keeper.c \ + src/host/batch.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/lib/usb/include/usb/addrkeep.h =================================================================== --- uspace/lib/usb/include/usb/addrkeep.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/addrkeep.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,86 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * USB address keeping for host controller drivers. + */ +#ifndef LIBUSB_ADDRKEEP_H_ +#define LIBUSB_ADDRKEEP_H_ + +#include +#include +#include + +/** Info about used address. */ +typedef struct { + /** Linked list member. */ + link_t link; + /** Address. */ + usb_address_t address; + /** Corresponding devman handle. */ + devman_handle_t devman_handle; +} usb_address_keeping_used_t; + +/** Structure for keeping track of free and used USB addresses. */ +typedef struct { + /** Head of list of used addresses. */ + link_t used_addresses; + /** Upper bound for USB addresses. */ + usb_address_t max_address; + /** Mutex protecting used address. */ + fibril_mutex_t used_addresses_guard; + /** Condition variable for used addresses. */ + fibril_condvar_t used_addresses_condvar; + + /** Condition variable mutex for default address. */ + fibril_mutex_t default_condvar_guard; + /** Condition variable for default address. */ + fibril_condvar_t default_condvar; + /** Whether is default address available. */ + bool default_available; +} usb_address_keeping_t; + +void usb_address_keeping_init(usb_address_keeping_t *, usb_address_t); + +void usb_address_keeping_reserve_default(usb_address_keeping_t *); +void usb_address_keeping_release_default(usb_address_keeping_t *); + +usb_address_t usb_address_keeping_request(usb_address_keeping_t *); +int usb_address_keeping_release(usb_address_keeping_t *, usb_address_t); +void usb_address_keeping_devman_bind(usb_address_keeping_t *, usb_address_t, + devman_handle_t); +usb_address_t usb_address_keeping_find(usb_address_keeping_t *, + devman_handle_t); + +#endif +/** + * @} + */ Index: uspace/lib/usb/include/usb/classes/classes.h =================================================================== --- uspace/lib/usb/include/usb/classes/classes.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/classes/classes.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,67 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * USB device classes (generic constants and functions). + */ +#ifndef LIBUSB_CLASSES_H_ +#define LIBUSB_CLASSES_H_ + +/** USB device class. */ +typedef enum { + USB_CLASS_USE_INTERFACE = 0x00, + USB_CLASS_AUDIO = 0x01, + USB_CLASS_COMMUNICATIONS_CDC_CONTROL = 0x02, + USB_CLASS_HID = 0x03, + USB_CLASS_PHYSICAL = 0x05, + USB_CLASS_IMAGE = 0x06, + USB_CLASS_PRINTER = 0x07, + USB_CLASS_MASS_STORAGE = 0x08, + USB_CLASS_HUB = 0x09, + USB_CLASS_CDC_DATA = 0x0A, + USB_CLASS_SMART_CARD = 0x0B, + USB_CLASS_CONTENT_SECURITY = 0x0D, + USB_CLASS_VIDEO = 0x0E, + USB_CLASS_PERSONAL_HEALTHCARE = 0x0F, + USB_CLASS_DIAGNOSTIC = 0xDC, + USB_CLASS_WIRELESS_CONTROLLER = 0xE0, + USB_CLASS_MISCELLANEOUS = 0xEF, + USB_CLASS_APPLICATION_SPECIFIC = 0xFE, + USB_CLASS_VENDOR_SPECIFIC = 0xFF, + /* USB_CLASS_ = 0x, */ +} usb_class_t; + +const char *usb_str_class(usb_class_t); + +#endif +/** + * @} + */ Index: uspace/lib/usb/include/usb/classes/hid.h =================================================================== --- uspace/lib/usb/include/usb/classes/hid.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/classes/hid.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,123 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * @brief USB HID device related types. + */ +#ifndef LIBUSB_HID_H_ +#define LIBUSB_HID_H_ + +#include +#include +#include + +/** USB/HID device requests. */ +typedef enum { + USB_HIDREQ_GET_REPORT = 1, + USB_HIDREQ_GET_IDLE = 2, + USB_HIDREQ_GET_PROTOCOL = 3, + /* Values 4 to 8 are reserved. */ + USB_HIDREQ_SET_REPORT = 9, + USB_HIDREQ_SET_IDLE = 10, + USB_HIDREQ_SET_PROTOCOL = 11 +} usb_hid_request_t; + +typedef enum { + USB_HID_REPORT_TYPE_INPUT = 1, + USB_HID_REPORT_TYPE_OUTPUT = 2, + USB_HID_REPORT_TYPE_FEATURE = 3 +} usb_hid_report_type_t; + +typedef enum { + USB_HID_PROTOCOL_BOOT = 0, + USB_HID_PROTOCOL_REPORT = 1 +} usb_hid_protocol_t; + +/** USB/HID subclass constants. */ +typedef enum { + USB_HID_SUBCLASS_NONE = 0, + USB_HID_SUBCLASS_BOOT = 1 +} usb_hid_subclass_t; + +/** USB/HID interface protocols. */ +typedef enum { + USB_HID_PROTOCOL_NONE = 0, + USB_HID_PROTOCOL_KEYBOARD = 1, + USB_HID_PROTOCOL_MOUSE = 2 +} usb_hid_iface_protocol_t; + +/** Part of standard USB HID descriptor specifying one class descriptor. + * + * (See HID Specification, p.22) + */ +typedef struct { + /** Type of class-specific descriptor (Report or Physical). */ + uint8_t type; + /** Length of class-specific descriptor in bytes. */ + uint16_t length; +} __attribute__ ((packed)) usb_standard_hid_class_descriptor_info_t; + +/** Standard USB HID descriptor. + * + * (See HID Specification, p.22) + * + * It is actually only the "header" of the descriptor, it does not contain + * the last two mandatory fields (type and length of the first class-specific + * descriptor). + */ +typedef struct { + /** Total size of this descriptor in bytes. + * + * This includes all class-specific descriptor info - type + length + * for each descriptor. + */ + uint8_t length; + /** Descriptor type (USB_DESCTYPE_HID). */ + uint8_t descriptor_type; + /** HID Class Specification release. */ + uint16_t spec_release; + /** Country code of localized hardware. */ + uint8_t country_code; + /** Total number of class-specific (i.e. Report and Physical) + * descriptors. + * + * @note There is always only one Report descriptor. + */ + uint8_t class_desc_count; + /** First mandatory class descriptor (Report) info. */ + usb_standard_hid_class_descriptor_info_t report_desc_info; +} __attribute__ ((packed)) usb_standard_hid_descriptor_t; + + +#endif +/** + * @} + */ Index: uspace/lib/usb/include/usb/classes/hid/utled.h =================================================================== --- uspace/lib/usb/include/usb/classes/hid/utled.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/classes/hid/utled.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,122 @@ +/* + * Copyright (c) 2010 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * @brief USB HID Usage Tables - LED page. + */ +#ifndef LIBUSB_UTLED_H_ +#define LIBUSB_UTLED_H_ + +typedef enum { + USB_HID_LED_UNDEFINED = 0, + USB_HID_LED_NUM_LOCK, + USB_HID_LED_CAPS_LOCK, + USB_HID_LED_SCROLL_LOCK, + USB_HID_LED_COMPOSE, + USB_HID_LED_KANA, + USB_HID_LED_POWER, + USB_HID_LED_SHIFT, + USB_HID_LED_DND, + USB_HID_LED_MUTE, + USB_HID_LED_TONE_ENABLE, + USB_HID_LED_HIGH_CUT_FILTER, + USB_HID_LED_LOW_CUT_FILTER, + USB_HID_LED_EQ_ENABLE, + USB_HID_LED_SOUND_FIELD_ON, + USB_HID_LED_SURROUND_ON, + USB_HID_LED_REPEAT, + USB_HID_LED_STEREO, + USB_HID_LED_SAMPLING_RATE_DETECT, + USB_HID_LED_SPINNING, + USB_HID_LED_CAV, + USB_HID_LED_CLV, + USB_HID_LED_RECORDING_FORMAT_DETECT, + USB_HID_LED_OFF_HOOK, + USB_HID_LED_RING, + USB_HID_LED_MESSAGE_WAITING, + USB_HID_LED_DATA_MODE, + USB_HID_LED_BATTERY_OPERATION, + USB_HID_LED_BATTERY_OK, + USB_HID_LED_BATTERY_LOW, + USB_HID_LED_SPEAKER, + USB_HID_LED_HEAD_SET, + USB_HID_LED_HOLD, + USB_HID_LED_MICRO, + USB_HID_LED_COVERAGE, + USB_HID_LED_NIGHT_MODE, + USB_HID_LED_SEND_CALLS, + USB_HID_LED_CALL_PICKUP, + USB_HID_LED_CONFERENCE, + USB_HID_LED_STAND_BY, + USB_HID_LED_CAMERA_ON, + USB_HID_LED_CAMERA_OFF, + USB_HID_LED_ON_LINE, + USB_HID_LED_OFF_LINE, + USB_HID_LED_BUSY, + USB_HID_LED_READY, + USB_HID_LED_PAPER_OUT, + USB_HID_LED_PAPER_JAM, + USB_HID_LED_REMOTE, + USB_HID_LED_FORWARD, + USB_HID_LED_REVERSE, + USB_HID_LED_STOP, + USB_HID_LED_REWIND, + USB_HID_LED_FAST_FORWARD, + USB_HID_LED_PLAY, + USB_HID_LED_PAUSE, + USB_HID_LED_RECORD, + USB_HID_LED_ERROR, + USB_HID_LED_USAGE_SELECTED_IND, + USB_HID_LED_USAGE_IN_USE_IND, + USB_HID_LED_USAGE_MULTI_MODE_IND, + USB_HID_LED_IND_ON, + USB_HID_LED_IND_FLASH, + USB_HID_LED_IND_SLOW_BLINK, + USB_HID_LED_IND_FAST_BLINK, + USB_HID_LED_IND_OFF, + USB_HID_LED_FLASH_ON_TIME, + USB_HID_LED_SLOW_BLINK_ON_TIME, + USB_HID_LED_SLOW_BLINK_OFF_TIME, + USB_HID_LED_FAST_BLINK_ON_TIME, + USB_HID_LED_FAST_BLINK_OFF_TIME, + USB_HID_LED_USAGE_IND_COLOR, + USB_HID_LED_IND_RED, + USB_HID_LED_IND_GREEN, + USB_HID_LED_IND_AMBER, + USB_HID_LED_GENERIC_IND, + USB_HID_LED_SYSTEM_SUSPEND, + USB_HID_LED_EXTERNAL_POWER +} usb_hid_usage_led_t; + +#endif /* LIBUSB_UTLED_H_ */ +/** + * @} + */ Index: uspace/lib/usb/include/usb/classes/hid_report_items.h =================================================================== --- uspace/lib/usb/include/usb/classes/hid_report_items.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/classes/hid_report_items.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * @brief USB HID parser. + */ +#ifndef LIBUSB_HID_REPORT_ITEMS_H_ +#define LIBUSB_HID_REPORT_ITEMS_H_ + +#include + +/* MAIN ITEMS */ +#define USB_HID_TAG_CLASS_MAIN 0x0 +#define USB_HID_REPORT_TAG_INPUT 0x8 +#define USB_HID_REPORT_TAG_OUTPUT 0x9 +#define USB_HID_REPORT_TAG_FEATURE 0xB +#define USB_HID_REPORT_TAG_COLLECTION 0xA +#define USB_HID_REPORT_TAG_END_COLLECTION 0xC + +/* GLOBAL ITEMS */ +#define USB_HID_TAG_CLASS_GLOBAL 0x1 +#define USB_HID_REPORT_TAG_USAGE_PAGE 0x0 +#define USB_HID_REPORT_TAG_LOGICAL_MINIMUM 0x1 +#define USB_HID_REPORT_TAG_LOGICAL_MAXIMUM 0x2 +#define USB_HID_REPORT_TAG_PHYSICAL_MINIMUM 0x3 +#define USB_HID_REPORT_TAG_PHYSICAL_MAXIMUM 0x4 +#define USB_HID_REPORT_TAG_UNIT_EXPONENT 0x5 +#define USB_HID_REPORT_TAG_UNIT 0x6 +#define USB_HID_REPORT_TAG_REPORT_SIZE 0x7 +#define USB_HID_REPORT_TAG_REPORT_ID 0x8 +#define USB_HID_REPORT_TAG_REPORT_COUNT 0x9 +#define USB_HID_REPORT_TAG_PUSH 0xA +#define USB_HID_REPORT_TAG_POP 0xB + + +/* LOCAL ITEMS */ +#define USB_HID_TAG_CLASS_LOCAL 0x2 +#define USB_HID_REPORT_TAG_USAGE 0x0 +#define USB_HID_REPORT_TAG_USAGE_MINIMUM 0x1 +#define USB_HID_REPORT_TAG_USAGE_MAXIMUM 0x2 +#define USB_HID_REPORT_TAG_DESIGNATOR_INDEX 0x3 +#define USB_HID_REPORT_TAG_DESIGNATOR_MINIMUM 0x4 +#define USB_HID_REPORT_TAG_DESIGNATOR_MAXIMUM 0x5 +#define USB_HID_REPORT_TAG_STRING_INDEX 0x7 +#define USB_HID_REPORT_TAG_STRING_MINIMUM 0x8 +#define USB_HID_REPORT_TAG_STRING_MAXIMUM 0x9 +#define USB_HID_REPORT_TAG_DELIMITER 0xA + +#endif +/** + * @} + */ Index: uspace/lib/usb/include/usb/classes/hidparser.h =================================================================== --- uspace/lib/usb/include/usb/classes/hidparser.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/classes/hidparser.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,310 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * USB HID report descriptor and report data parser + */ +#ifndef LIBUSB_HIDPARSER_H_ +#define LIBUSB_HIDPARSER_H_ + +#include +#include +#include + +/** + * Item prefix + */ +#define USB_HID_ITEM_SIZE(data) ((uint8_t)(data & 0x3)) +#define USB_HID_ITEM_TAG(data) ((uint8_t)((data & 0xF0) >> 4)) +#define USB_HID_ITEM_TAG_CLASS(data) ((uint8_t)((data & 0xC) >> 2)) +#define USB_HID_ITEM_IS_LONG(data) (data == 0xFE) + + +/** + * Input/Output/Feature Item flags + */ +/** Constant (1) / Variable (0) */ +#define USB_HID_ITEM_FLAG_CONSTANT(flags) ((flags & 0x1) == 0x1) +/** Variable (1) / Array (0) */ +#define USB_HID_ITEM_FLAG_VARIABLE(flags) ((flags & 0x2) == 0x2) +/** Absolute / Relative*/ +#define USB_HID_ITEM_FLAG_RELATIVE(flags) ((flags & 0x4) == 0x4) +/** Wrap / No Wrap */ +#define USB_HID_ITEM_FLAG_WRAP(flags) ((flags & 0x8) == 0x8) +#define USB_HID_ITEM_FLAG_LINEAR(flags) ((flags & 0x10) == 0x10) +#define USB_HID_ITEM_FLAG_PREFERRED(flags) ((flags & 0x20) == 0x20) +#define USB_HID_ITEM_FLAG_POSITION(flags) ((flags & 0x40) == 0x40) +#define USB_HID_ITEM_FLAG_VOLATILE(flags) ((flags & 0x80) == 0x80) +#define USB_HID_ITEM_FLAG_BUFFERED(flags) ((flags & 0x100) == 0x100) + + +/** + * Description of path of usage pages and usages in report descriptor + */ +#define USB_HID_PATH_COMPARE_STRICT 0 +#define USB_HID_PATH_COMPARE_END 1 +#define USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY 4 + +/** */ +typedef struct { + /** */ + int32_t usage_page; + /** */ + int32_t usage; + /** */ + link_t link; +} usb_hid_report_usage_path_t; + +/** */ +typedef struct { + /** */ + int depth; + + /** */ + link_t link; +} usb_hid_report_path_t; + +/** + * Description of report items + */ +typedef struct { + /** */ + int32_t id; + /** */ + int32_t usage_minimum; + /** */ + int32_t usage_maximum; + /** */ + int32_t logical_minimum; + /** */ + int32_t logical_maximum; + /** */ + int32_t size; + /** */ + int32_t count; + /** */ + size_t offset; + /** */ + int32_t delimiter; + /** */ + int32_t unit_exponent; + /** */ + int32_t unit; + + /** */ + int32_t string_index; + /** */ + int32_t string_minimum; + /** */ + int32_t string_maximum; + /** */ + int32_t designator_index; + /** */ + int32_t designator_minimum; + /** */ + int32_t designator_maximum; + /** */ + int32_t physical_minimum; + /** */ + int32_t physical_maximum; + + /** */ + uint8_t item_flags; + + /** */ + usb_hid_report_path_t *usage_path; + /** */ + link_t link; +} usb_hid_report_item_t; + + +/** HID report parser structure. */ +typedef struct { + /** */ + link_t input; + /** */ + link_t output; + /** */ + link_t feature; +} usb_hid_report_parser_t; + + +/** HID parser callbacks for IN items. */ +typedef struct { + /** Callback for keyboard. + * + * @param key_codes Array of pressed key (including modifiers). + * @param count Length of @p key_codes. + * @param arg Custom argument. + */ + void (*keyboard)(const uint8_t *key_codes, size_t count, const uint8_t modifiers, void *arg); +} usb_hid_report_in_callbacks_t; + + +typedef enum { + USB_HID_MOD_LCTRL = 0x01, + USB_HID_MOD_LSHIFT = 0x02, + USB_HID_MOD_LALT = 0x04, + USB_HID_MOD_LGUI = 0x08, + USB_HID_MOD_RCTRL = 0x10, + USB_HID_MOD_RSHIFT = 0x20, + USB_HID_MOD_RALT = 0x40, + USB_HID_MOD_RGUI = 0x80, + USB_HID_MOD_COUNT = 8 +} usb_hid_modifiers_t; + +//typedef enum { +// USB_HID_LED_NUM_LOCK = 0x1, +// USB_HID_LED_CAPS_LOCK = 0x2, +// USB_HID_LED_SCROLL_LOCK = 0x4, +// USB_HID_LED_COMPOSE = 0x8, +// USB_HID_LED_KANA = 0x10, +// USB_HID_LED_COUNT = 5 +//} usb_hid_led_t; + +static const usb_hid_modifiers_t + usb_hid_modifiers_consts[USB_HID_MOD_COUNT] = { + USB_HID_MOD_LCTRL, + USB_HID_MOD_LSHIFT, + USB_HID_MOD_LALT, + USB_HID_MOD_LGUI, + USB_HID_MOD_RCTRL, + USB_HID_MOD_RSHIFT, + USB_HID_MOD_RALT, + USB_HID_MOD_RGUI +}; + +//static const usb_hid_led_t usb_hid_led_consts[USB_HID_LED_COUNT] = { +// USB_HID_LED_NUM_LOCK, +// USB_HID_LED_CAPS_LOCK, +// USB_HID_LED_SCROLL_LOCK, +// USB_HID_LED_COMPOSE, +// USB_HID_LED_KANA +//}; + +//#define USB_HID_BOOT_KEYBOARD_NUM_LOCK 0x01 +//#define USB_HID_BOOT_KEYBOARD_CAPS_LOCK 0x02 +//#define USB_HID_BOOT_KEYBOARD_SCROLL_LOCK 0x04 +//#define USB_HID_BOOT_KEYBOARD_COMPOSE 0x08 +//#define USB_HID_BOOT_KEYBOARD_KANA 0x10 + +/* + * Descriptor parser functions + */ +/** */ +int usb_hid_parser_init(usb_hid_report_parser_t *parser); + +/** */ +int usb_hid_parse_report_descriptor(usb_hid_report_parser_t *parser, + const uint8_t *data, size_t size); + +/** */ +void usb_hid_free_report_parser(usb_hid_report_parser_t *parser); + +/** */ +void usb_hid_descriptor_print(usb_hid_report_parser_t *parser); + +/* + * Boot protocol functions + */ +/** */ +int usb_hid_boot_keyboard_input_report(const uint8_t *data, size_t size, + const usb_hid_report_in_callbacks_t *callbacks, void *arg); + +/** */ +int usb_hid_boot_keyboard_output_report(uint8_t leds, uint8_t *data, size_t size); + + +/* + * Input report parser functions + */ +/** */ +int usb_hid_parse_report(const usb_hid_report_parser_t *parser, + const uint8_t *data, size_t size, + usb_hid_report_path_t *path, int flags, + const usb_hid_report_in_callbacks_t *callbacks, void *arg); + +/** */ +size_t usb_hid_report_input_length(const usb_hid_report_parser_t *parser, + usb_hid_report_path_t *path, int flags); + + + +/* + * usage path functions + */ +/** */ +usb_hid_report_path_t *usb_hid_report_path(void); + +/** */ +void usb_hid_report_path_free(usb_hid_report_path_t *path); + +/** */ +int usb_hid_report_path_append_item(usb_hid_report_path_t *usage_path, int32_t usage_page, int32_t usage); + +/** */ +void usb_hid_report_remove_last_item(usb_hid_report_path_t *usage_path); + +/** */ +void usb_hid_report_null_last_item(usb_hid_report_path_t *usage_path); + +/** */ +void usb_hid_report_set_last_item(usb_hid_report_path_t *usage_path, int32_t tag, int32_t data); + +/** */ +int usb_hid_report_compare_usage_path(usb_hid_report_path_t *report_path, usb_hid_report_path_t *path, int flags); + +/** */ +usb_hid_report_path_t *usb_hid_report_path_clone(usb_hid_report_path_t *usage_path); + + +/* + * Output report parser functions + */ +/** Allocates output report buffer*/ +uint8_t *usb_hid_report_output(usb_hid_report_parser_t *parser, size_t *size); + +/** Frees output report buffer*/ +void usb_hid_report_output_free(uint8_t *output); + +/** Returns size of output for given usage path */ +size_t usb_hid_report_output_size(usb_hid_report_parser_t *parser, + usb_hid_report_path_t *path, int flags); + +/** Updates the output report buffer by translated given data */ +int usb_hid_report_output_translate(usb_hid_report_parser_t *parser, + usb_hid_report_path_t *path, int flags, + uint8_t *buffer, size_t size, + int32_t *data, size_t data_size); +#endif +/** + * @} + */ Index: uspace/lib/usb/include/usb/classes/hidreport.h =================================================================== --- uspace/lib/usb/include/usb/classes/hidreport.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/classes/hidreport.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,65 @@ +/* + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * USB HID report parser initialization from descriptors. + */ + +#ifndef LIBUSB_HIDREPORT_H_ +#define LIBUSB_HIDREPORT_H_ + +#include +#include + +/** + * Retrieves the Report descriptor from the USB device and initializes the + * report parser. + * + * \param dev USB device representing a HID device. + * \param parser HID Report parser. + * + * \retval EOK if successful. + * \retval EINVAL if one of the parameters is not given (is NULL). + * \retval ENOENT if there are some descriptors missing. + * \retval ENOMEM if an error with allocation occured. + * \retval EINVAL if the Report descriptor's size does not match the size + * from the interface descriptor. + * \return Other value inherited from function usb_pipe_start_session(), + * usb_pipe_end_session() or usb_request_get_descriptor(). + */ +int usb_hid_process_report_descriptor(usb_device_t *dev, + usb_hid_report_parser_t *parser); + +#endif /* LIBUSB_HIDREPORT_H_ */ + +/** + * @} + */ Index: uspace/lib/usb/include/usb/classes/hidreq.h =================================================================== --- uspace/lib/usb/include/usb/classes/hidreq.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/classes/hidreq.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,69 @@ +/* + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * HID class-specific requests. + */ + +#ifndef USB_KBD_HIDREQ_H_ +#define USB_KBD_HIDREQ_H_ + +#include + +#include +#include + +/*----------------------------------------------------------------------------*/ + +int usbhid_req_set_report(usb_pipe_t *ctrl_pipe, int iface_no, + usb_hid_report_type_t type, uint8_t *buffer, size_t buf_size); + +int usbhid_req_set_protocol(usb_pipe_t *ctrl_pipe, int iface_no, + usb_hid_protocol_t protocol); + +int usbhid_req_set_idle(usb_pipe_t *ctrl_pipe, int iface_no, uint8_t duration); + +int usbhid_req_get_report(usb_pipe_t *ctrl_pipe, int iface_no, + usb_hid_report_type_t type, uint8_t *buffer, size_t buf_size, + size_t *actual_size); + +int usbhid_req_get_protocol(usb_pipe_t *ctrl_pipe, int iface_no, + usb_hid_protocol_t *protocol); + +int usbhid_req_get_idle(usb_pipe_t *ctrl_pipe, int iface_no, uint8_t *duration); + +/*----------------------------------------------------------------------------*/ + +#endif /* USB_KBD_HIDREQ_H_ */ + +/** + * @} + */ Index: uspace/lib/usb/include/usb/classes/hidut.h =================================================================== --- uspace/lib/usb/include/usb/classes/hidut.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/classes/hidut.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,68 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * @brief USB HID Usage Tables. + */ +#ifndef LIBUSB_HIDUT_H_ +#define LIBUSB_HIDUT_H_ + +/** USB/HID Usage Pages. */ +typedef enum { + USB_HIDUT_PAGE_GENERIC_DESKTOP = 1, + USB_HIDUT_PAGE_SIMULATION = 2, + USB_HIDUT_PAGE_VR = 3, + USB_HIDUT_PAGE_SPORT = 4, + USB_HIDUT_PAGE_GAME = 5, + USB_HIDUT_PAGE_GENERIC_DEVICE = 6, + USB_HIDUT_PAGE_KEYBOARD = 7, + USB_HIDUT_PAGE_LED = 8, + USB_HIDUT_PAGE_BUTTON = 9 + /* USB_HIDUT_PAGE_ = , */ +} usb_hidut_usage_page_t; + +/** Usages for Generic Desktop Page. */ +typedef enum { + USB_HIDUT_USAGE_GENERIC_DESKTOP_POINTER = 1, + USB_HIDUT_USAGE_GENERIC_DESKTOP_MOUSE = 2, + USB_HIDUT_USAGE_GENERIC_DESKTOP_JOYSTICK = 4, + USB_HIDUT_USAGE_GENERIC_DESKTOP_GAMEPAD = 5, + USB_HIDUT_USAGE_GENERIC_DESKTOP_KEYBOARD = 6, + USB_HIDUT_USAGE_GENERIC_DESKTOP_KEYPAD = 7 + /* USB_HIDUT_USAGE_GENERIC_DESKTOP_ = , */ + +} usb_hidut_usage_generic_desktop_t; + + +#endif +/** + * @} + */ Index: uspace/lib/usb/include/usb/classes/hidutkbd.h =================================================================== --- uspace/lib/usb/include/usb/classes/hidutkbd.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/classes/hidutkbd.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,175 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * @brief USB HID key codes. + * @details + * This is not a typical header as by default it is equal to empty file. + * However, by cleverly defining the USB_HIDUT_KBD_KEY you can use it + * to generate conversion tables etc. + * + * For example, this creates enum for known keys: + * @code +#define USB_HIDUT_KBD_KEY(name, usage_id, l, lc, l1, l2) \ + USB_KBD_KEY_##name = usage_id, +typedef enum { + #include +} usb_key_code_t; + @endcode + * + * Maybe, it might be better that you would place such enums into separate + * files and create them as separate step before compiling to allow tools + * such as Doxygen get the definitions right. + * + * @warning This file does not include guard to prevent multiple inclusions + * into a single file. + */ + + +#ifndef USB_HIDUT_KBD_KEY +/** Declare keyboard key. + * @param name Key name (identifier). + * @param usage_id Key code (see Keyboard/Keypad Page (0x07) in HUT1.12. + * @param letter Corresponding character (0 if not applicable). + * @param letter_caps Corresponding character with Caps on. + * @param letter_mod1 Corresponding character with modifier #1 on. + * @param letter_mod2 Corresponding character with modifier #2 on. + */ +#define USB_HIDUT_KBD_KEY(name, usage_id, letter, letter_caps, letter_mod1, letter_mod2) + +#endif + +#define __NONPRINT(name, usage_id) \ + USB_HIDUT_KBD_KEY(name, usage_id, 0, 0, 0, 0) + +/* US alphabet letters */ +USB_HIDUT_KBD_KEY(A, 0x04, 'a', 'A', 0, 0) +USB_HIDUT_KBD_KEY(B, 0x05, 'b', 'B', 0, 0) +USB_HIDUT_KBD_KEY(C, 0x06, 'c', 'C', 0, 0) +USB_HIDUT_KBD_KEY(D, 0x07, 'd', 'D', 0, 0) +USB_HIDUT_KBD_KEY(E, 0x08, 'e', 'E', 0, 0) +USB_HIDUT_KBD_KEY(F, 0x09, 'f', 'F', 0, 0) +USB_HIDUT_KBD_KEY(G, 0x0A, 'g', 'G', 0, 0) +USB_HIDUT_KBD_KEY(H, 0x0B, 'h', 'H', 0, 0) +USB_HIDUT_KBD_KEY(I, 0x0C, 'i', 'I', 0, 0) +USB_HIDUT_KBD_KEY(J, 0x0D, 'j', 'J', 0, 0) +USB_HIDUT_KBD_KEY(K, 0x0E, 'k', 'K', 0, 0) +USB_HIDUT_KBD_KEY(L, 0x0F, 'l', 'L', 0, 0) +USB_HIDUT_KBD_KEY(M, 0x10, 'm', 'M', 0, 0) +USB_HIDUT_KBD_KEY(N, 0x11, 'n', 'N', 0, 0) +USB_HIDUT_KBD_KEY(O, 0x12, 'o', 'O', 0, 0) +USB_HIDUT_KBD_KEY(P, 0x13, 'p', 'P', 0, 0) +USB_HIDUT_KBD_KEY(Q, 0x14, 'q', 'Q', 0, 0) +USB_HIDUT_KBD_KEY(R, 0x15, 'r', 'R', 0, 0) +USB_HIDUT_KBD_KEY(S, 0x16, 's', 'S', 0, 0) +USB_HIDUT_KBD_KEY(T, 0x17, 't', 'T', 0, 0) +USB_HIDUT_KBD_KEY(U, 0x18, 'u', 'U', 0, 0) +USB_HIDUT_KBD_KEY(V, 0x19, 'v', 'V', 0, 0) +USB_HIDUT_KBD_KEY(W, 0x1A, 'w', 'W', 0, 0) +USB_HIDUT_KBD_KEY(X, 0x1B, 'x', 'X', 0, 0) +USB_HIDUT_KBD_KEY(Y, 0x1C, 'y', 'Y', 0, 0) +USB_HIDUT_KBD_KEY(Z, 0x1D, 'z', 'Z', 0, 0) + +/* Keyboard digits */ +USB_HIDUT_KBD_KEY(1, 0x1E, '1', '!', 0, 0) +USB_HIDUT_KBD_KEY(2, 0x1F, '2', '@', 0, 0) +USB_HIDUT_KBD_KEY(3, 0x20, '3', '#', 0, 0) +USB_HIDUT_KBD_KEY(4, 0x21, '4', '$', 0, 0) +USB_HIDUT_KBD_KEY(5, 0x22, '5', '%', 0, 0) +USB_HIDUT_KBD_KEY(6, 0x23, '6', '^', 0, 0) +USB_HIDUT_KBD_KEY(7, 0x24, '7', '&', 0, 0) +USB_HIDUT_KBD_KEY(8, 0x25, '8', '*', 0, 0) +USB_HIDUT_KBD_KEY(9, 0x26, '9', '(', 0, 0) +USB_HIDUT_KBD_KEY(0, 0x27, '0', ')', 0, 0) + +/* More-or-less typewriter command keys */ +USB_HIDUT_KBD_KEY(ENTER, 0x28, '\n', 0, 0, 0) +USB_HIDUT_KBD_KEY(ESCAPE, 0x29, 0, 0, 0, 0) +USB_HIDUT_KBD_KEY(BACKSPACE, 0x2A, '\b', 0, 0, 0) +USB_HIDUT_KBD_KEY(TAB, 0x2B, '\t', 0, 0, 0) +USB_HIDUT_KBD_KEY(SPACE, 0x2C, ' ', 0, 0, 0) + +/* Special (printable) characters */ +USB_HIDUT_KBD_KEY(DASH, 0x2D, '-', '_', 0, 0) +USB_HIDUT_KBD_KEY(EQUALS, 0x2E, '=', '+', 0, 0) +USB_HIDUT_KBD_KEY(LEFT_BRACKET, 0x2F, '[', '{', 0, 0) +USB_HIDUT_KBD_KEY(RIGHT_BRACKET, 0x30, ']', '}', 0, 0) +USB_HIDUT_KBD_KEY(BACKSLASH, 0x31, '\\', '|', 0, 0) +USB_HIDUT_KBD_KEY(HASH, 0x32, '#', '~', 0, 0) +USB_HIDUT_KBD_KEY(SEMICOLON, 0x33, ';', ':', 0, 0) +USB_HIDUT_KBD_KEY(APOSTROPHE, 0x34, '\'', '"', 0, 0) +USB_HIDUT_KBD_KEY(GRAVE_ACCENT, 0x35, '`', '~', 0, 0) +USB_HIDUT_KBD_KEY(COMMA, 0x36, ',', '<', 0, 0) +USB_HIDUT_KBD_KEY(PERIOD, 0x37, '.', '>', 0, 0) +USB_HIDUT_KBD_KEY(SLASH, 0x38, '/', '?', 0, 0) + +USB_HIDUT_KBD_KEY(CAPS_LOCK, 0x39, 0, 0, 0, 0) + +/* Function keys */ +__NONPRINT( F1, 0x3A) +__NONPRINT( F2, 0x3B) +__NONPRINT( F3, 0x3C) +__NONPRINT( F4, 0x3D) +__NONPRINT( F5, 0x3E) +__NONPRINT( F6, 0x3F) +__NONPRINT( F7, 0x40) +__NONPRINT( F8, 0x41) +__NONPRINT( F9, 0x42) +__NONPRINT(F10, 0x43) +__NONPRINT(F11, 0x44) +__NONPRINT(F12, 0x45) + +/* Cursor movement keys & co. */ +__NONPRINT(PRINT_SCREEN, 0x46) +__NONPRINT(SCROLL_LOCK, 0x47) +__NONPRINT(PAUSE, 0x48) +__NONPRINT(INSERT, 0x49) +__NONPRINT(HOME, 0x4A) +__NONPRINT(PAGE_UP, 0x4B) +__NONPRINT(DELETE, 0x4C) +__NONPRINT(END, 0x4D) +__NONPRINT(PAGE_DOWN, 0x4E) +__NONPRINT(RIGHT_ARROW, 0x4F) +__NONPRINT(LEFT_ARROW, 0x50) +__NONPRINT(DOWN_ARROW, 0x51) +__NONPRINT(UP_ARROW, 0x52) + + + + +/* USB_HIDUT_KBD_KEY(, 0x, '', '', 0, 0) */ + +#undef __NONPRINT + +/** + * @} + */ + Index: uspace/lib/usb/include/usb/classes/hub.h =================================================================== --- uspace/lib/usb/include/usb/classes/hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/classes/hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,222 @@ +/* + * Copyright (c) 2010 Matus Dekanek + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * @brief USB hub related structures. + */ +#ifndef LIBUSB_CLASS_HUB_H_ +#define LIBUSB_CLASS_HUB_H_ + +#include + +/** Hub class feature selector. + * @warning The constants are not unique (feature selectors are used + * for hub and port). + */ +typedef enum { + USB_HUB_FEATURE_C_HUB_LOCAL_POWER = 0, + USB_HUB_FEATURE_C_HUB_OVER_CURRENT = 1, + USB_HUB_FEATURE_PORT_CONNECTION = 0, + USB_HUB_FEATURE_PORT_ENABLE = 1, + USB_HUB_FEATURE_PORT_SUSPEND = 2, + USB_HUB_FEATURE_PORT_OVER_CURRENT = 3, + USB_HUB_FEATURE_PORT_RESET = 4, + USB_HUB_FEATURE_PORT_POWER = 8, + USB_HUB_FEATURE_PORT_LOW_SPEED = 9, + USB_HUB_FEATURE_C_PORT_CONNECTION = 16, + USB_HUB_FEATURE_C_PORT_ENABLE = 17, + USB_HUB_FEATURE_C_PORT_SUSPEND = 18, + USB_HUB_FEATURE_C_PORT_OVER_CURRENT = 19, + USB_HUB_FEATURE_C_PORT_RESET = 20, + /* USB_HUB_FEATURE_ = , */ +} usb_hub_class_feature_t; + +/** Header of standard hub descriptor without the "variadic" part. */ +typedef struct { + /** Descriptor length. */ + uint8_t length; + /** Descriptor type (0x29). */ + uint8_t descriptor_type; + /** Number of downstream ports. */ + uint8_t port_count; + /** Characteristics bitmask. */ + uint16_t characteristics; + /** Time from power-on to stabilization of current on the port. */ + uint8_t power_good_time; + /** Maximum current requirements in mA. */ + uint8_t max_current; +} __attribute__ ((packed)) usb_hub_descriptor_header_t; + +/** + * @brief usb hub descriptor + * + * For more information see Universal Serial Bus Specification Revision 1.1 chapter 11.16.2 + */ +typedef struct usb_hub_descriptor_type { + /** Number of bytes in this descriptor, including this byte */ + //uint8_t bDescLength; + + /** Descriptor Type, value: 29H for hub descriptor */ + //uint8_t bDescriptorType; + + /** Number of downstream ports that this hub supports */ + uint8_t ports_count; + + /** + D1...D0: Logical Power Switching Mode + 00: Ganged power switching (all ports power at + once) + 01: Individual port power switching + 1X: Reserved. Used only on 1.0 compliant hubs + that implement no power switching. + D2: Identifies a Compound Device + 0: Hub is not part of a compound device + 1: Hub is part of a compound device + D4...D3: Over-current Protection Mode + 00: Global Over-current Protection. The hub + reports over-current as a summation of all + ports current draw, without a breakdown of + individual port over-current status. + 01: Individual Port Over-current Protection. The + hub reports over-current on a per-port basis. + Each port has an over-current indicator. + 1X: No Over-current Protection. This option is + allowed only for bus-powered hubs that do not + implement over-current protection. + D15...D5: + Reserved + */ + uint16_t hub_characteristics; + + /** + Time (in 2ms intervals) from the time the power-on + sequence begins on a port until power is good on that + port. The USB System Software uses this value to + determine how long to wait before accessing a + powered-on port. + */ + uint8_t pwr_on_2_good_time; + + /** + Maximum current requirements of the Hub Controller + electronics in mA. + */ + uint8_t current_requirement; + + /** + Indicates if a port has a removable device attached. + This field is reported on byte-granularity. Within a + byte, if no port exists for a given location, the field + representing the port characteristics returns 0. + Bit value definition: + 0B - Device is removable + 1B - Device is non-removable + This is a bitmap corresponding to the individual ports + on the hub: + Bit 0: Reserved for future use + Bit 1: Port 1 + Bit 2: Port 2 + .... + Bit n: Port n (implementation-dependent, up to a + maximum of 255 ports). + */ + uint8_t * devices_removable; + + /** + This field exists for reasons of compatibility with + software written for 1.0 compliant devices. All bits in + this field should be set to 1B. This field has one bit for + each port on the hub with additional pad bits, if + necessary, to make the number of bits in the field an + integer multiple of 8. + */ + //uint8_t * port_pwr_ctrl_mask; +} usb_hub_descriptor_t; + + + +/** @brief usb hub specific request types. + * + * For more information see Universal Serial Bus Specification Revision 1.1 chapter 11.16.2 + */ +typedef enum { + /** This request resets a value reported in the hub status. */ + USB_HUB_REQ_TYPE_CLEAR_HUB_FEATURE = 0x20, + /** This request resets a value reported in the port status. */ + USB_HUB_REQ_TYPE_CLEAR_PORT_FEATURE = 0x23, + /** This is an optional per-port diagnostic request that returns the bus state value, as sampled at the last EOF2 point. */ + USB_HUB_REQ_TYPE_GET_STATE = 0xA3, + /** This request returns the hub descriptor. */ + USB_HUB_REQ_TYPE_GET_DESCRIPTOR = 0xA0, + /** This request returns the current hub status and the states that have changed since the previous acknowledgment. */ + USB_HUB_REQ_TYPE_GET_HUB_STATUS = 0xA0, + /** This request returns the current port status and the current value of the port status change bits. */ + USB_HUB_REQ_TYPE_GET_PORT_STATUS = 0xA3, + /** This request overwrites the hub descriptor. */ + USB_HUB_REQ_TYPE_SET_DESCRIPTOR = 0x20, + /** This request sets a value reported in the hub status. */ + USB_HUB_REQ_TYPE_SET_HUB_FEATURE = 0x20, + /** This request sets a value reported in the port status. */ + USB_HUB_REQ_TYPE_SET_PORT_FEATURE = 0x23 +} usb_hub_bm_request_type_t; + +/** @brief hub class request codes*/ +/// \TODO these are duplicit to standart descriptors +typedef enum { + /** */ + USB_HUB_REQUEST_GET_STATUS = 0, + /** */ + USB_HUB_REQUEST_CLEAR_FEATURE = 1, + /** */ + USB_HUB_REQUEST_GET_STATE = 2, + /** */ + USB_HUB_REQUEST_SET_FEATURE = 3, + /** */ + USB_HUB_REQUEST_GET_DESCRIPTOR = 6, + /** */ + USB_HUB_REQUEST_SET_DESCRIPTOR = 7 +} usb_hub_request_t; + +/** + * Maximum size of usb hub descriptor in bytes + */ +extern size_t USB_HUB_MAX_DESCRIPTOR_SIZE; + + + + + + + +#endif +/** + * @} + */ Index: uspace/lib/usb/include/usb/ddfiface.h =================================================================== --- uspace/lib/usb/include/usb/ddfiface.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/ddfiface.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * Implementations of DDF interfaces functions. + */ +#ifndef LIBUSB_DDFIFACE_H_ +#define LIBUSB_DDFIFACE_H_ + +#include +#include +#include + +int usb_iface_get_hc_handle_hub_impl(ddf_fun_t *, devman_handle_t *); +int usb_iface_get_address_hub_impl(ddf_fun_t *, devman_handle_t, + usb_address_t *); +extern usb_iface_t usb_iface_hub_impl; + +int usb_iface_get_hc_handle_hub_child_impl(ddf_fun_t *, devman_handle_t *); +int usb_iface_get_address_hub_child_impl(ddf_fun_t *, devman_handle_t, + usb_address_t *); +extern usb_iface_t usb_iface_hub_child_impl; + +int usb_iface_get_hc_handle_hc_impl(ddf_fun_t *, devman_handle_t *); + + +#endif +/** + * @} + */ Index: uspace/lib/usb/include/usb/debug.h =================================================================== --- uspace/lib/usb/include/usb/debug.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/debug.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,120 @@ +/* + * Copyright (c) 2010-2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * Debugging related functions. + */ +#ifndef LIBUSB_DEBUG_H_ +#define LIBUSB_DEBUG_H_ +#include +#include +#include + +void usb_dump_standard_descriptor(FILE *, const char *, const char *, + const uint8_t *, size_t); + +/** Logging level. */ +typedef enum { + /** Fatal, unrecoverable, error. + * Such error prevents the driver from working at all. + */ + USB_LOG_LEVEL_FATAL, + + /** Serious but recoverable error + * Shall be used for errors fatal for single device but not for + * driver itself. + */ + USB_LOG_LEVEL_ERROR, + + /** Warning. + * Problems from which the driver is able to recover gracefully. + */ + USB_LOG_LEVEL_WARNING, + + /** Information message. + * This should be the last level that is printed by default to + * the screen. + * Typical usage is to inform that new device was found and what + * are its capabilities. + * Do not use for repetitive actions (such as device polling). + */ + USB_LOG_LEVEL_INFO, + + /** Debugging message. */ + USB_LOG_LEVEL_DEBUG, + + /** More detailed debugging message. */ + USB_LOG_LEVEL_DEBUG2, + + /** Terminating constant for logging levels. */ + USB_LOG_LEVEL_MAX +} usb_log_level_t; + +/** Default log level. */ +#define USB_LOG_LEVEL_DEFAULT USB_LOG_LEVEL_DEBUG + + +void usb_log_enable(usb_log_level_t, const char *); + +void usb_log_printf(usb_log_level_t, const char *, ...); + +/** Log fatal error. */ +#define usb_log_fatal(format, ...) \ + usb_log_printf(USB_LOG_LEVEL_FATAL, format, ##__VA_ARGS__) + +/** Log normal (recoverable) error. */ +#define usb_log_error(format, ...) \ + usb_log_printf(USB_LOG_LEVEL_ERROR, format, ##__VA_ARGS__) + +/** Log warning. */ +#define usb_log_warning(format, ...) \ + usb_log_printf(USB_LOG_LEVEL_WARNING, format, ##__VA_ARGS__) + +/** Log informational message. */ +#define usb_log_info(format, ...) \ + usb_log_printf(USB_LOG_LEVEL_INFO, format, ##__VA_ARGS__) + +/** Log debugging message. */ +#define usb_log_debug(format, ...) \ + usb_log_printf(USB_LOG_LEVEL_DEBUG, format, ##__VA_ARGS__) + +/** Log verbose debugging message. */ +#define usb_log_debug2(format, ...) \ + usb_log_printf(USB_LOG_LEVEL_DEBUG2, format, ##__VA_ARGS__) + +const char *usb_debug_str_buffer(const uint8_t *, size_t, size_t); + + +#endif +/** + * @} + */ + Index: uspace/lib/usb/include/usb/descriptor.h =================================================================== --- uspace/lib/usb/include/usb/descriptor.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/descriptor.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,172 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * Standard USB descriptors. + */ +#ifndef LIBUSB_DESCRIPTOR_H_ +#define LIBUSB_DESCRIPTOR_H_ + +#include + +/** Descriptor type. */ +typedef enum { + USB_DESCTYPE_DEVICE = 1, + USB_DESCTYPE_CONFIGURATION = 2, + USB_DESCTYPE_STRING = 3, + USB_DESCTYPE_INTERFACE = 4, + USB_DESCTYPE_ENDPOINT = 5, + USB_DESCTYPE_HID = 0x21, + USB_DESCTYPE_HID_REPORT = 0x22, + USB_DESCTYPE_HID_PHYSICAL = 0x23, + USB_DESCTYPE_HUB = 0x29, + /* USB_DESCTYPE_ = */ +} usb_descriptor_type_t; + +/** Standard USB device descriptor. + */ +typedef struct { + /** Size of this descriptor in bytes. */ + uint8_t length; + /** Descriptor type (USB_DESCTYPE_DEVICE). */ + uint8_t descriptor_type; + /** USB specification release number. + * The number shall be coded as binary-coded decimal (BCD). + */ + uint16_t usb_spec_version; + /** Device class. */ + uint8_t device_class; + /** Device sub-class. */ + uint8_t device_subclass; + /** Device protocol. */ + uint8_t device_protocol; + /** Maximum packet size for endpoint zero. + * Valid values are only 8, 16, 32, 64). + */ + uint8_t max_packet_size; + /** Vendor ID. */ + uint16_t vendor_id; + /** Product ID. */ + uint16_t product_id; + /** Device release number (in BCD). */ + uint16_t device_version; + /** Manufacturer descriptor index. */ + uint8_t str_manufacturer; + /** Product descriptor index. */ + uint8_t str_product; + /** Device serial number descriptor index. */ + uint8_t str_serial_number; + /** Number of possible configurations. */ + uint8_t configuration_count; +} __attribute__ ((packed)) usb_standard_device_descriptor_t; + +/** Standard USB configuration descriptor. + */ +typedef struct { + /** Size of this descriptor in bytes. */ + uint8_t length; + /** Descriptor type (USB_DESCTYPE_CONFIGURATION). */ + uint8_t descriptor_type; + /** Total length of all data of this configuration. + * This includes the combined length of all descriptors + * (configuration, interface, endpoint, class-specific and + * vendor-specific) valid for this configuration. + */ + uint16_t total_length; + /** Number of possible interfaces under this configuration. */ + uint8_t interface_count; + /** Configuration value used when setting this configuration. */ + uint8_t configuration_number; + /** String descriptor describing this configuration. */ + uint8_t str_configuration; + /** Attribute bitmap. */ + uint8_t attributes; + /** Maximum power consumption from the USB under this configuration. + * Expressed in 2mA unit (e.g. 50 ~ 100mA). + */ + uint8_t max_power; +} __attribute__ ((packed)) usb_standard_configuration_descriptor_t; + +/** Standard USB interface descriptor. + */ +typedef struct { + /** Size of this descriptor in bytes. */ + uint8_t length; + /** Descriptor type (USB_DESCTYPE_INTERFACE). */ + uint8_t descriptor_type; + /** Number of interface. + * Zero-based index into array of interfaces for current configuration. + */ + uint8_t interface_number; + /** Alternate setting for value in interface_number. */ + uint8_t alternate_setting; + /** Number of endpoints used by this interface. + * This number must exclude usage of endpoint zero + * (default control pipe). + */ + uint8_t endpoint_count; + /** Class code. */ + uint8_t interface_class; + /** Subclass code. */ + uint8_t interface_subclass; + /** Protocol code. */ + uint8_t interface_protocol; + /** String descriptor describing this interface. */ + uint8_t str_interface; +} __attribute__ ((packed)) usb_standard_interface_descriptor_t; + +/** Standard USB endpoint descriptor. + */ +typedef struct { + /** Size of this descriptor in bytes. */ + uint8_t length; + /** Descriptor type (USB_DESCTYPE_ENDPOINT). */ + uint8_t descriptor_type; + /** Endpoint address together with data flow direction. */ + uint8_t endpoint_address; + /** Endpoint attributes. + * Includes transfer type (usb_transfer_type_t). + */ + uint8_t attributes; + /** Maximum packet size. */ + uint16_t max_packet_size; + /** Polling interval in milliseconds. + * Ignored for bulk and control endpoints. + * Isochronous endpoints must use value 1. + * Interrupt endpoints any value from 1 to 255. + */ + uint8_t poll_interval; +} __attribute__ ((packed)) usb_standard_endpoint_descriptor_t; + +#endif +/** + * @} + */ Index: uspace/lib/usb/include/usb/devdrv.h =================================================================== --- uspace/lib/usb/include/usb/devdrv.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/devdrv.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,118 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * USB device driver framework. + */ +#ifndef LIBUSB_DEVDRV_H_ +#define LIBUSB_DEVDRV_H_ + +#include + +/** Descriptors for USB device. */ +typedef struct { + /** Standard device descriptor. */ + usb_standard_device_descriptor_t device; + /** Full configuration descriptor of current configuration. */ + uint8_t *configuration; + size_t configuration_size; +} usb_device_descriptors_t; + +/** USB device structure. */ +typedef struct { + /** The default control pipe. */ + usb_pipe_t ctrl_pipe; + /** Other endpoint pipes. + * This is an array of other endpoint pipes in the same order as + * in usb_driver_t. + */ + usb_endpoint_mapping_t *pipes; + /** Current interface. + * Usually, drivers operate on single interface only. + * This item contains the value of the interface or -1 for any. + */ + int interface_no; + + /** Some useful descriptors. */ + usb_device_descriptors_t descriptors; + + /** Generic DDF device backing this one. */ + ddf_dev_t *ddf_dev; + /** Custom driver data. + * Do not use the entry in generic device, that is already used + * by the framework. + */ + void *driver_data; + + /** Connection backing the pipes. + * Typically, you will not need to use this attribute at all. + */ + usb_device_connection_t wire; +} usb_device_t; + +/** USB driver ops. */ +typedef struct { + /** Callback when new device is about to be controlled by the driver. */ + int (*add_device)(usb_device_t *); +} usb_driver_ops_t; + +/** USB driver structure. */ +typedef struct { + /** Driver name. + * This name is copied to the generic driver name and must be exactly + * the same as the directory name where the driver executable resides. + */ + const char *name; + /** Expected endpoints description, excluding default control endpoint. + * + * It MUST be of size expected_enpoints_count(excluding default ctrl) + 1 + * where the last record MUST BE NULL, otherwise catastrophic things may + * happen. + */ + usb_endpoint_description_t **endpoints; + /** Driver ops. */ + usb_driver_ops_t *ops; +} usb_driver_t; + +int usb_driver_main(usb_driver_t *); + +typedef bool (*usb_polling_callback_t)(usb_device_t *, + uint8_t *, size_t, void *); +typedef void (*usb_polling_terminted_callback_t)(usb_device_t *, bool, void *); + + +int usb_device_auto_poll(usb_device_t *, size_t, + usb_polling_callback_t, size_t, usb_polling_terminted_callback_t, void *); + +#endif +/** + * @} + */ Index: uspace/lib/usb/include/usb/dp.h =================================================================== --- uspace/lib/usb/include/usb/dp.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/dp.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,85 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * USB descriptor parser. + */ +#ifndef LIBUSB_DP_H_ +#define LIBUSB_DP_H_ + +#include +#include +#include + +/** USB descriptors nesting. + * The nesting describes the logical tree USB descriptors form + * (e.g. that endpoint descriptor belongs to interface or that + * interface belongs to configuration). + * + * See usb_descriptor_type_t for descriptor constants. + */ +typedef struct { + /** Child descriptor id. */ + int child; + /** Parent descriptor id. */ + int parent; +} usb_dp_descriptor_nesting_t; + +extern usb_dp_descriptor_nesting_t usb_dp_standard_descriptor_nesting[]; + +/** Descriptor parser structure. */ +typedef struct { + /** Used descriptor nesting. */ + usb_dp_descriptor_nesting_t *nesting; +} usb_dp_parser_t; + +/** Descriptor parser data. */ +typedef struct { + /** Data to be parsed. */ + uint8_t *data; + /** Size of input data in bytes. */ + size_t size; + /** Custom argument. */ + void *arg; +} usb_dp_parser_data_t; + +uint8_t *usb_dp_get_nested_descriptor(usb_dp_parser_t *, + usb_dp_parser_data_t *, uint8_t *); +uint8_t *usb_dp_get_sibling_descriptor(usb_dp_parser_t *, + usb_dp_parser_data_t *, uint8_t *, uint8_t *); + +void usb_dp_walk_simple(uint8_t *, size_t, usb_dp_descriptor_nesting_t *, + void (*)(uint8_t *, size_t, void *), void *); + +#endif +/** + * @} + */ Index: uspace/lib/usb/include/usb/host/batch.h =================================================================== --- uspace/lib/usb/include/usb/host/batch.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/host/batch.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,96 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup libusb + * @{ + */ +/** @file + * USB transfer transaction structures. + */ +#ifndef LIBUSB_HOST_BATCH_H +#define LIBUSB_HOST_BATCH_H + +#include + +#include +#include + +typedef struct usb_transfer_batch usb_transfer_batch_t; +struct usb_transfer_batch { + link_t link; + usb_target_t target; + usb_transfer_type_t transfer_type; + usb_speed_t speed; + usb_direction_t direction; + usbhc_iface_transfer_in_callback_t callback_in; + usbhc_iface_transfer_out_callback_t callback_out; + char *buffer; + char *transport_buffer; + size_t buffer_size; + char *setup_buffer; + size_t setup_size; + size_t max_packet_size; + size_t transfered_size; + void (*next_step)(usb_transfer_batch_t *); + int error; + ddf_fun_t *fun; + void *arg; + void *private_data; +}; + +void usb_transfer_batch_init( + usb_transfer_batch_t *instance, + usb_target_t target, + usb_transfer_type_t transfer_type, + usb_speed_t speed, + size_t max_packet_size, + char *buffer, + char *transport_buffer, + size_t buffer_size, + char *setup_buffer, + size_t setup_size, + usbhc_iface_transfer_in_callback_t func_in, + usbhc_iface_transfer_out_callback_t func_out, + void *arg, + ddf_fun_t *fun, + void *private_data +); + +static inline usb_transfer_batch_t *usb_transfer_batch_from_link(link_t *l) +{ + assert(l); + return list_get_instance(l, usb_transfer_batch_t, link); +} + +void usb_transfer_batch_call_in(usb_transfer_batch_t *instance); +void usb_transfer_batch_call_out(usb_transfer_batch_t *instance); +void usb_transfer_batch_finish(usb_transfer_batch_t *instance, int error); + +#endif +/** + * @} + */ Index: uspace/lib/usb/include/usb/host/device_keeper.h =================================================================== --- uspace/lib/usb/include/usb/host/device_keeper.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/host/device_keeper.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,109 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * Device keeper structure and functions. + * + * Typical USB host controller needs to keep track of various settings for + * each device that is connected to it. + * State of toggle bit, device speed etc. etc. + * This structure shall simplify the management. + */ +#ifndef LIBUSB_HOST_DEVICE_KEEPER_H +#define LIBUSB_HOST_DEVICE_KEEPER_H +#include +#include +#include + +/** Number of USB address for array dimensions. */ +#define USB_ADDRESS_COUNT (USB11_ADDRESS_MAX + 1) + +/** Information about attached USB device. */ +struct usb_device_info { + usb_speed_t speed; + bool occupied; + bool control_used; + uint16_t toggle_status[2]; + devman_handle_t handle; +}; + +/** Host controller device keeper. + * You shall not access members directly but only using functions below. + */ +typedef struct { + struct usb_device_info devices[USB_ADDRESS_COUNT]; + fibril_mutex_t guard; + fibril_condvar_t change; + usb_address_t last_address; +} usb_device_keeper_t; + +void usb_device_keeper_init(usb_device_keeper_t *instance); + +void usb_device_keeper_reserve_default_address(usb_device_keeper_t *instance, + usb_speed_t speed); + +void usb_device_keeper_release_default_address(usb_device_keeper_t *instance); + +void usb_device_keeper_reset_if_need(usb_device_keeper_t *instance, + usb_target_t target, + const uint8_t *setup_data); + +int usb_device_keeper_get_toggle(usb_device_keeper_t *instance, + usb_target_t target, usb_direction_t direction); + +int usb_device_keeper_set_toggle(usb_device_keeper_t *instance, + usb_target_t target, usb_direction_t direction, bool toggle); + +usb_address_t device_keeper_get_free_address(usb_device_keeper_t *instance, + usb_speed_t speed); + +void usb_device_keeper_bind(usb_device_keeper_t *instance, + usb_address_t address, devman_handle_t handle); + +void usb_device_keeper_release(usb_device_keeper_t *instance, + usb_address_t address); + +usb_address_t usb_device_keeper_find(usb_device_keeper_t *instance, + devman_handle_t handle); + +usb_speed_t usb_device_keeper_get_speed(usb_device_keeper_t *instance, + usb_address_t address); + +void usb_device_keeper_use_control(usb_device_keeper_t *instance, + usb_address_t address); + +void usb_device_keeper_release_control(usb_device_keeper_t *instance, + usb_address_t address); + +#endif +/** + * @} + */ Index: uspace/lib/usb/include/usb/hub.h =================================================================== --- uspace/lib/usb/include/usb/hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,72 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * Functions needed by hub drivers. + * + * For class specific requests, see usb/classes/hub.h. + */ +#ifndef LIBUSB_HUB_H_ +#define LIBUSB_HUB_H_ + +#include +#include + +int usb_hc_new_device_wrapper(ddf_dev_t *, usb_hc_connection_t *, usb_speed_t, + int (*)(int, void *), int, void *, + usb_address_t *, devman_handle_t *, + ddf_dev_ops_t *, void *, ddf_fun_t **); + +/** Info about device attached to host controller. + * + * This structure exists only to keep the same signature of + * usb_hc_register_device() when more properties of the device + * would have to be passed to the host controller. + */ +typedef struct { + /** Device address. */ + usb_address_t address; + /** Devman handle of the device. */ + devman_handle_t handle; +} usb_hc_attached_device_t; + +int usb_hc_reserve_default_address(usb_hc_connection_t *, usb_speed_t); +int usb_hc_release_default_address(usb_hc_connection_t *); + +usb_address_t usb_hc_request_address(usb_hc_connection_t *, usb_speed_t); +int usb_hc_register_device(usb_hc_connection_t *, + const usb_hc_attached_device_t *); +int usb_hc_unregister_device(usb_hc_connection_t *, usb_address_t); + +#endif +/** + * @} + */ Index: uspace/lib/usb/include/usb/pipes.h =================================================================== --- uspace/lib/usb/include/usb/pipes.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/pipes.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,152 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * USB pipes representation. + */ +#ifndef LIBUSB_PIPES_H_ +#define LIBUSB_PIPES_H_ + +#include +#include +#include +#include +#include +#include + +/** Abstraction of a physical connection to the device. + * This type is an abstraction of the USB wire that connects the host and + * the function (device). + */ +typedef struct { + /** Handle of the host controller device is connected to. */ + devman_handle_t hc_handle; + /** Address of the device. */ + usb_address_t address; +} usb_device_connection_t; + +/** Abstraction of a logical connection to USB device endpoint. + * It encapsulates endpoint attributes (transfer type etc.) as well + * as information about currently running sessions. + * This endpoint must be bound with existing usb_device_connection_t + * (i.e. the wire to send data over). + */ +typedef struct { + /** The connection used for sending the data. */ + usb_device_connection_t *wire; + + /** Endpoint number. */ + usb_endpoint_t endpoint_no; + + /** Endpoint transfer type. */ + usb_transfer_type_t transfer_type; + + /** Endpoint direction. */ + usb_direction_t direction; + + /** Maximum packet size for the endpoint. */ + size_t max_packet_size; + + /** Phone to the host controller. + * Negative when no session is active. + */ + int hc_phone; +} usb_pipe_t; + + +/** Description of endpoint characteristics. */ +typedef struct { + /** Transfer type (e.g. control or interrupt). */ + usb_transfer_type_t transfer_type; + /** Transfer direction (to or from a device). */ + usb_direction_t direction; + /** Interface class this endpoint belongs to (-1 for any). */ + int interface_class; + /** Interface subclass this endpoint belongs to (-1 for any). */ + int interface_subclass; + /** Interface protocol this endpoint belongs to (-1 for any). */ + int interface_protocol; + /** Extra endpoint flags. */ + unsigned int flags; +} usb_endpoint_description_t; + +/** Mapping of endpoint pipes and endpoint descriptions. */ +typedef struct { + /** Endpoint pipe. */ + usb_pipe_t *pipe; + /** Endpoint description. */ + const usb_endpoint_description_t *description; + /** Interface number the endpoint must belong to (-1 for any). */ + int interface_no; + /** Found descriptor fitting the description. */ + usb_standard_endpoint_descriptor_t *descriptor; + /** Interface descriptor the endpoint belongs to. */ + usb_standard_interface_descriptor_t *interface; + /** Whether the endpoint was actually found. */ + bool present; +} usb_endpoint_mapping_t; + +int usb_device_connection_initialize_on_default_address( + usb_device_connection_t *, usb_hc_connection_t *); +int usb_device_connection_initialize_from_device(usb_device_connection_t *, + ddf_dev_t *); +int usb_device_connection_initialize(usb_device_connection_t *, + devman_handle_t, usb_address_t); + +int usb_device_get_assigned_interface(ddf_dev_t *); +usb_address_t usb_device_get_assigned_address(devman_handle_t); + +int usb_pipe_initialize(usb_pipe_t *, usb_device_connection_t *, + usb_endpoint_t, usb_transfer_type_t, size_t, usb_direction_t); +int usb_pipe_initialize_default_control(usb_pipe_t *, + usb_device_connection_t *); +int usb_pipe_probe_default_control(usb_pipe_t *); +int usb_pipe_initialize_from_configuration(usb_endpoint_mapping_t *, + size_t, uint8_t *, size_t, usb_device_connection_t *); +int usb_pipe_register(usb_pipe_t *, unsigned int, usb_hc_connection_t *); +int usb_pipe_unregister(usb_pipe_t *, usb_hc_connection_t *); + +int usb_pipe_start_session(usb_pipe_t *); +int usb_pipe_end_session(usb_pipe_t *); +bool usb_pipe_is_session_started(usb_pipe_t *); + +int usb_pipe_read(usb_pipe_t *, void *, size_t, size_t *); +int usb_pipe_write(usb_pipe_t *, void *, size_t); + +int usb_pipe_control_read(usb_pipe_t *, void *, size_t, + void *, size_t, size_t *); +int usb_pipe_control_write(usb_pipe_t *, void *, size_t, + void *, size_t); + +#endif +/** + * @} + */ Index: uspace/lib/usb/include/usb/recognise.h =================================================================== --- uspace/lib/usb/include/usb/recognise.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/recognise.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * USB device recognition. + */ +#ifndef LIBUSB_RECOGNISE_H_ +#define LIBUSB_RECOGNISE_H_ + +#include +#include +#include +#include + +int usb_device_create_match_ids_from_device_descriptor( + const usb_standard_device_descriptor_t *, match_id_list_t *); + +int usb_device_create_match_ids_from_interface( + const usb_standard_device_descriptor_t *, + const usb_standard_interface_descriptor_t *, match_id_list_t *); + +int usb_device_create_match_ids(usb_pipe_t *, match_id_list_t *); + +int usb_device_register_child_in_devman(usb_address_t, devman_handle_t, + ddf_dev_t *, devman_handle_t *, ddf_dev_ops_t *, void *, ddf_fun_t **); + +#endif +/** + * @} + */ Index: uspace/lib/usb/include/usb/request.h =================================================================== --- uspace/lib/usb/include/usb/request.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/request.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,140 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * Standard USB requests. + */ +#ifndef LIBUSB_REQUEST_H_ +#define LIBUSB_REQUEST_H_ + +#include +#include +#include +#include +#include + +/** USB device status - device is self powered (opposed to bus powered). */ +#define USB_DEVICE_STATUS_SELF_POWERED ((uint16_t)(1 << 0)) + +/** USB device status - remote wake-up signaling is enabled. */ +#define USB_DEVICE_STATUS_REMOTE_WAKEUP ((uint16_t)(1 << 1)) + +/** USB endpoint status - endpoint is halted (stalled). */ +#define USB_ENDPOINT_STATUS_HALTED ((uint16_t)(1 << 0)) + +/** Standard device request. */ +typedef enum { + USB_DEVREQ_GET_STATUS = 0, + USB_DEVREQ_CLEAR_FEATURE = 1, + USB_DEVREQ_SET_FEATURE = 3, + USB_DEVREQ_SET_ADDRESS = 5, + USB_DEVREQ_GET_DESCRIPTOR = 6, + USB_DEVREQ_SET_DESCRIPTOR = 7, + USB_DEVREQ_GET_CONFIGURATION = 8, + USB_DEVREQ_SET_CONFIGURATION = 9, + USB_DEVREQ_GET_INTERFACE = 10, + USB_DEVREQ_SET_INTERFACE = 11, + USB_DEVREQ_SYNCH_FRAME = 12, + USB_DEVREQ_LAST_STD +} usb_stddevreq_t; + +/** Device request setup packet. + * The setup packet describes the request. + */ +typedef struct { + /** Request type. + * The type combines transfer direction, request type and + * intended recipient. + */ + uint8_t request_type; + /** Request identification. */ + uint8_t request; + /** Main parameter to the request. */ + union { + uint16_t value; + /* FIXME: add #ifdefs according to host endianness */ + struct { + uint8_t value_low; + uint8_t value_high; + }; + }; + /** Auxiliary parameter to the request. + * Typically, it is offset to something. + */ + uint16_t index; + /** Length of extra data. */ + uint16_t length; +} __attribute__ ((packed)) usb_device_request_setup_packet_t; + +int usb_control_request_set(usb_pipe_t *, + usb_request_type_t, usb_request_recipient_t, uint8_t, + uint16_t, uint16_t, void *, size_t); + +int usb_control_request_get(usb_pipe_t *, + usb_request_type_t, usb_request_recipient_t, uint8_t, + uint16_t, uint16_t, void *, size_t, size_t *); + +int usb_request_get_status(usb_pipe_t *, usb_request_recipient_t, + uint16_t, uint16_t *); +int usb_request_clear_feature(usb_pipe_t *, usb_request_type_t, + usb_request_recipient_t, uint16_t, uint16_t); +int usb_request_set_feature(usb_pipe_t *, usb_request_type_t, + usb_request_recipient_t, uint16_t, uint16_t); +int usb_request_set_address(usb_pipe_t *, usb_address_t); +int usb_request_get_descriptor(usb_pipe_t *, usb_request_type_t, + usb_request_recipient_t, uint8_t, uint8_t, uint16_t, void *, size_t, + size_t *); +int usb_request_get_descriptor_alloc(usb_pipe_t *, usb_request_type_t, + usb_request_recipient_t, uint8_t, uint8_t, uint16_t, void **, size_t *); +int usb_request_get_device_descriptor(usb_pipe_t *, + usb_standard_device_descriptor_t *); +int usb_request_get_bare_configuration_descriptor(usb_pipe_t *, int, + usb_standard_configuration_descriptor_t *); +int usb_request_get_full_configuration_descriptor(usb_pipe_t *, int, + void *, size_t, size_t *); +int usb_request_get_full_configuration_descriptor_alloc(usb_pipe_t *, + int, void **, size_t *); +int usb_request_set_descriptor(usb_pipe_t *, usb_request_type_t, + usb_request_recipient_t, uint8_t, uint8_t, uint16_t, void *, size_t); +int usb_request_get_configuration(usb_pipe_t *, uint8_t *); +int usb_request_set_configuration(usb_pipe_t *, uint8_t); +int usb_request_get_interface(usb_pipe_t *, uint8_t, uint8_t *); +int usb_request_set_interface(usb_pipe_t *, uint8_t, uint8_t); + +int usb_request_get_supported_languages(usb_pipe_t *, + l18_win_locales_t **, size_t *); +int usb_request_get_string(usb_pipe_t *, size_t, l18_win_locales_t, + char **); + +#endif +/** + * @} + */ Index: uspace/lib/usb/include/usb/usb.h =================================================================== --- uspace/lib/usb/include/usb/usb.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/usb.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,174 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * Common USB types and functions. + */ +#ifndef LIBUSB_USB_H_ +#define LIBUSB_USB_H_ + +#include +#include + +/** Convert 16bit value from native (host) endianness to USB endianness. */ +#define uint16_host2usb(n) host2uint16_t_le((n)) + +/** Convert 32bit value from native (host) endianness to USB endianness. */ +#define uint32_host2usb(n) host2uint32_t_le((n)) + +/** Convert 16bit value from USB endianness into native (host) one. */ +#define uint16_usb2host(n) uint16_t_le2host((n)) + +/** Convert 32bit value from USB endianness into native (host) one. */ +#define uint32_usb2host(n) uint32_t_le2host((n)) + + +/** USB transfer type. */ +typedef enum { + USB_TRANSFER_CONTROL = 0, + USB_TRANSFER_ISOCHRONOUS = 1, + USB_TRANSFER_BULK = 2, + USB_TRANSFER_INTERRUPT = 3 +} usb_transfer_type_t; + +const char * usb_str_transfer_type(usb_transfer_type_t t); +const char * usb_str_transfer_type_short(usb_transfer_type_t t); + +/** USB data transfer direction. */ +typedef enum { + USB_DIRECTION_IN, + USB_DIRECTION_OUT, + USB_DIRECTION_BOTH +} usb_direction_t; + +/** USB speeds. */ +typedef enum { + /** USB 1.1 low speed (1.5Mbits/s). */ + USB_SPEED_LOW, + /** USB 1.1 full speed (12Mbits/s). */ + USB_SPEED_FULL, + /** USB 2.0 high speed (480Mbits/s). */ + USB_SPEED_HIGH +} usb_speed_t; + +const char *usb_str_speed(usb_speed_t); + + +/** USB request type target. */ +typedef enum { + USB_REQUEST_TYPE_STANDARD = 0, + USB_REQUEST_TYPE_CLASS = 1, + USB_REQUEST_TYPE_VENDOR = 2 +} usb_request_type_t; + +/** USB request recipient. */ +typedef enum { + USB_REQUEST_RECIPIENT_DEVICE = 0, + USB_REQUEST_RECIPIENT_INTERFACE = 1, + USB_REQUEST_RECIPIENT_ENDPOINT = 2 +} usb_request_recipient_t; + +/** USB address type. + * Negative values could be used to indicate error. + */ +typedef int usb_address_t; + +/** Default USB address. */ +#define USB_ADDRESS_DEFAULT 0 +/** Maximum address number in USB 1.1. */ +#define USB11_ADDRESS_MAX 128 + +/** USB endpoint number type. + * Negative values could be used to indicate error. + */ +typedef int usb_endpoint_t; + +/** Maximum endpoint number in USB 1.1. + */ +#define USB11_ENDPOINT_MAX 16 + + +/** USB complete address type. + * Pair address + endpoint is identification of transaction recipient. + */ +typedef struct { + usb_address_t address; + usb_endpoint_t endpoint; +} usb_target_t; + +/** Compare USB targets (addresses and endpoints). + * + * @param a First target. + * @param b Second target. + * @return Whether @p a and @p b points to the same pipe on the same device. + */ +static inline int usb_target_same(usb_target_t a, usb_target_t b) +{ + return (a.address == b.address) + && (a.endpoint == b.endpoint); +} + +/** General handle type. + * Used by various USB functions as opaque handle. + */ +typedef sysarg_t usb_handle_t; + +/** USB packet identifier. */ +typedef enum { +#define _MAKE_PID_NIBBLE(tag, type) \ + ((uint8_t)(((tag) << 2) | (type))) +#define _MAKE_PID(tag, type) \ + ( \ + _MAKE_PID_NIBBLE(tag, type) \ + | ((~_MAKE_PID_NIBBLE(tag, type)) << 4) \ + ) + USB_PID_OUT = _MAKE_PID(0, 1), + USB_PID_IN = _MAKE_PID(2, 1), + USB_PID_SOF = _MAKE_PID(1, 1), + USB_PID_SETUP = _MAKE_PID(3, 1), + + USB_PID_DATA0 = _MAKE_PID(0 ,3), + USB_PID_DATA1 = _MAKE_PID(2 ,3), + + USB_PID_ACK = _MAKE_PID(0 ,2), + USB_PID_NAK = _MAKE_PID(2 ,2), + USB_PID_STALL = _MAKE_PID(3 ,2), + + USB_PID_PRE = _MAKE_PID(3 ,0), + /* USB_PID_ = _MAKE_PID( ,), */ +#undef _MAKE_PID +#undef _MAKE_PID_NIBBLE +} usb_packet_id; + +#endif +/** + * @} + */ Index: uspace/lib/usb/include/usb/usbdevice.h =================================================================== --- uspace/lib/usb/include/usb/usbdevice.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/include/usb/usbdevice.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,67 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * General communication between device drivers and host controller driver. + */ +#ifndef LIBUSB_USBDEVICE_H_ +#define LIBUSB_USBDEVICE_H_ + +#include +#include +#include +#include +#include + +/** Connection to the host controller driver. */ +typedef struct { + /** Devman handle of the host controller. */ + devman_handle_t hc_handle; + /** Phone to the host controller. */ + int hc_phone; +} usb_hc_connection_t; + +int usb_hc_find(devman_handle_t, devman_handle_t *); + +int usb_hc_connection_initialize_from_device(usb_hc_connection_t *, + ddf_dev_t *); +int usb_hc_connection_initialize(usb_hc_connection_t *, devman_handle_t); + +int usb_hc_connection_open(usb_hc_connection_t *); +bool usb_hc_connection_is_opened(const usb_hc_connection_t *); +int usb_hc_connection_close(usb_hc_connection_t *); + + + +#endif +/** + * @} + */ Index: uspace/lib/usb/src/addrkeep.c =================================================================== --- uspace/lib/usb/src/addrkeep.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/addrkeep.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,347 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * @brief Address keeping. + */ +#include +#include +#include + +/** For loop over all used addresses in address keeping. + * + * @param link Iterator. + * @param addresses Addresses keeping structure to iterate. + */ +#define for_all_used_addresses(link, addresses) \ + for (link = (addresses)->used_addresses.next; \ + link != &(addresses)->used_addresses; \ + link = link->next) + +/** Get instance of usb_address_keeping_used_t. */ +#define used_address_get_instance(lnk) \ + list_get_instance(lnk, usb_address_keeping_used_t, link) + +/** Invalid value of devman handle. */ +#define INVALID_DEVMAN_HANDLE \ + ((devman_handle_t)-1) + +/** Creates structure for used USB address. + * + * @param address USB address. + * @return Initialized structure. + * @retval NULL Out of memory. + */ +static usb_address_keeping_used_t *usb_address_keeping_used_create( + usb_address_t address) +{ + usb_address_keeping_used_t *info + = malloc(sizeof(usb_address_keeping_used_t)); + if (info == NULL) { + return NULL; + } + + info->address = address; + info->devman_handle = INVALID_DEVMAN_HANDLE; + list_initialize(&info->link); + return info; +} + +/** Destroys structure for used USB address. + * + * @param info Structure to be destroyed. + */ +static void usb_address_keeping_used_destroy(usb_address_keeping_used_t *info) +{ + free(info); +} + +/** Find used USB address structure by USB address. + * + * It is expected that guard mutex is already locked. + * + * @param addresses Address keeping info. + * @param address Address to be found. + * @return Structure describing looked for address. + * @retval NULL Address not found. + */ +static usb_address_keeping_used_t *usb_address_keeping_used_find_no_lock( + usb_address_keeping_t *addresses, usb_address_t address) +{ + link_t *link; + for_all_used_addresses(link, addresses) { + usb_address_keeping_used_t *info + = used_address_get_instance(link); + + if (info->address == address) { + return info; + } + } + + return NULL; +} + +/** Initialize address keeping structure. + * + * @param addresses Address keeping info. + * @param max_address Maximum USB address (exclusive bound). + */ +void usb_address_keeping_init(usb_address_keeping_t *addresses, + usb_address_t max_address) +{ + /* + * Items related with used addresses. + */ + addresses->max_address = max_address; + list_initialize(&addresses->used_addresses); + fibril_mutex_initialize(&addresses->used_addresses_guard); + fibril_condvar_initialize(&addresses->used_addresses_condvar); + + /* + * Items related with default address. + */ + addresses->default_available = true; + fibril_condvar_initialize(&addresses->default_condvar); + fibril_mutex_initialize(&addresses->default_condvar_guard); +} + +/** Reserved default USB address. + * + * This function blocks until reserved address is available. + * + * @see usb_address_keeping_release_default + * + * @param addresses Address keeping info. + */ +void usb_address_keeping_reserve_default(usb_address_keeping_t *addresses) +{ + fibril_mutex_lock(&addresses->default_condvar_guard); + while (!addresses->default_available) { + fibril_condvar_wait(&addresses->default_condvar, + &addresses->default_condvar_guard); + } + addresses->default_available = false; + fibril_mutex_unlock(&addresses->default_condvar_guard); +} + +/** Releases default USB address. + * + * @see usb_address_keeping_reserve_default + * + * @param addresses Address keeping info. + */ +void usb_address_keeping_release_default(usb_address_keeping_t *addresses) +{ + fibril_mutex_lock(&addresses->default_condvar_guard); + addresses->default_available = true; + fibril_condvar_signal(&addresses->default_condvar); + fibril_mutex_unlock(&addresses->default_condvar_guard); +} + +/** Request free address assignment. + * + * This function does not block when there are not free addresses to be + * assigned. + * + * @param addresses Address keeping info. + * @return USB address that could be used or negative error code. + * @retval ELIMIT No more addresses to assign. + * @retval ENOMEM Out of memory. + */ +usb_address_t usb_address_keeping_request(usb_address_keeping_t *addresses) +{ + usb_address_t previous_address = 0; + usb_address_t free_address = 0; + + fibril_mutex_lock(&addresses->used_addresses_guard); + link_t *new_address_position; + if (list_empty(&addresses->used_addresses)) { + free_address = 1; + new_address_position = addresses->used_addresses.next; + } else { + usb_address_keeping_used_t *first + = used_address_get_instance(addresses->used_addresses.next); + previous_address = first->address; + + for_all_used_addresses(new_address_position, addresses) { + usb_address_keeping_used_t *info + = used_address_get_instance(new_address_position); + if (info->address > previous_address + 1) { + free_address = previous_address + 1; + break; + } + previous_address = info->address; + } + + if (free_address == 0) { + usb_address_keeping_used_t *last + = used_address_get_instance(addresses->used_addresses.next); + free_address = last->address + 1; + } + } + + if (free_address >= addresses->max_address) { + free_address = ELIMIT; + goto leave; + } + + usb_address_keeping_used_t *used + = usb_address_keeping_used_create(free_address); + if (used == NULL) { + free_address = ENOMEM; + goto leave; + } + + list_prepend(&used->link, new_address_position); + +leave: + fibril_mutex_unlock(&addresses->used_addresses_guard); + + return free_address; +} + +/** Release USB address. + * + * @param addresses Address keeping info. + * @param address Address to be released. + * @return Error code. + * @retval ENOENT Address is not in use. + */ +int usb_address_keeping_release(usb_address_keeping_t *addresses, + usb_address_t address) +{ + int rc = ENOENT; + + fibril_mutex_lock(&addresses->used_addresses_guard); + + usb_address_keeping_used_t *info + = usb_address_keeping_used_find_no_lock(addresses, address); + + if (info != NULL) { + rc = EOK; + list_remove(&info->link); + usb_address_keeping_used_destroy(info); + } + + fibril_mutex_unlock(&addresses->used_addresses_guard); + + return rc; +} + +/** Bind devman handle with USB address. + * + * When the @p address is invalid (e.g. no such entry), the request + * is silently ignored. + * + * @param addresses Address keeping info. + * @param address USB address. + * @param handle Devman handle. + */ +void usb_address_keeping_devman_bind(usb_address_keeping_t *addresses, + usb_address_t address, devman_handle_t handle) +{ + fibril_mutex_lock(&addresses->used_addresses_guard); + + usb_address_keeping_used_t *info + = usb_address_keeping_used_find_no_lock(addresses, address); + if (info == NULL) { + goto leave; + } + + assert(info->address == address); + info->devman_handle = handle; + + /* + * Inform that new handle was added. + */ + fibril_condvar_broadcast(&addresses->used_addresses_condvar); + +leave: + fibril_mutex_unlock(&addresses->used_addresses_guard); +} + +/** Find address by its devman handle. + * + * @param addresses Address keeping info. + * @param handle Devman handle. + * @return USB address or negative error code. + * @retval ENOENT No such address. + */ +static usb_address_t usb_address_keeping_find_no_lock( + usb_address_keeping_t *addresses, devman_handle_t handle) +{ + usb_address_t address = ENOENT; + + link_t *link; + for_all_used_addresses(link, addresses) { + usb_address_keeping_used_t *info + = used_address_get_instance(link); + + if (info->devman_handle == handle) { + address = info->address; + break; + } + } + + return address; +} + +/** Find USB address by its devman handle. + * + * This function blocks until corresponding address is found. + * + * @param addresses Address keeping info. + * @param handle Devman handle. + * @return USB address or negative error code. + */ +usb_address_t usb_address_keeping_find(usb_address_keeping_t *addresses, + devman_handle_t handle) +{ + usb_address_t address = ENOENT; + + fibril_mutex_lock(&addresses->used_addresses_guard); + while (true) { + address = usb_address_keeping_find_no_lock(addresses, handle); + if (address != ENOENT) { + break; + } + fibril_condvar_wait(&addresses->used_addresses_condvar, + &addresses->used_addresses_guard); + } + + fibril_mutex_unlock(&addresses->used_addresses_guard); + + return address; +} + +/** + * @} + */ Index: uspace/lib/usb/src/class.c =================================================================== --- uspace/lib/usb/src/class.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/class.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,92 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * @brief Class related functions. + */ +#include +#include + +/** Tell string representation of USB class. + * + * @param cls Class code. + * @return String representation. + */ +const char *usb_str_class(usb_class_t cls) +{ + switch (cls) { + case USB_CLASS_USE_INTERFACE: + return "use-interface"; + case USB_CLASS_AUDIO: + return "audio"; + case USB_CLASS_COMMUNICATIONS_CDC_CONTROL: + return "communications"; + case USB_CLASS_HID: + return "HID"; + case USB_CLASS_PHYSICAL: + return "physical"; + case USB_CLASS_IMAGE: + return "image"; + case USB_CLASS_PRINTER: + return "printer"; + case USB_CLASS_MASS_STORAGE: + return "mass-storage"; + case USB_CLASS_HUB: + return "hub"; + case USB_CLASS_CDC_DATA: + return "CDC"; + case USB_CLASS_SMART_CARD: + return "smart-card"; + case USB_CLASS_CONTENT_SECURITY: + return "security"; + case USB_CLASS_VIDEO: + return "video"; + case USB_CLASS_PERSONAL_HEALTHCARE: + return "healthcare"; + case USB_CLASS_DIAGNOSTIC: + return "diagnostic"; + case USB_CLASS_WIRELESS_CONTROLLER: + return "wireless"; + case USB_CLASS_MISCELLANEOUS: + return "misc"; + case USB_CLASS_APPLICATION_SPECIFIC: + return "application"; + case USB_CLASS_VENDOR_SPECIFIC: + return "vendor"; + default: + return "unknown"; + } +} + + +/** + * @} + */ Index: uspace/lib/usb/src/ddfiface.c =================================================================== --- uspace/lib/usb/src/ddfiface.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/ddfiface.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,171 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * Implementations of DDF interfaces functions (actual implementation). + */ +#include +#include +#include +#include +#include +#include +#include + +/** DDF interface for USB device, implementation for typical hub. */ +usb_iface_t usb_iface_hub_impl = { + .get_hc_handle = usb_iface_get_hc_handle_hub_impl, + .get_address = usb_iface_get_address_hub_impl +}; + +/** DDF interface for USB device, implementation for child of a typical hub. */ +usb_iface_t usb_iface_hub_child_impl = { + .get_hc_handle = usb_iface_get_hc_handle_hub_child_impl, + .get_address = usb_iface_get_address_hub_child_impl +}; + + +/** Get host controller handle, interface implementation for hub driver. + * + * @param[in] fun Device function the operation is running on. + * @param[out] handle Storage for the host controller handle. + * @return Error code. + */ +int usb_iface_get_hc_handle_hub_impl(ddf_fun_t *fun, devman_handle_t *handle) +{ + assert(fun); + return usb_hc_find(fun->handle, handle); +} + +/** Get host controller handle, interface implementation for child of + * a hub driver. + * + * @param[in] fun Device function the operation is running on. + * @param[out] handle Storage for the host controller handle. + * @return Error code. + */ +int usb_iface_get_hc_handle_hub_child_impl(ddf_fun_t *fun, + devman_handle_t *handle) +{ + assert(fun != NULL); + + int parent_phone = devman_parent_device_connect(fun->handle, + IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + + sysarg_t hc_handle; + int rc = async_req_1_1(parent_phone, DEV_IFACE_ID(USB_DEV_IFACE), + IPC_M_USB_GET_HOST_CONTROLLER_HANDLE, &hc_handle); + + async_hangup(parent_phone); + + if (rc != EOK) { + return rc; + } + + *handle = hc_handle; + + return EOK; +} + +/** Get host controller handle, interface implementation for HC driver. + * + * @param[in] fun Device function the operation is running on. + * @param[out] handle Storage for the host controller handle. + * @return Always EOK. + */ +int usb_iface_get_hc_handle_hc_impl(ddf_fun_t *fun, devman_handle_t *handle) +{ + assert(fun); + + if (handle != NULL) { + *handle = fun->handle; + } + + return EOK; +} + +/** Get USB device address, interface implementation for hub driver. + * + * @param[in] fun Device function the operation is running on. + * @param[in] handle Devman handle of USB device we want address of. + * @param[out] address Storage for USB address of device with handle @p handle. + * @return Error code. + */ +int usb_iface_get_address_hub_impl(ddf_fun_t *fun, devman_handle_t handle, + usb_address_t *address) +{ + assert(fun); + int parent_phone = devman_parent_device_connect(fun->handle, + IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + + sysarg_t addr; + int rc = async_req_2_1(parent_phone, DEV_IFACE_ID(USB_DEV_IFACE), + IPC_M_USB_GET_ADDRESS, handle, &addr); + + async_hangup(parent_phone); + + if (rc != EOK) { + return rc; + } + + if (address != NULL) { + *address = (usb_address_t) addr; + } + + return EOK; +} + +/** Get USB device address, interface implementation for child of + * a hub driver. + * + * @param[in] fun Device function the operation is running on. + * @param[in] handle Devman handle of USB device we want address of. + * @param[out] address Storage for USB address of device with handle @p handle. + * @return Error code. + */ +int usb_iface_get_address_hub_child_impl(ddf_fun_t *fun, + devman_handle_t handle, usb_address_t *address) +{ + if (handle == 0) { + handle = fun->handle; + } + return usb_iface_get_address_hub_impl(fun, handle, address); +} + +/** + * @} + */ Index: uspace/lib/usb/src/debug.c =================================================================== --- uspace/lib/usb/src/debug.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/debug.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,261 @@ +/* + * Copyright (c) 2010-2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * Debugging and logging support. + */ +#include +#include +#include +#include +#include +#include + +/** Level of logging messages. */ +static usb_log_level_t log_level = USB_LOG_LEVEL_WARNING; + +/** Prefix for logging messages. */ +static const char *log_prefix = "usb"; + +/** Serialization mutex for logging functions. */ +static FIBRIL_MUTEX_INITIALIZE(log_serializer); + +/** File where to store the log. */ +static FILE *log_stream = NULL; + + +/** Enable logging. + * + * @param level Maximal enabled level (including this one). + * @param message_prefix Prefix for each printed message. + */ +void usb_log_enable(usb_log_level_t level, const char *message_prefix) +{ + log_prefix = message_prefix; + log_level = level; + if (log_stream == NULL) { + char *fname; + int rc = asprintf(&fname, "/log/%s", message_prefix); + if (rc > 0) { + log_stream = fopen(fname, "w"); + free(fname); + } + } +} + +/** Get log level name prefix. + * + * @param level Log level. + * @return String prefix for the message. + */ +static const char *log_level_name(usb_log_level_t level) +{ + switch (level) { + case USB_LOG_LEVEL_FATAL: + return " FATAL"; + case USB_LOG_LEVEL_ERROR: + return " ERROR"; + case USB_LOG_LEVEL_WARNING: + return " WARN"; + case USB_LOG_LEVEL_INFO: + return " info"; + default: + return ""; + } +} + +/** Print logging message. + * + * @param level Verbosity level of the message. + * @param format Formatting directive. + */ +void usb_log_printf(usb_log_level_t level, const char *format, ...) +{ + FILE *screen_stream = NULL; + switch (level) { + case USB_LOG_LEVEL_FATAL: + case USB_LOG_LEVEL_ERROR: + screen_stream = stderr; + break; + default: + screen_stream = stdout; + break; + } + assert(screen_stream != NULL); + + va_list args; + + /* + * Serialize access to log files. + * Always print to log file, to screen print only when the enabled + * log level is high enough. + */ + fibril_mutex_lock(&log_serializer); + + const char *level_name = log_level_name(level); + + if (log_stream != NULL) { + va_start(args, format); + + fprintf(log_stream, "[%s]%s: ", log_prefix, level_name); + vfprintf(log_stream, format, args); + fflush(log_stream); + + va_end(args); + } + + if (level <= log_level) { + va_start(args, format); + + fprintf(screen_stream, "[%s]%s: ", log_prefix, level_name); + vfprintf(screen_stream, format, args); + fflush(screen_stream); + + va_end(args); + } + + fibril_mutex_unlock(&log_serializer); +} + + +#define REMAINDER_STR_FMT " (%zu)..." +/* string + terminator + number width (enough for 4GB)*/ +#define REMAINDER_STR_LEN (5 + 1 + 10) + +/** How many bytes to group together. */ +#define BUFFER_DUMP_GROUP_SIZE 4 + +/** Size of the string for buffer dumps. */ +#define BUFFER_DUMP_LEN 240 /* Ought to be enough for everybody ;-). */ + +/** Fibril local storage for the dumped buffer. */ +static fibril_local char buffer_dump[BUFFER_DUMP_LEN]; + +/** Dump buffer into string. + * + * The function dumps given buffer into hexadecimal format and stores it + * in a static fibril local string. + * That means that you do not have to deallocate the string (actually, you + * can not do that) and you do not have to guard it against concurrent + * calls to it. + * The only limitation is that each call rewrites the buffer again. + * Thus, it is necessary to copy the buffer elsewhere (that includes printing + * to screen or writing to file). + * Since this function is expected to be used for debugging prints only, + * that is not a big limitation. + * + * @warning You cannot use this function twice in the same printf + * (see detailed explanation). + * + * @param buffer Buffer to be printed (can be NULL). + * @param size Size of the buffer in bytes (can be zero). + * @param dumped_size How many bytes to actually dump (zero means all). + * @return Dumped buffer as a static (but fibril local) string. + */ +const char *usb_debug_str_buffer(const uint8_t *buffer, size_t size, + size_t dumped_size) +{ + /* + * Remove previous string (that might also reveal double usage of + * this function). + */ + bzero(buffer_dump, BUFFER_DUMP_LEN); + + if (buffer == NULL) { + return "(null)"; + } + if (size == 0) { + return "(empty)"; + } + if ((dumped_size == 0) || (dumped_size > size)) { + dumped_size = size; + } + + /* How many bytes are available in the output buffer. */ + size_t buffer_remaining_size = BUFFER_DUMP_LEN - 1 - REMAINDER_STR_LEN; + char *it = buffer_dump; + + size_t index = 0; + + while (index < size) { + /* Determine space before the number. */ + const char *space_before; + if (index == 0) { + space_before = ""; + } else if ((index % BUFFER_DUMP_GROUP_SIZE) == 0) { + space_before = " "; + } else { + space_before = " "; + } + + /* + * Add the byte as a hexadecimal number plus the space. + * We do it into temporary buffer to ensure that always + * the whole byte is printed. + */ + int val = buffer[index]; + char current_byte[16]; + int printed = snprintf(current_byte, 16, + "%s%02x", space_before, val); + if (printed < 0) { + break; + } + + if ((size_t) printed > buffer_remaining_size) { + break; + } + + /* We can safely add 1, because space for end 0 is reserved. */ + str_append(it, buffer_remaining_size + 1, current_byte); + + buffer_remaining_size -= printed; + /* Point at the terminator 0. */ + it += printed; + index++; + + if (index >= dumped_size) { + break; + } + } + + /* Add how many bytes were not printed. */ + if (index < size) { + snprintf(it, REMAINDER_STR_LEN, + REMAINDER_STR_FMT, size - index); + } + + return buffer_dump; +} + + +/** + * @} + */ Index: uspace/lib/usb/src/devdrv.c =================================================================== --- uspace/lib/usb/src/devdrv.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/devdrv.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,314 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * USB device driver framework. + */ +#include +#include +#include +#include +#include +#include + +static int generic_add_device(ddf_dev_t *); + +static driver_ops_t generic_driver_ops = { + .add_device = generic_add_device +}; +static driver_t generic_driver = { + .driver_ops = &generic_driver_ops +}; + +static usb_driver_t *driver = NULL; + + +/** Main routine of USB device driver. + * + * Under normal conditions, this function never returns. + * + * @param drv USB device driver structure. + * @return Task exit status. + */ +int usb_driver_main(usb_driver_t *drv) +{ + assert(drv != NULL); + + /* Prepare the generic driver. */ + generic_driver.name = drv->name; + + driver = drv; + + return ddf_driver_main(&generic_driver); +} + +/** Log out of memory error on given device. + * + * @param dev Device causing the trouble. + */ +static void usb_log_oom(ddf_dev_t *dev) +{ + usb_log_error("Out of memory when adding device `%s'.\n", + dev->name); +} + +/** Count number of pipes the driver expects. + * + * @param drv USB driver. + * @return Number of pipes (excluding default control pipe). + */ +static size_t count_other_pipes(usb_driver_t *drv) +{ + size_t count = 0; + if (drv->endpoints == NULL) { + return 0; + } + + while (drv->endpoints[count] != NULL) { + count++; + } + + return count; +} + +/** Initialize endpoint pipes, excluding default control one. + * + * @param drv The device driver. + * @param dev Device to be initialized. + * @return Error code. + */ +static int initialize_other_pipes(usb_driver_t *drv, usb_device_t *dev) +{ + int rc; + dev->interface_no = usb_device_get_assigned_interface(dev->ddf_dev); + + size_t pipe_count = count_other_pipes(drv); + dev->pipes = malloc(sizeof(usb_endpoint_mapping_t) * pipe_count); + if (dev->pipes == NULL) { + usb_log_oom(dev->ddf_dev); + return ENOMEM; + } + + size_t i; + + /* Initialize to NULL first for rollback purposes. */ + for (i = 0; i < pipe_count; i++) { + dev->pipes[i].pipe = NULL; + } + + for (i = 0; i < pipe_count; i++) { + dev->pipes[i].pipe = malloc(sizeof(usb_pipe_t)); + if (dev->pipes[i].pipe == NULL) { + usb_log_oom(dev->ddf_dev); + rc = ENOMEM; + goto rollback; + } + + dev->pipes[i].description = drv->endpoints[i]; + dev->pipes[i].interface_no = dev->interface_no; + } + + rc = usb_pipe_initialize_from_configuration(dev->pipes, pipe_count, + dev->descriptors.configuration, dev->descriptors.configuration_size, + &dev->wire); + if (rc != EOK) { + usb_log_error("Failed initializing USB endpoints: %s.\n", + str_error(rc)); + goto rollback; + } + + /* Register the endpoints. */ + usb_hc_connection_t hc_conn; + rc = usb_hc_connection_initialize_from_device(&hc_conn, dev->ddf_dev); + if (rc != EOK) { + usb_log_error( + "Failed initializing connection to host controller: %s.\n", + str_error(rc)); + goto rollback; + } + rc = usb_hc_connection_open(&hc_conn); + if (rc != EOK) { + usb_log_error("Failed to connect to host controller: %s.\n", + str_error(rc)); + goto rollback; + } + for (i = 0; i < pipe_count; i++) { + if (dev->pipes[i].present) { + rc = usb_pipe_register(dev->pipes[i].pipe, + dev->pipes[i].descriptor->poll_interval, + &hc_conn); + /* Ignore error when operation not supported by HC. */ + if ((rc != EOK) && (rc != ENOTSUP)) { + /* FIXME: what shall we do? */ + dev->pipes[i].present = false; + free(dev->pipes[i].pipe); + dev->pipes[i].pipe = NULL; + } + } + } + /* Ignoring errors here. */ + usb_hc_connection_close(&hc_conn); + + return EOK; + +rollback: + for (i = 0; i < pipe_count; i++) { + if (dev->pipes[i].pipe != NULL) { + free(dev->pipes[i].pipe); + } + } + free(dev->pipes); + + return rc; +} + +/** Initialize all endpoint pipes. + * + * @param drv The driver. + * @param dev The device to be initialized. + * @return Error code. + */ +static int initialize_pipes(usb_device_t *dev) +{ + int rc; + + rc = usb_device_connection_initialize_from_device(&dev->wire, + dev->ddf_dev); + if (rc != EOK) { + usb_log_error( + "Failed initializing connection on device `%s'. %s.\n", + dev->ddf_dev->name, str_error(rc)); + return rc; + } + + rc = usb_pipe_initialize_default_control(&dev->ctrl_pipe, + &dev->wire); + if (rc != EOK) { + usb_log_error("Failed to initialize default control pipe " \ + "on device `%s': %s.\n", + dev->ddf_dev->name, str_error(rc)); + return rc; + } + + rc = usb_pipe_probe_default_control(&dev->ctrl_pipe); + if (rc != EOK) { + usb_log_error( + "Probing default control pipe on device `%s' failed: %s.\n", + dev->ddf_dev->name, str_error(rc)); + return rc; + } + + /* + * For further actions, we need open session on default control pipe. + */ + rc = usb_pipe_start_session(&dev->ctrl_pipe); + if (rc != EOK) { + usb_log_error("Failed to start an IPC session: %s.\n", + str_error(rc)); + return rc; + } + + /* Get the device descriptor. */ + rc = usb_request_get_device_descriptor(&dev->ctrl_pipe, + &dev->descriptors.device); + if (rc != EOK) { + usb_log_error("Failed to retrieve device descriptor: %s.\n", + str_error(rc)); + return rc; + } + + /* Get the full configuration descriptor. */ + rc = usb_request_get_full_configuration_descriptor_alloc( + &dev->ctrl_pipe, 0, (void **) &dev->descriptors.configuration, + &dev->descriptors.configuration_size); + if (rc != EOK) { + usb_log_error("Failed retrieving configuration descriptor: %s. %s\n", + dev->ddf_dev->name, str_error(rc)); + return rc; + } + + if (driver->endpoints != NULL) { + rc = initialize_other_pipes(driver, dev); + } + + /* No checking here. */ + usb_pipe_end_session(&dev->ctrl_pipe); + + /* Rollback actions. */ + if (rc != EOK) { + if (dev->descriptors.configuration != NULL) { + free(dev->descriptors.configuration); + } + } + + return rc; +} + +/** Callback when new device is supposed to be controlled by this driver. + * + * This callback is a wrapper for USB specific version of @c add_device. + * + * @param gen_dev Device structure as prepared by DDF. + * @return Error code. + */ +int generic_add_device(ddf_dev_t *gen_dev) +{ + assert(driver); + assert(driver->ops); + assert(driver->ops->add_device); + + int rc; + + usb_device_t *dev = malloc(sizeof(usb_device_t)); + if (dev == NULL) { + usb_log_error("Out of memory when adding device `%s'.\n", + gen_dev->name); + return ENOMEM; + } + + + dev->ddf_dev = gen_dev; + dev->ddf_dev->driver_data = dev; + dev->driver_data = NULL; + dev->descriptors.configuration = NULL; + + rc = initialize_pipes(dev); + if (rc != EOK) { + free(dev); + return rc; + } + + return driver->ops->add_device(dev); +} + +/** + * @} + */ Index: uspace/lib/usb/src/devpoll.c =================================================================== --- uspace/lib/usb/src/devpoll.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/devpoll.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,190 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * USB device driver framework - automatic interrupt polling. + */ +#include +#include +#include +#include +#include +#include + +/** Maximum number of failed consecutive requests before announcing failure. */ +#define MAX_FAILED_ATTEMPTS 3 + +/** Data needed for polling. */ +typedef struct { + usb_device_t *dev; + size_t pipe_index; + usb_polling_callback_t callback; + usb_polling_terminted_callback_t terminated_callback; + size_t request_size; + uint8_t *buffer; + void *custom_arg; +} polling_data_t; + +/** Polling fibril. + * + * @param arg Pointer to polling_data_t. + * @return Always EOK. + */ +static int polling_fibril(void *arg) +{ + polling_data_t *polling_data = (polling_data_t *) arg; + assert(polling_data); + + usb_pipe_t *pipe + = polling_data->dev->pipes[polling_data->pipe_index].pipe; + + size_t failed_attempts = 0; + while (failed_attempts < MAX_FAILED_ATTEMPTS) { + int rc; + + rc = usb_pipe_start_session(pipe); + if (rc != EOK) { + failed_attempts++; + continue; + } + + size_t actual_size; + rc = usb_pipe_read(pipe, polling_data->buffer, + polling_data->request_size, &actual_size); + + /* Quit the session regardless of errors. */ + usb_pipe_end_session(pipe); + + if (rc != EOK) { + failed_attempts++; + continue; + } + + /* We have the data, execute the callback now. */ + bool carry_on = polling_data->callback(polling_data->dev, + polling_data->buffer, actual_size, + polling_data->custom_arg); + + if (!carry_on) { + failed_attempts = 0; + break; + } + + /* Reset as something might be only a temporary problem. */ + failed_attempts = 0; + } + + if (failed_attempts > 0) { + usb_log_error( + "Polling of device `%s' terminated: recurring failures.\n", + polling_data->dev->ddf_dev->name); + } + + if (polling_data->terminated_callback != NULL) { + polling_data->terminated_callback(polling_data->dev, + failed_attempts > 0, polling_data->custom_arg); + } + + /* Free the allocated memory. */ + free(polling_data->buffer); + free(polling_data); + + return EOK; +} + +/** Start automatic device polling over interrupt in pipe. + * + * @warning It is up to the callback to produce delays between individual + * requests. + * + * @warning There is no guarantee when the request to the device + * will be sent for the first time (it is possible that this + * first request would be executed prior to return from this function). + * + * @param dev Device to be periodically polled. + * @param pipe_index Index of the endpoint pipe used for polling. + * @param callback Callback when data are available. + * @param request_size How many bytes to ask for in each request. + * @param terminated_callback Callback when polling is terminated. + * @param arg Custom argument (passed as is to the callbacks). + * @return Error code. + * @retval EOK New fibril polling the device was already started. + */ +int usb_device_auto_poll(usb_device_t *dev, size_t pipe_index, + usb_polling_callback_t callback, size_t request_size, + usb_polling_terminted_callback_t terminated_callback, void *arg) +{ + if ((dev == NULL) || (callback == NULL)) { + return EBADMEM; + } + if (request_size == 0) { + return EINVAL; + } + if ((dev->pipes[pipe_index].pipe->transfer_type != USB_TRANSFER_INTERRUPT) + || (dev->pipes[pipe_index].pipe->direction != USB_DIRECTION_IN)) { + return EINVAL; + } + + polling_data_t *polling_data = malloc(sizeof(polling_data_t)); + if (polling_data == NULL) { + return ENOMEM; + } + + /* Allocate now to prevent immediate failure in the polling fibril. */ + polling_data->buffer = malloc(request_size); + if (polling_data->buffer == NULL) { + free(polling_data); + return ENOMEM; + } + polling_data->dev = dev; + polling_data->pipe_index = pipe_index; + polling_data->callback = callback; + polling_data->terminated_callback = terminated_callback; + polling_data->request_size = request_size; + polling_data->custom_arg = arg; + + fid_t fibril = fibril_create(polling_fibril, polling_data); + if (fibril == 0) { + free(polling_data->buffer); + free(polling_data); + /* FIXME: better error code. */ + return ENOMEM; + } + fibril_add_ready(fibril); + + /* The allocated buffer etc. will be freed by the fibril. */ + + return EOK; +} + +/** + * @} + */ Index: uspace/lib/usb/src/dp.c =================================================================== --- uspace/lib/usb/src/dp.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/dp.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,326 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** + * @file + * USB descriptor parser (implementation). + * + * The descriptor parser is a generic parser for structure, where individual + * items are stored in single buffer and each item begins with length followed + * by type. These types are organized into tree hierarchy. + * + * The parser is able of only two actions: find first child and find next + * sibling. + */ +#include +#include +#include +#include +#include +#include +#include + +#define NESTING(parentname, childname) \ + { \ + .child = USB_DESCTYPE_##childname, \ + .parent = USB_DESCTYPE_##parentname, \ + } +#define LAST_NESTING { -1, -1 } + +/** Nesting of standard USB descriptors. */ +usb_dp_descriptor_nesting_t usb_dp_standard_descriptor_nesting[] = { + NESTING(CONFIGURATION, INTERFACE), + NESTING(INTERFACE, ENDPOINT), + NESTING(INTERFACE, HUB), + NESTING(INTERFACE, HID), + NESTING(HID, HID_REPORT), + LAST_NESTING +}; + +#undef NESTING +#undef LAST_NESTING + +/** Tells whether pointer points inside descriptor data. + * + * @param data Parser data. + * @param ptr Pointer to be verified. + * @return Whether @p ptr points inside data->data field. + */ +static bool is_valid_descriptor_pointer(usb_dp_parser_data_t *data, + uint8_t *ptr) +{ + if (ptr == NULL) { + return false; + } + + if (ptr < data->data) { + return false; + } + + if ((size_t)(ptr - data->data) >= data->size) { + return false; + } + + return true; +} + +/** Get next descriptor regardless of the nesting. + * + * @param data Parser data. + * @param current Pointer to current descriptor. + * @return Pointer to start of next descriptor. + * @retval NULL Invalid input or no next descriptor. + */ +static uint8_t *get_next_descriptor(usb_dp_parser_data_t *data, + uint8_t *current) +{ + assert(is_valid_descriptor_pointer(data, current)); + + uint8_t current_length = *current; + uint8_t *next = current + current_length; + + if (!is_valid_descriptor_pointer(data, next)) { + return NULL; + } + + return next; +} + +/** Get descriptor type. + * + * @see usb_descriptor_type_t + * + * @param data Parser data. + * @param start Pointer to start of the descriptor. + * @return Descriptor type. + * @retval -1 Invalid input. + */ +static int get_descriptor_type(usb_dp_parser_data_t *data, uint8_t *start) +{ + if (start == NULL) { + return -1; + } + + start++; + if (!is_valid_descriptor_pointer(data, start)) { + return -1; + } else { + return (int) (*start); + } +} + +/** Tells whether descriptors could be nested. + * + * @param parser Parser. + * @param child Child descriptor type. + * @param parent Parent descriptor type. + * @return Whether @p child could be child of @p parent. + */ +static bool is_nested_descriptor_type(usb_dp_parser_t *parser, + int child, int parent) +{ + usb_dp_descriptor_nesting_t *nesting = parser->nesting; + while ((nesting->child > 0) && (nesting->parent > 0)) { + if ((nesting->child == child) && (nesting->parent == parent)) { + return true; + } + nesting++; + } + return false; +} + +/** Tells whether descriptors could be nested. + * + * @param parser Parser. + * @param data Parser data. + * @param child Pointer to child descriptor. + * @param parent Pointer to parent descriptor. + * @return Whether @p child could be child of @p parent. + */ +static bool is_nested_descriptor(usb_dp_parser_t *parser, + usb_dp_parser_data_t *data, uint8_t *child, uint8_t *parent) +{ + return is_nested_descriptor_type(parser, + get_descriptor_type(data, child), + get_descriptor_type(data, parent)); +} + +/** Find first nested descriptor of given parent. + * + * @param parser Parser. + * @param data Parser data. + * @param parent Pointer to the beginning of parent descriptor. + * @return Pointer to the beginning of the first nested (child) descriptor. + * @retval NULL No child descriptor found. + * @retval NULL Invalid input. + */ +uint8_t *usb_dp_get_nested_descriptor(usb_dp_parser_t *parser, + usb_dp_parser_data_t *data, uint8_t *parent) +{ + if (!is_valid_descriptor_pointer(data, parent)) { + return NULL; + } + + uint8_t *next = get_next_descriptor(data, parent); + if (next == NULL) { + return NULL; + } + + if (is_nested_descriptor(parser, data, next, parent)) { + return next; + } else { + return NULL; + } +} + +/** Skip all nested descriptors. + * + * @param parser Parser. + * @param data Parser data. + * @param parent Pointer to the beginning of parent descriptor. + * @return Pointer to first non-child descriptor. + * @retval NULL No next descriptor. + * @retval NULL Invalid input. + */ +static uint8_t *skip_nested_descriptors(usb_dp_parser_t *parser, + usb_dp_parser_data_t *data, uint8_t *parent) +{ + uint8_t *child = usb_dp_get_nested_descriptor(parser, data, parent); + if (child == NULL) { + return get_next_descriptor(data, parent); + } + uint8_t *next_child = skip_nested_descriptors(parser, data, child); + while (is_nested_descriptor(parser, data, next_child, parent)) { + next_child = skip_nested_descriptors(parser, data, next_child); + } + + return next_child; +} + +/** Get sibling descriptor. + * + * @param parser Parser. + * @param data Parser data. + * @param parent Pointer to common parent descriptor. + * @param sibling Left sibling. + * @return Pointer to first right sibling of @p sibling. + * @retval NULL No sibling exist. + * @retval NULL Invalid input. + */ +uint8_t *usb_dp_get_sibling_descriptor(usb_dp_parser_t *parser, + usb_dp_parser_data_t *data, uint8_t *parent, uint8_t *sibling) +{ + if (!is_valid_descriptor_pointer(data, parent) + || !is_valid_descriptor_pointer(data, sibling)) { + return NULL; + } + + uint8_t *possible_sibling = skip_nested_descriptors(parser, data, sibling); + if (possible_sibling == NULL) { + return NULL; + } + + int parent_type = get_descriptor_type(data, parent); + int possible_sibling_type = get_descriptor_type(data, possible_sibling); + if (is_nested_descriptor_type(parser, possible_sibling_type, parent_type)) { + return possible_sibling; + } else { + return NULL; + } +} + +/** Browser of the descriptor tree. + * + * @see usb_dp_walk_simple + * + * @param parser Descriptor parser. + * @param data Data for descriptor parser. + * @param root Pointer to current root of the tree. + * @param depth Current nesting depth. + * @param callback Callback for each found descriptor. + * @param arg Custom (user) argument. + */ +static void usb_dp_browse_simple_internal(usb_dp_parser_t *parser, + usb_dp_parser_data_t *data, uint8_t *root, size_t depth, + void (*callback)(uint8_t *, size_t, void *), void *arg) +{ + if (root == NULL) { + return; + } + callback(root, depth, arg); + uint8_t *child = usb_dp_get_nested_descriptor(parser, data, root); + do { + usb_dp_browse_simple_internal(parser, data, child, depth + 1, + callback, arg); + child = usb_dp_get_sibling_descriptor(parser, data, + root, child); + } while (child != NULL); +} + +/** Browse flatten descriptor tree. + * + * The callback is called with following arguments: pointer to the start + * of the descriptor (somewhere inside @p descriptors), depth of the nesting + * (starting from 0 for the first descriptor) and the custom argument. + * Note that the size of the descriptor is not passed because it can + * be read from the first byte of the descriptor. + * + * @param descriptors Descriptor data. + * @param descriptors_size Size of descriptor data (in bytes). + * @param descriptor_nesting Possible descriptor nesting. + * @param callback Callback for each found descriptor. + * @param arg Custom (user) argument. + */ +void usb_dp_walk_simple(uint8_t *descriptors, size_t descriptors_size, + usb_dp_descriptor_nesting_t *descriptor_nesting, + void (*callback)(uint8_t *, size_t, void *), void *arg) +{ + if ((descriptors == NULL) || (descriptors_size == 0) + || (descriptor_nesting == NULL) || (callback == NULL)) { + return; + } + + usb_dp_parser_data_t data = { + .data = descriptors, + .size = descriptors_size, + .arg = NULL + }; + + usb_dp_parser_t parser = { + .nesting = descriptor_nesting + }; + + usb_dp_browse_simple_internal(&parser, &data, descriptors, + 0, callback, arg); +} + +/** @} + */ Index: uspace/lib/usb/src/dump.c =================================================================== --- uspace/lib/usb/src/dump.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/dump.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,292 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * Descriptor dumping. + */ +#include +#include +#include +#include +#include +#include +#include +#include +#include + +/** Mapping between descriptor id and dumping function. */ +typedef struct { + /** Descriptor id. */ + int id; + /** Dumping function. */ + void (*dump)(FILE *, const char *, const char *, + const uint8_t *, size_t); +} descriptor_dump_t; + +static void usb_dump_descriptor_device(FILE *, const char *, const char *, + const uint8_t *, size_t); +static void usb_dump_descriptor_configuration(FILE *, const char *, const char *, + const uint8_t *, size_t); +static void usb_dump_descriptor_interface(FILE *, const char *, const char *, + const uint8_t *, size_t); +static void usb_dump_descriptor_string(FILE *, const char *, const char *, + const uint8_t *, size_t); +static void usb_dump_descriptor_endpoint(FILE *, const char *, const char *, + const uint8_t *, size_t); +static void usb_dump_descriptor_hid(FILE *, const char *, const char *, + const uint8_t *, size_t); +static void usb_dump_descriptor_hub(FILE *, const char *, const char *, + const uint8_t *, size_t); +static void usb_dump_descriptor_generic(FILE *, const char *, const char *, + const uint8_t *, size_t); + +/** Descriptor dumpers mapping. */ +static descriptor_dump_t descriptor_dumpers[] = { + { USB_DESCTYPE_DEVICE, usb_dump_descriptor_device }, + { USB_DESCTYPE_CONFIGURATION, usb_dump_descriptor_configuration }, + { USB_DESCTYPE_STRING, usb_dump_descriptor_string }, + { USB_DESCTYPE_INTERFACE, usb_dump_descriptor_interface }, + { USB_DESCTYPE_ENDPOINT, usb_dump_descriptor_endpoint }, + { USB_DESCTYPE_HID, usb_dump_descriptor_hid }, + { USB_DESCTYPE_HUB, usb_dump_descriptor_hub }, + { -1, usb_dump_descriptor_generic }, + { -1, NULL } +}; + +/** Dumps standard USB descriptor. + * The @p line_suffix must contain the newline \\n character. + * When @p line_suffix or @p line_prefix is NULL, they are substitued with + * default values + * ( - for prefix and line termination for suffix). + * + * @param output Output file stream to dump descriptor to. + * @param line_prefix Prefix for each line of output. + * @param line_suffix Suffix of each line of output. + * @param descriptor Actual descriptor. + * @param descriptor_length Descriptor size. + */ +void usb_dump_standard_descriptor(FILE *output, + const char *line_prefix, const char *line_suffix, + const uint8_t *descriptor, size_t descriptor_length) +{ + if (descriptor_length < 2) { + return; + } + int type = descriptor[1]; + + descriptor_dump_t *dumper = descriptor_dumpers; + while (dumper->dump != NULL) { + if ((dumper->id == type) || (dumper->id < 0)) { + dumper->dump(output, line_prefix, line_suffix, + descriptor, descriptor_length); + return; + } + dumper++; + } +} + +/** Prints single line of USB descriptor dump. + * @warning This macro abuses heavily the naming conventions used + * by all dumping functions (i.e. names for output file stream (@c output) and + * line prefix and suffix (@c line_prefix and @c line_suffix respectively))- + * + * @param fmt Formatting string. + */ +#define PRINTLINE(fmt, ...) \ + fprintf(output, "%s" fmt "%s", \ + line_prefix ? line_prefix : " - ", \ + __VA_ARGS__, \ + line_suffix ? line_suffix : "\n") + +#define BCD_INT(a) (((unsigned int)(a)) / 256) +#define BCD_FRAC(a) (((unsigned int)(a)) % 256) + +#define BCD_FMT "%x.%x" +#define BCD_ARGS(a) BCD_INT((a)), BCD_FRAC((a)) + +static void usb_dump_descriptor_device(FILE *output, + const char *line_prefix, const char *line_suffix, + const uint8_t *descriptor, size_t descriptor_length) +{ + usb_standard_device_descriptor_t *d + = (usb_standard_device_descriptor_t *) descriptor; + if (descriptor_length < sizeof(*d)) { + return; + } + + PRINTLINE("bLength = %d", d->length); + PRINTLINE("bDescriptorType = 0x%02x", d->descriptor_type); + PRINTLINE("bcdUSB = %d (" BCD_FMT ")", d->usb_spec_version, + BCD_ARGS(d->usb_spec_version)); + PRINTLINE("bDeviceClass = 0x%02x", d->device_class); + PRINTLINE("bDeviceSubClass = 0x%02x", d->device_subclass); + PRINTLINE("bDeviceProtocol = 0x%02x", d->device_protocol); + PRINTLINE("bMaxPacketSize0 = %d", d->max_packet_size); + PRINTLINE("idVendor = 0x%04x", d->vendor_id); + PRINTLINE("idProduct = 0x%04x", d->product_id); + PRINTLINE("bcdDevice = %d", d->device_version); + PRINTLINE("iManufacturer = %d", d->str_manufacturer); + PRINTLINE("iProduct = %d", d->str_product); + PRINTLINE("iSerialNumber = %d", d->str_serial_number); + PRINTLINE("bNumConfigurations = %d", d->configuration_count); +} + +static void usb_dump_descriptor_configuration(FILE *output, + const char *line_prefix, const char *line_suffix, + const uint8_t *descriptor, size_t descriptor_length) +{ + usb_standard_configuration_descriptor_t *d + = (usb_standard_configuration_descriptor_t *) descriptor; + if (descriptor_length < sizeof(*d)) { + return; + } + + bool self_powered = d->attributes & 64; + bool remote_wakeup = d->attributes & 32; + + PRINTLINE("bLength = %d", d->length); + PRINTLINE("bDescriptorType = 0x%02x", d->descriptor_type); + PRINTLINE("wTotalLength = %d", d->total_length); + PRINTLINE("bNumInterfaces = %d", d->interface_count); + PRINTLINE("bConfigurationValue = %d", d->configuration_number); + PRINTLINE("iConfiguration = %d", d->str_configuration); + PRINTLINE("bmAttributes = %d [%s%s%s]", d->attributes, + self_powered ? "self-powered" : "", + (self_powered & remote_wakeup) ? ", " : "", + remote_wakeup ? "remote-wakeup" : ""); + PRINTLINE("MaxPower = %d (%dmA)", d->max_power, + 2 * d->max_power); +} + +static void usb_dump_descriptor_interface(FILE *output, + const char *line_prefix, const char *line_suffix, + const uint8_t *descriptor, size_t descriptor_length) +{ + usb_standard_interface_descriptor_t *d + = (usb_standard_interface_descriptor_t *) descriptor; + if (descriptor_length < sizeof(*d)) { + return; + } + + PRINTLINE("bLength = %d", d->length); + PRINTLINE("bDescriptorType = 0x%02x", d->descriptor_type); + PRINTLINE("bInterfaceNumber = %d", d->interface_number); + PRINTLINE("bAlternateSetting = %d", d->alternate_setting); + PRINTLINE("bNumEndpoints = %d", d->endpoint_count); + PRINTLINE("bInterfaceClass = %s", d->interface_class == 0 + ? "reserved (0)" : usb_str_class(d->interface_class)); + PRINTLINE("bInterfaceSubClass = %d", d->interface_subclass); + PRINTLINE("bInterfaceProtocol = %d", d->interface_protocol); + PRINTLINE("iInterface = %d", d->str_interface); +} + +static void usb_dump_descriptor_string(FILE *output, + const char *line_prefix, const char *line_suffix, + const uint8_t *descriptor, size_t descriptor_length) +{ +} + +static void usb_dump_descriptor_endpoint(FILE *output, + const char *line_prefix, const char *line_suffix, + const uint8_t *descriptor, size_t descriptor_length) +{ + usb_standard_endpoint_descriptor_t *d + = (usb_standard_endpoint_descriptor_t *) descriptor; + if (descriptor_length < sizeof(*d)) { + return; + } + + int endpoint = d->endpoint_address & 15; + usb_direction_t direction = d->endpoint_address & 128 + ? USB_DIRECTION_IN : USB_DIRECTION_OUT; + usb_transfer_type_t transfer_type = d->attributes & 3; + + PRINTLINE("bLength = %d", d->length); + PRINTLINE("bDescriptorType = 0x%02X", d->descriptor_type); + PRINTLINE("bEndpointAddress = 0x%02X [%d, %s]", + d->endpoint_address, endpoint, + direction == USB_DIRECTION_IN ? "in" : "out"); + PRINTLINE("bmAttributes = %d [%s]", d->attributes, + usb_str_transfer_type(transfer_type)); + PRINTLINE("wMaxPacketSize = %d", d->max_packet_size); + PRINTLINE("bInterval = %dms", d->poll_interval); +} + +static void usb_dump_descriptor_hid(FILE *output, + const char *line_prefix, const char *line_suffix, + const uint8_t *descriptor, size_t descriptor_length) +{ + usb_standard_hid_descriptor_t *d + = (usb_standard_hid_descriptor_t *) descriptor; + if (descriptor_length < sizeof(*d)) { + return; + } + + PRINTLINE("bLength = %d", d->length); + PRINTLINE("bDescriptorType = 0x%02x", d->descriptor_type); + PRINTLINE("bcdHID = %d (" BCD_FMT ")", d->spec_release, + BCD_ARGS(d->spec_release)); + PRINTLINE("bCountryCode = %d", d->country_code); + PRINTLINE("bNumDescriptors = %d", d->class_desc_count); + PRINTLINE("bDescriptorType = %d", d->report_desc_info.type); + PRINTLINE("wDescriptorLength = %d", d->report_desc_info.length); + + /* Print info about report descriptors. */ + size_t i; + size_t count = (descriptor_length - sizeof(*d)) + / sizeof(usb_standard_hid_class_descriptor_info_t); + usb_standard_hid_class_descriptor_info_t *d2 + = (usb_standard_hid_class_descriptor_info_t *) + (descriptor + sizeof(*d)); + for (i = 0; i < count; i++, d2++) { + PRINTLINE("bDescriptorType = %d", d2->type); + PRINTLINE("wDescriptorLength = %d", d2->length); + } +} + +static void usb_dump_descriptor_hub(FILE *output, + const char *line_prefix, const char *line_suffix, + const uint8_t *descriptor, size_t descriptor_length) +{ + /* TODO */ +} + +static void usb_dump_descriptor_generic(FILE *output, + const char *line_prefix, const char *line_suffix, + const uint8_t *descriptor, size_t descriptor_length) +{ + /* TODO */ +} + + +/** + * @} + */ Index: uspace/lib/usb/src/hidparser.c =================================================================== --- uspace/lib/usb/src/hidparser.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/hidparser.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,1327 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * HID report descriptor and report data parser implementation. + */ +#include +#include +#include +#include +#include +#include + +/** */ +#define USB_HID_NEW_REPORT_ITEM 1 + +/** */ +#define USB_HID_NO_ACTION 2 + +/** */ +#define USB_HID_UNKNOWN_TAG -99 + +/* + * Private descriptor parser functions + */ +int usb_hid_report_parse_tag(uint8_t tag, uint8_t class, const uint8_t *data, size_t item_size, + usb_hid_report_item_t *report_item, usb_hid_report_path_t *usage_path); +int usb_hid_report_parse_main_tag(uint8_t tag, const uint8_t *data, size_t item_size, + usb_hid_report_item_t *report_item, usb_hid_report_path_t *usage_path); +int usb_hid_report_parse_global_tag(uint8_t tag, const uint8_t *data, size_t item_size, + usb_hid_report_item_t *report_item, usb_hid_report_path_t *usage_path); +int usb_hid_report_parse_local_tag(uint8_t tag, const uint8_t *data, size_t item_size, + usb_hid_report_item_t *report_item, usb_hid_report_path_t *usage_path); + +void usb_hid_descriptor_print_list(link_t *head); +int usb_hid_report_reset_local_items(); +void usb_hid_free_report_list(link_t *head); + +/* + * Data translation private functions + */ +int32_t usb_hid_report_tag_data_int32(const uint8_t *data, size_t size); +inline size_t usb_hid_count_item_offset(usb_hid_report_item_t * report_item, size_t offset); +int usb_hid_translate_data(usb_hid_report_item_t *item, const uint8_t *data, size_t j); +int32_t usb_hid_translate_data_reverse(usb_hid_report_item_t *item, int32_t value); +int usb_pow(int a, int b); + +// TODO: tohle ma bejt asi jinde +int usb_pow(int a, int b) +{ + switch(b) { + case 0: + return 1; + break; + case 1: + return a; + break; + default: + return a * usb_pow(a, b-1); + break; + } +} + +/** + * Initialize the report descriptor parser structure + * + * @param parser Report descriptor parser structure + * @return Error code + */ +int usb_hid_parser_init(usb_hid_report_parser_t *parser) +{ + if(parser == NULL) { + return EINVAL; + } + + list_initialize(&(parser->input)); + list_initialize(&(parser->output)); + list_initialize(&(parser->feature)); + + return EOK; +} + + +/** Parse HID report descriptor. + * + * @param parser Opaque HID report parser structure. + * @param data Data describing the report. + * @return Error code. + */ +int usb_hid_parse_report_descriptor(usb_hid_report_parser_t *parser, + const uint8_t *data, size_t size) +{ + size_t i=0; + uint8_t tag=0; + uint8_t item_size=0; + int class=0; + int ret; + usb_hid_report_item_t *report_item=0; + usb_hid_report_item_t *new_report_item; + usb_hid_report_path_t *usage_path; + usb_hid_report_path_t *tmp_usage_path; + + size_t offset_input=0; + size_t offset_output=0; + size_t offset_feature=0; + + + /* parser structure initialization*/ + if(usb_hid_parser_init(parser) != EOK) { + return EINVAL; + } + + + /*report item initialization*/ + if(!(report_item=malloc(sizeof(usb_hid_report_item_t)))){ + return ENOMEM; + } + memset(report_item, 0, sizeof(usb_hid_report_item_t)); + list_initialize(&(report_item->link)); + + /* usage path context initialization */ + if(!(usage_path=usb_hid_report_path())){ + return ENOMEM; + } + + while(i= size){ + return EINVAL; // TODO ERROR CODE + } + + tag = USB_HID_ITEM_TAG(data[i]); + item_size = USB_HID_ITEM_SIZE(data[i]); + class = USB_HID_ITEM_TAG_CLASS(data[i]); + + usb_log_debug2( + "i(%u) data(%X) value(%X): TAG %u, class %u, size %u - ", i, + data[i], usb_hid_report_tag_data_int32(data+i+1,item_size), + tag, class, item_size); + + ret = usb_hid_report_parse_tag(tag,class,data+i+1, + item_size,report_item, usage_path); + usb_log_debug2("ret: %u\n", ret); + switch(ret){ + case USB_HID_NEW_REPORT_ITEM: + // store report item to report and create the new one + usb_log_debug("\nNEW REPORT ITEM: %X",ret); + + // store current usage path + report_item->usage_path = usage_path; + + // clone path to the new one + tmp_usage_path = usb_hid_report_path_clone(usage_path); + + // swap + usage_path = tmp_usage_path; + tmp_usage_path = NULL; + + + switch(tag) { + case USB_HID_REPORT_TAG_INPUT: + report_item->offset = offset_input; + offset_input += report_item->count * report_item->size; + usb_log_debug(" - INPUT\n"); + list_append(&(report_item->link), &(parser->input)); + break; + case USB_HID_REPORT_TAG_OUTPUT: + report_item->offset = offset_output; + offset_output += report_item->count * report_item->size; + usb_log_debug(" - OUTPUT\n"); + list_append(&(report_item->link), &(parser->output)); + + break; + case USB_HID_REPORT_TAG_FEATURE: + report_item->offset = offset_feature; + offset_feature += report_item->count * report_item->size; + usb_log_debug(" - FEATURE\n"); + list_append(&(report_item->link), &(parser->feature)); + break; + default: + usb_log_debug("\tjump over - tag %X\n", tag); + break; + } + + /* clone current state table to the new item */ + if(!(new_report_item = malloc(sizeof(usb_hid_report_item_t)))) { + return ENOMEM; + } + memcpy(new_report_item,report_item, sizeof(usb_hid_report_item_t)); + /* reset local items */ + new_report_item->usage_minimum = 0; + new_report_item->usage_maximum = 0; + + link_initialize(&(new_report_item->link)); + report_item = new_report_item; + + break; + case USB_HID_REPORT_TAG_PUSH: + // push current state to stack + // not yet implemented + break; + case USB_HID_REPORT_TAG_POP: + // restore current state from stack + // not yet implemented + break; + + default: + // nothing special to do + break; + } + + /* jump over the processed block */ + i += 1 + USB_HID_ITEM_SIZE(data[i]); + } + else{ + // TBD + i += 3 + USB_HID_ITEM_SIZE(data[i+1]); + } + + + } + + return EOK; +} + + +/** + * Parse input report. + * + * @param data Data for report + * @param size Size of report + * @param callbacks Callbacks for report actions + * @param arg Custom arguments + * + * @return Error code + */ +int usb_hid_boot_keyboard_input_report(const uint8_t *data, size_t size, + const usb_hid_report_in_callbacks_t *callbacks, void *arg) +{ + int i; + usb_hid_report_item_t item; + + /* fill item due to the boot protocol report descriptor */ + // modifier keys are in the first byte + uint8_t modifiers = data[0]; + + item.offset = 2; /* second byte is reserved */ + item.size = 8; + item.count = 6; + item.usage_minimum = 0; + item.usage_maximum = 255; + item.logical_minimum = 0; + item.logical_maximum = 255; + + if (size != 8) { + return -1; //ERANGE; + } + + uint8_t keys[6]; + for (i = 0; i < item.count; i++) { + keys[i] = data[i + item.offset]; + } + + callbacks->keyboard(keys, 6, modifiers, arg); + return EOK; +} + +/** + * Makes output report for keyboard boot protocol + * + * @param leds + * @param output Output report data buffer + * @param size Size of the output buffer + * @return Error code + */ +int usb_hid_boot_keyboard_output_report(uint8_t leds, uint8_t *data, size_t size) +{ + if(size != 1){ + return -1; + } + + /* used only first five bits, others are only padding*/ + *data = leds; + return EOK; +} + +/** + * Parse one tag of the report descriptor + * + * @param Tag to parse + * @param Report descriptor buffer + * @param Size of data belongs to this tag + * @param Current report item structe + * @return Code of action to be done next + */ +int usb_hid_report_parse_tag(uint8_t tag, uint8_t class, const uint8_t *data, size_t item_size, + usb_hid_report_item_t *report_item, usb_hid_report_path_t *usage_path) +{ + int ret; + + switch(class){ + case USB_HID_TAG_CLASS_MAIN: + + if((ret=usb_hid_report_parse_main_tag(tag,data,item_size,report_item, usage_path)) == EOK) { + return USB_HID_NEW_REPORT_ITEM; + } + else { + /*TODO process the error */ + return ret; + } + break; + + case USB_HID_TAG_CLASS_GLOBAL: + return usb_hid_report_parse_global_tag(tag,data,item_size,report_item, usage_path); + break; + + case USB_HID_TAG_CLASS_LOCAL: + return usb_hid_report_parse_local_tag(tag,data,item_size,report_item, usage_path); + break; + default: + return USB_HID_NO_ACTION; + } +} + +/** + * Parse main tags of report descriptor + * + * @param Tag identifier + * @param Data buffer + * @param Length of data buffer + * @param Current state table + * @return Error code + */ + +int usb_hid_report_parse_main_tag(uint8_t tag, const uint8_t *data, size_t item_size, + usb_hid_report_item_t *report_item, usb_hid_report_path_t *usage_path) +{ + switch(tag) + { + case USB_HID_REPORT_TAG_INPUT: + case USB_HID_REPORT_TAG_OUTPUT: + case USB_HID_REPORT_TAG_FEATURE: + report_item->item_flags = *data; + return EOK; + break; + + case USB_HID_REPORT_TAG_COLLECTION: + usb_hid_report_path_append_item(usage_path, 0, 0); + + return USB_HID_NO_ACTION; + break; + + case USB_HID_REPORT_TAG_END_COLLECTION: + // TODO + // znici posledni uroven ve vsech usage paths + // otazka jestli nema nicit dve, respektive novou posledni vynulovat? + usb_hid_report_remove_last_item(usage_path); + return USB_HID_NO_ACTION; + break; + default: + return USB_HID_NO_ACTION; + } + + return EOK; +} + +/** + * Parse global tags of report descriptor + * + * @param Tag identifier + * @param Data buffer + * @param Length of data buffer + * @param Current state table + * @return Error code + */ +int usb_hid_report_parse_global_tag(uint8_t tag, const uint8_t *data, size_t item_size, + usb_hid_report_item_t *report_item, usb_hid_report_path_t *usage_path) +{ + // TODO take care about the bit length of data + switch(tag) + { + case USB_HID_REPORT_TAG_USAGE_PAGE: + // zmeni to jenom v poslednim poli aktualni usage path + usb_hid_report_set_last_item(usage_path, USB_HID_TAG_CLASS_GLOBAL, + usb_hid_report_tag_data_int32(data,item_size)); + break; + case USB_HID_REPORT_TAG_LOGICAL_MINIMUM: + report_item->logical_minimum = usb_hid_report_tag_data_int32(data,item_size); + break; + case USB_HID_REPORT_TAG_LOGICAL_MAXIMUM: + report_item->logical_maximum = usb_hid_report_tag_data_int32(data,item_size); + break; + case USB_HID_REPORT_TAG_PHYSICAL_MINIMUM: + report_item->physical_minimum = usb_hid_report_tag_data_int32(data,item_size); + break; + case USB_HID_REPORT_TAG_PHYSICAL_MAXIMUM: + report_item->physical_maximum = usb_hid_report_tag_data_int32(data,item_size); + break; + case USB_HID_REPORT_TAG_UNIT_EXPONENT: + report_item->unit_exponent = usb_hid_report_tag_data_int32(data,item_size); + break; + case USB_HID_REPORT_TAG_UNIT: + report_item->unit = usb_hid_report_tag_data_int32(data,item_size); + break; + case USB_HID_REPORT_TAG_REPORT_SIZE: + report_item->size = usb_hid_report_tag_data_int32(data,item_size); + break; + case USB_HID_REPORT_TAG_REPORT_COUNT: + report_item->count = usb_hid_report_tag_data_int32(data,item_size); + break; + case USB_HID_REPORT_TAG_REPORT_ID: + report_item->id = usb_hid_report_tag_data_int32(data,item_size); + break; + case USB_HID_REPORT_TAG_PUSH: + case USB_HID_REPORT_TAG_POP: + return tag; + break; + + default: + return USB_HID_NO_ACTION; + } + + return EOK; +} + +/** + * Parse local tags of report descriptor + * + * @param Tag identifier + * @param Data buffer + * @param Length of data buffer + * @param Current state table + * @return Error code + */ +int usb_hid_report_parse_local_tag(uint8_t tag, const uint8_t *data, size_t item_size, + usb_hid_report_item_t *report_item, usb_hid_report_path_t *usage_path) +{ + switch(tag) + { + case USB_HID_REPORT_TAG_USAGE: + usb_hid_report_set_last_item(usage_path, USB_HID_TAG_CLASS_LOCAL, + usb_hid_report_tag_data_int32(data,item_size)); + break; + case USB_HID_REPORT_TAG_USAGE_MINIMUM: + report_item->usage_minimum = usb_hid_report_tag_data_int32(data,item_size); + break; + case USB_HID_REPORT_TAG_USAGE_MAXIMUM: + report_item->usage_maximum = usb_hid_report_tag_data_int32(data,item_size); + break; + case USB_HID_REPORT_TAG_DESIGNATOR_INDEX: + report_item->designator_index = usb_hid_report_tag_data_int32(data,item_size); + break; + case USB_HID_REPORT_TAG_DESIGNATOR_MINIMUM: + report_item->designator_minimum = usb_hid_report_tag_data_int32(data,item_size); + break; + case USB_HID_REPORT_TAG_DESIGNATOR_MAXIMUM: + report_item->designator_maximum = usb_hid_report_tag_data_int32(data,item_size); + break; + case USB_HID_REPORT_TAG_STRING_INDEX: + report_item->string_index = usb_hid_report_tag_data_int32(data,item_size); + break; + case USB_HID_REPORT_TAG_STRING_MINIMUM: + report_item->string_minimum = usb_hid_report_tag_data_int32(data,item_size); + break; + case USB_HID_REPORT_TAG_STRING_MAXIMUM: + report_item->string_maximum = usb_hid_report_tag_data_int32(data,item_size); + break; + case USB_HID_REPORT_TAG_DELIMITER: + report_item->delimiter = usb_hid_report_tag_data_int32(data,item_size); + break; + + default: + return USB_HID_NO_ACTION; + } + + return EOK; +} + +/** + * Converts raw data to int32 (thats the maximum length of short item data) + * + * @param Data buffer + * @param Size of buffer + * @return Converted int32 number + */ +int32_t usb_hid_report_tag_data_int32(const uint8_t *data, size_t size) +{ + unsigned int i; + int32_t result; + + result = 0; + for(i=0; inext; item != head; item = item->next) { + + report_item = list_get_instance(item, usb_hid_report_item_t, link); + + usb_log_debug("\tOFFSET: %X\n", report_item->offset); + usb_log_debug("\tCOUNT: %X\n", report_item->count); + usb_log_debug("\tSIZE: %X\n", report_item->size); + usb_log_debug("\tCONSTANT/VAR: %X\n", USB_HID_ITEM_FLAG_CONSTANT(report_item->item_flags)); + usb_log_debug("\tVARIABLE/ARRAY: %X\n", USB_HID_ITEM_FLAG_VARIABLE(report_item->item_flags)); + usb_log_debug("\tUSAGE PATH:\n"); + + path = report_item->usage_path->link.next; + while(path != &report_item->usage_path->link) { + path_item = list_get_instance(path, usb_hid_report_usage_path_t, link); + usb_log_debug("\t\tUSAGE PAGE: %X, USAGE: %X\n", path_item->usage_page, path_item->usage); + path = path->next; + } + + usb_log_debug("\tLOGMIN: %X\n", report_item->logical_minimum); + usb_log_debug("\tLOGMAX: %X\n", report_item->logical_maximum); + usb_log_debug("\tPHYMIN: %X\n", report_item->physical_minimum); + usb_log_debug("\tPHYMAX: %X\n", report_item->physical_maximum); + usb_log_debug("\tUSAGEMIN: %X\n", report_item->usage_minimum); + usb_log_debug("\tUSAGEMAX: %X\n", report_item->usage_maximum); + + usb_log_debug("\n"); + + } + + +} +/** + * Prints content of given report descriptor in human readable format. + * + * @param parser Parsed descriptor to print + * @return void + */ +void usb_hid_descriptor_print(usb_hid_report_parser_t *parser) +{ + if(parser == NULL) { + return; + } + + usb_log_debug("INPUT:\n"); + usb_hid_descriptor_print_list(&parser->input); + + usb_log_debug("OUTPUT: \n"); + usb_hid_descriptor_print_list(&parser->output); + + usb_log_debug("FEATURE:\n"); + usb_hid_descriptor_print_list(&parser->feature); + +} + +/** + * Releases whole linked list of report items + * + * @param head Head of list of report descriptor items (usb_hid_report_item_t) + * @return void + */ +void usb_hid_free_report_list(link_t *head) +{ + return; + + usb_hid_report_item_t *report_item; + link_t *next; + + if(head == NULL || list_empty(head)) { + return; + } + + next = head->next; + while(next != head) { + + report_item = list_get_instance(next, usb_hid_report_item_t, link); + + while(!list_empty(&report_item->usage_path->link)) { + usb_hid_report_remove_last_item(report_item->usage_path); + } + + + next = next->next; + + free(report_item); + } + + return; + +} + +/** Frees the HID report descriptor parser structure + * + * @param parser Opaque HID report parser structure + * @return void + */ +void usb_hid_free_report_parser(usb_hid_report_parser_t *parser) +{ + if(parser == NULL){ + return; + } + + usb_hid_free_report_list(&parser->input); + usb_hid_free_report_list(&parser->output); + usb_hid_free_report_list(&parser->feature); + + return; +} + +/** Parse and act upon a HID report. + * + * @see usb_hid_parse_report_descriptor + * + * @param parser Opaque HID report parser structure. + * @param data Data for the report. + * @param callbacks Callbacks for report actions. + * @param arg Custom argument (passed through to the callbacks). + * @return Error code. + */ +int usb_hid_parse_report(const usb_hid_report_parser_t *parser, + const uint8_t *data, size_t size, + usb_hid_report_path_t *path, int flags, + const usb_hid_report_in_callbacks_t *callbacks, void *arg) +{ + link_t *list_item; + usb_hid_report_item_t *item; + uint8_t *keys; + uint8_t item_value; + size_t key_count=0; + size_t i=0; + size_t j=0; + + if(parser == NULL) { + return EINVAL; + } + + /* get the size of result array */ + key_count = usb_hid_report_input_length(parser, path, flags); + + if(!(keys = malloc(sizeof(uint8_t) * key_count))){ + return ENOMEM; + } + + /* read data */ + list_item = parser->input.next; + while(list_item != &(parser->input)) { + + item = list_get_instance(list_item, usb_hid_report_item_t, link); + if(!USB_HID_ITEM_FLAG_CONSTANT(item->item_flags) && + (usb_hid_report_compare_usage_path(item->usage_path, path, flags) == EOK)) { + for(j=0; j<(size_t)(item->count); j++) { + if((USB_HID_ITEM_FLAG_VARIABLE(item->item_flags) == 0) || + ((item->usage_minimum == 0) && (item->usage_maximum == 0))) { + // variable item + keys[i++] = usb_hid_translate_data(item, data,j); + } + else { + // bitmapa + if((item_value = usb_hid_translate_data(item, data, j)) != 0) { + keys[i++] = (item->count - 1 - j) + item->usage_minimum; + } + else { + keys[i++] = 0; + } + } + } + } + list_item = list_item->next; + } + + callbacks->keyboard(keys, key_count, 0, arg); + + free(keys); + return EOK; + +} + +/** + * Translate data from the report as specified in report descriptor + * + * @param item Report descriptor item with definition of translation + * @param data Data to translate + * @param j Index of processed field in report descriptor item + * @return Translated data + */ +int usb_hid_translate_data(usb_hid_report_item_t *item, const uint8_t *data, size_t j) +{ + int resolution; + int offset; + int part_size; + + int32_t value; + int32_t mask; + const uint8_t *foo; + + // now only common numbers llowed + if(item->size > 32) { + return 0; + } + + if((item->physical_minimum == 0) && (item->physical_maximum == 0)) { + item->physical_minimum = item->logical_minimum; + item->physical_maximum = item->logical_maximum; + } + + if(item->physical_maximum == item->physical_minimum){ + resolution = 1; + } + else { + resolution = (item->logical_maximum - item->logical_minimum) / + ((item->physical_maximum - item->physical_minimum) * + (usb_pow(10,(item->unit_exponent)))); + } + offset = item->offset + (j * item->size); + + // FIXME + if((offset/8) != ((offset+item->size)/8)) { + usb_log_debug2("offset %d\n", offset); + + part_size = ((offset+item->size)%8); + usb_log_debug2("part size %d\n",part_size); + + // the higher one + foo = data+(offset/8); + mask = ((1 << (item->size-part_size))-1); + value = (*foo & mask) << part_size; + + usb_log_debug2("hfoo %x\n", *foo); + usb_log_debug2("hmaska %x\n", mask); + usb_log_debug2("hval %d\n", value); + + // the lower one + foo = data+((offset+item->size)/8); + mask = ((1 << part_size)-1) << (8-part_size); + value += ((*foo & mask) >> (8-part_size)); + + usb_log_debug2("lfoo %x\n", *foo); + usb_log_debug2("lmaska %x\n", mask); + usb_log_debug2("lval %d\n", ((*foo & mask) >> (8-(item->size-part_size)))); + usb_log_debug2("val %d\n", value); + + + } + else { + foo = data+(offset/8); + mask = ((1 << item->size)-1) << (8-((offset%8)+item->size)); + value = (*foo & mask) >> (8-((offset%8)+item->size)); + + usb_log_debug2("offset %d\n", offset); + + usb_log_debug2("foo %x\n", *foo); + usb_log_debug2("maska %x\n", mask); + usb_log_debug2("val %d\n", value); + } + + usb_log_debug2("---\n\n"); + + return (int)(((value - item->logical_minimum) / resolution) + item->physical_minimum); + +} + +/** + * + * + * @param parser + * @param path + * @param flags + * @return + */ +size_t usb_hid_report_input_length(const usb_hid_report_parser_t *parser, + usb_hid_report_path_t *path, int flags) +{ + size_t ret = 0; + link_t *item; + usb_hid_report_item_t *report_item; + + if(parser == NULL) { + return 0; + } + + item = parser->input.next; + while(&parser->input != item) { + report_item = list_get_instance(item, usb_hid_report_item_t, link); + if(!USB_HID_ITEM_FLAG_CONSTANT(report_item->item_flags) && + (usb_hid_report_compare_usage_path(report_item->usage_path, path, flags) == EOK)) { + ret += report_item->count; + } + + item = item->next; + } + + return ret; +} + + +/** + * + * @param usage_path + * @param usage_page + * @param usage + * @return + */ +int usb_hid_report_path_append_item(usb_hid_report_path_t *usage_path, + int32_t usage_page, int32_t usage) +{ + usb_hid_report_usage_path_t *item; + + if(!(item=malloc(sizeof(usb_hid_report_usage_path_t)))) { + return ENOMEM; + } + list_initialize(&item->link); + + item->usage = usage; + item->usage_page = usage_page; + + list_append (&usage_path->link, &item->link); + usage_path->depth++; + return EOK; +} + +/** + * + * @param usage_path + * @return + */ +void usb_hid_report_remove_last_item(usb_hid_report_path_t *usage_path) +{ + usb_hid_report_usage_path_t *item; + + if(!list_empty(&usage_path->link)){ + item = list_get_instance(usage_path->link.prev, usb_hid_report_usage_path_t, link); + list_remove(usage_path->link.prev); + usage_path->depth--; + free(item); + } +} + +/** + * + * @param usage_path + * @return + */ +void usb_hid_report_null_last_item(usb_hid_report_path_t *usage_path) +{ + usb_hid_report_usage_path_t *item; + + if(!list_empty(&usage_path->link)){ + item = list_get_instance(usage_path->link.prev, usb_hid_report_usage_path_t, link); + memset(item, 0, sizeof(usb_hid_report_usage_path_t)); + } +} + +/** + * + * @param usage_path + * @param tag + * @param data + * @return + */ +void usb_hid_report_set_last_item(usb_hid_report_path_t *usage_path, int32_t tag, int32_t data) +{ + usb_hid_report_usage_path_t *item; + + if(!list_empty(&usage_path->link)){ + item = list_get_instance(usage_path->link.prev, usb_hid_report_usage_path_t, link); + + switch(tag) { + case USB_HID_TAG_CLASS_GLOBAL: + item->usage_page = data; + break; + case USB_HID_TAG_CLASS_LOCAL: + item->usage = data; + break; + } + } + +} + +/** + * + * + * @param report_path + * @param path + * @param flags + * @return + */ +int usb_hid_report_compare_usage_path(usb_hid_report_path_t *report_path, + usb_hid_report_path_t *path, + int flags) +{ + usb_hid_report_usage_path_t *report_item; + usb_hid_report_usage_path_t *path_item; + + link_t *report_link; + link_t *path_link; + + int only_page; + + if(path->depth == 0){ + return EOK; + } + + + if((only_page = flags & USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY) != 0){ + flags -= USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY; + } + + switch(flags){ + /* path must be completly identical */ + case USB_HID_PATH_COMPARE_STRICT: + if(report_path->depth != path->depth){ + return 1; + } + + report_link = report_path->link.next; + path_link = path->link.next; + + while((report_link != &report_path->link) && (path_link != &path->link)) { + report_item = list_get_instance(report_link, usb_hid_report_usage_path_t, link); + path_item = list_get_instance(path_link, usb_hid_report_usage_path_t, link); + + if((report_item->usage_page != path_item->usage_page) || + ((only_page == 0) && (report_item->usage != path_item->usage))) { + return 1; + } else { + report_link = report_link->next; + path_link = path_link->next; + } + + } + + if((report_link == &report_path->link) && (path_link == &path->link)) { + return EOK; + } + else { + return 1; + } + break; + + /* compare with only the end of path*/ + case USB_HID_PATH_COMPARE_END: + report_link = report_path->link.prev; + path_link = path->link.prev; + + if(list_empty(&path->link)){ + return EOK; + } + + while((report_link != &report_path->link) && (path_link != &path->link)) { + report_item = list_get_instance(report_link, usb_hid_report_usage_path_t, link); + path_item = list_get_instance(path_link, usb_hid_report_usage_path_t, link); + + if((report_item->usage_page != path_item->usage_page) || + ((only_page == 0) && (report_item->usage != path_item->usage))) { + return 1; + } else { + report_link = report_link->prev; + path_link = path_link->prev; + } + + } + + if(path_link == &path->link) { + return EOK; + } + else { + return 1; + } + + break; + + default: + return EINVAL; + } + + + + +} + +/** + * + * @return + */ +usb_hid_report_path_t *usb_hid_report_path(void) +{ + usb_hid_report_path_t *path; + path = malloc(sizeof(usb_hid_report_path_t)); + if(!path){ + return NULL; + } + else { + path->depth = 0; + list_initialize(&path->link); + return path; + } +} + +/** + * + * @param path + * @return void + */ +void usb_hid_report_path_free(usb_hid_report_path_t *path) +{ + while(!list_empty(&path->link)){ + usb_hid_report_remove_last_item(path); + } +} + + +/** + * Clone content of given usage path to the new one + * + * @param usage_path + * @return + */ +usb_hid_report_path_t *usb_hid_report_path_clone(usb_hid_report_path_t *usage_path) +{ + usb_hid_report_usage_path_t *path_item; + link_t *path_link; + usb_hid_report_path_t *new_usage_path = usb_hid_report_path (); + + if(new_usage_path == NULL){ + return NULL; + } + + if(list_empty(&usage_path->link)){ + return new_usage_path; + } + + path_link = usage_path->link.next; + while(path_link != &usage_path->link) { + path_item = list_get_instance(path_link, usb_hid_report_usage_path_t, link); + usb_hid_report_path_append_item (new_usage_path, path_item->usage_page, path_item->usage); + + path_link = path_link->next; + } + + return new_usage_path; +} + + +/*** OUTPUT API **/ + +/** Allocates output report buffer + * + * @param parser + * @param size + * @return + */ +uint8_t *usb_hid_report_output(usb_hid_report_parser_t *parser, size_t *size) +{ + if(parser == NULL) { + *size = 0; + return NULL; + } + + // read the last output report item + usb_hid_report_item_t *last; + link_t *link; + + link = parser->output.prev; + if(link != &parser->output) { + last = list_get_instance(link, usb_hid_report_item_t, link); + *size = (last->offset + (last->size * last->count)) / 8; + + uint8_t *buffer = malloc(sizeof(uint8_t) * (*size)); + memset(buffer, 0, sizeof(uint8_t) * (*size)); + usb_log_debug("output buffer: %s\n", usb_debug_str_buffer(buffer, *size, 0)); + + return buffer; + } + else { + *size = 0; + return NULL; + } +} + + +/** Frees output report buffer + * + * @param output Output report buffer + * @return + */ +void usb_hid_report_output_free(uint8_t *output) + +{ + if(output != NULL) { + free (output); + } +} + +/** Returns size of output for given usage path + * + * @param parser + * @param path + * @param flags + * @return + */ +size_t usb_hid_report_output_size(usb_hid_report_parser_t *parser, + usb_hid_report_path_t *path, int flags) +{ + size_t ret = 0; + link_t *item; + usb_hid_report_item_t *report_item; + + if(parser == NULL) { + return 0; + } + + item = parser->output.next; + while(&parser->output != item) { + report_item = list_get_instance(item, usb_hid_report_item_t, link); + if(!USB_HID_ITEM_FLAG_CONSTANT(report_item->item_flags) && + (usb_hid_report_compare_usage_path(report_item->usage_path, path, flags) == EOK)) { + ret += report_item->count; + } + + item = item->next; + } + + return ret; + +} + +/** Updates the output report buffer by translated given data + * + * @param parser + * @param path + * @param flags + * @param buffer + * @param size + * @param data + * @param data_size + * @return + */ +int usb_hid_report_output_translate(usb_hid_report_parser_t *parser, + usb_hid_report_path_t *path, int flags, + uint8_t *buffer, size_t size, + int32_t *data, size_t data_size) +{ + usb_hid_report_item_t *report_item; + link_t *item; + size_t idx=0; + int i=0; + int32_t value=0; + int offset; + int length; + int32_t tmp_value; + + if(parser == NULL) { + return EINVAL; + } + + usb_log_debug("OUTPUT BUFFER: %s\n", usb_debug_str_buffer(buffer,size, 0)); + usb_log_debug("OUTPUT DATA[0]: %d, DATA[1]: %d, DATA[2]: %d\n", data[0], data[1], data[2]); + + item = parser->output.next; + while(item != &parser->output) { + report_item = list_get_instance(item, usb_hid_report_item_t, link); + + for(i=0; icount; i++) { + + if(idx >= data_size) { + break; + } + + if((USB_HID_ITEM_FLAG_VARIABLE(report_item->item_flags) == 0) || + ((report_item->usage_minimum == 0) && (report_item->usage_maximum == 0))) { + +// // variable item + value = usb_hid_translate_data_reverse(report_item, data[idx++]); + offset = report_item->offset + (i * report_item->size); + length = report_item->size; + } + else { + //bitmap + value += usb_hid_translate_data_reverse(report_item, data[idx++]); + offset = report_item->offset; + length = report_item->size * report_item->count; + } + + if((offset/8) == ((offset+length-1)/8)) { + // je to v jednom bytu + if(((size_t)(offset/8) >= size) || ((size_t)(offset+length-1)/8) >= size) { + break; // TODO ErrorCode + } + + size_t shift = offset%8; + + value = value << shift; + value = value & (((1 << length)-1) << shift); + + uint8_t mask = 0; + mask = 0xff - (((1 << length) - 1) << shift); + buffer[offset/8] = (buffer[offset/8] & mask) | value; + } + else { + // je to ve dvou!! FIXME: melo by to umet delsi jak 2 + + // konec prvniho -- dolni x bitu + tmp_value = value; + tmp_value = tmp_value & ((1 << (8-(offset%8)))-1); + tmp_value = tmp_value << (offset%8); + + uint8_t mask = 0; + mask = ~(((1 << (8-(offset%8)))-1) << (offset%8)); + buffer[offset/8] = (buffer[offset/8] & mask) | tmp_value; + + // a ted druhej -- hornich length-x bitu + value = value >> (8 - (offset % 8)); + value = value & ((1 << (length - (8 - (offset % 8)))) - 1); + + mask = ((1 << (length - (8 - (offset % 8)))) - 1); + buffer[(offset+length-1)/8] = (buffer[(offset+length-1)/8] & mask) | value; + } + + } + + item = item->next; + } + + usb_log_debug("OUTPUT BUFFER: %s\n", usb_debug_str_buffer(buffer,size, 0)); + + return EOK; +} + +/** + * + * @param item + * @param value + * @return + */ +int32_t usb_hid_translate_data_reverse(usb_hid_report_item_t *item, int value) +{ + int ret=0; + int resolution; + + if(USB_HID_ITEM_FLAG_CONSTANT(item->item_flags)) { + ret = item->logical_minimum; + } + + if((USB_HID_ITEM_FLAG_VARIABLE(item->item_flags) == 0)) { + + // variable item + if((item->physical_minimum == 0) && (item->physical_maximum == 0)) { + item->physical_minimum = item->logical_minimum; + item->physical_maximum = item->logical_maximum; + } + + if(item->physical_maximum == item->physical_minimum){ + resolution = 1; + } + else { + resolution = (item->logical_maximum - item->logical_minimum) / + ((item->physical_maximum - item->physical_minimum) * + (usb_pow(10,(item->unit_exponent)))); + } + + ret = ((value - item->physical_minimum) * resolution) + item->logical_minimum; + } + else { + // bitmapa + if(value == 0) { + ret = 0; + } + else { + size_t bitmap_idx = (value - item->usage_minimum); + ret = 1 << bitmap_idx; + } + } + + + return ret; +} + + +/** + * @} + */ Index: uspace/lib/usb/src/hidreport.c =================================================================== --- uspace/lib/usb/src/hidreport.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/hidreport.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,228 @@ +/* + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** + * @file + * USB HID keyboard device structure and API. + */ + +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +static int usb_hid_get_report_descriptor(usb_device_t *dev, + uint8_t **report_desc, size_t *size) +{ + assert(report_desc != NULL); + assert(size != NULL); + + usb_dp_parser_t parser = { + .nesting = usb_dp_standard_descriptor_nesting + }; + + usb_dp_parser_data_t parser_data = { + .data = dev->descriptors.configuration, + .size = dev->descriptors.configuration_size, + .arg = NULL + }; + + /* + * First nested descriptor of the configuration descriptor. + */ + uint8_t *d = + usb_dp_get_nested_descriptor(&parser, &parser_data, + dev->descriptors.configuration); + + /* + * Find the interface descriptor corresponding to our interface number. + */ + int i = 0; + while (d != NULL && i < dev->interface_no) { + d = usb_dp_get_sibling_descriptor(&parser, &parser_data, + dev->descriptors.configuration, d); + } + + if (d == NULL) { + usb_log_error("The %d. interface descriptor not found!\n", + dev->interface_no); + return ENOENT; + } + + /* + * First nested descriptor of the interface descriptor. + */ + uint8_t *iface_desc = d; + d = usb_dp_get_nested_descriptor(&parser, &parser_data, iface_desc); + + /* + * Search through siblings until the HID descriptor is found. + */ + while (d != NULL && *(d + 1) != USB_DESCTYPE_HID) { + d = usb_dp_get_sibling_descriptor(&parser, &parser_data, + iface_desc, d); + } + + if (d == NULL) { + usb_log_fatal("No HID descriptor found!\n"); + return ENOENT; + } + + if (*d != sizeof(usb_standard_hid_descriptor_t)) { + usb_log_error("HID descriptor hass wrong size (%u, expected %u" + ")\n", *d, sizeof(usb_standard_hid_descriptor_t)); + return EINVAL; + } + + usb_standard_hid_descriptor_t *hid_desc = + (usb_standard_hid_descriptor_t *)d; + + uint16_t length = hid_desc->report_desc_info.length; + size_t actual_size = 0; + + /* + * Start session for the control transfer. + */ + int sess_rc = usb_pipe_start_session(&dev->ctrl_pipe); + if (sess_rc != EOK) { + usb_log_warning("Failed to start a session: %s.\n", + str_error(sess_rc)); + return sess_rc; + } + + /* + * Allocate space for the report descriptor. + */ + *report_desc = (uint8_t *)malloc(length); + if (*report_desc == NULL) { + usb_log_error("Failed to allocate space for Report descriptor." + "\n"); + return ENOMEM; + } + + usb_log_debug("Getting Report descriptor, expected size: %u\n", length); + + /* + * Get the descriptor from the device. + */ + int rc = usb_request_get_descriptor(&dev->ctrl_pipe, + USB_REQUEST_TYPE_STANDARD, USB_REQUEST_RECIPIENT_INTERFACE, + USB_DESCTYPE_HID_REPORT, 0, dev->interface_no, + *report_desc, length, &actual_size); + + if (rc != EOK) { + free(*report_desc); + *report_desc = NULL; + return rc; + } + + if (actual_size != length) { + free(*report_desc); + *report_desc = NULL; + usb_log_error("Report descriptor has wrong size (%u, expected " + "%u)\n", actual_size, length); + return EINVAL; + } + + /* + * End session for the control transfer. + */ + sess_rc = usb_pipe_end_session(&dev->ctrl_pipe); + if (sess_rc != EOK) { + usb_log_warning("Failed to end a session: %s.\n", + str_error(sess_rc)); + free(*report_desc); + *report_desc = NULL; + return sess_rc; + } + + *size = length; + + usb_log_debug("Done.\n"); + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +int usb_hid_process_report_descriptor(usb_device_t *dev, + usb_hid_report_parser_t *parser) +{ + if (dev == NULL || parser == NULL) { + usb_log_error("Failed to process Report descriptor: wrong " + "parameters given.\n"); + return EINVAL; + } + + uint8_t *report_desc = NULL; + size_t report_size; + + int rc = usb_hid_get_report_descriptor(dev, &report_desc, + &report_size); + + if (rc != EOK) { + usb_log_error("Problem with getting Report descriptor: %s.\n", + str_error(rc)); + if (report_desc != NULL) { + free(report_desc); + } + return rc; + } + + assert(report_desc != NULL); + + rc = usb_hid_parse_report_descriptor(parser, report_desc, report_size); + if (rc != EOK) { + usb_log_error("Problem parsing Report descriptor: %s.\n", + str_error(rc)); + free(report_desc); + return rc; + } + + usb_hid_descriptor_print(parser); + free(report_desc); + + return EOK; +} + +/** + * @} + */ Index: uspace/lib/usb/src/hidreq.c =================================================================== --- uspace/lib/usb/src/hidreq.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/hidreq.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,479 @@ +/* + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** @file + * HID class-specific requests. + */ + +#include +#include +#include + +#include +#include +#include +#include + +#include + +/*----------------------------------------------------------------------------*/ +/** + * Send Set Report request to the HID device. + * + * @param hid_dev HID device to send the request to. + * @param type Type of the report. + * @param buffer Report data. + * @param buf_size Report data size (in bytes). + * + * @retval EOK if successful. + * @retval EINVAL if no HID device is given. + * @return Other value inherited from one of functions + * usb_pipe_start_session(), usb_pipe_end_session(), + * usb_control_request_set(). + */ +int usbhid_req_set_report(usb_pipe_t *ctrl_pipe, int iface_no, + usb_hid_report_type_t type, uint8_t *buffer, size_t buf_size) +{ + if (ctrl_pipe == NULL) { + usb_log_warning("usbhid_req_set_report(): no pipe given.\n"); + return EINVAL; + } + + if (iface_no < 0) { + usb_log_warning("usbhid_req_set_report(): no interface given." + "\n"); + return EINVAL; + } + + /* + * No need for checking other parameters, as they are checked in + * the called function (usb_control_request_set()). + */ + + int rc, sess_rc; + + sess_rc = usb_pipe_start_session(ctrl_pipe); + if (sess_rc != EOK) { + usb_log_warning("Failed to start a session: %s.\n", + str_error(sess_rc)); + return sess_rc; + } + + uint16_t value = 0; + value |= (type << 8); + + usb_log_debug("Sending Set_Report request to the device.\n"); + + rc = usb_control_request_set(ctrl_pipe, + USB_REQUEST_TYPE_CLASS, USB_REQUEST_RECIPIENT_INTERFACE, + USB_HIDREQ_SET_REPORT, value, iface_no, buffer, buf_size); + + sess_rc = usb_pipe_end_session(ctrl_pipe); + + if (rc != EOK) { + usb_log_warning("Error sending output report to the keyboard: " + "%s.\n", str_error(rc)); + return rc; + } + + if (sess_rc != EOK) { + usb_log_warning("Error closing session: %s.\n", + str_error(sess_rc)); + return sess_rc; + } + + return EOK; +} + +/*----------------------------------------------------------------------------*/ +/** + * Send Set Protocol request to the HID device. + * + * @param hid_dev HID device to send the request to. + * @param protocol Protocol to set. + * + * @retval EOK if successful. + * @retval EINVAL if no HID device is given. + * @return Other value inherited from one of functions + * usb_pipe_start_session(), usb_pipe_end_session(), + * usb_control_request_set(). + */ +int usbhid_req_set_protocol(usb_pipe_t *ctrl_pipe, int iface_no, + usb_hid_protocol_t protocol) +{ + if (ctrl_pipe == NULL) { + usb_log_warning("usbhid_req_set_report(): no pipe given.\n"); + return EINVAL; + } + + if (iface_no < 0) { + usb_log_warning("usbhid_req_set_report(): no interface given." + "\n"); + return EINVAL; + } + + /* + * No need for checking other parameters, as they are checked in + * the called function (usb_control_request_set()). + */ + + int rc, sess_rc; + + sess_rc = usb_pipe_start_session(ctrl_pipe); + if (sess_rc != EOK) { + usb_log_warning("Failed to start a session: %s.\n", + str_error(sess_rc)); + return sess_rc; + } + + usb_log_debug("Sending Set_Protocol request to the device (" + "protocol: %d, iface: %d).\n", protocol, iface_no); + + rc = usb_control_request_set(ctrl_pipe, + USB_REQUEST_TYPE_CLASS, USB_REQUEST_RECIPIENT_INTERFACE, + USB_HIDREQ_SET_PROTOCOL, protocol, iface_no, NULL, 0); + + sess_rc = usb_pipe_end_session(ctrl_pipe); + + if (rc != EOK) { + usb_log_warning("Error sending output report to the keyboard: " + "%s.\n", str_error(rc)); + return rc; + } + + if (sess_rc != EOK) { + usb_log_warning("Error closing session: %s.\n", + str_error(sess_rc)); + return sess_rc; + } + + return EOK; +} + +/*----------------------------------------------------------------------------*/ +/** + * Send Set Idle request to the HID device. + * + * @param hid_dev HID device to send the request to. + * @param duration Duration value (is multiplicated by 4 by the device to + * get real duration in miliseconds). + * + * @retval EOK if successful. + * @retval EINVAL if no HID device is given. + * @return Other value inherited from one of functions + * usb_pipe_start_session(), usb_pipe_end_session(), + * usb_control_request_set(). + */ +int usbhid_req_set_idle(usb_pipe_t *ctrl_pipe, int iface_no, uint8_t duration) +{ + if (ctrl_pipe == NULL) { + usb_log_warning("usbhid_req_set_report(): no pipe given.\n"); + return EINVAL; + } + + if (iface_no < 0) { + usb_log_warning("usbhid_req_set_report(): no interface given." + "\n"); + return EINVAL; + } + + /* + * No need for checking other parameters, as they are checked in + * the called function (usb_control_request_set()). + */ + + int rc, sess_rc; + + sess_rc = usb_pipe_start_session(ctrl_pipe); + if (sess_rc != EOK) { + usb_log_warning("Failed to start a session: %s.\n", + str_error(sess_rc)); + return sess_rc; + } + + usb_log_debug("Sending Set_Idle request to the device (" + "duration: %u, iface: %d).\n", duration, iface_no); + + uint16_t value = duration << 8; + + rc = usb_control_request_set(ctrl_pipe, + USB_REQUEST_TYPE_CLASS, USB_REQUEST_RECIPIENT_INTERFACE, + USB_HIDREQ_SET_IDLE, value, iface_no, NULL, 0); + + sess_rc = usb_pipe_end_session(ctrl_pipe); + + if (rc != EOK) { + usb_log_warning("Error sending output report to the keyboard: " + "%s.\n", str_error(rc)); + return rc; + } + + if (sess_rc != EOK) { + usb_log_warning("Error closing session: %s.\n", + str_error(sess_rc)); + return sess_rc; + } + + return EOK; +} + +/*----------------------------------------------------------------------------*/ +/** + * Send Get Report request to the HID device. + * + * @param[in] hid_dev HID device to send the request to. + * @param[in] type Type of the report. + * @param[in][out] buffer Buffer for the report data. + * @param[in] buf_size Size of the buffer (in bytes). + * @param[out] actual_size Actual size of report received from the device + * (in bytes). + * + * @retval EOK if successful. + * @retval EINVAL if no HID device is given. + * @return Other value inherited from one of functions + * usb_pipe_start_session(), usb_pipe_end_session(), + * usb_control_request_set(). + */ +int usbhid_req_get_report(usb_pipe_t *ctrl_pipe, int iface_no, + usb_hid_report_type_t type, uint8_t *buffer, size_t buf_size, + size_t *actual_size) +{ + if (ctrl_pipe == NULL) { + usb_log_warning("usbhid_req_set_report(): no pipe given.\n"); + return EINVAL; + } + + if (iface_no < 0) { + usb_log_warning("usbhid_req_set_report(): no interface given." + "\n"); + return EINVAL; + } + + /* + * No need for checking other parameters, as they are checked in + * the called function (usb_control_request_set()). + */ + + int rc, sess_rc; + + sess_rc = usb_pipe_start_session(ctrl_pipe); + if (sess_rc != EOK) { + usb_log_warning("Failed to start a session: %s.\n", + str_error(sess_rc)); + return sess_rc; + } + + uint16_t value = 0; + value |= (type << 8); + + usb_log_debug("Sending Get_Report request to the device.\n"); + + rc = usb_control_request_get(ctrl_pipe, + USB_REQUEST_TYPE_CLASS, USB_REQUEST_RECIPIENT_INTERFACE, + USB_HIDREQ_GET_REPORT, value, iface_no, buffer, buf_size, + actual_size); + + sess_rc = usb_pipe_end_session(ctrl_pipe); + + if (rc != EOK) { + usb_log_warning("Error sending output report to the keyboard: " + "%s.\n", str_error(rc)); + return rc; + } + + if (sess_rc != EOK) { + usb_log_warning("Error closing session: %s.\n", + str_error(sess_rc)); + return sess_rc; + } + + return EOK; +} + +/*----------------------------------------------------------------------------*/ +/** + * Send Get Protocol request to the HID device. + * + * @param[in] hid_dev HID device to send the request to. + * @param[out] protocol Current protocol of the device. + * + * @retval EOK if successful. + * @retval EINVAL if no HID device is given. + * @return Other value inherited from one of functions + * usb_pipe_start_session(), usb_pipe_end_session(), + * usb_control_request_set(). + */ +int usbhid_req_get_protocol(usb_pipe_t *ctrl_pipe, int iface_no, + usb_hid_protocol_t *protocol) +{ + if (ctrl_pipe == NULL) { + usb_log_warning("usbhid_req_set_report(): no pipe given.\n"); + return EINVAL; + } + + if (iface_no < 0) { + usb_log_warning("usbhid_req_set_report(): no interface given." + "\n"); + return EINVAL; + } + + /* + * No need for checking other parameters, as they are checked in + * the called function (usb_control_request_set()). + */ + + int rc, sess_rc; + + sess_rc = usb_pipe_start_session(ctrl_pipe); + if (sess_rc != EOK) { + usb_log_warning("Failed to start a session: %s.\n", + str_error(sess_rc)); + return sess_rc; + } + + usb_log_debug("Sending Get_Protocol request to the device (" + "iface: %d).\n", iface_no); + + uint8_t buffer[1]; + size_t actual_size = 0; + + rc = usb_control_request_get(ctrl_pipe, + USB_REQUEST_TYPE_CLASS, USB_REQUEST_RECIPIENT_INTERFACE, + USB_HIDREQ_GET_PROTOCOL, 0, iface_no, buffer, 1, &actual_size); + + sess_rc = usb_pipe_end_session(ctrl_pipe); + + if (rc != EOK) { + usb_log_warning("Error sending output report to the keyboard: " + "%s.\n", str_error(rc)); + return rc; + } + + if (sess_rc != EOK) { + usb_log_warning("Error closing session: %s.\n", + str_error(sess_rc)); + return sess_rc; + } + + if (actual_size != 1) { + usb_log_warning("Wrong data size: %zu, expected: 1.\n", + actual_size); + return ELIMIT; + } + + *protocol = buffer[0]; + + return EOK; +} + +/*----------------------------------------------------------------------------*/ +/** + * Send Get Idle request to the HID device. + * + * @param[in] hid_dev HID device to send the request to. + * @param[out] duration Duration value (multiplicate by 4 to get real duration + * in miliseconds). + * + * @retval EOK if successful. + * @retval EINVAL if no HID device is given. + * @return Other value inherited from one of functions + * usb_pipe_start_session(), usb_pipe_end_session(), + * usb_control_request_set(). + */ +int usbhid_req_get_idle(usb_pipe_t *ctrl_pipe, int iface_no, uint8_t *duration) +{ + if (ctrl_pipe == NULL) { + usb_log_warning("usbhid_req_set_report(): no pipe given.\n"); + return EINVAL; + } + + if (iface_no < 0) { + usb_log_warning("usbhid_req_set_report(): no interface given." + "\n"); + return EINVAL; + } + + /* + * No need for checking other parameters, as they are checked in + * the called function (usb_control_request_set()). + */ + + int rc, sess_rc; + + sess_rc = usb_pipe_start_session(ctrl_pipe); + if (sess_rc != EOK) { + usb_log_warning("Failed to start a session: %s.\n", + str_error(sess_rc)); + return sess_rc; + } + + usb_log_debug("Sending Get_Idle request to the device (" + "iface: %d).\n", iface_no); + + uint16_t value = 0; + uint8_t buffer[1]; + size_t actual_size = 0; + + rc = usb_control_request_get(ctrl_pipe, + USB_REQUEST_TYPE_CLASS, USB_REQUEST_RECIPIENT_INTERFACE, + USB_HIDREQ_GET_IDLE, value, iface_no, buffer, 1, + &actual_size); + + sess_rc = usb_pipe_end_session(ctrl_pipe); + + if (rc != EOK) { + usb_log_warning("Error sending output report to the keyboard: " + "%s.\n", str_error(rc)); + return rc; + } + + if (sess_rc != EOK) { + usb_log_warning("Error closing session: %s.\n", + str_error(sess_rc)); + return sess_rc; + } + + if (actual_size != 1) { + usb_log_warning("Wrong data size: %zu, expected: 1.\n", + actual_size); + return ELIMIT; + } + + *duration = buffer[0]; + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +/** + * @} + */ Index: uspace/lib/usb/src/host/batch.c =================================================================== --- uspace/lib/usb/src/host/batch.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/host/batch.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,142 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup libusb + * @{ + */ +/** @file + * USB transfer transaction structures (implementation). + */ +#include +#include + +#include +#include +#include + +void usb_transfer_batch_init( + usb_transfer_batch_t *instance, + usb_target_t target, + usb_transfer_type_t transfer_type, + usb_speed_t speed, + size_t max_packet_size, + char *buffer, + char *transport_buffer, + size_t buffer_size, + char *setup_buffer, + size_t setup_size, + usbhc_iface_transfer_in_callback_t func_in, + usbhc_iface_transfer_out_callback_t func_out, + void *arg, + ddf_fun_t *fun, + void *private_data + ) +{ + assert(instance); + link_initialize(&instance->link); + instance->target = target; + instance->transfer_type = transfer_type; + instance->speed = speed; + instance->direction = USB_DIRECTION_BOTH; + instance->callback_in = func_in; + instance->callback_out = func_out; + instance->arg = arg; + instance->buffer = buffer; + instance->transport_buffer = transport_buffer; + instance->buffer_size = buffer_size; + instance->setup_buffer = setup_buffer; + instance->setup_size = setup_size; + instance->max_packet_size = max_packet_size; + instance->fun = fun; + instance->private_data = private_data; + instance->transfered_size = 0; + instance->next_step = NULL; + instance->error = EOK; + +} +/*----------------------------------------------------------------------------*/ +/** Mark batch as finished and continue with next step. + * + * @param[in] instance Batch structure to use. + * + */ +void usb_transfer_batch_finish(usb_transfer_batch_t *instance, int error) +{ + assert(instance); + instance->error = error; + instance->next_step(instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare data, get error status and call callback in. + * + * @param[in] instance Batch structure to use. + * Copies data from transport buffer, and calls callback with appropriate + * parameters. + */ +void usb_transfer_batch_call_in(usb_transfer_batch_t *instance) +{ + assert(instance); + assert(instance->callback_in); + + /* We are data in, we need data */ + memcpy(instance->buffer, instance->transport_buffer, + instance->buffer_size); + + usb_log_debug("Batch %p done (T%d.%d, %s %s in, %zuB): %s (%d).\n", + instance, + instance->target.address, instance->target.endpoint, + usb_str_speed(instance->speed), + usb_str_transfer_type_short(instance->transfer_type), + instance->transfered_size, + str_error(instance->error), instance->error); + + instance->callback_in(instance->fun, instance->error, + instance->transfered_size, instance->arg); +} +/*----------------------------------------------------------------------------*/ +/** Get error status and call callback out. + * + * @param[in] instance Batch structure to use. + */ +void usb_transfer_batch_call_out(usb_transfer_batch_t *instance) +{ + assert(instance); + assert(instance->callback_out); + + usb_log_debug("Batch %p done (T%d.%d, %s %s out): %s (%d).\n", + instance, + instance->target.address, instance->target.endpoint, + usb_str_speed(instance->speed), + usb_str_transfer_type_short(instance->transfer_type), + str_error(instance->error), instance->error); + + instance->callback_out(instance->fun, + instance->error, instance->arg); +} +/** + * @} + */ Index: uspace/lib/usb/src/host/device_keeper.c =================================================================== --- uspace/lib/usb/src/host/device_keeper.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/host/device_keeper.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,335 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * Device keeper structure and functions (implementation). + */ +#include +#include +#include +#include + +/*----------------------------------------------------------------------------*/ +/** Initialize device keeper structure. + * + * @param[in] instance Memory place to initialize. + * + * Set all values to false/0. + */ +void usb_device_keeper_init(usb_device_keeper_t *instance) +{ + assert(instance); + fibril_mutex_initialize(&instance->guard); + fibril_condvar_initialize(&instance->change); + instance->last_address = 0; + unsigned i = 0; + for (; i < USB_ADDRESS_COUNT; ++i) { + instance->devices[i].occupied = false; + instance->devices[i].control_used = false; + instance->devices[i].handle = 0; + instance->devices[i].toggle_status[0] = 0; + instance->devices[i].toggle_status[1] = 0; + } +} +/*----------------------------------------------------------------------------*/ +/** Attempt to obtain address 0, blocks. + * + * @param[in] instance Device keeper structure to use. + * @param[in] speed Speed of the device requesting default address. + */ +void usb_device_keeper_reserve_default_address(usb_device_keeper_t *instance, + usb_speed_t speed) +{ + assert(instance); + fibril_mutex_lock(&instance->guard); + while (instance->devices[USB_ADDRESS_DEFAULT].occupied) { + fibril_condvar_wait(&instance->change, &instance->guard); + } + instance->devices[USB_ADDRESS_DEFAULT].occupied = true; + instance->devices[USB_ADDRESS_DEFAULT].speed = speed; + fibril_mutex_unlock(&instance->guard); +} +/*----------------------------------------------------------------------------*/ +/** Attempt to obtain address 0, blocks. + * + * @param[in] instance Device keeper structure to use. + * @param[in] speed Speed of the device requesting default address. + */ +void usb_device_keeper_release_default_address(usb_device_keeper_t *instance) +{ + assert(instance); + fibril_mutex_lock(&instance->guard); + instance->devices[USB_ADDRESS_DEFAULT].occupied = false; + fibril_mutex_unlock(&instance->guard); + fibril_condvar_signal(&instance->change); +} +/*----------------------------------------------------------------------------*/ +/** Check setup packet data for signs of toggle reset. + * + * @param[in] instance Device keeper structure to use. + * @param[in] target Device to receive setup packet. + * @param[in] data Setup packet data. + * + * Really ugly one. + */ +void usb_device_keeper_reset_if_need(usb_device_keeper_t *instance, + usb_target_t target, const uint8_t *data) +{ + assert(instance); + fibril_mutex_lock(&instance->guard); + if (target.endpoint > 15 || target.endpoint < 0 + || target.address >= USB_ADDRESS_COUNT || target.address < 0 + || !instance->devices[target.address].occupied) { + fibril_mutex_unlock(&instance->guard); + usb_log_error("Invalid data when checking for toggle reset.\n"); + return; + } + + switch (data[1]) + { + case 0x01: /*clear feature*/ + /* recipient is endpoint, value is zero (ENDPOINT_STALL) */ + if (((data[0] & 0xf) == 1) && ((data[2] | data[3]) == 0)) { + /* endpoint number is < 16, thus first byte is enough */ + instance->devices[target.address].toggle_status[0] &= + ~(1 << data[4]); + instance->devices[target.address].toggle_status[1] &= + ~(1 << data[4]); + } + break; + + case 0x9: /* set configuration */ + case 0x11: /* set interface */ + /* target must be device */ + if ((data[0] & 0xf) == 0) { + instance->devices[target.address].toggle_status[0] = 0; + instance->devices[target.address].toggle_status[1] = 0; + } + break; + } + fibril_mutex_unlock(&instance->guard); +} +/*----------------------------------------------------------------------------*/ +/** Get current value of endpoint toggle. + * + * @param[in] instance Device keeper structure to use. + * @param[in] target Device and endpoint used. + * @return Error code + */ +int usb_device_keeper_get_toggle(usb_device_keeper_t *instance, + usb_target_t target, usb_direction_t direction) +{ + assert(instance); + /* only control pipes are bi-directional and those do not need toggle */ + if (direction == USB_DIRECTION_BOTH) + return ENOENT; + int ret; + fibril_mutex_lock(&instance->guard); + if (target.endpoint > 15 || target.endpoint < 0 + || target.address >= USB_ADDRESS_COUNT || target.address < 0 + || !instance->devices[target.address].occupied) { + usb_log_error("Invalid data when asking for toggle value.\n"); + ret = EINVAL; + } else { + ret = (instance->devices[target.address].toggle_status[direction] + >> target.endpoint) & 1; + } + fibril_mutex_unlock(&instance->guard); + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Set current value of endpoint toggle. + * + * @param[in] instance Device keeper structure to use. + * @param[in] target Device and endpoint used. + * @param[in] toggle Toggle value. + * @return Error code. + */ +int usb_device_keeper_set_toggle(usb_device_keeper_t *instance, + usb_target_t target, usb_direction_t direction, bool toggle) +{ + assert(instance); + /* only control pipes are bi-directional and those do not need toggle */ + if (direction == USB_DIRECTION_BOTH) + return ENOENT; + int ret; + fibril_mutex_lock(&instance->guard); + if (target.endpoint > 15 || target.endpoint < 0 + || target.address >= USB_ADDRESS_COUNT || target.address < 0 + || !instance->devices[target.address].occupied) { + usb_log_error("Invalid data when setting toggle value.\n"); + ret = EINVAL; + } else { + if (toggle) { + instance->devices[target.address].toggle_status[direction] + |= (1 << target.endpoint); + } else { + instance->devices[target.address].toggle_status[direction] + &= ~(1 << target.endpoint); + } + ret = EOK; + } + fibril_mutex_unlock(&instance->guard); + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Get a free USB address + * + * @param[in] instance Device keeper structure to use. + * @param[in] speed Speed of the device requiring address. + * @return Free address, or error code. + */ +usb_address_t device_keeper_get_free_address(usb_device_keeper_t *instance, + usb_speed_t speed) +{ + assert(instance); + fibril_mutex_lock(&instance->guard); + + usb_address_t new_address = instance->last_address; + do { + ++new_address; + if (new_address > USB11_ADDRESS_MAX) + new_address = 1; + if (new_address == instance->last_address) { + fibril_mutex_unlock(&instance->guard); + return ENOSPC; + } + } while (instance->devices[new_address].occupied); + + assert(new_address != USB_ADDRESS_DEFAULT); + assert(instance->devices[new_address].occupied == false); + instance->devices[new_address].occupied = true; + instance->devices[new_address].speed = speed; + instance->devices[new_address].toggle_status[0] = 0; + instance->devices[new_address].toggle_status[1] = 0; + instance->last_address = new_address; + fibril_mutex_unlock(&instance->guard); + return new_address; +} +/*----------------------------------------------------------------------------*/ +/** Bind USB address to devman handle. + * + * @param[in] instance Device keeper structure to use. + * @param[in] address Device address + * @param[in] handle Devman handle of the device. + */ +void usb_device_keeper_bind(usb_device_keeper_t *instance, + usb_address_t address, devman_handle_t handle) +{ + assert(instance); + fibril_mutex_lock(&instance->guard); + assert(address > 0); + assert(address <= USB11_ADDRESS_MAX); + assert(instance->devices[address].occupied); + instance->devices[address].handle = handle; + fibril_mutex_unlock(&instance->guard); +} +/*----------------------------------------------------------------------------*/ +/** Release used USB address. + * + * @param[in] instance Device keeper structure to use. + * @param[in] address Device address + */ +void usb_device_keeper_release(usb_device_keeper_t *instance, + usb_address_t address) +{ + assert(instance); + assert(address > 0); + assert(address <= USB11_ADDRESS_MAX); + + fibril_mutex_lock(&instance->guard); + assert(instance->devices[address].occupied); + instance->devices[address].occupied = false; + fibril_mutex_unlock(&instance->guard); +} +/*----------------------------------------------------------------------------*/ +/** Find USB address associated with the device + * + * @param[in] instance Device keeper structure to use. + * @param[in] handle Devman handle of the device seeking its address. + * @return USB Address, or error code. + */ +usb_address_t usb_device_keeper_find(usb_device_keeper_t *instance, + devman_handle_t handle) +{ + assert(instance); + fibril_mutex_lock(&instance->guard); + usb_address_t address = 1; + while (address <= USB11_ADDRESS_MAX) { + if (instance->devices[address].handle == handle) { + fibril_mutex_unlock(&instance->guard); + return address; + } + ++address; + } + fibril_mutex_unlock(&instance->guard); + return ENOENT; +} +/*----------------------------------------------------------------------------*/ +/** Get speed associated with the address + * + * @param[in] instance Device keeper structure to use. + * @param[in] address Address of the device. + * @return USB speed. + */ +usb_speed_t usb_device_keeper_get_speed(usb_device_keeper_t *instance, + usb_address_t address) +{ + assert(instance); + assert(address >= 0); + assert(address <= USB11_ADDRESS_MAX); + return instance->devices[address].speed; +} +/*----------------------------------------------------------------------------*/ +void usb_device_keeper_use_control(usb_device_keeper_t *instance, + usb_address_t address) +{ + assert(instance); + fibril_mutex_lock(&instance->guard); + while (instance->devices[address].control_used) { + fibril_condvar_wait(&instance->change, &instance->guard); + } + instance->devices[address].control_used = true; + fibril_mutex_unlock(&instance->guard); +} +/*----------------------------------------------------------------------------*/ +void usb_device_keeper_release_control(usb_device_keeper_t *instance, + usb_address_t address) +{ + assert(instance); + fibril_mutex_lock(&instance->guard); + instance->devices[address].control_used = false; + fibril_mutex_unlock(&instance->guard); + fibril_condvar_signal(&instance->change); +} +/** + * @} + */ Index: uspace/lib/usb/src/hub.c =================================================================== --- uspace/lib/usb/src/hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,321 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * Functions needed by hub drivers. + */ +#include +#include +#include +#include +#include +#include +#include + +/** Check that HC connection is alright. + * + * @param conn Connection to be checked. + */ +#define CHECK_CONNECTION(conn) \ + do { \ + assert((conn)); \ + if (!usb_hc_connection_is_opened((conn))) { \ + return ENOENT; \ + } \ + } while (false) + + +/** Tell host controller to reserve default address. + * + * @param connection Opened connection to host controller. + * @param speed Speed of the device that will respond on the default address. + * @return Error code. + */ +int usb_hc_reserve_default_address(usb_hc_connection_t *connection, + usb_speed_t speed) +{ + CHECK_CONNECTION(connection); + + return async_req_2_0(connection->hc_phone, + DEV_IFACE_ID(USBHC_DEV_IFACE), + IPC_M_USBHC_RESERVE_DEFAULT_ADDRESS, speed); +} + +/** Tell host controller to release default address. + * + * @param connection Opened connection to host controller. + * @return Error code. + */ +int usb_hc_release_default_address(usb_hc_connection_t *connection) +{ + CHECK_CONNECTION(connection); + + return async_req_1_0(connection->hc_phone, + DEV_IFACE_ID(USBHC_DEV_IFACE), + IPC_M_USBHC_RELEASE_DEFAULT_ADDRESS); +} + +/** Ask host controller for free address assignment. + * + * @param connection Opened connection to host controller. + * @param speed Speed of the new device (device that will be assigned + * the returned address). + * @return Assigned USB address or negative error code. + */ +usb_address_t usb_hc_request_address(usb_hc_connection_t *connection, + usb_speed_t speed) +{ + CHECK_CONNECTION(connection); + + sysarg_t address; + int rc = async_req_2_1(connection->hc_phone, + DEV_IFACE_ID(USBHC_DEV_IFACE), + IPC_M_USBHC_REQUEST_ADDRESS, speed, + &address); + if (rc != EOK) { + return (usb_address_t) rc; + } else { + return (usb_address_t) address; + } +} + +/** Inform host controller about new device. + * + * @param connection Opened connection to host controller. + * @param attached_device Information about the new device. + * @return Error code. + */ +int usb_hc_register_device(usb_hc_connection_t * connection, + const usb_hc_attached_device_t *attached_device) +{ + CHECK_CONNECTION(connection); + if (attached_device == NULL) { + return EBADMEM; + } + + return async_req_3_0(connection->hc_phone, + DEV_IFACE_ID(USBHC_DEV_IFACE), + IPC_M_USBHC_BIND_ADDRESS, + attached_device->address, attached_device->handle); +} + +/** Inform host controller about device removal. + * + * @param connection Opened connection to host controller. + * @param address Address of the device that is being removed. + * @return Error code. + */ +int usb_hc_unregister_device(usb_hc_connection_t *connection, + usb_address_t address) +{ + CHECK_CONNECTION(connection); + + return async_req_2_0(connection->hc_phone, + DEV_IFACE_ID(USBHC_DEV_IFACE), + IPC_M_USBHC_RELEASE_ADDRESS, address); +} + + +/** Wrapper for registering attached device to the hub. + * + * The @p enable_port function is expected to enable signaling on given + * port. + * The two arguments to it can have arbitrary meaning + * (the @p port_no is only a suggestion) + * and are not touched at all by this function + * (they are passed as is to the @p enable_port function). + * + * If the @p enable_port fails (i.e. does not return EOK), the device + * addition is canceled. + * The return value is then returned (it is good idea to use different + * error codes than those listed as return codes by this function itself). + * + * @param[in] parent Parent device (i.e. the hub device). + * @param[in] connection Opened connection to host controller. + * @param[in] dev_speed New device speed. + * @param[in] enable_port Function for enabling signaling through the port the + * device is attached to. + * @param[in] port_no Port number (passed through to @p enable_port). + * @param[in] arg Any data argument to @p enable_port. + * @param[out] assigned_address USB address of the device. + * @param[out] assigned_handle Devman handle of the new device. + * @param[in] dev_ops Child device ops. + * @param[in] new_dev_data Arbitrary pointer to be stored in the child + * as @c driver_data. + * @param[out] new_fun Storage where pointer to allocated child function + * will be written. + * @return Error code. + * @retval ENOENT Connection to HC not opened. + * @retval EADDRNOTAVAIL Failed retrieving free address from host controller. + * @retval EBUSY Failed reserving default USB address. + * @retval ENOTCONN Problem connecting to the host controller via USB pipe. + * @retval ESTALL Problem communication with device (either SET_ADDRESS + * request or requests for descriptors when creating match ids). + */ +int usb_hc_new_device_wrapper(ddf_dev_t *parent, usb_hc_connection_t *connection, + usb_speed_t dev_speed, + int (*enable_port)(int port_no, void *arg), int port_no, void *arg, + usb_address_t *assigned_address, devman_handle_t *assigned_handle, + ddf_dev_ops_t *dev_ops, void *new_dev_data, ddf_fun_t **new_fun) +{ + CHECK_CONNECTION(connection); + + /* + * Request new address. + */ + usb_address_t dev_addr = usb_hc_request_address(connection, dev_speed); + if (dev_addr < 0) { + return EADDRNOTAVAIL; + } + + int rc; + + /* + * Reserve the default address. + */ + rc = usb_hc_reserve_default_address(connection, dev_speed); + if (rc != EOK) { + rc = EBUSY; + goto leave_release_free_address; + } + + /* + * Enable the port (i.e. allow signaling through this port). + */ + rc = enable_port(port_no, arg); + if (rc != EOK) { + goto leave_release_default_address; + } + + /* + * Change the address from default to the free one. + * We need to create a new control pipe for that. + */ + usb_device_connection_t dev_conn; + rc = usb_device_connection_initialize_on_default_address(&dev_conn, + connection); + if (rc != EOK) { + rc = ENOTCONN; + goto leave_release_default_address; + } + + usb_pipe_t ctrl_pipe; + rc = usb_pipe_initialize_default_control(&ctrl_pipe, + &dev_conn); + if (rc != EOK) { + rc = ENOTCONN; + goto leave_release_default_address; + } + rc = usb_pipe_probe_default_control(&ctrl_pipe); + if (rc != EOK) { + rc = ENOTCONN; + goto leave_release_default_address; + } + + rc = usb_pipe_start_session(&ctrl_pipe); + if (rc != EOK) { + rc = ENOTCONN; + goto leave_release_default_address; + } + + rc = usb_request_set_address(&ctrl_pipe, dev_addr); + if (rc != EOK) { + rc = ESTALL; + goto leave_stop_session; + } + + usb_pipe_end_session(&ctrl_pipe); + + /* + * Once the address is changed, we can return the default address. + */ + usb_hc_release_default_address(connection); + + /* + * It is time to register the device with devman. + */ + /* FIXME: create device_register that will get opened ctrl pipe. */ + devman_handle_t child_handle; + rc = usb_device_register_child_in_devman(dev_addr, dev_conn.hc_handle, + parent, &child_handle, + dev_ops, new_dev_data, new_fun); + if (rc != EOK) { + rc = ESTALL; + goto leave_release_free_address; + } + + /* + * And now inform the host controller about the handle. + */ + usb_hc_attached_device_t new_device = { + .address = dev_addr, + .handle = child_handle + }; + rc = usb_hc_register_device(connection, &new_device); + if (rc != EOK) { + rc = EDESTADDRREQ; + goto leave_release_free_address; + } + + /* + * And we are done. + */ + if (assigned_address != NULL) { + *assigned_address = dev_addr; + } + if (assigned_handle != NULL) { + *assigned_handle = child_handle; + } + + return EOK; + + + + /* + * Error handling (like nested exceptions) starts here. + * Completely ignoring errors here. + */ + +leave_stop_session: + usb_pipe_end_session(&ctrl_pipe); + +leave_release_default_address: + usb_hc_release_default_address(connection); + +leave_release_free_address: + usb_hc_unregister_device(connection, dev_addr); + + return rc; +} + +/** + * @} + */ Index: uspace/lib/usb/src/pipes.c =================================================================== --- uspace/lib/usb/src/pipes.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/pipes.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,305 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * USB endpoint pipes miscellaneous functions. + */ +#include +#include +#include +#include +#include +#include +#include +#include + +#define IPC_AGAIN_DELAY (1000 * 2) /* 2ms */ + +/** Tell USB address assigned to given device. + * + * @param phone Phone to parent device. + * @param dev Device in question. + * @return USB address or error code. + */ +static usb_address_t get_my_address(int phone, ddf_dev_t *dev) +{ + sysarg_t address; + + /* + * We are sending special value as a handle - zero - to get + * handle of the parent function (that handle was used + * when registering our device @p dev. + */ + int rc = async_req_2_1(phone, DEV_IFACE_ID(USB_DEV_IFACE), + IPC_M_USB_GET_ADDRESS, + 0, &address); + + if (rc != EOK) { + return rc; + } + + return (usb_address_t) address; +} + +/** Tell USB interface assigned to given device. + * + * @param device Device in question. + * @return Interface number (negative code means any). + */ +int usb_device_get_assigned_interface(ddf_dev_t *device) +{ + int parent_phone = devman_parent_device_connect(device->handle, + IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return -1; + } + + sysarg_t iface_no; + int rc = async_req_2_1(parent_phone, DEV_IFACE_ID(USB_DEV_IFACE), + IPC_M_USB_GET_INTERFACE, + device->handle, &iface_no); + + async_hangup(parent_phone); + + if (rc != EOK) { + return -1; + } + + return (int) iface_no; +} + +/** Tell USB address assigned to given device. + * + * @param dev_handle Devman handle of the USB device in question. + * @return USB address or negative error code. + */ +usb_address_t usb_device_get_assigned_address(devman_handle_t dev_handle) +{ + int parent_phone = devman_parent_device_connect(dev_handle, + IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + + sysarg_t address; + + int rc = async_req_2_1(parent_phone, DEV_IFACE_ID(USB_DEV_IFACE), + IPC_M_USB_GET_ADDRESS, + dev_handle, &address); + + if (rc != EOK) { + return rc; + } + + async_hangup(parent_phone); + + return (usb_address_t) address; +} + +/** Initialize connection to USB device. + * + * @param connection Connection structure to be initialized. + * @param dev Generic device backing the USB device. + * @return Error code. + */ +int usb_device_connection_initialize_from_device( + usb_device_connection_t *connection, ddf_dev_t *dev) +{ + assert(connection); + assert(dev); + + int rc; + devman_handle_t hc_handle; + usb_address_t my_address; + + rc = usb_hc_find(dev->handle, &hc_handle); + if (rc != EOK) { + return rc; + } + + int parent_phone = devman_parent_device_connect(dev->handle, + IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + + /* + * Asking for "my" address may require several attempts. + * That is because following scenario may happen: + * - parent driver (i.e. driver of parent device) announces new device + * and devman launches current driver + * - parent driver is preempted and thus does not send address-handle + * binding to HC driver + * - this driver gets here and wants the binding + * - the HC does not know the binding yet and thus it answers ENOENT + * So, we need to wait for the HC to learn the binding. + */ + do { + my_address = get_my_address(parent_phone, dev); + + if (my_address == ENOENT) { + /* Be nice, let other fibrils run and try again. */ + async_usleep(IPC_AGAIN_DELAY); + } else if (my_address < 0) { + /* Some other problem, no sense trying again. */ + rc = my_address; + goto leave; + } + + } while (my_address < 0); + + rc = usb_device_connection_initialize(connection, + hc_handle, my_address); + +leave: + async_hangup(parent_phone); + return rc; +} + +/** Initialize connection to USB device. + * + * @param connection Connection structure to be initialized. + * @param host_controller_handle Devman handle of host controller device is + * connected to. + * @param device_address Device USB address. + * @return Error code. + */ +int usb_device_connection_initialize(usb_device_connection_t *connection, + devman_handle_t host_controller_handle, usb_address_t device_address) +{ + assert(connection); + + if ((device_address < 0) || (device_address >= USB11_ADDRESS_MAX)) { + return EINVAL; + } + + connection->hc_handle = host_controller_handle; + connection->address = device_address; + + return EOK; +} + +/** Initialize connection to USB device on default address. + * + * @param dev_connection Device connection structure to be initialized. + * @param hc_connection Initialized connection to host controller. + * @return Error code. + */ +int usb_device_connection_initialize_on_default_address( + usb_device_connection_t *dev_connection, + usb_hc_connection_t *hc_connection) +{ + assert(dev_connection); + + if (hc_connection == NULL) { + return EBADMEM; + } + + return usb_device_connection_initialize(dev_connection, + hc_connection->hc_handle, (usb_address_t) 0); +} + + +/** Start a session on the endpoint pipe. + * + * A session is something inside what any communication occurs. + * It is expected that sessions would be started right before the transfer + * and ended - see usb_pipe_end_session() - after the last + * transfer. + * The reason for this is that session actually opens some communication + * channel to the host controller (or to the physical hardware if you + * wish) and thus it involves acquiring kernel resources. + * Since they are limited, sessions shall not be longer than strictly + * necessary. + * + * @param pipe Endpoint pipe to start the session on. + * @return Error code. + */ +int usb_pipe_start_session(usb_pipe_t *pipe) +{ + assert(pipe); + + if (usb_pipe_is_session_started(pipe)) { + return EBUSY; + } + + int phone = devman_device_connect(pipe->wire->hc_handle, 0); + if (phone < 0) { + return phone; + } + + pipe->hc_phone = phone; + + return EOK; +} + + +/** Ends a session on the endpoint pipe. + * + * @see usb_pipe_start_session + * + * @param pipe Endpoint pipe to end the session on. + * @return Error code. + */ +int usb_pipe_end_session(usb_pipe_t *pipe) +{ + assert(pipe); + + if (!usb_pipe_is_session_started(pipe)) { + return ENOENT; + } + + int rc = async_hangup(pipe->hc_phone); + if (rc != EOK) { + return rc; + } + + pipe->hc_phone = -1; + + return EOK; +} + +/** Tell whether a session is started (open) on the endpoint pipe. + * + * The expected usage of this function is in assertions for some + * nested functions. + * + * @param pipe Endpoint pipe in question. + * @return Whether @p pipe has opened a session. + */ +bool usb_pipe_is_session_started(usb_pipe_t *pipe) +{ + return (pipe->hc_phone >= 0); +} + +/** + * @} + */ Index: uspace/lib/usb/src/pipesinit.c =================================================================== --- uspace/lib/usb/src/pipesinit.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/pipesinit.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,498 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * Initialization of endpoint pipes. + * + */ +#include +#include +#include +#include +#include +#include +#include + +#define CTRL_PIPE_MIN_PACKET_SIZE 8 +#define DEV_DESCR_MAX_PACKET_SIZE_OFFSET 7 + + +#define NESTING(parentname, childname) \ + { \ + .child = USB_DESCTYPE_##childname, \ + .parent = USB_DESCTYPE_##parentname, \ + } +#define LAST_NESTING { -1, -1 } + +/** Nesting pairs of standard descriptors. */ +static usb_dp_descriptor_nesting_t descriptor_nesting[] = { + NESTING(CONFIGURATION, INTERFACE), + NESTING(INTERFACE, ENDPOINT), + NESTING(INTERFACE, HUB), + NESTING(INTERFACE, HID), + NESTING(HID, HID_REPORT), + LAST_NESTING +}; + +/** Tells whether given descriptor is of endpoint type. + * + * @param descriptor Descriptor in question. + * @return Whether the given descriptor is endpoint descriptor. + */ +static inline bool is_endpoint_descriptor(uint8_t *descriptor) +{ + return descriptor[1] == USB_DESCTYPE_ENDPOINT; +} + +/** Tells whether found endpoint corresponds to endpoint described by user. + * + * @param wanted Endpoint description as entered by driver author. + * @param found Endpoint description obtained from endpoint descriptor. + * @return Whether the @p found descriptor fits the @p wanted descriptor. + */ +static bool endpoint_fits_description(const usb_endpoint_description_t *wanted, + usb_endpoint_description_t *found) +{ +#define _SAME(fieldname) ((wanted->fieldname) == (found->fieldname)) + + if (!_SAME(direction)) { + return false; + } + + if (!_SAME(transfer_type)) { + return false; + } + + if ((wanted->interface_class >= 0) && !_SAME(interface_class)) { + return false; + } + + if ((wanted->interface_subclass >= 0) && !_SAME(interface_subclass)) { + return false; + } + + if ((wanted->interface_protocol >= 0) && !_SAME(interface_protocol)) { + return false; + } + +#undef _SAME + + return true; +} + +/** Find endpoint mapping for a found endpoint. + * + * @param mapping Endpoint mapping list. + * @param mapping_count Number of endpoint mappings in @p mapping. + * @param found_endpoint Description of found endpoint. + * @param interface_number Number of currently processed interface. + * @return Endpoint mapping corresponding to @p found_endpoint. + * @retval NULL No corresponding endpoint found. + */ +static usb_endpoint_mapping_t *find_endpoint_mapping( + usb_endpoint_mapping_t *mapping, size_t mapping_count, + usb_endpoint_description_t *found_endpoint, + int interface_number) +{ + while (mapping_count > 0) { + bool interface_number_fits = (mapping->interface_no < 0) + || (mapping->interface_no == interface_number); + + bool endpoint_descriptions_fits = endpoint_fits_description( + mapping->description, found_endpoint); + + if (interface_number_fits && endpoint_descriptions_fits) { + return mapping; + } + + mapping++; + mapping_count--; + } + return NULL; +} + +/** Process endpoint descriptor. + * + * @param mapping Endpoint mapping list. + * @param mapping_count Number of endpoint mappings in @p mapping. + * @param interface Interface descriptor under which belongs the @p endpoint. + * @param endpoint Endpoint descriptor. + * @param wire Connection backing the endpoint pipes. + * @return Error code. + */ +static int process_endpoint( + usb_endpoint_mapping_t *mapping, size_t mapping_count, + usb_standard_interface_descriptor_t *interface, + usb_standard_endpoint_descriptor_t *endpoint, + usb_device_connection_t *wire) +{ + usb_endpoint_description_t description; + + /* + * Get endpoint characteristics. + */ + + /* Actual endpoint number is in bits 0..3 */ + usb_endpoint_t ep_no = endpoint->endpoint_address & 0x0F; + + /* Endpoint direction is set by bit 7 */ + description.direction = (endpoint->endpoint_address & 128) + ? USB_DIRECTION_IN : USB_DIRECTION_OUT; + /* Transfer type is in bits 0..2 and the enum values corresponds 1:1 */ + description.transfer_type = endpoint->attributes & 3; + + /* + * Get interface characteristics. + */ + description.interface_class = interface->interface_class; + description.interface_subclass = interface->interface_subclass; + description.interface_protocol = interface->interface_protocol; + + /* + * Find the most fitting mapping and initialize the pipe. + */ + usb_endpoint_mapping_t *ep_mapping = find_endpoint_mapping(mapping, + mapping_count, &description, interface->interface_number); + if (ep_mapping == NULL) { + return ENOENT; + } + + if (ep_mapping->pipe == NULL) { + return EBADMEM; + } + if (ep_mapping->present) { + return EEXISTS; + } + + int rc = usb_pipe_initialize(ep_mapping->pipe, wire, + ep_no, description.transfer_type, endpoint->max_packet_size, + description.direction); + if (rc != EOK) { + return rc; + } + + ep_mapping->present = true; + ep_mapping->descriptor = endpoint; + ep_mapping->interface = interface; + + return EOK; +} + +/** Process whole USB interface. + * + * @param mapping Endpoint mapping list. + * @param mapping_count Number of endpoint mappings in @p mapping. + * @param parser Descriptor parser. + * @param parser_data Descriptor parser data. + * @param interface_descriptor Interface descriptor. + * @return Error code. + */ +static int process_interface( + usb_endpoint_mapping_t *mapping, size_t mapping_count, + usb_dp_parser_t *parser, usb_dp_parser_data_t *parser_data, + uint8_t *interface_descriptor) +{ + uint8_t *descriptor = usb_dp_get_nested_descriptor(parser, + parser_data, interface_descriptor); + + if (descriptor == NULL) { + return ENOENT; + } + + do { + if (is_endpoint_descriptor(descriptor)) { + (void) process_endpoint(mapping, mapping_count, + (usb_standard_interface_descriptor_t *) + interface_descriptor, + (usb_standard_endpoint_descriptor_t *) + descriptor, + (usb_device_connection_t *) parser_data->arg); + } + + descriptor = usb_dp_get_sibling_descriptor(parser, parser_data, + interface_descriptor, descriptor); + } while (descriptor != NULL); + + return EOK; +} + +/** Initialize endpoint pipes from configuration descriptor. + * + * The mapping array is expected to conform to following rules: + * - @c pipe must point to already allocated structure with uninitialized pipe + * - @c description must point to prepared endpoint description + * - @c descriptor does not need to be initialized (will be overwritten) + * - @c interface does not need to be initialized (will be overwritten) + * - @c present does not need to be initialized (will be overwritten) + * + * After processing the configuration descriptor, the mapping is updated + * in the following fashion: + * - @c present will be set to @c true when the endpoint was found in the + * configuration + * - @c descriptor will point inside the configuration descriptor to endpoint + * corresponding to given description (or NULL for not found descriptor) + * - @c interface will point inside the configuration descriptor to interface + * descriptor the endpoint @c descriptor belongs to (or NULL for not found + * descriptor) + * - @c pipe will be initialized when found, otherwise left untouched + * - @c description will be untouched under all circumstances + * + * @param mapping Endpoint mapping list. + * @param mapping_count Number of endpoint mappings in @p mapping. + * @param configuration_descriptor Full configuration descriptor (is expected + * to be in USB endianness: i.e. as-is after being retrieved from + * the device). + * @param configuration_descriptor_size Size of @p configuration_descriptor + * in bytes. + * @param connection Connection backing the endpoint pipes. + * @return Error code. + */ +int usb_pipe_initialize_from_configuration( + usb_endpoint_mapping_t *mapping, size_t mapping_count, + uint8_t *configuration_descriptor, size_t configuration_descriptor_size, + usb_device_connection_t *connection) +{ + assert(connection); + + if (configuration_descriptor == NULL) { + return EBADMEM; + } + if (configuration_descriptor_size + < sizeof(usb_standard_configuration_descriptor_t)) { + return ERANGE; + } + + /* + * Go through the mapping and set all endpoints to not present. + */ + size_t i; + for (i = 0; i < mapping_count; i++) { + mapping[i].present = false; + mapping[i].descriptor = NULL; + mapping[i].interface = NULL; + } + + /* + * Prepare the descriptor parser. + */ + usb_dp_parser_t dp_parser = { + .nesting = descriptor_nesting + }; + usb_dp_parser_data_t dp_data = { + .data = configuration_descriptor, + .size = configuration_descriptor_size, + .arg = connection + }; + + /* + * Iterate through all interfaces. + */ + uint8_t *interface = usb_dp_get_nested_descriptor(&dp_parser, + &dp_data, configuration_descriptor); + if (interface == NULL) { + return ENOENT; + } + do { + (void) process_interface(mapping, mapping_count, + &dp_parser, &dp_data, + interface); + interface = usb_dp_get_sibling_descriptor(&dp_parser, &dp_data, + configuration_descriptor, interface); + } while (interface != NULL); + + return EOK; +} + +/** Initialize USB endpoint pipe. + * + * @param pipe Endpoint pipe to be initialized. + * @param connection Connection to the USB device backing this pipe (the wire). + * @param endpoint_no Endpoint number (in USB 1.1 in range 0 to 15). + * @param transfer_type Transfer type (e.g. interrupt or bulk). + * @param max_packet_size Maximum packet size in bytes. + * @param direction Endpoint direction (in/out). + * @return Error code. + */ +int usb_pipe_initialize(usb_pipe_t *pipe, + usb_device_connection_t *connection, usb_endpoint_t endpoint_no, + usb_transfer_type_t transfer_type, size_t max_packet_size, + usb_direction_t direction) +{ + assert(pipe); + assert(connection); + + pipe->wire = connection; + pipe->hc_phone = -1; + pipe->endpoint_no = endpoint_no; + pipe->transfer_type = transfer_type; + pipe->max_packet_size = max_packet_size; + pipe->direction = direction; + + return EOK; +} + + +/** Initialize USB endpoint pipe as the default zero control pipe. + * + * @param pipe Endpoint pipe to be initialized. + * @param connection Connection to the USB device backing this pipe (the wire). + * @return Error code. + */ +int usb_pipe_initialize_default_control(usb_pipe_t *pipe, + usb_device_connection_t *connection) +{ + assert(pipe); + assert(connection); + + int rc = usb_pipe_initialize(pipe, connection, + 0, USB_TRANSFER_CONTROL, CTRL_PIPE_MIN_PACKET_SIZE, + USB_DIRECTION_BOTH); + + return rc; +} + +/** Probe default control pipe for max packet size. + * + * The function tries to get the correct value of max packet size several + * time before giving up. + * + * The session on the pipe shall not be started. + * + * @param pipe Default control pipe. + * @return Error code. + */ +int usb_pipe_probe_default_control(usb_pipe_t *pipe) +{ + assert(pipe); + assert(DEV_DESCR_MAX_PACKET_SIZE_OFFSET < CTRL_PIPE_MIN_PACKET_SIZE); + + if ((pipe->direction != USB_DIRECTION_BOTH) || + (pipe->transfer_type != USB_TRANSFER_CONTROL) || + (pipe->endpoint_no != 0)) { + return EINVAL; + } + +#define TRY_LOOP(attempt_var) \ + for (attempt_var = 0; attempt_var < 3; attempt_var++) + + size_t failed_attempts; + int rc; + + TRY_LOOP(failed_attempts) { + rc = usb_pipe_start_session(pipe); + if (rc == EOK) { + break; + } + } + if (rc != EOK) { + return rc; + } + + + uint8_t dev_descr_start[CTRL_PIPE_MIN_PACKET_SIZE]; + size_t transferred_size; + TRY_LOOP(failed_attempts) { + rc = usb_request_get_descriptor(pipe, USB_REQUEST_TYPE_STANDARD, + USB_REQUEST_RECIPIENT_DEVICE, USB_DESCTYPE_DEVICE, + 0, 0, dev_descr_start, CTRL_PIPE_MIN_PACKET_SIZE, + &transferred_size); + if (rc == EOK) { + if (transferred_size != CTRL_PIPE_MIN_PACKET_SIZE) { + rc = ELIMIT; + continue; + } + break; + } + } + usb_pipe_end_session(pipe); + if (rc != EOK) { + return rc; + } + + pipe->max_packet_size + = dev_descr_start[DEV_DESCR_MAX_PACKET_SIZE_OFFSET]; + + return EOK; +} + +/** Register endpoint with the host controller. + * + * @param pipe Pipe to be registered. + * @param interval Polling interval. + * @param hc_connection Connection to the host controller (must be opened). + * @return Error code. + */ +int usb_pipe_register(usb_pipe_t *pipe, + unsigned int interval, + usb_hc_connection_t *hc_connection) +{ + assert(pipe); + assert(hc_connection); + + if (!usb_hc_connection_is_opened(hc_connection)) { + return EBADF; + } + +#define _PACK(high, low) ((high) * 256 + (low)) + + return async_req_5_0(hc_connection->hc_phone, + DEV_IFACE_ID(USBHC_DEV_IFACE), IPC_M_USBHC_REGISTER_ENDPOINT, + _PACK(pipe->wire->address, pipe->endpoint_no), + _PACK(pipe->transfer_type, pipe->direction), + pipe->max_packet_size, interval); + +#undef _PACK +} + +/** Revert endpoint registration with the host controller. + * + * @param pipe Pipe to be unregistered. + * @param hc_connection Connection to the host controller (must be opened). + * @return Error code. + */ +int usb_pipe_unregister(usb_pipe_t *pipe, + usb_hc_connection_t *hc_connection) +{ + assert(pipe); + assert(hc_connection); + + if (!usb_hc_connection_is_opened(hc_connection)) { + return EBADF; + } + + return async_req_4_0(hc_connection->hc_phone, + DEV_IFACE_ID(USBHC_DEV_IFACE), IPC_M_USBHC_UNREGISTER_ENDPOINT, + pipe->wire->address, pipe->endpoint_no, pipe->direction); +} + +/** + * @} + */ Index: uspace/lib/usb/src/pipesio.c =================================================================== --- uspace/lib/usb/src/pipesio.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/pipesio.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,511 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * Input and output functions (reads and writes) on endpoint pipes. + * + * Note on synchronousness of the operations: there is ABSOLUTELY NO + * guarantee that a call to particular function will not trigger a fibril + * switch. + * + * Note about the implementation: the transfer requests are always divided + * into two functions. + * The outer one does checking of input parameters (e.g. that session was + * already started, buffers are not NULL etc), while the inner one + * (with _no_checks suffix) does the actual IPC (it checks for IPC errors, + * obviously). + */ +#include +#include +#include +#include +#include + +/** Request an in transfer, no checking of input parameters. + * + * @param[in] pipe Pipe used for the transfer. + * @param[out] buffer Buffer where to store the data. + * @param[in] size Size of the buffer (in bytes). + * @param[out] size_transfered Number of bytes that were actually transfered. + * @return Error code. + */ +static int usb_pipe_read_no_checks(usb_pipe_t *pipe, + void *buffer, size_t size, size_t *size_transfered) +{ + /* + * Get corresponding IPC method. + * In future, replace with static array of mappings + * transfer type -> method. + */ + usbhc_iface_funcs_t ipc_method; + switch (pipe->transfer_type) { + case USB_TRANSFER_INTERRUPT: + ipc_method = IPC_M_USBHC_INTERRUPT_IN; + break; + case USB_TRANSFER_BULK: + ipc_method = IPC_M_USBHC_BULK_IN; + break; + default: + return ENOTSUP; + } + + /* + * Make call identifying target USB device and type of transfer. + */ + aid_t opening_request = async_send_4(pipe->hc_phone, + DEV_IFACE_ID(USBHC_DEV_IFACE), ipc_method, + pipe->wire->address, pipe->endpoint_no, + pipe->max_packet_size, + NULL); + if (opening_request == 0) { + return ENOMEM; + } + + /* + * Retrieve the data. + */ + ipc_call_t data_request_call; + aid_t data_request = async_data_read(pipe->hc_phone, buffer, size, + &data_request_call); + + if (data_request == 0) { + /* + * FIXME: + * How to let the other side know that we want to abort? + */ + async_wait_for(opening_request, NULL); + return ENOMEM; + } + + /* + * Wait for the answer. + */ + sysarg_t data_request_rc; + sysarg_t opening_request_rc; + async_wait_for(data_request, &data_request_rc); + async_wait_for(opening_request, &opening_request_rc); + + if (data_request_rc != EOK) { + /* Prefer the return code of the opening request. */ + if (opening_request_rc != EOK) { + return (int) opening_request_rc; + } else { + return (int) data_request_rc; + } + } + if (opening_request_rc != EOK) { + return (int) opening_request_rc; + } + + *size_transfered = IPC_GET_ARG2(data_request_call); + + return EOK; +} + + +/** Request a read (in) transfer on an endpoint pipe. + * + * @param[in] pipe Pipe used for the transfer. + * @param[out] buffer Buffer where to store the data. + * @param[in] size Size of the buffer (in bytes). + * @param[out] size_transfered Number of bytes that were actually transfered. + * @return Error code. + */ +int usb_pipe_read(usb_pipe_t *pipe, + void *buffer, size_t size, size_t *size_transfered) +{ + assert(pipe); + + if (buffer == NULL) { + return EINVAL; + } + + if (size == 0) { + return EINVAL; + } + + if (!usb_pipe_is_session_started(pipe)) { + return EBADF; + } + + if (pipe->direction != USB_DIRECTION_IN) { + return EBADF; + } + + if (pipe->transfer_type == USB_TRANSFER_CONTROL) { + return EBADF; + } + + size_t act_size = 0; + int rc; + + rc = usb_pipe_read_no_checks(pipe, buffer, size, &act_size); + if (rc != EOK) { + return rc; + } + + if (size_transfered != NULL) { + *size_transfered = act_size; + } + + return EOK; +} + + + + +/** Request an out transfer, no checking of input parameters. + * + * @param[in] pipe Pipe used for the transfer. + * @param[in] buffer Buffer with data to transfer. + * @param[in] size Size of the buffer (in bytes). + * @return Error code. + */ +static int usb_pipe_write_no_check(usb_pipe_t *pipe, + void *buffer, size_t size) +{ + /* + * Get corresponding IPC method. + * In future, replace with static array of mappings + * transfer type -> method. + */ + usbhc_iface_funcs_t ipc_method; + switch (pipe->transfer_type) { + case USB_TRANSFER_INTERRUPT: + ipc_method = IPC_M_USBHC_INTERRUPT_OUT; + break; + case USB_TRANSFER_BULK: + ipc_method = IPC_M_USBHC_BULK_OUT; + break; + default: + return ENOTSUP; + } + + /* + * Make call identifying target USB device and type of transfer. + */ + aid_t opening_request = async_send_4(pipe->hc_phone, + DEV_IFACE_ID(USBHC_DEV_IFACE), ipc_method, + pipe->wire->address, pipe->endpoint_no, + pipe->max_packet_size, + NULL); + if (opening_request == 0) { + return ENOMEM; + } + + /* + * Send the data. + */ + int rc = async_data_write_start(pipe->hc_phone, buffer, size); + if (rc != EOK) { + async_wait_for(opening_request, NULL); + return rc; + } + + /* + * Wait for the answer. + */ + sysarg_t opening_request_rc; + async_wait_for(opening_request, &opening_request_rc); + + return (int) opening_request_rc; +} + +/** Request a write (out) transfer on an endpoint pipe. + * + * @param[in] pipe Pipe used for the transfer. + * @param[in] buffer Buffer with data to transfer. + * @param[in] size Size of the buffer (in bytes). + * @return Error code. + */ +int usb_pipe_write(usb_pipe_t *pipe, + void *buffer, size_t size) +{ + assert(pipe); + + if (buffer == NULL) { + return EINVAL; + } + + if (size == 0) { + return EINVAL; + } + + if (!usb_pipe_is_session_started(pipe)) { + return EBADF; + } + + if (pipe->direction != USB_DIRECTION_OUT) { + return EBADF; + } + + if (pipe->transfer_type == USB_TRANSFER_CONTROL) { + return EBADF; + } + + int rc = usb_pipe_write_no_check(pipe, buffer, size); + + return rc; +} + + +/** Request a control read transfer, no checking of input parameters. + * + * @param[in] pipe Pipe used for the transfer. + * @param[in] setup_buffer Buffer with the setup packet. + * @param[in] setup_buffer_size Size of the setup packet (in bytes). + * @param[out] data_buffer Buffer for incoming data. + * @param[in] data_buffer_size Size of the buffer for incoming data (in bytes). + * @param[out] data_transfered_size Number of bytes that were actually + * transfered during the DATA stage. + * @return Error code. + */ +static int usb_pipe_control_read_no_check(usb_pipe_t *pipe, + void *setup_buffer, size_t setup_buffer_size, + void *data_buffer, size_t data_buffer_size, size_t *data_transfered_size) +{ + /* + * Make call identifying target USB device and control transfer type. + */ + aid_t opening_request = async_send_4(pipe->hc_phone, + DEV_IFACE_ID(USBHC_DEV_IFACE), IPC_M_USBHC_CONTROL_READ, + pipe->wire->address, pipe->endpoint_no, + pipe->max_packet_size, + NULL); + if (opening_request == 0) { + return ENOMEM; + } + + /* + * Send the setup packet. + */ + int rc = async_data_write_start(pipe->hc_phone, + setup_buffer, setup_buffer_size); + if (rc != EOK) { + async_wait_for(opening_request, NULL); + return rc; + } + + /* + * Retrieve the data. + */ + ipc_call_t data_request_call; + aid_t data_request = async_data_read(pipe->hc_phone, + data_buffer, data_buffer_size, + &data_request_call); + if (data_request == 0) { + async_wait_for(opening_request, NULL); + return ENOMEM; + } + + /* + * Wait for the answer. + */ + sysarg_t data_request_rc; + sysarg_t opening_request_rc; + async_wait_for(data_request, &data_request_rc); + async_wait_for(opening_request, &opening_request_rc); + + if (data_request_rc != EOK) { + /* Prefer the return code of the opening request. */ + if (opening_request_rc != EOK) { + return (int) opening_request_rc; + } else { + return (int) data_request_rc; + } + } + if (opening_request_rc != EOK) { + return (int) opening_request_rc; + } + + *data_transfered_size = IPC_GET_ARG2(data_request_call); + + return EOK; +} + +/** Request a control read transfer on an endpoint pipe. + * + * This function encapsulates all three stages of a control transfer. + * + * @param[in] pipe Pipe used for the transfer. + * @param[in] setup_buffer Buffer with the setup packet. + * @param[in] setup_buffer_size Size of the setup packet (in bytes). + * @param[out] data_buffer Buffer for incoming data. + * @param[in] data_buffer_size Size of the buffer for incoming data (in bytes). + * @param[out] data_transfered_size Number of bytes that were actually + * transfered during the DATA stage. + * @return Error code. + */ +int usb_pipe_control_read(usb_pipe_t *pipe, + void *setup_buffer, size_t setup_buffer_size, + void *data_buffer, size_t data_buffer_size, size_t *data_transfered_size) +{ + assert(pipe); + + if ((setup_buffer == NULL) || (setup_buffer_size == 0)) { + return EINVAL; + } + + if ((data_buffer == NULL) || (data_buffer_size == 0)) { + return EINVAL; + } + + if (!usb_pipe_is_session_started(pipe)) { + return EBADF; + } + + if ((pipe->direction != USB_DIRECTION_BOTH) + || (pipe->transfer_type != USB_TRANSFER_CONTROL)) { + return EBADF; + } + + size_t act_size = 0; + int rc = usb_pipe_control_read_no_check(pipe, + setup_buffer, setup_buffer_size, + data_buffer, data_buffer_size, &act_size); + + if (rc != EOK) { + return rc; + } + + if (data_transfered_size != NULL) { + *data_transfered_size = act_size; + } + + return EOK; +} + + +/** Request a control write transfer, no checking of input parameters. + * + * @param[in] pipe Pipe used for the transfer. + * @param[in] setup_buffer Buffer with the setup packet. + * @param[in] setup_buffer_size Size of the setup packet (in bytes). + * @param[in] data_buffer Buffer with data to be sent. + * @param[in] data_buffer_size Size of the buffer with outgoing data (in bytes). + * @return Error code. + */ +static int usb_pipe_control_write_no_check(usb_pipe_t *pipe, + void *setup_buffer, size_t setup_buffer_size, + void *data_buffer, size_t data_buffer_size) +{ + /* + * Make call identifying target USB device and control transfer type. + */ + aid_t opening_request = async_send_5(pipe->hc_phone, + DEV_IFACE_ID(USBHC_DEV_IFACE), IPC_M_USBHC_CONTROL_WRITE, + pipe->wire->address, pipe->endpoint_no, + data_buffer_size, + pipe->max_packet_size, + NULL); + if (opening_request == 0) { + return ENOMEM; + } + + /* + * Send the setup packet. + */ + int rc = async_data_write_start(pipe->hc_phone, + setup_buffer, setup_buffer_size); + if (rc != EOK) { + async_wait_for(opening_request, NULL); + return rc; + } + + /* + * Send the data (if any). + */ + if (data_buffer_size > 0) { + rc = async_data_write_start(pipe->hc_phone, + data_buffer, data_buffer_size); + if (rc != EOK) { + async_wait_for(opening_request, NULL); + return rc; + } + } + + /* + * Wait for the answer. + */ + sysarg_t opening_request_rc; + async_wait_for(opening_request, &opening_request_rc); + + return (int) opening_request_rc; +} + +/** Request a control write transfer on an endpoint pipe. + * + * This function encapsulates all three stages of a control transfer. + * + * @param[in] pipe Pipe used for the transfer. + * @param[in] setup_buffer Buffer with the setup packet. + * @param[in] setup_buffer_size Size of the setup packet (in bytes). + * @param[in] data_buffer Buffer with data to be sent. + * @param[in] data_buffer_size Size of the buffer with outgoing data (in bytes). + * @return Error code. + */ +int usb_pipe_control_write(usb_pipe_t *pipe, + void *setup_buffer, size_t setup_buffer_size, + void *data_buffer, size_t data_buffer_size) +{ + assert(pipe); + + if ((setup_buffer == NULL) || (setup_buffer_size == 0)) { + return EINVAL; + } + + if ((data_buffer == NULL) && (data_buffer_size > 0)) { + return EINVAL; + } + + if ((data_buffer != NULL) && (data_buffer_size == 0)) { + return EINVAL; + } + + if (!usb_pipe_is_session_started(pipe)) { + return EBADF; + } + + if ((pipe->direction != USB_DIRECTION_BOTH) + || (pipe->transfer_type != USB_TRANSFER_CONTROL)) { + return EBADF; + } + + int rc = usb_pipe_control_write_no_check(pipe, + setup_buffer, setup_buffer_size, data_buffer, data_buffer_size); + + return rc; +} + + +/** + * @} + */ Index: uspace/lib/usb/src/recognise.c =================================================================== --- uspace/lib/usb/src/recognise.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/recognise.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,452 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * Functions for recognition of attached devices. + */ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +/** Index to append after device name for uniqueness. */ +static size_t device_name_index = 0; +/** Mutex guard for device_name_index. */ +static FIBRIL_MUTEX_INITIALIZE(device_name_index_mutex); + +/** DDF operations of child devices. */ +ddf_dev_ops_t child_ops = { + .interfaces[USB_DEV_IFACE] = &usb_iface_hub_child_impl +}; + +/** Get integer part from BCD coded number. */ +#define BCD_INT(a) (((unsigned int)(a)) / 256) +/** Get fraction part from BCD coded number (as an integer, no less). */ +#define BCD_FRAC(a) (((unsigned int)(a)) % 256) + +/** Format for BCD coded number to be used in printf. */ +#define BCD_FMT "%x.%x" +/** Arguments to printf for BCD coded number. */ +#define BCD_ARGS(a) BCD_INT((a)), BCD_FRAC((a)) + +/* FIXME: make this dynamic */ +#define MATCH_STRING_MAX 256 + +/** Add formatted match id. + * + * @param matches List of match ids where to add to. + * @param score Score of the match. + * @param format Printf-like format + * @return Error code. + */ +static int usb_add_match_id(match_id_list_t *matches, int score, + const char *format, ...) +{ + char *match_str = NULL; + match_id_t *match_id = NULL; + int rc; + + match_str = malloc(MATCH_STRING_MAX + 1); + if (match_str == NULL) { + rc = ENOMEM; + goto failure; + } + + /* + * FIXME: replace with dynamic allocation of exact size + */ + va_list args; + va_start(args, format ); + vsnprintf(match_str, MATCH_STRING_MAX, format, args); + match_str[MATCH_STRING_MAX] = 0; + va_end(args); + + match_id = create_match_id(); + if (match_id == NULL) { + rc = ENOMEM; + goto failure; + } + + match_id->id = match_str; + match_id->score = score; + add_match_id(matches, match_id); + + return EOK; + +failure: + if (match_str != NULL) { + free(match_str); + } + if (match_id != NULL) { + match_id->id = NULL; + delete_match_id(match_id); + } + + return rc; +} + +/** Add match id to list or return with error code. + * + * @param match_ids List of match ids. + * @param score Match id score. + * @param format Format of the matching string + * @param ... Arguments for the format. + */ +#define ADD_MATCHID_OR_RETURN(match_ids, score, format, ...) \ + do { \ + int __rc = usb_add_match_id((match_ids), (score), \ + format, ##__VA_ARGS__); \ + if (__rc != EOK) { \ + return __rc; \ + } \ + } while (0) + +/** Create device match ids based on its interface. + * + * @param[in] desc_device Device descriptor. + * @param[in] desc_interface Interface descriptor. + * @param[out] matches Initialized list of match ids. + * @return Error code (the two mentioned are not the only ones). + * @retval EINVAL Invalid input parameters (expects non NULL pointers). + * @retval ENOENT Device class is not "use interface". + */ +int usb_device_create_match_ids_from_interface( + const usb_standard_device_descriptor_t *desc_device, + const usb_standard_interface_descriptor_t *desc_interface, + match_id_list_t *matches) +{ + if (desc_interface == NULL) { + return EINVAL; + } + if (matches == NULL) { + return EINVAL; + } + + if (desc_interface->interface_class == USB_CLASS_USE_INTERFACE) { + return ENOENT; + } + + const char *classname = usb_str_class(desc_interface->interface_class); + assert(classname != NULL); + +#define IFACE_PROTOCOL_FMT "interface&class=%s&subclass=0x%02x&protocol=0x%02x" +#define IFACE_PROTOCOL_ARGS classname, desc_interface->interface_subclass, \ + desc_interface->interface_protocol + +#define IFACE_SUBCLASS_FMT "interface&class=%s&subclass=0x%02x" +#define IFACE_SUBCLASS_ARGS classname, desc_interface->interface_subclass + +#define IFACE_CLASS_FMT "interface&class=%s" +#define IFACE_CLASS_ARGS classname + +#define VENDOR_RELEASE_FMT "vendor=0x%04x&product=0x%04x&release=" BCD_FMT +#define VENDOR_RELEASE_ARGS desc_device->vendor_id, desc_device->product_id, \ + BCD_ARGS(desc_device->device_version) + +#define VENDOR_PRODUCT_FMT "vendor=0x%04x&product=0x%04x" +#define VENDOR_PRODUCT_ARGS desc_device->vendor_id, desc_device->product_id + +#define VENDOR_ONLY_FMT "vendor=0x%04x" +#define VENDOR_ONLY_ARGS desc_device->vendor_id + + /* + * If the vendor is specified, create match ids with vendor with + * higher score. + * Then the same ones without the vendor part. + */ + if ((desc_device != NULL) && (desc_device->vendor_id != 0)) { + /* First, interface matches with device release number. */ + ADD_MATCHID_OR_RETURN(matches, 250, + "usb&" VENDOR_RELEASE_FMT "&" IFACE_PROTOCOL_FMT, + VENDOR_RELEASE_ARGS, IFACE_PROTOCOL_ARGS); + ADD_MATCHID_OR_RETURN(matches, 240, + "usb&" VENDOR_RELEASE_FMT "&" IFACE_SUBCLASS_FMT, + VENDOR_RELEASE_ARGS, IFACE_SUBCLASS_ARGS); + ADD_MATCHID_OR_RETURN(matches, 230, + "usb&" VENDOR_RELEASE_FMT "&" IFACE_CLASS_FMT, + VENDOR_RELEASE_ARGS, IFACE_CLASS_ARGS); + + /* Next, interface matches without release number. */ + ADD_MATCHID_OR_RETURN(matches, 220, + "usb&" VENDOR_PRODUCT_FMT "&" IFACE_PROTOCOL_FMT, + VENDOR_PRODUCT_ARGS, IFACE_PROTOCOL_ARGS); + ADD_MATCHID_OR_RETURN(matches, 210, + "usb&" VENDOR_PRODUCT_FMT "&" IFACE_SUBCLASS_FMT, + VENDOR_PRODUCT_ARGS, IFACE_SUBCLASS_ARGS); + ADD_MATCHID_OR_RETURN(matches, 200, + "usb&" VENDOR_PRODUCT_FMT "&" IFACE_CLASS_FMT, + VENDOR_PRODUCT_ARGS, IFACE_CLASS_ARGS); + + /* Finally, interface matches with only vendor. */ + ADD_MATCHID_OR_RETURN(matches, 190, + "usb&" VENDOR_ONLY_FMT "&" IFACE_PROTOCOL_FMT, + VENDOR_ONLY_ARGS, IFACE_PROTOCOL_ARGS); + ADD_MATCHID_OR_RETURN(matches, 180, + "usb&" VENDOR_ONLY_FMT "&" IFACE_SUBCLASS_FMT, + VENDOR_ONLY_ARGS, IFACE_SUBCLASS_ARGS); + ADD_MATCHID_OR_RETURN(matches, 170, + "usb&" VENDOR_ONLY_FMT "&" IFACE_CLASS_FMT, + VENDOR_ONLY_ARGS, IFACE_CLASS_ARGS); + } + + /* Now, the same but without any vendor specification. */ + ADD_MATCHID_OR_RETURN(matches, 160, + "usb&" IFACE_PROTOCOL_FMT, + IFACE_PROTOCOL_ARGS); + ADD_MATCHID_OR_RETURN(matches, 150, + "usb&" IFACE_SUBCLASS_FMT, + IFACE_SUBCLASS_ARGS); + ADD_MATCHID_OR_RETURN(matches, 140, + "usb&" IFACE_CLASS_FMT, + IFACE_CLASS_ARGS); + +#undef IFACE_PROTOCOL_FMT +#undef IFACE_PROTOCOL_ARGS +#undef IFACE_SUBCLASS_FMT +#undef IFACE_SUBCLASS_ARGS +#undef IFACE_CLASS_FMT +#undef IFACE_CLASS_ARGS +#undef VENDOR_RELEASE_FMT +#undef VENDOR_RELEASE_ARGS +#undef VENDOR_PRODUCT_FMT +#undef VENDOR_PRODUCT_ARGS +#undef VENDOR_ONLY_FMT +#undef VENDOR_ONLY_ARGS + + /* As a last resort, try fallback driver. */ + ADD_MATCHID_OR_RETURN(matches, 10, "usb&interface&fallback"); + + return EOK; +} + +/** Create DDF match ids from USB device descriptor. + * + * @param matches List of match ids to extend. + * @param device_descriptor Device descriptor returned by given device. + * @return Error code. + */ +int usb_device_create_match_ids_from_device_descriptor( + const usb_standard_device_descriptor_t *device_descriptor, + match_id_list_t *matches) +{ + /* + * Unless the vendor id is 0, the pair idVendor-idProduct + * quite uniquely describes the device. + */ + if (device_descriptor->vendor_id != 0) { + /* First, with release number. */ + ADD_MATCHID_OR_RETURN(matches, 100, + "usb&vendor=0x%04x&product=0x%04x&release=" BCD_FMT, + (int) device_descriptor->vendor_id, + (int) device_descriptor->product_id, + BCD_ARGS(device_descriptor->device_version)); + + /* Next, without release number. */ + ADD_MATCHID_OR_RETURN(matches, 90, + "usb&vendor=0x%04x&product=0x%04x", + (int) device_descriptor->vendor_id, + (int) device_descriptor->product_id); + } + + /* + * If the device class points to interface we skip adding + * class directly but we add a multi interface device. + */ + if (device_descriptor->device_class != USB_CLASS_USE_INTERFACE) { + ADD_MATCHID_OR_RETURN(matches, 50, "usb&class=%s", + usb_str_class(device_descriptor->device_class)); + } else { + ADD_MATCHID_OR_RETURN(matches, 50, "usb&mid"); + } + + /* As a last resort, try fallback driver. */ + ADD_MATCHID_OR_RETURN(matches, 10, "usb&fallback"); + + return EOK; +} + + +/** Create match ids describing attached device. + * + * @warning The list of match ids @p matches may change even when + * function exits with error. + * + * @param ctrl_pipe Control pipe to given device (session must be already + * started). + * @param matches Initialized list of match ids. + * @return Error code. + */ +int usb_device_create_match_ids(usb_pipe_t *ctrl_pipe, + match_id_list_t *matches) +{ + int rc; + /* + * Retrieve device descriptor and add matches from it. + */ + usb_standard_device_descriptor_t device_descriptor; + + rc = usb_request_get_device_descriptor(ctrl_pipe, &device_descriptor); + if (rc != EOK) { + return rc; + } + + rc = usb_device_create_match_ids_from_device_descriptor( + &device_descriptor, matches); + if (rc != EOK) { + return rc; + } + + return EOK; +} + +/** Probe for device kind and register it in devman. + * + * @param[in] address Address of the (unknown) attached device. + * @param[in] hc_handle Handle of the host controller. + * @param[in] parent Parent device. + * @param[out] child_handle Handle of the child device. + * @param[in] dev_ops Child device ops. + * @param[in] dev_data Arbitrary pointer to be stored in the child + * as @c driver_data. + * @param[out] child_fun Storage where pointer to allocated child function + * will be written. + * @return Error code. + */ +int usb_device_register_child_in_devman(usb_address_t address, + devman_handle_t hc_handle, + ddf_dev_t *parent, devman_handle_t *child_handle, + ddf_dev_ops_t *dev_ops, void *dev_data, ddf_fun_t **child_fun) +{ + size_t this_device_name_index; + + fibril_mutex_lock(&device_name_index_mutex); + this_device_name_index = device_name_index; + device_name_index++; + fibril_mutex_unlock(&device_name_index_mutex); + + ddf_fun_t *child = NULL; + char *child_name = NULL; + int rc; + usb_device_connection_t dev_connection; + usb_pipe_t ctrl_pipe; + + rc = usb_device_connection_initialize(&dev_connection, hc_handle, address); + if (rc != EOK) { + goto failure; + } + + rc = usb_pipe_initialize_default_control(&ctrl_pipe, + &dev_connection); + if (rc != EOK) { + goto failure; + } + rc = usb_pipe_probe_default_control(&ctrl_pipe); + if (rc != EOK) { + goto failure; + } + + /* + * TODO: Once the device driver framework support persistent + * naming etc., something more descriptive could be created. + */ + rc = asprintf(&child_name, "usb%02zu_a%d", + this_device_name_index, address); + if (rc < 0) { + goto failure; + } + + child = ddf_fun_create(parent, fun_inner, child_name); + if (child == NULL) { + rc = ENOMEM; + goto failure; + } + + if (dev_ops != NULL) { + child->ops = dev_ops; + } else { + child->ops = &child_ops; + } + + child->driver_data = dev_data; + + rc = usb_pipe_start_session(&ctrl_pipe); + if (rc != EOK) { + goto failure; + } + + rc = usb_device_create_match_ids(&ctrl_pipe, &child->match_ids); + if (rc != EOK) { + goto failure; + } + + rc = usb_pipe_end_session(&ctrl_pipe); + if (rc != EOK) { + goto failure; + } + + rc = ddf_fun_bind(child); + if (rc != EOK) { + goto failure; + } + + if (child_handle != NULL) { + *child_handle = child->handle; + } + + if (child_fun != NULL) { + *child_fun = child; + } + + return EOK; + +failure: + if (child != NULL) { + child->name = NULL; + /* This takes care of match_id deallocation as well. */ + ddf_fun_destroy(child); + } + if (child_name != NULL) { + free(child_name); + } + + return rc; +} + + +/** + * @} + */ Index: uspace/lib/usb/src/request.c =================================================================== --- uspace/lib/usb/src/request.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/request.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,875 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * Standard USB requests (implementation). + */ +#include +#include +#include +#include + +#define MAX_DATA_LENGTH ((size_t)(0xFFFF)) + +/** Generic wrapper for SET requests using standard control request format. + * + * @see usb_pipe_control_write + * + * @param pipe Pipe used for the communication. + * @param request_type Request type (standard/class/vendor). + * @param recipient Request recipient (e.g. device or endpoint). + * @param request Actual request (e.g. GET_DESCRIPTOR). + * @param value Value of @c wValue field of setup packet + * (must be in USB endianness). + * @param index Value of @c wIndex field of setup packet + * (must be in USB endianness). + * @param data Data to be sent during DATA stage + * (expected to be in USB endianness). + * @param data_size Size of the @p data buffer (in native endianness). + * @return Error code. + * @retval EBADMEM @p pipe is NULL. + * @retval EBADMEM @p data is NULL and @p data_size is not zero. + * @retval ERANGE Data buffer too large. + */ +int usb_control_request_set(usb_pipe_t *pipe, + usb_request_type_t request_type, usb_request_recipient_t recipient, + uint8_t request, + uint16_t value, uint16_t index, + void *data, size_t data_size) +{ + if (pipe == NULL) { + return EBADMEM; + } + + if (data_size > MAX_DATA_LENGTH) { + return ERANGE; + } + + if ((data_size > 0) && (data == NULL)) { + return EBADMEM; + } + + /* + * TODO: check that @p request_type and @p recipient are + * within ranges. + */ + + usb_device_request_setup_packet_t setup_packet; + setup_packet.request_type = (request_type << 5) | recipient; + setup_packet.request = request; + setup_packet.value = value; + setup_packet.index = index; + setup_packet.length = (uint16_t) data_size; + + int rc = usb_pipe_control_write(pipe, + &setup_packet, sizeof(setup_packet), + data, data_size); + + return rc; +} + + /** Generic wrapper for GET requests using standard control request format. + * + * @see usb_pipe_control_read + * + * @param pipe Pipe used for the communication. + * @param request_type Request type (standard/class/vendor). + * @param recipient Request recipient (e.g. device or endpoint). + * @param request Actual request (e.g. GET_DESCRIPTOR). + * @param value Value of @c wValue field of setup packet + * (must be in USB endianness). + * @param index Value of @c wIndex field of setup packet + * (must be in USB endianness). + * @param data Buffer where to store data accepted during the DATA stage. + * (they will come in USB endianness). + * @param data_size Size of the @p data buffer + * (in native endianness). + * @param actual_data_size Actual size of transfered data + * (in native endianness). + * @return Error code. + * @retval EBADMEM @p pipe is NULL. + * @retval EBADMEM @p data is NULL and @p data_size is not zero. + * @retval ERANGE Data buffer too large. + */ +int usb_control_request_get(usb_pipe_t *pipe, + usb_request_type_t request_type, usb_request_recipient_t recipient, + uint8_t request, + uint16_t value, uint16_t index, + void *data, size_t data_size, size_t *actual_data_size) +{ + if (pipe == NULL) { + return EBADMEM; + } + + if (data_size > MAX_DATA_LENGTH) { + return ERANGE; + } + + if ((data_size > 0) && (data == NULL)) { + return EBADMEM; + } + + /* + * TODO: check that @p request_type and @p recipient are + * within ranges. + */ + + usb_device_request_setup_packet_t setup_packet; + setup_packet.request_type = 128 | (request_type << 5) | recipient; + setup_packet.request = request; + setup_packet.value = value; + setup_packet.index = index; + setup_packet.length = (uint16_t) data_size; + + int rc = usb_pipe_control_read(pipe, + &setup_packet, sizeof(setup_packet), + data, data_size, actual_data_size); + + return rc; +} + +/** Retrieve status of a USB device. + * + * @param[in] pipe Control endpoint pipe (session must be already started). + * @param[in] index Recipient index (in native endianness). + * @param[in] recipient Recipient of the GET_STATUS request. + * @param[out] status Recipient status (in native endianness). + * @return Error code. + */ +int usb_request_get_status(usb_pipe_t *pipe, + usb_request_recipient_t recipient, uint16_t index, + uint16_t *status) +{ + if ((recipient == USB_REQUEST_RECIPIENT_DEVICE) && (index != 0)) { + return EINVAL; + } + + if (status == NULL) { + return EBADMEM; + } + + uint16_t status_usb_endianess; + size_t data_transfered_size; + int rc = usb_control_request_get(pipe, USB_REQUEST_TYPE_STANDARD, + recipient, USB_DEVREQ_GET_STATUS, 0, uint16_host2usb(index), + &status_usb_endianess, 2, &data_transfered_size); + if (rc != EOK) { + return rc; + } + if (data_transfered_size != 2) { + return ELIMIT; + } + + *status = uint16_usb2host(status_usb_endianess); + + return EOK; +} + +/** Clear or disable specific device feature. + * + * @param[in] pipe Control endpoint pipe (session must be already started). + * @param[in] request_type Request type (standard/class/vendor). + * @param[in] recipient Recipient of the CLEAR_FEATURE request. + * @param[in] feature_selector Feature selector (in native endianness). + * @param[in] index Recipient index (in native endianness). + * @return Error code. + */ +int usb_request_clear_feature(usb_pipe_t *pipe, + usb_request_type_t request_type, usb_request_recipient_t recipient, + uint16_t feature_selector, uint16_t index) +{ + if (request_type == USB_REQUEST_TYPE_STANDARD) { + if ((recipient == USB_REQUEST_RECIPIENT_DEVICE) + && (index != 0)) { + return EINVAL; + } + } + + int rc = usb_control_request_set(pipe, request_type, recipient, + USB_DEVREQ_CLEAR_FEATURE, + uint16_host2usb(feature_selector), uint16_host2usb(index), + NULL, 0); + + return rc; +} + +/** Set or enable specific device feature. + * + * @param[in] pipe Control endpoint pipe (session must be already started). + * @param[in] request_type Request type (standard/class/vendor). + * @param[in] recipient Recipient of the SET_FEATURE request. + * @param[in] feature_selector Feature selector (in native endianness). + * @param[in] index Recipient index (in native endianness). + * @return Error code. + */ +int usb_request_set_feature(usb_pipe_t *pipe, + usb_request_type_t request_type, usb_request_recipient_t recipient, + uint16_t feature_selector, uint16_t index) +{ + if (request_type == USB_REQUEST_TYPE_STANDARD) { + if ((recipient == USB_REQUEST_RECIPIENT_DEVICE) + && (index != 0)) { + return EINVAL; + } + } + + int rc = usb_control_request_set(pipe, request_type, recipient, + USB_DEVREQ_SET_FEATURE, + uint16_host2usb(feature_selector), uint16_host2usb(index), + NULL, 0); + + return rc; +} + +/** Change address of connected device. + * This function automatically updates the backing connection to point to + * the new address. + * + * @param pipe Control endpoint pipe (session must be already started). + * @param new_address New USB address to be set (in native endianness). + * @return Error code. + */ +int usb_request_set_address(usb_pipe_t *pipe, + usb_address_t new_address) +{ + if ((new_address < 0) || (new_address >= USB11_ADDRESS_MAX)) { + return EINVAL; + } + + uint16_t addr = uint16_host2usb((uint16_t)new_address); + + int rc = usb_control_request_set(pipe, + USB_REQUEST_TYPE_STANDARD, USB_REQUEST_RECIPIENT_DEVICE, + USB_DEVREQ_SET_ADDRESS, + addr, 0, + NULL, 0); + + if (rc != EOK) { + return rc; + } + + assert(pipe->wire != NULL); + /* TODO: prevent other from accessing wire now. */ + pipe->wire->address = new_address; + + return EOK; +} + +/** Retrieve USB descriptor of a USB device. + * + * @param[in] pipe Control endpoint pipe (session must be already started). + * @param[in] request_type Request type (standard/class/vendor). + * @param[in] recipient Request recipient (device/interface/endpoint). + * @param[in] descriptor_type Descriptor type (device/configuration/HID/...). + * @param[in] descriptor_index Descriptor index. + * @param[in] language Language index. + * @param[out] buffer Buffer where to store the retrieved descriptor. + * @param[in] size Size of the @p buffer. + * @param[out] actual_size Number of bytes actually transferred. + * @return Error code. + */ +int usb_request_get_descriptor(usb_pipe_t *pipe, + usb_request_type_t request_type, usb_request_recipient_t recipient, + uint8_t descriptor_type, uint8_t descriptor_index, + uint16_t language, + void *buffer, size_t size, size_t *actual_size) +{ + if (buffer == NULL) { + return EBADMEM; + } + if (size == 0) { + return EINVAL; + } + + uint16_t wValue = descriptor_index | (descriptor_type << 8); + + return usb_control_request_get(pipe, + request_type, recipient, + USB_DEVREQ_GET_DESCRIPTOR, + wValue, language, + buffer, size, actual_size); +} + +/** Retrieve USB descriptor, allocate space for it. + * + * @param[in] pipe Control endpoint pipe (session must be already started). + * @param[in] request_type Request type (standard/class/vendor). + * @param[in] recipient Request recipient (device/interface/endpoint). + * @param[in] descriptor_type Descriptor type (device/configuration/HID/...). + * @param[in] descriptor_index Descriptor index. + * @param[in] language Language index. + * @param[out] buffer_ptr Where to store pointer to allocated buffer. + * @param[out] buffer_size Where to store the size of the descriptor. + * @return + */ +int usb_request_get_descriptor_alloc(usb_pipe_t * pipe, + usb_request_type_t request_type, usb_request_recipient_t recipient, + uint8_t descriptor_type, uint8_t descriptor_index, + uint16_t language, + void **buffer_ptr, size_t *buffer_size) +{ + if (buffer_ptr == NULL) { + return EBADMEM; + } + + int rc; + + /* + * Get only first byte to retrieve descriptor length. + */ + uint8_t tmp_buffer[1]; + size_t bytes_transfered; + rc = usb_request_get_descriptor(pipe, request_type, recipient, + descriptor_type, descriptor_index, language, + &tmp_buffer, 1, &bytes_transfered); + if (rc != EOK) { + return rc; + } + if (bytes_transfered != 1) { + /* FIXME: some better error code? */ + return ESTALL; + } + + size_t size = tmp_buffer[0]; + if (size == 0) { + /* FIXME: some better error code? */ + return ESTALL; + } + + /* + * Allocate buffer and get the descriptor again. + */ + void *buffer = malloc(size); + if (buffer == NULL) { + return ENOMEM; + } + + rc = usb_request_get_descriptor(pipe, request_type, recipient, + descriptor_type, descriptor_index, language, + buffer, size, &bytes_transfered); + if (rc != EOK) { + free(buffer); + return rc; + } + if (bytes_transfered != size) { + free(buffer); + /* FIXME: some better error code? */ + return ESTALL; + } + + *buffer_ptr = buffer; + if (buffer_size != NULL) { + *buffer_size = size; + } + + return EOK; +} + +/** Retrieve standard device descriptor of a USB device. + * + * @param[in] pipe Control endpoint pipe (session must be already started). + * @param[out] descriptor Storage for the device descriptor. + * @return Error code. + */ +int usb_request_get_device_descriptor(usb_pipe_t *pipe, + usb_standard_device_descriptor_t *descriptor) +{ + if (descriptor == NULL) { + return EBADMEM; + } + + size_t actually_transferred = 0; + usb_standard_device_descriptor_t descriptor_tmp; + int rc = usb_request_get_descriptor(pipe, + USB_REQUEST_TYPE_STANDARD, USB_REQUEST_RECIPIENT_DEVICE, + USB_DESCTYPE_DEVICE, 0, 0, + &descriptor_tmp, sizeof(descriptor_tmp), + &actually_transferred); + + if (rc != EOK) { + return rc; + } + + /* Verify that all data has been transferred. */ + if (actually_transferred < sizeof(descriptor_tmp)) { + return ELIMIT; + } + + /* Everything is okay, copy the descriptor. */ + memcpy(descriptor, &descriptor_tmp, + sizeof(descriptor_tmp)); + + return EOK; +} + +/** Retrieve configuration descriptor of a USB device. + * + * The function does not retrieve additional data binded with configuration + * descriptor (such as its interface and endpoint descriptors) - use + * usb_request_get_full_configuration_descriptor() instead. + * + * @param[in] pipe Control endpoint pipe (session must be already started). + * @param[in] index Descriptor index. + * @param[out] descriptor Storage for the device descriptor. + * @return Error code. + */ +int usb_request_get_bare_configuration_descriptor(usb_pipe_t *pipe, + int index, usb_standard_configuration_descriptor_t *descriptor) +{ + if (descriptor == NULL) { + return EBADMEM; + } + + if ((index < 0) || (index > 0xFF)) { + return ERANGE; + } + + size_t actually_transferred = 0; + usb_standard_configuration_descriptor_t descriptor_tmp; + int rc = usb_request_get_descriptor(pipe, + USB_REQUEST_TYPE_STANDARD, USB_REQUEST_RECIPIENT_DEVICE, + USB_DESCTYPE_CONFIGURATION, index, 0, + &descriptor_tmp, sizeof(descriptor_tmp), + &actually_transferred); + if (rc != EOK) { + return rc; + } + + /* Verify that all data has been transferred. */ + if (actually_transferred < sizeof(descriptor_tmp)) { + return ELIMIT; + } + + /* Everything is okay, copy the descriptor. */ + memcpy(descriptor, &descriptor_tmp, + sizeof(descriptor_tmp)); + + return EOK; +} + +/** Retrieve full configuration descriptor of a USB device. + * + * @warning The @p buffer might be touched (i.e. its contents changed) + * even when error occurs. + * + * @param[in] pipe Control endpoint pipe (session must be already started). + * @param[in] index Descriptor index. + * @param[out] descriptor Storage for the device descriptor. + * @param[in] descriptor_size Size of @p descriptor buffer. + * @param[out] actual_size Number of bytes actually transferred. + * @return Error code. + */ +int usb_request_get_full_configuration_descriptor(usb_pipe_t *pipe, + int index, void *descriptor, size_t descriptor_size, size_t *actual_size) +{ + if ((index < 0) || (index > 0xFF)) { + return ERANGE; + } + + return usb_request_get_descriptor(pipe, + USB_REQUEST_TYPE_STANDARD, USB_REQUEST_RECIPIENT_DEVICE, + USB_DESCTYPE_CONFIGURATION, index, 0, + descriptor, descriptor_size, actual_size); +} + +/** Retrieve full configuration descriptor, allocate space for it. + * + * The function takes care that full configuration descriptor is returned + * (i.e. the function will fail when less data then descriptor.totalLength + * is returned). + * + * @param[in] pipe Control endpoint pipe (session must be already started). + * @param[in] index Configuration index. + * @param[out] descriptor_ptr Where to store pointer to allocated buffer. + * @param[out] descriptor_size Where to store the size of the descriptor. + * @return Error code. + */ +int usb_request_get_full_configuration_descriptor_alloc( + usb_pipe_t *pipe, int index, + void **descriptor_ptr, size_t *descriptor_size) +{ + int rc; + + if (descriptor_ptr == NULL) { + return EBADMEM; + } + + usb_standard_configuration_descriptor_t bare_config; + rc = usb_request_get_bare_configuration_descriptor(pipe, index, + &bare_config); + if (rc != EOK) { + return rc; + } + if (bare_config.descriptor_type != USB_DESCTYPE_CONFIGURATION) { + return ENOENT; + } + if (bare_config.total_length < sizeof(bare_config)) { + return ELIMIT; + } + + void *buffer = malloc(bare_config.total_length); + if (buffer == NULL) { + return ENOMEM; + } + + size_t transferred = 0; + rc = usb_request_get_full_configuration_descriptor(pipe, index, + buffer, bare_config.total_length, &transferred); + if (rc != EOK) { + free(buffer); + return rc; + } + + if (transferred != bare_config.total_length) { + free(buffer); + return ELIMIT; + } + + /* Everything looks okay, copy the pointers. */ + + *descriptor_ptr = buffer; + + if (descriptor_size != NULL) { + *descriptor_size = bare_config.total_length; + } + + return EOK; +} + +/** Update existing or add new USB descriptor to a USB device. + * + * @param[in] pipe Control endpoint pipe (session must be already started). + * @param[in] request_type Request type (standard/class/vendor). + * @param[in] recipient Request recipient (device/interface/endpoint). + * @param[in] descriptor_type Descriptor type (device/configuration/HID/...). + * @param[in] descriptor_index Descriptor index. + * @param[in] language Language index (in native endianness). + * @param[in] buffer Buffer with the new descriptor (in USB endianness). + * @param[in] size Size of the @p buffer in bytes (in native endianness). + * @return Error code. + */ +int usb_request_set_descriptor(usb_pipe_t *pipe, + usb_request_type_t request_type, usb_request_recipient_t recipient, + uint8_t descriptor_type, uint8_t descriptor_index, + uint16_t language, + void *buffer, size_t size) +{ + if (buffer == NULL) { + return EBADMEM; + } + if (size == 0) { + return EINVAL; + } + + /* FIXME: proper endianness. */ + uint16_t wValue = descriptor_index | (descriptor_type << 8); + + return usb_control_request_set(pipe, + request_type, recipient, + USB_DEVREQ_SET_DESCRIPTOR, + wValue, language, + buffer, size); +} + +/** Get current configuration value of USB device. + * + * @param[in] pipe Control endpoint pipe (session must be already started). + * @param[out] configuration_value Current configuration value. + * @return Error code. + */ +int usb_request_get_configuration(usb_pipe_t *pipe, + uint8_t *configuration_value) +{ + uint8_t value; + size_t actual_size; + + int rc = usb_control_request_get(pipe, + USB_REQUEST_TYPE_STANDARD, USB_REQUEST_RECIPIENT_DEVICE, + USB_DEVREQ_GET_CONFIGURATION, + 0, 0, + &value, 1, &actual_size); + + if (rc != EOK) { + return rc; + } + if (actual_size != 1) { + return ELIMIT; + } + + if (configuration_value != NULL) { + *configuration_value = value; + } + + return EOK; +} + +/** Set configuration of USB device. + * + * @param pipe Control endpoint pipe (session must be already started). + * @param configuration_value New configuration value. + * @return Error code. + */ +int usb_request_set_configuration(usb_pipe_t *pipe, + uint8_t configuration_value) +{ + uint16_t config_value + = uint16_host2usb((uint16_t) configuration_value); + + return usb_control_request_set(pipe, + USB_REQUEST_TYPE_STANDARD, USB_REQUEST_RECIPIENT_DEVICE, + USB_DEVREQ_SET_CONFIGURATION, config_value, 0, + NULL, 0); +} + +/** Get selected alternate setting for USB interface. + * + * @param[in] pipe Control endpoint pipe (session must be already started). + * @param[in] interface_index Interface index. + * @param[out] alternate_setting Alternate setting for the interface. + * @return Error code. + */ +int usb_request_get_interface(usb_pipe_t *pipe, + uint8_t interface_index, uint8_t *alternate_setting) +{ + uint8_t value; + size_t actual_size; + + int rc = usb_control_request_get(pipe, + USB_REQUEST_TYPE_STANDARD, USB_REQUEST_RECIPIENT_INTERFACE, + USB_DEVREQ_GET_INTERFACE, + 0, uint16_host2usb((uint16_t) interface_index), + &value, 1, &actual_size); + + if (rc != EOK) { + return rc; + } + if (actual_size != 1) { + return ELIMIT; + } + + if (alternate_setting != NULL) { + *alternate_setting = value; + } + + return EOK; +} + +/** Select alternate setting for USB interface. + * + * @param[in] pipe Control endpoint pipe (session must be already started). + * @param[in] interface_index Interface index. + * @param[in] alternate_setting Alternate setting to select. + * @return Error code. + */ +int usb_request_set_interface(usb_pipe_t *pipe, + uint8_t interface_index, uint8_t alternate_setting) +{ + return usb_control_request_set(pipe, + USB_REQUEST_TYPE_STANDARD, USB_REQUEST_RECIPIENT_INTERFACE, + USB_DEVREQ_SET_INTERFACE, + uint16_host2usb((uint16_t) alternate_setting), + uint16_host2usb((uint16_t) interface_index), + NULL, 0); +} + +/** Get list of supported languages by USB device. + * + * @param[in] pipe Control endpoint pipe (session must be already started). + * @param[out] languages_ptr Where to store pointer to allocated array of + * supported languages. + * @param[out] languages_count Number of supported languages. + * @return Error code. + */ +int usb_request_get_supported_languages(usb_pipe_t *pipe, + l18_win_locales_t **languages_ptr, size_t *languages_count) +{ + int rc; + + if (languages_ptr == NULL) { + return EBADMEM; + } + if (languages_count == NULL) { + return EBADMEM; + } + + uint8_t *string_descriptor = NULL; + size_t string_descriptor_size = 0; + rc = usb_request_get_descriptor_alloc(pipe, + USB_REQUEST_TYPE_STANDARD, USB_REQUEST_RECIPIENT_DEVICE, + USB_DESCTYPE_STRING, 0, 0, + (void **) &string_descriptor, &string_descriptor_size); + if (rc != EOK) { + return rc; + } + if (string_descriptor_size <= 2) { + free(string_descriptor); + return EEMPTY; + } + /* Subtract first 2 bytes (length and descriptor type). */ + string_descriptor_size -= 2; + + /* Odd number of bytes - descriptor is broken? */ + if ((string_descriptor_size % 2) != 0) { + /* FIXME: shall we return with error or silently ignore? */ + free(string_descriptor); + return ESTALL; + } + + size_t langs_count = string_descriptor_size / 2; + l18_win_locales_t *langs + = malloc(sizeof(l18_win_locales_t) * langs_count); + if (langs == NULL) { + free(string_descriptor); + return ENOMEM; + } + + size_t i; + for (i = 0; i < langs_count; i++) { + /* Language code from the descriptor is in USB endianness. */ + /* FIXME: is this really correct? */ + uint16_t lang_code = (string_descriptor[2 + 2 * i + 1] << 8) + + string_descriptor[2 + 2 * i]; + langs[i] = uint16_usb2host(lang_code); + } + + free(string_descriptor); + + *languages_ptr = langs; + *languages_count =langs_count; + + return EOK; +} + +/** Get string (descriptor) from USB device. + * + * The string is returned in native encoding of the operating system. + * For HelenOS, that is UTF-8. + * + * @param[in] pipe Control endpoint pipe (session must be already started). + * @param[in] index String index (in native endianness), + * first index has number 1 (index from descriptors can be used directly). + * @param[in] lang String language (in native endianness). + * @param[out] string_ptr Where to store allocated string in native encoding. + * @return Error code. + */ +int usb_request_get_string(usb_pipe_t *pipe, + size_t index, l18_win_locales_t lang, char **string_ptr) +{ + if (string_ptr == NULL) { + return EBADMEM; + } + /* + * Index is actually one byte value and zero index is used + * to retrieve list of supported languages. + */ + if ((index < 1) || (index > 0xFF)) { + return ERANGE; + } + /* Language is actually two byte value. */ + if (lang > 0xFFFF) { + return ERANGE; + } + + int rc; + + /* Prepare dynamically allocated variables. */ + uint8_t *string = NULL; + wchar_t *string_chars = NULL; + + /* Get the actual descriptor. */ + size_t string_size; + rc = usb_request_get_descriptor_alloc(pipe, + USB_REQUEST_TYPE_STANDARD, USB_REQUEST_RECIPIENT_DEVICE, + USB_DESCTYPE_STRING, index, uint16_host2usb(lang), + (void **) &string, &string_size); + if (rc != EOK) { + goto leave; + } + + if (string_size <= 2) { + rc = EEMPTY; + goto leave; + } + /* Subtract first 2 bytes (length and descriptor type). */ + string_size -= 2; + + /* Odd number of bytes - descriptor is broken? */ + if ((string_size % 2) != 0) { + /* FIXME: shall we return with error or silently ignore? */ + rc = ESTALL; + goto leave; + } + + size_t string_char_count = string_size / 2; + string_chars = malloc(sizeof(wchar_t) * (string_char_count + 1)); + if (string_chars == NULL) { + rc = ENOMEM; + goto leave; + } + + /* + * Build a wide string. + * And do not forget to set NULL terminator (string descriptors + * do not have them). + */ + size_t i; + for (i = 0; i < string_char_count; i++) { + uint16_t uni_char = (string[2 + 2 * i + 1] << 8) + + string[2 + 2 * i]; + string_chars[i] = uni_char; + } + string_chars[string_char_count] = 0; + + + /* Convert to normal string. */ + char *str = wstr_to_astr(string_chars); + if (str == NULL) { + rc = ENOMEM; + goto leave; + } + + *string_ptr = str; + rc = EOK; + +leave: + if (string != NULL) { + free(string); + } + if (string_chars != NULL) { + free(string_chars); + } + + return rc; +} + +/** + * @} + */ Index: uspace/lib/usb/src/usb.c =================================================================== --- uspace/lib/usb/src/usb.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/usb.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,101 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * Common USB functions. + */ +#include +#include + +#define ARR_SIZE(arr) (sizeof(arr)/sizeof(arr[0])) + +static const char *str_speed[] = { + "low", + "full", + "high" +}; + +static const char *str_transfer_type[] = { + "control", + "isochronous", + "bulk", + "interrupt" +}; + +static const char *str_transfer_type_short[] = { + "ctrl", + "iso", + "bulk", + "intr" +}; + +/** String representation for USB transfer type. + * + * @param t Transfer type. + * @return Transfer type as a string (in English). + */ +const char *usb_str_transfer_type(usb_transfer_type_t t) +{ + if (t >= ARR_SIZE(str_transfer_type)) { + return "invalid"; + } + return str_transfer_type[t]; +} + +/** String representation for USB transfer type (short version). + * + * @param t Transfer type. + * @return Transfer type as a short string for debugging messages. + */ +const char *usb_str_transfer_type_short(usb_transfer_type_t t) +{ + if (t >= ARR_SIZE(str_transfer_type_short)) { + return "invl"; + } + return str_transfer_type_short[t]; +} + +/** String representation of USB speed. + * + * @param s The speed. + * @return USB speed as a string (in English). + */ +const char *usb_str_speed(usb_speed_t s) +{ + if (s >= ARR_SIZE(str_speed)) { + return "invalid"; + } + return str_speed[s]; +} + +/** + * @} + */ Index: uspace/lib/usb/src/usbdevice.c =================================================================== --- uspace/lib/usb/src/usbdevice.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usb/src/usbdevice.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,179 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * General communication between device drivers and host controller driver. + */ +#include +#include +#include +#include +#include +#include +#include + +/** Find host controller handle that is ancestor of given device. + * + * @param[in] device_handle Device devman handle. + * @param[out] hc_handle Where to store handle of host controller + * controlling device with @p device_handle handle. + * @return Error code. + */ +int usb_hc_find(devman_handle_t device_handle, devman_handle_t *hc_handle) +{ + int parent_phone = devman_parent_device_connect(device_handle, + IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + + devman_handle_t h; + usb_log_debug("asking for HC handle (my handle is %zu).\n", device_handle); + int rc = async_req_1_1(parent_phone, DEV_IFACE_ID(USB_DEV_IFACE), + IPC_M_USB_GET_HOST_CONTROLLER_HANDLE, &h); + + async_hangup(parent_phone); + + if (rc != EOK) { + return rc; + } + + if (hc_handle != NULL) { + *hc_handle = h; + } + + return EOK; +} + +/** Initialize connection to USB host controller. + * + * @param connection Connection to be initialized. + * @param device Device connecting to the host controller. + * @return Error code. + */ +int usb_hc_connection_initialize_from_device(usb_hc_connection_t *connection, + ddf_dev_t *device) +{ + assert(connection); + + if (device == NULL) { + return EBADMEM; + } + + devman_handle_t hc_handle; + int rc = usb_hc_find(device->handle, &hc_handle); + if (rc != EOK) { + return rc; + } + + rc = usb_hc_connection_initialize(connection, hc_handle); + + return rc; +} + +/** Manually initialize connection to USB host controller. + * + * @param connection Connection to be initialized. + * @param hc_handle Devman handle of the host controller. + * @return Error code. + */ +int usb_hc_connection_initialize(usb_hc_connection_t *connection, + devman_handle_t hc_handle) +{ + assert(connection); + + connection->hc_handle = hc_handle; + connection->hc_phone = -1; + + return EOK; +} + +/** Open connection to host controller. + * + * @param connection Connection to the host controller. + * @return Error code. + */ +int usb_hc_connection_open(usb_hc_connection_t *connection) +{ + assert(connection); + + if (usb_hc_connection_is_opened(connection)) { + return EBUSY; + } + + int phone = devman_device_connect(connection->hc_handle, 0); + if (phone < 0) { + return phone; + } + + connection->hc_phone = phone; + + return EOK; +} + +/** Tells whether connection to host controller is opened. + * + * @param connection Connection to the host controller. + * @return Whether connection is opened. + */ +bool usb_hc_connection_is_opened(const usb_hc_connection_t *connection) +{ + assert(connection); + + return (connection->hc_phone >= 0); +} + +/** Close connection to the host controller. + * + * @param connection Connection to the host controller. + * @return Error code. + */ +int usb_hc_connection_close(usb_hc_connection_t *connection) +{ + assert(connection); + + if (!usb_hc_connection_is_opened(connection)) { + return ENOENT; + } + + int rc = async_hangup(connection->hc_phone); + if (rc != EOK) { + return rc; + } + + connection->hc_phone = -1; + + return EOK; +} + +/** + * @} + */ Index: uspace/lib/usbvirt/Makefile =================================================================== --- uspace/lib/usbvirt/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usbvirt/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,42 @@ +# +# Copyright (c) 2010 Vojtech Horky +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBRARY = libusbvirt + +EXTRA_CFLAGS = -I$(LIBUSB_PREFIX)/include -I$(LIBDRV_PREFIX)/include -Iinclude + +SOURCES = \ + src/callback.c \ + src/ctrlpipe.c \ + src/debug.c \ + src/main.c \ + src/stdreq.c \ + src/transaction.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/lib/usbvirt/include/usbvirt/device.h =================================================================== --- uspace/lib/usbvirt/include/usbvirt/device.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usbvirt/include/usbvirt/device.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,285 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusbvirt + * @{ + */ +/** @file + * @brief Virtual USB device. + */ +#ifndef LIBUSBVIRT_DEVICE_H_ +#define LIBUSBVIRT_DEVICE_H_ + +#include +#include +#include + +/** Request type of a control transfer. */ +typedef enum { + /** Standard USB request. */ + USBVIRT_REQUEST_TYPE_STANDARD = 0, + /** Standard class USB request. */ + USBVIRT_REQUEST_TYPE_CLASS = 1 +} usbvirt_request_type_t; + +/** Recipient of control request. */ +typedef enum { + /** Device is the recipient of the control request. */ + USBVIRT_REQUEST_RECIPIENT_DEVICE = 0, + /** Interface is the recipient of the control request. */ + USBVIRT_REQUEST_RECIPIENT_INTERFACE = 1, + /** Endpoint is the recipient of the control request. */ + USBVIRT_REQUEST_RECIPIENT_ENDPOINT = 2, + /** Other part of the device is the recipient of the control request. */ + USBVIRT_REQUEST_RECIPIENT_OTHER = 3 +} usbvirt_request_recipient_t; + +/** Possible states of virtual USB device. + * Notice that these are not 1:1 mappings to those in USB specification. + */ +typedef enum { + /** Default state, device listens at default address. */ + USBVIRT_STATE_DEFAULT, + /** Device has non-default address assigned. */ + USBVIRT_STATE_ADDRESS, + /** Device is configured. */ + USBVIRT_STATE_CONFIGURED +} usbvirt_device_state_t; + +typedef struct usbvirt_device usbvirt_device_t; +struct usbvirt_control_transfer; + +typedef int (*usbvirt_on_device_request_t)(usbvirt_device_t *dev, + usb_device_request_setup_packet_t *request, + uint8_t *data); + +/** Callback for control request over pipe zero. + * + * @param dev Virtual device answering the call. + * @param request Request setup packet. + * @param data Data when DATA stage is present. + * @return Error code. + */ +typedef int (*usbvirt_control_request_callback_t)(usbvirt_device_t *dev, + usb_device_request_setup_packet_t *request, + uint8_t *data); + +/** Handler for control transfer on endpoint zero. */ +typedef struct { + /** Request type bitmap. + * Use USBVIRT_MAKE_CONTROL_REQUEST_TYPE for creating the bitmap. + */ + uint8_t request_type; + /** Request code. */ + uint8_t request; + /** Request name for debugging. */ + const char *name; + /** Callback for the request. + * NULL value here announces end of a list. + */ + usbvirt_control_request_callback_t callback; +} usbvirt_control_transfer_handler_t; + +/** Create control request type bitmap. + * + * @param direction Transfer direction (use usb_direction_t). + * @param type Request type (use usbvirt_request_type_t). + * @param recipient Recipient of the request (use usbvirt_request_recipient_t). + * @return Request type bitmap. + */ +#define USBVIRT_MAKE_CONTROL_REQUEST_TYPE(direction, type, recipient) \ + ((((direction) == USB_DIRECTION_IN) ? 1 : 0) << 7) \ + | (((type) & 3) << 5) \ + | (((recipient) & 31)) + +/** Create last item in an array of control request handlers. */ +#define USBVIRT_CONTROL_TRANSFER_HANDLER_LAST { 0, 0, NULL, NULL } + +/** Device operations. */ +typedef struct { + /** Callbacks for transfers over control pipe zero. */ + usbvirt_control_transfer_handler_t *control_transfer_handlers; + + int (*on_control_transfer)(usbvirt_device_t *dev, + usb_endpoint_t endpoint, struct usbvirt_control_transfer *transfer); + + /** Callback for all other incoming data. */ + int (*on_data)(usbvirt_device_t *dev, + usb_endpoint_t endpoint, void *buffer, size_t size); + + /** Callback for host request for data. */ + int (*on_data_request)(usbvirt_device_t *dev, + usb_endpoint_t endpoint, void *buffer, size_t size, size_t *actual_size); + + /** Decides direction of control transfer. */ + usb_direction_t (*decide_control_transfer_direction)( + usb_endpoint_t endpoint, void *buffer, size_t size); + + /** Callback when device changes its state. + * + * It is correct that this function is called when both states + * are equal (e.g. this function is called during SET_CONFIGURATION + * request done on already configured device). + * + * @warning The value of dev->state before calling + * this function is not specified (i.e. can be @p old_state or + * @p new_state). + */ + void (*on_state_change)(usbvirt_device_t *dev, + usbvirt_device_state_t old_state, usbvirt_device_state_t new_state); +} usbvirt_device_ops_t; + +/** Extra configuration data for GET_CONFIGURATION request. */ +typedef struct { + /** Actual data. */ + uint8_t *data; + /** Data length. */ + size_t length; +} usbvirt_device_configuration_extras_t; + +/** Single device configuration. */ +typedef struct { + /** Standard configuration descriptor. */ + usb_standard_configuration_descriptor_t *descriptor; + /** Array of extra data. */ + usbvirt_device_configuration_extras_t *extra; + /** Length of @c extra array. */ + size_t extra_count; +} usbvirt_device_configuration_t; + +/** Standard USB descriptors. */ +typedef struct { + /** Standard device descriptor. + * There is always only one such descriptor for the device. + */ + usb_standard_device_descriptor_t *device; + + /** Configurations. */ + usbvirt_device_configuration_t *configuration; + /** Number of configurations. */ + size_t configuration_count; + /** Index of currently selected configuration. */ + uint8_t current_configuration; +} usbvirt_descriptors_t; + +/** Information about on-going control transfer. + */ +typedef struct usbvirt_control_transfer { + /** Transfer direction (read/write control transfer). */ + usb_direction_t direction; + /** Request data. */ + void *request; + /** Size of request data. */ + size_t request_size; + /** Payload. */ + void *data; + /** Size of payload. */ + size_t data_size; +} usbvirt_control_transfer_t; + +typedef enum { + USBVIRT_DEBUGTAG_BASE = 1, + USBVIRT_DEBUGTAG_TRANSACTION = 2, + USBVIRT_DEBUGTAG_CONTROL_PIPE_ZERO = 4, + USBVIRT_DEBUGTAG_ALL = 255 +} usbvirt_debug_tags_t; + +/** Virtual USB device. */ +struct usbvirt_device { + /** Callback device operations. */ + usbvirt_device_ops_t *ops; + + /** Custom device data. */ + void *device_data; + + /** Reply onto control transfer. + */ + int (*control_transfer_reply)(usbvirt_device_t *dev, + usb_endpoint_t endpoint, void *buffer, size_t size); + + /** Device name. + * Used in debug prints and sent to virtual host controller. + */ + const char *name; + + /** Standard descriptors. */ + usbvirt_descriptors_t *descriptors; + + /** Current device state. */ + usbvirt_device_state_t state; + + /** Device address. */ + usb_address_t address; + /** New device address. + * This field is used during SET_ADDRESS request. + * On all other occasions, it holds invalid address (e.g. -1). + */ + usb_address_t new_address; + + /** Process OUT transaction. */ + int (*transaction_out)(usbvirt_device_t *dev, + usb_endpoint_t endpoint, void *buffer, size_t size); + /** Process SETUP transaction. */ + int (*transaction_setup)(usbvirt_device_t *dev, + usb_endpoint_t endpoint, void *buffer, size_t size); + /** Process IN transaction. */ + int (*transaction_in)(usbvirt_device_t *dev, + usb_endpoint_t endpoint, void *buffer, size_t size, size_t *data_size); + + /** State information on control-transfer endpoints. */ + usbvirt_control_transfer_t current_control_transfers[USB11_ENDPOINT_MAX]; + + /* User debugging. */ + + /** Debug print. */ + void (*debug)(usbvirt_device_t *dev, int level, uint8_t tag, + const char *format, ...); + + /** Current debug level. */ + int debug_level; + + /** Bitmap of currently enabled tags. */ + uint8_t debug_enabled_tags; + + /* Library debugging. */ + + /** Debug print. */ + void (*lib_debug)(usbvirt_device_t *dev, int level, uint8_t tag, + const char *format, ...); + + /** Current debug level. */ + int lib_debug_level; + + /** Bitmap of currently enabled tags. */ + uint8_t lib_debug_enabled_tags; +}; + +#endif +/** + * @} + */ Index: uspace/lib/usbvirt/include/usbvirt/hub.h =================================================================== --- uspace/lib/usbvirt/include/usbvirt/hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usbvirt/include/usbvirt/hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,68 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusbvirt + * @{ + */ +/** @file + * @brief Virtual USB device. + */ +#ifndef LIBUSBVIRT_HUB_H_ +#define LIBUSBVIRT_HUB_H_ + +#include "device.h" + +/** USB transaction type. + * This types does not correspond directly to types in USB specification, + * as actually DATA transactions are marked with these types to identify + * their direction (and tag). + */ +typedef enum { + USBVIRT_TRANSACTION_SETUP, + USBVIRT_TRANSACTION_IN, + USBVIRT_TRANSACTION_OUT +} usbvirt_transaction_type_t; + +const char *usbvirt_str_transaction_type(usbvirt_transaction_type_t type); + +/** Telephony methods of virtual devices. */ +typedef enum { + IPC_M_USBVIRT_GET_NAME = IPC_FIRST_USER_METHOD, + IPC_M_USBVIRT_TRANSACTION_SETUP, + IPC_M_USBVIRT_TRANSACTION_OUT, + IPC_M_USBVIRT_TRANSACTION_IN, +} usbvirt_device_method_t; + +int usbvirt_connect(usbvirt_device_t *); +int usbvirt_connect_local(usbvirt_device_t *); +int usbvirt_disconnect(usbvirt_device_t *dev); + +#endif +/** + * @} + */ Index: uspace/lib/usbvirt/src/callback.c =================================================================== --- uspace/lib/usbvirt/src/callback.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usbvirt/src/callback.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,237 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusbvirt + * @{ + */ +/** @file + * @brief Callback connection handling. + */ +#include +#include +#include +#include +#include +#include + +#include "private.h" + +#define NAMESPACE "usb" +#define USB_MAX_PAYLOAD_SIZE 1020 + +/** Wrapper for SETUP transaction over telephone. */ +static void handle_setup_transaction(usbvirt_device_t *device, + ipc_callid_t iid, ipc_call_t icall) +{ + usb_address_t address = IPC_GET_ARG1(icall); + usb_endpoint_t endpoint = IPC_GET_ARG2(icall); + size_t expected_len = IPC_GET_ARG3(icall); + + if (address != device->address) { + async_answer_0(iid, EADDRNOTAVAIL); + return; + } + + if ((endpoint < 0) || (endpoint >= USB11_ENDPOINT_MAX)) { + async_answer_0(iid, EINVAL); + return; + } + + if (expected_len == 0) { + async_answer_0(iid, EINVAL); + return; + } + + size_t len = 0; + void * buffer = NULL; + int rc = async_data_write_accept(&buffer, false, + 1, USB_MAX_PAYLOAD_SIZE, 0, &len); + + if (rc != EOK) { + async_answer_0(iid, rc); + return; + } + + rc = device->transaction_setup(device, endpoint, buffer, len); + + async_answer_0(iid, rc); +} + +/** Wrapper for OUT transaction over telephone. */ +static void handle_out_transaction(usbvirt_device_t *device, + ipc_callid_t iid, ipc_call_t icall) +{ + usb_address_t address = IPC_GET_ARG1(icall); + usb_endpoint_t endpoint = IPC_GET_ARG2(icall); + size_t expected_len = IPC_GET_ARG3(icall); + + if (address != device->address) { + async_answer_0(iid, EADDRNOTAVAIL); + return; + } + + if ((endpoint < 0) || (endpoint >= USB11_ENDPOINT_MAX)) { + async_answer_0(iid, EINVAL); + return; + } + + int rc = EOK; + + size_t len = 0; + void *buffer = NULL; + + if (expected_len > 0) { + rc = async_data_write_accept(&buffer, false, + 1, USB_MAX_PAYLOAD_SIZE, 0, &len); + + if (rc != EOK) { + async_answer_0(iid, rc); + return; + } + } + + rc = device->transaction_out(device, endpoint, buffer, len); + + if (buffer != NULL) { + free(buffer); + } + + async_answer_0(iid, rc); +} + + +/** Wrapper for IN transaction over telephone. */ +static void handle_in_transaction(usbvirt_device_t *device, + ipc_callid_t iid, ipc_call_t icall) +{ + usb_address_t address = IPC_GET_ARG1(icall); + usb_endpoint_t endpoint = IPC_GET_ARG2(icall); + size_t expected_len = IPC_GET_ARG3(icall); + + if (address != device->address) { + async_answer_0(iid, EADDRNOTAVAIL); + return; + } + + if ((endpoint < 0) || (endpoint >= USB11_ENDPOINT_MAX)) { + async_answer_0(iid, EINVAL); + return; + } + + int rc = EOK; + + void *buffer = expected_len > 0 ? malloc(expected_len) : NULL; + size_t len; + + rc = device->transaction_in(device, endpoint, buffer, expected_len, &len); + /* + * If the request was processed, we will send data back. + */ + if ((rc == EOK) && (expected_len > 0)) { + size_t receive_len; + ipc_callid_t callid; + if (!async_data_read_receive(&callid, &receive_len)) { + async_answer_0(iid, EINVAL); + return; + } + if (len > receive_len) { + len = receive_len; + } + async_data_read_finalize(callid, buffer, len); + } + + async_answer_1(iid, rc, len); +} + +/** Wrapper for getting device name. */ +static void handle_get_name(usbvirt_device_t *device, + ipc_callid_t iid, ipc_call_t icall) +{ + if (device->name == NULL) { + async_answer_0(iid, ENOENT); + } + + size_t size = str_size(device->name); + + ipc_callid_t callid; + size_t accepted_size; + if (!async_data_read_receive(&callid, &accepted_size)) { + async_answer_0(iid, EINVAL); + return; + } + + if (accepted_size > size) { + accepted_size = size; + } + async_data_read_finalize(callid, device->name, accepted_size); + + async_answer_1(iid, EOK, accepted_size); +} + +/** Callback connection for a given device. */ +void device_callback_connection(usbvirt_device_t *device, ipc_callid_t iid, ipc_call_t *icall) +{ + async_answer_0(iid, EOK); + + while (true) { + ipc_callid_t callid; + ipc_call_t call; + + callid = async_get_call(&call); + switch (IPC_GET_IMETHOD(call)) { + case IPC_M_PHONE_HUNGUP: + async_answer_0(callid, EOK); + return; + + case IPC_M_USBVIRT_GET_NAME: + handle_get_name(device, callid, call); + break; + + case IPC_M_USBVIRT_TRANSACTION_SETUP: + handle_setup_transaction(device, callid, call); + break; + + case IPC_M_USBVIRT_TRANSACTION_OUT: + handle_out_transaction(device, callid, call); + break; + + case IPC_M_USBVIRT_TRANSACTION_IN: + handle_in_transaction(device, callid, call); + break; + + default: + async_answer_0(callid, EINVAL); + break; + } + } +} + + +/** + * @} + */ Index: uspace/lib/usbvirt/src/ctrlpipe.c =================================================================== --- uspace/lib/usbvirt/src/ctrlpipe.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usbvirt/src/ctrlpipe.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,182 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusbvirt + * @{ + */ +/** @file + * @brief Device control pipe. + */ +#include + +#include "private.h" + +/** Compares handler type with request packet type. + * + * @param handler Handler. + * @param request_packet Request packet. + * @return Whether handler can serve this packet. + */ +static bool is_suitable_handler(usbvirt_control_transfer_handler_t *handler, + usb_device_request_setup_packet_t *request_packet) +{ + return ( + (handler->request_type == request_packet->request_type) + && (handler->request == request_packet->request)); + +} + +/** Find suitable transfer handler for given request packet. + * + * @param handlers Array of available handlers. + * @param request_packet Request SETUP packet. + * @return Handler or NULL. + */ +static usbvirt_control_transfer_handler_t *find_handler( + usbvirt_control_transfer_handler_t *handlers, + usb_device_request_setup_packet_t *request_packet) +{ + if (handlers == NULL) { + return NULL; + } + + while (handlers->callback != NULL) { + if (is_suitable_handler(handlers, request_packet)) { + return handlers; + } + handlers++; + } + + return NULL; +} + +#define _GET_BIT(byte, bit) \ + (((byte) & (1 << (bit))) ? '1' : '0') +#define _GET_BITS(byte) \ + _GET_BIT(byte, 7), _GET_BIT(byte, 6), _GET_BIT(byte, 5), \ + _GET_BIT(byte, 4), _GET_BIT(byte, 3), _GET_BIT(byte, 2), \ + _GET_BIT(byte, 1), _GET_BIT(byte, 0) + +static int find_and_run_handler(usbvirt_device_t *device, + usbvirt_control_transfer_handler_t *handlers, + usb_device_request_setup_packet_t *setup_packet, + uint8_t *data) +{ + int rc = EFORWARD; + usbvirt_control_transfer_handler_t *suitable_handler + = find_handler(handlers, setup_packet); + if (suitable_handler != NULL) { + const char *callback_name = "user handler"; + if (suitable_handler->name != NULL) { + callback_name = suitable_handler->name; + } + device->lib_debug(device, 1, USBVIRT_DEBUGTAG_CONTROL_PIPE_ZERO, + "pipe #0 - calling %s " \ + "[%c.%c%c.%c%c%c%c%c, R%d, V%d, I%d, L%d]", + callback_name, + _GET_BITS(setup_packet->request_type), + setup_packet->request, setup_packet->value, + setup_packet->index, setup_packet->length); + rc = suitable_handler->callback(device, setup_packet, data); + } + + return rc; +} +#undef _GET_BITS +#undef _GET_BIT + + +/** Handle communication over control pipe zero. + */ +int control_pipe(usbvirt_device_t *device, usbvirt_control_transfer_t *transfer) +{ + device->lib_debug(device, 2, USBVIRT_DEBUGTAG_CONTROL_PIPE_ZERO, + "op on control pipe zero (request_size=%u)", transfer->request_size); + + if (transfer->request_size < sizeof(usb_device_request_setup_packet_t)) { + return ENOMEM; + } + + usb_device_request_setup_packet_t *request + = (usb_device_request_setup_packet_t *) transfer->request; + + /* + * First, see whether user provided its own callback. + */ + int rc = EFORWARD; + if (device->ops) { + rc = find_and_run_handler(device, + device->ops->control_transfer_handlers, + request, transfer->data); + } + + /* + * If there was no user callback or the callback returned EFORWARD, + * we need to run a local handler. + */ + if (rc == EFORWARD) { + rc = find_and_run_handler(device, + control_pipe_zero_local_handlers, + request, transfer->data); + } + + /* + * Check for SET_ADDRESS finalization. + */ + if (device->new_address != -1) { + /* + * TODO: handle when this request is invalid (e.g. + * setting address when in configured state). + */ + usbvirt_device_state_t new_state; + if (device->new_address == 0) { + new_state = USBVIRT_STATE_DEFAULT; + } else { + new_state = USBVIRT_STATE_ADDRESS; + } + device->address = device->new_address; + + device->new_address = -1; + + if (DEVICE_HAS_OP(device, on_state_change)) { + device->ops->on_state_change(device, device->state, + new_state); + } + device->state = new_state; + + device->lib_debug(device, 2, USBVIRT_DEBUGTAG_CONTROL_PIPE_ZERO, + "device address changed to %d (state %s)", + device->address, str_device_state(device->state)); + } + + return rc; +} + +/** + * @} + */ Index: uspace/lib/usbvirt/src/debug.c =================================================================== --- uspace/lib/usbvirt/src/debug.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usbvirt/src/debug.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,103 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusbvirt + * @{ + */ +/** @file + * @brief Debugging support. + */ +#include +#include + +#include "private.h" + + +static void debug_print(int level, uint8_t tag, + int current_level, uint8_t enabled_tags, + const char *format, va_list args) +{ + if (level > current_level) { + return; + } + + if ((tag & enabled_tags) == 0) { + return; + } + + bool print_prefix = true; + + if ((format[0] == '%') && (format[1] == 'M')) { + format += 2; + print_prefix = false; + } + + if (print_prefix) { + printf("[vusb]: "); + while (--level > 0) { + printf(" "); + } + } + + vprintf(format, args); + + if (print_prefix) { + printf("\n"); + } +} + + +void user_debug(usbvirt_device_t *device, int level, uint8_t tag, + const char *format, ...) +{ + va_list args; + va_start(args, format); + + debug_print(level, tag, + device->debug_level, device->debug_enabled_tags, + format, args); + + va_end(args); +} + +void lib_debug(usbvirt_device_t *device, int level, uint8_t tag, + const char *format, ...) +{ + va_list args; + va_start(args, format); + + debug_print(level, tag, + device->lib_debug_level, device->lib_debug_enabled_tags, + format, args); + + va_end(args); +} + +/** + * @} + */ Index: uspace/lib/usbvirt/src/main.c =================================================================== --- uspace/lib/usbvirt/src/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usbvirt/src/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,284 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusbvirt + * @{ + */ +/** @file + * @brief Device registration with virtual USB framework. + */ +#include +#include +#include +#include +#include + +#include "private.h" + +#define NAMESPACE "usb" + +/** Virtual device wrapper. */ +typedef struct { + /** Actual device. */ + usbvirt_device_t *device; + /** Phone to host controller. */ + int vhcd_phone; + /** Device id. */ + sysarg_t id; + /** Linked-list member. */ + link_t link; +} virtual_device_t; + +/*** List of known device. */ +static LIST_INITIALIZE(device_list); + +/** Find virtual device wrapper based on the contents. */ +static virtual_device_t *find_device(usbvirt_device_t *device) +{ + if (list_empty(&device_list)) { + return NULL; + } + + link_t *pos; + for (pos = device_list.next; pos != &device_list; pos = pos->next) { + virtual_device_t *dev + = list_get_instance(pos, virtual_device_t, link); + if (dev->device == device) { + return dev; + } + } + + return NULL; +} + +/** Find virtual device wrapper by its id. */ +static virtual_device_t *find_device_by_id(sysarg_t id) +{ + if (list_empty(&device_list)) { + return NULL; + } + + link_t *pos; + for (pos = device_list.next; pos != &device_list; pos = pos->next) { + virtual_device_t *dev + = list_get_instance(pos, virtual_device_t, link); + if (dev->id == id) { + return dev; + } + } + + return NULL; +} + +/** Reply to a control transfer. */ +static int control_transfer_reply(usbvirt_device_t *device, + usb_endpoint_t endpoint, void *buffer, size_t size) +{ + usbvirt_control_transfer_t *transfer = &device->current_control_transfers[endpoint]; + if (transfer->data != NULL) { + free(transfer->data); + } + transfer->data = malloc(size); + memcpy(transfer->data, buffer, size); + transfer->data_size = size; + + return EOK; +} + +/** Initialize virtual device. */ +static void device_init(usbvirt_device_t *dev) +{ + dev->transaction_out = transaction_out; + dev->transaction_setup = transaction_setup; + dev->transaction_in = transaction_in; + + dev->control_transfer_reply = control_transfer_reply; + + dev->debug = user_debug; + dev->lib_debug = lib_debug; + + dev->state = USBVIRT_STATE_DEFAULT; + dev->address = 0; + dev->new_address = -1; + + size_t i; + for (i = 0; i < USB11_ENDPOINT_MAX; i++) { + usbvirt_control_transfer_t *transfer = &dev->current_control_transfers[i]; + transfer->direction = 0; + transfer->request = NULL; + transfer->request_size = 0; + transfer->data = NULL; + transfer->data_size = 0; + } +} + +/** Add a virtual device. + * The returned device (if not NULL) shall be destroy via destroy_device(). + */ +static virtual_device_t *add_device(usbvirt_device_t *dev) +{ + assert(find_device(dev) == NULL); + virtual_device_t *new_device + = (virtual_device_t *) malloc(sizeof(virtual_device_t)); + + new_device->device = dev; + link_initialize(&new_device->link); + + list_append(&new_device->link, &device_list); + + return new_device; +} + +/** Destroy virtual device. */ +static void destroy_device(virtual_device_t *dev) +{ + if (dev->vhcd_phone > 0) { + async_hangup(dev->vhcd_phone); + } + + list_remove(&dev->link); + + free(dev); +} + +/** Callback connection handler. */ +static void callback_connection(ipc_callid_t iid, ipc_call_t *icall) +{ + // FIXME - determine which device just called back + virtual_device_t *dev = find_device_by_id(0); + if (dev == NULL) { + async_answer_0(iid, EINVAL); + printf("Ooops\n"); + return; + } + + device_callback_connection(dev->device, iid, icall); +} + +/** Create necessary phones for communication with virtual HCD. + * This function wraps following calls: + * -# open /dev/devices/\\virt\\usbhc for reading + * -# access phone of file opened in previous step + * -# create callback through just opened phone + * -# create handler for calling on data from host to function + * -# return the (outgoing) phone + * + * @warning This function is wrapper for several actions and therefore + * it is not possible - in case of error - to determine at which point + * error occurred. + * + * @param dev Device to connect. + * @return EOK on success or error code from errno.h. + */ +int usbvirt_connect(usbvirt_device_t *dev) +{ + virtual_device_t *virtual_device = find_device(dev); + if (virtual_device != NULL) { + return EEXISTS; + } + + const char *vhc_path = "/virt/usbhc/hc"; + int rc; + devman_handle_t handle; + + rc = devman_device_get_handle(vhc_path, &handle, 0); + if (rc != EOK) { + printf("devman_device_get_handle() failed\n"); + return rc; + } + + int hcd_phone = devman_device_connect(handle, 0); + + if (hcd_phone < 0) { + printf("devman_device_connect() failed\n"); + return hcd_phone; + } + + rc = async_connect_to_me(hcd_phone, 0, 0, 0, callback_connection); + if (rc != EOK) { + printf("ipc_connect_to_me() failed\n"); + return rc; + } + + device_init(dev); + + virtual_device = add_device(dev); + virtual_device->vhcd_phone = hcd_phone; + virtual_device->id = 0; + + return EOK; +} + +/** Prepares device as local. + * This is useful if you want to have a virtual device in the same task + * as HCD. + * + * @param dev Device to connect. + * @return Error code. + * @retval EOK Device connected. + * @retval EEXISTS This device is already connected. + */ +int usbvirt_connect_local(usbvirt_device_t *dev) +{ + virtual_device_t *virtual_device = find_device(dev); + if (virtual_device != NULL) { + return EEXISTS; + } + + device_init(dev); + + virtual_device = add_device(dev); + virtual_device->vhcd_phone = -1; + virtual_device->id = 0; + + return EOK; +} + +/** Disconnects device from HCD. + * + * @param dev Device to be disconnected. + * @return Error code. + * @retval EOK Device connected. + * @retval ENOENT This device is not connected. + */ +int usbvirt_disconnect(usbvirt_device_t *dev) +{ + virtual_device_t *virtual_device = find_device(dev); + if (virtual_device == NULL) { + return ENOENT; + } + + destroy_device(virtual_device); + + return EOK; +} + + +/** + * @} + */ Index: uspace/lib/usbvirt/src/private.h =================================================================== --- uspace/lib/usbvirt/src/private.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usbvirt/src/private.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,94 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusbvirt + * @{ + */ +/** @file + * @brief Virtual USB private header. + */ +#ifndef LIBUSBVIRT_PRIVATE_H_ +#define LIBUSBVIRT_PRIVATE_H_ + +#include +#include +#include + + +#define DEVICE_HAS_OP(dev, op) \ + ( \ + ( ((dev)->ops) != NULL ) \ + && \ + ( ((dev)->ops->op) != NULL ) \ + ) + +int usbvirt_data_to_host(struct usbvirt_device *dev, + usb_endpoint_t endpoint, void *buffer, size_t size); + +int handle_incoming_data(struct usbvirt_device *dev, + usb_endpoint_t endpoint, void *buffer, size_t size); + +int control_pipe(usbvirt_device_t *device, usbvirt_control_transfer_t *transfer); + +int handle_std_request(usbvirt_device_t *device, usb_device_request_setup_packet_t *request, uint8_t *data); + +void device_callback_connection(usbvirt_device_t *device, ipc_callid_t iid, ipc_call_t *icall); + +int transaction_setup(usbvirt_device_t *device, usb_endpoint_t endpoint, + void *buffer, size_t size); +int transaction_out(usbvirt_device_t *device, usb_endpoint_t endpoint, + void *buffer, size_t size); +int transaction_in(usbvirt_device_t *device, usb_endpoint_t endpoint, + void *buffer, size_t size, size_t *data_size); + + +void user_debug(usbvirt_device_t *device, int level, uint8_t tag, + const char *format, ...); +void lib_debug(usbvirt_device_t *device, int level, uint8_t tag, + const char *format, ...); + +static inline const char *str_device_state(usbvirt_device_state_t state) +{ + switch (state) { + case USBVIRT_STATE_DEFAULT: + return "default"; + case USBVIRT_STATE_ADDRESS: + return "address"; + case USBVIRT_STATE_CONFIGURED: + return "configured"; + default: + return "unknown"; + } +} + +extern usbvirt_control_transfer_handler_t control_pipe_zero_local_handlers[]; + +#endif +/** + * @} + */ Index: uspace/lib/usbvirt/src/stdreq.c =================================================================== --- uspace/lib/usbvirt/src/stdreq.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usbvirt/src/stdreq.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,214 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusbvirt + * @{ + */ +/** @file + * @brief Preprocessing of standard device requests. + */ +#include +#include +#include +#include + +#include "private.h" + +/* + * All sub handlers must return EFORWARD to inform the caller that + * they were not able to process the request (yes, it is abuse of + * this error code but such error code shall not collide with anything + * else in this context). + */ + +/** GET_DESCRIPTOR handler. */ +static int handle_get_descriptor(usbvirt_device_t *device, + usb_device_request_setup_packet_t *setup_packet, uint8_t *extra_data) +{ + uint8_t type = setup_packet->value_high; + uint8_t index = setup_packet->value_low; + + /* + * Standard device descriptor. + */ + if ((type == USB_DESCTYPE_DEVICE) && (index == 0)) { + if (device->descriptors && device->descriptors->device) { + return device->control_transfer_reply(device, 0, + device->descriptors->device, + device->descriptors->device->length); + } else { + return EFORWARD; + } + } + + /* + * Configuration descriptor together with interface, endpoint and + * class-specific descriptors. + */ + if (type == USB_DESCTYPE_CONFIGURATION) { + if (!device->descriptors) { + return EFORWARD; + } + if (index >= device->descriptors->configuration_count) { + return EFORWARD; + } + /* Copy the data. */ + usbvirt_device_configuration_t *config = &device->descriptors + ->configuration[index]; + uint8_t *all_data = malloc(config->descriptor->total_length); + if (all_data == NULL) { + return ENOMEM; + } + + uint8_t *ptr = all_data; + memcpy(ptr, config->descriptor, config->descriptor->length); + ptr += config->descriptor->length; + size_t i; + for (i = 0; i < config->extra_count; i++) { + usbvirt_device_configuration_extras_t *extra + = &config->extra[i]; + memcpy(ptr, extra->data, extra->length); + ptr += extra->length; + } + + int rc = device->control_transfer_reply(device, 0, + all_data, config->descriptor->total_length); + + free(all_data); + + return rc; + } + + return EFORWARD; +} + +/** SET_ADDRESS handler. */ +static int handle_set_address(usbvirt_device_t *device, + usb_device_request_setup_packet_t *setup_packet, uint8_t *extra_data) +{ + uint16_t new_address = setup_packet->value; + uint16_t zero1 = setup_packet->index; + uint16_t zero2 = setup_packet->length; + + if ((zero1 != 0) || (zero2 != 0)) { + return EINVAL; + } + + if (new_address > 127) { + return EINVAL; + } + + device->new_address = new_address; + + return EOK; +} + +/** SET_CONFIGURATION handler. */ +static int handle_set_configuration(usbvirt_device_t *device, + usb_device_request_setup_packet_t *setup_packet, uint8_t *extra_data) +{ + uint16_t configuration_value = setup_packet->value; + uint16_t zero1 = setup_packet->index; + uint16_t zero2 = setup_packet->length; + + if ((zero1 != 0) || (zero2 != 0)) { + return EINVAL; + } + + /* + * Configuration value is 1 byte information. + */ + if (configuration_value > 255) { + return EINVAL; + } + + /* + * Do nothing when in default state. According to specification, + * this is not specified. + */ + if (device->state == USBVIRT_STATE_DEFAULT) { + return EOK; + } + + if (configuration_value == 0) { + if (DEVICE_HAS_OP(device, on_state_change)) { + device->ops->on_state_change(device, device->state, + USBVIRT_STATE_ADDRESS); + } + device->state = USBVIRT_STATE_ADDRESS; + } else { + /* + * TODO: browse provided configurations and verify that + * user selected existing configuration. + */ + if (DEVICE_HAS_OP(device, on_state_change)) { + device->ops->on_state_change(device, device->state, + USBVIRT_STATE_CONFIGURED); + } + device->state = USBVIRT_STATE_CONFIGURED; + if (device->descriptors) { + device->descriptors->current_configuration + = configuration_value; + } + } + + return EOK; +} + + +#define MAKE_BM_REQUEST(direction, recipient) \ + USBVIRT_MAKE_CONTROL_REQUEST_TYPE(direction, \ + USBVIRT_REQUEST_TYPE_STANDARD, recipient) +#define MAKE_BM_REQUEST_DEV(direction) \ + MAKE_BM_REQUEST(direction, USBVIRT_REQUEST_RECIPIENT_DEVICE) + +usbvirt_control_transfer_handler_t control_pipe_zero_local_handlers[] = { + { + .request_type = MAKE_BM_REQUEST_DEV(USB_DIRECTION_IN), + .request = USB_DEVREQ_GET_DESCRIPTOR, + .name = "GetDescriptor()", + .callback = handle_get_descriptor + }, + { + .request_type = MAKE_BM_REQUEST_DEV(USB_DIRECTION_OUT), + .request = USB_DEVREQ_SET_ADDRESS, + .name = "SetAddress()", + .callback = handle_set_address + }, + { + .request_type = MAKE_BM_REQUEST_DEV(USB_DIRECTION_OUT), + .request = USB_DEVREQ_SET_CONFIGURATION, + .name = "SetConfiguration()", + .callback = handle_set_configuration + }, + USBVIRT_CONTROL_TRANSFER_HANDLER_LAST +}; + +/** + * @} + */ Index: uspace/lib/usbvirt/src/transaction.c =================================================================== --- uspace/lib/usbvirt/src/transaction.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/lib/usbvirt/src/transaction.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,268 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusbvirt + * @{ + */ +/** @file + * @brief Transaction processing. + */ +#include +#include +#include + +#include "private.h" + +static usb_direction_t setup_transaction_direction(usbvirt_device_t *, + usb_endpoint_t, void *, size_t); +static void process_control_transfer(usbvirt_device_t *, + usb_endpoint_t, usbvirt_control_transfer_t *); + +/** Convert virtual USB transaction type to string. + */ +const char *usbvirt_str_transaction_type(usbvirt_transaction_type_t type) +{ + switch (type) { + case USBVIRT_TRANSACTION_SETUP: + return "setup"; + case USBVIRT_TRANSACTION_IN: + return "in"; + case USBVIRT_TRANSACTION_OUT: + return "out"; + default: + return "unknown"; + } +} + +/** SETUP transaction handling. + * The setup transaction only prepares control transfer on given endpoint. + */ +int transaction_setup(usbvirt_device_t *device, usb_endpoint_t endpoint, + void *buffer, size_t size) +{ + device->lib_debug(device, 1, USBVIRT_DEBUGTAG_TRANSACTION, + "setup transaction: endpoint=%d, size=%u", endpoint, size); + + usbvirt_control_transfer_t *transfer = &device->current_control_transfers[endpoint]; + + if (transfer->request != NULL) { + free(transfer->request); + } + if (transfer->data != NULL) { + free(transfer->data); + } + + transfer->direction = setup_transaction_direction(device, endpoint, + buffer, size); + transfer->request = malloc(size); + memcpy(transfer->request, buffer, size); + transfer->request_size = size; + transfer->data = NULL; + transfer->data_size = 0; + + if (transfer->direction == USB_DIRECTION_IN) { + process_control_transfer(device, endpoint, transfer); + } + + return EOK; +} + +/** OUT transaction handling. + * The OUT transaction can trigger processing of a control transfer. + */ +int transaction_out(usbvirt_device_t *device, usb_endpoint_t endpoint, + void *buffer, size_t size) +{ + device->lib_debug(device, 1, USBVIRT_DEBUGTAG_TRANSACTION, + "out transaction: endpoint=%d, size=%u", endpoint, size); + + /* + * First check whether it is a transaction over control pipe. + */ + usbvirt_control_transfer_t *transfer = &device->current_control_transfers[endpoint]; + if (transfer->request != NULL) { + if (transfer->direction == USB_DIRECTION_OUT) { + /* + * For out transactions, append the data to the buffer. + */ + uint8_t *new_buffer = (uint8_t *) malloc(transfer->data_size + size); + if (transfer->data) { + memcpy(new_buffer, transfer->data, transfer->data_size); + } + memcpy(new_buffer + transfer->data_size, buffer, size); + + if (transfer->data) { + free(transfer->data); + } + transfer->data = new_buffer; + transfer->data_size += size; + } else { + /* + * For in transactions, this means end of the + * transaction. + */ + free(transfer->request); + if (transfer->data) { + free(transfer->data); + } + transfer->request = NULL; + transfer->request_size = 0; + transfer->data = NULL; + transfer->data_size = 0; + } + + return EOK; + } + + /* + * Otherwise, announce that some data has come. + */ + if (device->ops && device->ops->on_data) { + return device->ops->on_data(device, endpoint, buffer, size); + } else { + return ENOTSUP; + } +} + +/** IN transaction handling. + * The IN transaction can trigger processing of a control transfer. + */ +int transaction_in(usbvirt_device_t *device, usb_endpoint_t endpoint, + void *buffer, size_t size, size_t *data_size) +{ + device->lib_debug(device, 1, USBVIRT_DEBUGTAG_TRANSACTION, + "in transaction: endpoint=%d, size=%u", endpoint, size); + + /* + * First check whether it is a transaction over control pipe. + */ + usbvirt_control_transfer_t *transfer = &device->current_control_transfers[endpoint]; + if (transfer->request != NULL) { + if (transfer->direction == USB_DIRECTION_OUT) { + /* + * This means end of input data. + */ + process_control_transfer(device, endpoint, transfer); + } else { + /* + * For in transactions, this means sending next part + * of the buffer. + */ + // FIXME: handle when the HC wants the data back + // in more chunks + size_t actual_size = 0; + if (transfer->data) { + actual_size = transfer->data_size; + } + if (actual_size > size) { + actual_size = size; + } + device->lib_debug(device, 1, USBVIRT_DEBUGTAG_TRANSACTION, + "in transaction: will copy %zu bytes", actual_size); + if (actual_size > 0) { + memcpy(buffer, transfer->data, actual_size); + if (data_size) { + *data_size = actual_size; + } + } + } + + return EOK; + } + + if (size == 0) { + return EINVAL; + } + + int rc = 1; + + if (device->ops && device->ops->on_data_request) { + rc = device->ops->on_data_request(device, endpoint, buffer, size, data_size); + } + + return rc; +} + +/** Determine direction of control transfer. + * First, try the user provided callback, otherwise guess, believing that + * it uses the same format as control pipe 0. + */ +static usb_direction_t setup_transaction_direction(usbvirt_device_t *device, + usb_endpoint_t endpoint, + void *data, size_t size) +{ + int direction = -1; + if (device->ops && device->ops->decide_control_transfer_direction) { + direction = device->ops->decide_control_transfer_direction(endpoint, + data, size); + } + + /* + * If the user-supplied routine have not handled the direction + * (or simply was not provided) we will guess, hoping that it + * uses same format as standard request on control pipe zero. + */ + if (direction < 0) { + if (size > 0) { + uint8_t *ptr = (uint8_t *) data; + if ((ptr[0] & 128) == 128) { + direction = USB_DIRECTION_IN; + } else { + direction = USB_DIRECTION_OUT; + } + } else { + /* This shall not happen anyway. */ + direction = USB_DIRECTION_OUT; + } + } + + return (usb_direction_t) direction; +} + +/** Process control transfer. + */ +static void process_control_transfer(usbvirt_device_t *device, + usb_endpoint_t endpoint, + usbvirt_control_transfer_t *transfer) +{ + int rc = EFORWARD; + + if (device->ops && device->ops->on_control_transfer) { + rc = device->ops->on_control_transfer(device, endpoint, transfer); + } + + if (rc == EFORWARD) { + if (endpoint == 0) { + rc = control_pipe(device, transfer); + } + } +} + +/** + * @} + */ Index: uspace/srv/devman/main.c =================================================================== --- uspace/srv/devman/main.c (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/srv/devman/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -567,5 +567,6 @@ if (driver == NULL) { log_msg(LVL_ERROR, "IPC forwarding refused - " \ - "the device %" PRIun " is not in usable state.", handle); + "the device %" PRIun "(%s) is not in usable state.", + handle, dev->pfun->pathname); async_answer_0(iid, ENOENT); return; Index: uspace/srv/fs/fat/fat_dentry.c =================================================================== --- uspace/srv/fs/fat/fat_dentry.c (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/srv/fs/fat/fat_dentry.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -42,5 +42,5 @@ static bool is_d_char(const char ch) { - if (isalnum(ch) || ch == '_') + if (isalnum(ch) || ch == '_' || ch == '-') return true; else Index: uspace/srv/hid/console/console.c =================================================================== --- uspace/srv/hid/console/console.c (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/srv/hid/console/console.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -41,4 +41,5 @@ #include #include +#include #include #include @@ -64,4 +65,6 @@ #define NAME "console" #define NAMESPACE "term" +/** Interval for checking for new keyboard (1/4s). */ +#define HOTPLUG_WATCH_INTERVAL (1000 * 250) /** Phone to the keyboard driver. */ @@ -317,6 +320,7 @@ static void change_console(console_t *cons) { - if (cons == active_console) + if (cons == active_console) { return; + } fb_pending_flush(); @@ -458,6 +462,7 @@ if (IPC_GET_ARG1(call) == 1) { int newcon = gcons_mouse_btn((bool) IPC_GET_ARG2(call)); - if (newcon != -1) + if (newcon != -1) { change_console(&consoles[newcon]); + } } retval = 0; @@ -710,49 +715,123 @@ } +static int connect_keyboard_or_mouse(const char *devname, + async_client_conn_t handler, const char *path) +{ + int fd = open(path, O_RDONLY); + if (fd < 0) { + return fd; + } + + int phone = fd_phone(fd); + if (phone < 0) { + printf(NAME ": Failed to connect to input device\n"); + return phone; + } + + int rc = async_connect_to_me(phone, SERVICE_CONSOLE, 0, 0, handler); + if (rc != EOK) { + printf(NAME ": " \ + "Failed to create callback from input device: %s.\n", + str_error(rc)); + return rc; + } + + printf(NAME ": found %s \"%s\".\n", devname, path); + + return phone; +} + +static int connect_keyboard(const char *path) +{ + return connect_keyboard_or_mouse("keyboard", keyboard_events, path); +} + +static int connect_mouse(const char *path) +{ + return connect_keyboard_or_mouse("mouse", mouse_events, path); +} + +struct hid_class_info { + char *classname; + int (*connection_func)(const char *); +}; + +/** Periodically check for new keyboards in /dev/class/. + * + * @param arg Class name. + * @return This function should never exit. + */ +static int check_new_device_fibril(void *arg) +{ + struct hid_class_info *dev_info = arg; + + size_t index = 1; + + while (true) { + async_usleep(HOTPLUG_WATCH_INTERVAL); + char *path; + int rc = asprintf(&path, "/dev/class/%s\\%zu", + dev_info->classname, index); + if (rc < 0) { + continue; + } + rc = 0; + rc = dev_info->connection_func(path); + if (rc > 0) { + /* We do not allow unplug. */ + index++; + } + + free(path); + } + + return EOK; +} + + +/** Start a fibril monitoring hot-plugged keyboards. + */ +static void check_new_devices_in_background(int (*connection_func)(const char *), + const char *classname) +{ + struct hid_class_info *dev_info = malloc(sizeof(struct hid_class_info)); + if (dev_info == NULL) { + printf(NAME ": " \ + "out of memory, will not start hot-plug-watch fibril.\n"); + return; + } + int rc; + + rc = asprintf(&dev_info->classname, "%s", classname); + if (rc < 0) { + printf(NAME ": failed to format classname: %s.\n", + str_error(rc)); + return; + } + dev_info->connection_func = connection_func; + + fid_t fid = fibril_create(check_new_device_fibril, (void *)dev_info); + if (!fid) { + printf(NAME + ": failed to create hot-plug-watch fibril for %s.\n", + classname); + return; + } + fibril_add_ready(fid); +} + static bool console_init(char *input) { /* Connect to input device */ - int input_fd = open(input, O_RDONLY); - if (input_fd < 0) { - printf(NAME ": Failed opening %s\n", input); + kbd_phone = connect_keyboard(input); + if (kbd_phone < 0) { return false; } - - kbd_phone = fd_phone(input_fd); - if (kbd_phone < 0) { - printf(NAME ": Failed to connect to input device\n"); - return false; - } - - /* NB: The callback connection is slotted for removal */ - if (async_connect_to_me(kbd_phone, SERVICE_CONSOLE, 0, 0, keyboard_events) - != 0) { - printf(NAME ": Failed to create callback from input device\n"); - return false; - } - - /* Connect to mouse device */ - mouse_phone = -1; - int mouse_fd = open("/dev/hid_in/mouse", O_RDONLY); - - if (mouse_fd < 0) { - printf(NAME ": Notice - failed opening %s\n", "/dev/hid_in/mouse"); - goto skip_mouse; - } - - mouse_phone = fd_phone(mouse_fd); + + mouse_phone = connect_mouse("/dev/hid_in/mouse"); if (mouse_phone < 0) { - printf(NAME ": Failed to connect to mouse device\n"); - goto skip_mouse; - } - - if (async_connect_to_me(mouse_phone, SERVICE_CONSOLE, 0, 0, mouse_events) - != 0) { - printf(NAME ": Failed to create callback from mouse device\n"); - mouse_phone = -1; - goto skip_mouse; - } - -skip_mouse: + printf(NAME ": Failed to connect to mouse device: %s.\n", + str_error(mouse_phone)); + } /* Connect to framebuffer driver */ @@ -837,4 +916,8 @@ printf(NAME ": Error registering kconsole notifications\n"); + /* Start fibril for checking on hot-plugged keyboards. */ + check_new_devices_in_background(connect_keyboard, "keyboard"); + check_new_devices_in_background(connect_mouse, "mouse"); + return true; } @@ -856,5 +939,5 @@ if (!console_init(argv[1])) return -1; - + printf(NAME ": Accepting connections\n"); async_manager();