Index: uspace/drv/ehci-hcd/Makefile =================================================================== --- uspace/drv/ehci-hcd/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ehci-hcd/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,47 @@ +# +# 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 = \ + $(LIBUSBHOST_PREFIX)/libusbhost.a \ + $(LIBUSB_PREFIX)/libusb.a \ + $(LIBDRV_PREFIX)/libdrv.a +EXTRA_CFLAGS += \ + -I$(LIBUSB_PREFIX)/include \ + -I$(LIBUSBHOST_PREFIX)/include \ + -I$(LIBDRV_PREFIX)/include + +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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ehci-hcd/ehci-hcd.ma (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,39 @@ +10 pci/ven=1002&dev=4345 +10 pci/ven=1002&dev=4386 +10 pci/ven=1002&dev=4396 +10 pci/ven=1002&dev=4373 +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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ehci-hcd/ehci.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ehci-hcd/hc_iface.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 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__) + +/** 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; +} + +/** Find device handle by USB address. + * + * @param[in] fun DDF function that was called. + * @param[in] address Address in question. + * @param[out] handle Where to store device handle if found. + * @return Error code. + */ +static int find_by_address(ddf_fun_t *fun, usb_address_t address, + devman_handle_t *handle) +{ + UNSUPPORTED("find_by_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] speed Endpoint speed (invalid means to use device one). + * @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_speed_t speed, 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] 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, + 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] 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, + 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] 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, + 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] 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, + 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] 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, + 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] 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, + 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 = { + .request_address = request_address, + .bind_address = bind_address, + .find_by_address = find_by_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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ehci-hcd/main.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,130 @@ +/* + * 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 reg_base = 0; + size_t reg_size = 0; + int irq = 0; + + int ret = pci_get_my_registers(device, ®_base, ®_size, &irq); + CHECK_RET_RETURN(ret, + "Failed to get memory addresses for %" PRIun ": %s.\n", + device->handle, str_error(ret)); + usb_log_info("Memory mapped regs at 0x%" PRIxn " (size %zu), IRQ %d.\n", + reg_base, reg_size, irq); + + ret = pci_disable_legacy(device, reg_base, reg_size, irq); + CHECK_RET_RETURN(ret, + "Failed to disable legacy USB: %s.\n", 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)); + ret = ddf_fun_add_to_class(hc_fun, USB_HC_DDF_CLASS_NAME); + CHECK_RET_RETURN(ret, + "Failed to add EHCI to HC class: %s.\n", + str_error(ret)); + + usb_log_info("Controlling new EHCI device `%s' (handle %" PRIun ").\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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ehci-hcd/pci.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,375 @@ +/* + * 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 + +#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 STS_OFFSET 0x4 +#define INT_OFFSET 0x8 +#define CFG_OFFSET 0x40 + +#define USBCMD_RUN 1 +#define USBSTS_HALTED (1 << 12) + +#define USBLEGSUP_OFFSET 0 +#define USBLEGSUP_BIOS_CONTROL (1 << 16) +#define USBLEGSUP_OS_CONTROL (1 << 24) +#define USBLEGCTLSTS_OFFSET 4 + +#define DEFAULT_WAIT 1000 +#define WAIT_STEP 10 + +#define PCI_READ(size) \ +do { \ + const int parent_phone = \ + devman_parent_device_connect(dev->handle, IPC_FLAG_BLOCKING);\ + if (parent_phone < 0) {\ + return parent_phone; \ + } \ + sysarg_t add = (sysarg_t)address; \ + sysarg_t val; \ + const int ret = \ + async_req_2_1(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), \ + IPC_M_CONFIG_SPACE_READ_##size, add, &val); \ + assert(value); \ + *value = val; \ + async_hangup(parent_phone); \ + return ret; \ +} while(0) + +static int pci_read32(const ddf_dev_t *dev, int address, uint32_t *value) +{ + PCI_READ(32); +} +static int pci_read16(const ddf_dev_t *dev, int address, uint16_t *value) +{ + PCI_READ(16); +} +static int pci_read8(const ddf_dev_t *dev, int address, uint8_t *value) +{ + PCI_READ(8); +} +#define PCI_WRITE(size) \ +do { \ + const int parent_phone = \ + devman_parent_device_connect(dev->handle, IPC_FLAG_BLOCKING);\ + if (parent_phone < 0) {\ + return parent_phone; \ + } \ + sysarg_t add = (sysarg_t)address; \ + sysarg_t val = value; \ + const int ret = \ + async_req_3_0(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), \ + IPC_M_CONFIG_SPACE_WRITE_##size, add, val); \ + async_hangup(parent_phone); \ + return ret; \ +} while(0) + +static int pci_write32(const ddf_dev_t *dev, int address, uint32_t value) +{ + PCI_WRITE(32); +} +static int pci_write16(const ddf_dev_t *dev, int address, uint16_t value) +{ + PCI_WRITE(16); +} +static int pci_write8(const ddf_dev_t *dev, int address, uint8_t value) +{ + PCI_WRITE(8); +} + +/** 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(const ddf_dev_t *dev, + uintptr_t *mem_reg_address, size_t *mem_reg_size, int *irq_no) +{ + assert(dev != NULL); + + const 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: %" PRIxn" %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(const ddf_dev_t *device) +{ + const int parent_phone = + devman_parent_device_connect(device->handle, IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + const 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( + const ddf_dev_t *device, uintptr_t reg_base, size_t reg_size, int irq) +{ + assert(device); + (void) pci_read16; + (void) pci_read8; + (void) pci_write16; + +#define CHECK_RET_RETURN(ret, message...) \ + if (ret != EOK) { \ + usb_log_error(message); \ + return ret; \ + } else (void)0 + + /* Map EHCI registers */ + void *regs = NULL; + int ret = pio_enable((void*)reg_base, reg_size, ®s); + CHECK_RET_RETURN(ret, "Failed to map registers %p: %s.\n", + (void *) reg_base, str_error(ret)); + + const uint32_t hcc_params = + *(uint32_t*)(regs + HCC_PARAMS_OFFSET); + usb_log_debug("Value of hcc params register: %x.\n", hcc_params); + + /* Read value of EHCI Extended Capabilities Pointer + * position of EEC registers (points to PCI config space) */ + const uint32_t eecp = + (hcc_params >> HCC_PARAMS_EECP_OFFSET) & HCC_PARAMS_EECP_MASK; + usb_log_debug("Value of EECP: %x.\n", eecp); + + /* Read the first EEC. i.e. Legacy Support register */ + uint32_t usblegsup; + ret = pci_read32(device, eecp + USBLEGSUP_OFFSET, &usblegsup); + CHECK_RET_RETURN(ret, "Failed to read USBLEGSUP: %s.\n", str_error(ret)); + usb_log_debug("USBLEGSUP: %" PRIx32 ".\n", usblegsup); + + /* Request control from firmware/BIOS, by writing 1 to highest byte. + * (OS Control semaphore)*/ + usb_log_debug("Requesting OS control.\n"); + ret = pci_write8(device, eecp + USBLEGSUP_OFFSET + 3, 1); + CHECK_RET_RETURN(ret, "Failed to request OS EHCI control: %s.\n", + str_error(ret)); + + size_t wait = 0; + /* Wait for BIOS to release control. */ + ret = pci_read32(device, eecp + USBLEGSUP_OFFSET, &usblegsup); + while ((wait < DEFAULT_WAIT) && (usblegsup & USBLEGSUP_BIOS_CONTROL)) { + async_usleep(WAIT_STEP); + ret = pci_read32(device, eecp + USBLEGSUP_OFFSET, &usblegsup); + wait += WAIT_STEP; + } + + + if ((usblegsup & USBLEGSUP_BIOS_CONTROL) == 0) { + usb_log_info("BIOS released control after %zu usec.\n", wait); + } else { + /* BIOS failed to hand over control, this should not happen. */ + usb_log_warning( "BIOS failed to release control after " + "%zu usecs, force it.\n", wait); + ret = pci_write32(device, eecp + USBLEGSUP_OFFSET, + USBLEGSUP_OS_CONTROL); + CHECK_RET_RETURN(ret, "Failed to force OS control: %s.\n", + str_error(ret)); + /* Check capability type here, A value of 01h + * identifies the capability as Legacy Support. + * This extended capability requires one + * additional 32-bit register for control/status information, + * and this register is located at offset EECP+04h + * */ + if ((usblegsup & 0xff) == 1) { + /* Read the second EEC + * Legacy Support and Control register */ + uint32_t usblegctlsts; + ret = pci_read32( + device, eecp + USBLEGCTLSTS_OFFSET, &usblegctlsts); + CHECK_RET_RETURN(ret, + "Failed to get USBLEGCTLSTS: %s.\n", str_error(ret)); + usb_log_debug("USBLEGCTLSTS: %" PRIx32 ".\n", + usblegctlsts); + /* Zero SMI enables in legacy control register. + * It should prevent pre-OS code from interfering. */ + ret = pci_write32(device, eecp + USBLEGCTLSTS_OFFSET, + 0xe0000000); /* three upper bits are WC */ + CHECK_RET_RETURN(ret, + "Failed(%d) zero USBLEGCTLSTS.\n", ret); + udelay(10); + ret = pci_read32( + device, eecp + USBLEGCTLSTS_OFFSET, &usblegctlsts); + CHECK_RET_RETURN(ret, + "Failed to get USBLEGCTLSTS 2: %s.\n", + str_error(ret)); + usb_log_debug("Zeroed USBLEGCTLSTS: %" PRIx32 ".\n", + usblegctlsts); + } + } + + + /* Read again Legacy Support register */ + ret = pci_read32(device, eecp + USBLEGSUP_OFFSET, &usblegsup); + CHECK_RET_RETURN(ret, "Failed to read USBLEGSUP: %s.\n", str_error(ret)); + usb_log_debug("USBLEGSUP: %" PRIx32 ".\n", usblegsup); + + /* + * TURN OFF EHCI FOR NOW, DRIVER WILL REINITIALIZE IT + */ + + /* Get size of capability registers in memory space. */ + const unsigned operation_offset = *(uint8_t*)regs; + usb_log_debug("USBCMD offset: %d.\n", operation_offset); + + /* Zero USBCMD register. */ + volatile uint32_t *usbcmd = + (uint32_t*)((uint8_t*)regs + operation_offset + CMD_OFFSET); + volatile uint32_t *usbsts = + (uint32_t*)((uint8_t*)regs + operation_offset + STS_OFFSET); + volatile uint32_t *usbconf = + (uint32_t*)((uint8_t*)regs + operation_offset + CFG_OFFSET); + volatile uint32_t *usbint = + (uint32_t*)((uint8_t*)regs + operation_offset + INT_OFFSET); + usb_log_debug("USBCMD value: %x.\n", *usbcmd); + if (*usbcmd & USBCMD_RUN) { + *usbsts = 0x3f; /* ack all interrupts */ + *usbint = 0; /* disable all interrutps */ + *usbconf = 0; /* relase control of RH ports */ + + *usbcmd = 0; + /* Wait until hc is halted */ + while ((*usbsts & USBSTS_HALTED) == 0); + usb_log_info("EHCI turned off.\n"); + } else { + usb_log_info("EHCI was not running.\n"); + } + usb_log_debug("Registers: \n" + "\t USBCMD: %x(0x00080000 = at least 1ms between interrupts)\n" + "\t USBSTS: %x(0x00001000 = HC halted)\n" + "\t USBINT: %x(0x0 = no interrupts).\n" + "\t CONFIG: %x(0x0 = ports controlled by companion hc).\n", + *usbcmd, *usbsts, *usbint, *usbconf); + + return ret; +#undef CHECK_RET_RETURN +} +/*----------------------------------------------------------------------------*/ +/** + * @} + */ + +/** + * @} + */ Index: uspace/drv/ehci-hcd/pci.h =================================================================== --- uspace/drv/ehci-hcd/pci.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ehci-hcd/pci.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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(const ddf_dev_t *, uintptr_t *, size_t *, int *); +int pci_enable_interrupts(const ddf_dev_t *); +int pci_disable_legacy(const ddf_dev_t *, uintptr_t, size_t, int); + +#endif +/** + * @} + */ + Index: uspace/drv/ohci/Makefile =================================================================== --- uspace/drv/ohci/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,58 @@ +# +# 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 = \ + $(LIBUSBHOST_PREFIX)/libusbhost.a \ + $(LIBUSBDEV_PREFIX)/libusbdev.a \ + $(LIBUSB_PREFIX)/libusb.a \ + $(LIBDRV_PREFIX)/libdrv.a +EXTRA_CFLAGS += \ + -I$(LIBUSB_PREFIX)/include \ + -I$(LIBUSBDEV_PREFIX)/include \ + -I$(LIBUSBHOST_PREFIX)/include \ + -I$(LIBDRV_PREFIX)/include + +BINARY = ohci + +SOURCES = \ + batch.c \ + endpoint_list.c \ + hc.c \ + hcd_endpoint.c \ + iface.c \ + main.c \ + ohci.c \ + pci.c \ + root_hub.c \ + hw_struct/endpoint_descriptor.c \ + hw_struct/transfer_descriptor.c + + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/ohci/batch.c =================================================================== --- uspace/drv/ohci/batch.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/batch.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,429 @@ +/* + * 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 "hcd_endpoint.h" +#include "utils/malloc32.h" +#include "hw_struct/endpoint_descriptor.h" +#include "hw_struct/transfer_descriptor.h" + +/** OHCI specific data required for USB transfer */ +typedef struct ohci_transfer_batch { + /** Endpoint descriptor of the target endpoint. */ + ed_t *ed; + /** List of TDs needed for the transfer */ + td_t **tds; + /** Number of TDs used by the transfer */ + size_t td_count; + /** Dummy TD to be left at the ED and used by the next transfer */ + size_t leave_td; + /** Data buffer, must be accessible byb the OHCI hw. */ + void *device_buffer; +} ohci_transfer_batch_t; +/*----------------------------------------------------------------------------*/ +static void batch_control(usb_transfer_batch_t *instance, + usb_direction_t data_dir, usb_direction_t status_dir); +static void batch_data(usb_transfer_batch_t *instance); +/*----------------------------------------------------------------------------*/ +/** Safely destructs ohci_transfer_batch_t structure + * + * @param[in] ohci_batch Instance to destroy. + */ +static void ohci_transfer_batch_dispose(void *ohci_batch) +{ + ohci_transfer_batch_t *instance = ohci_batch; + if (!instance) + return; + free32(instance->device_buffer); + unsigned i = 0; + if (instance->tds) { + for (; i< instance->td_count; ++i) { + if (i != instance->leave_td) + free32(instance->tds[i]); + } + free(instance->tds); + } + free(instance); +} +/*----------------------------------------------------------------------------*/ +/** Allocate memory initialize internal structures + * + * @param[in] fun DDF function to pass to callback. + * @param[in] ep Communication target + * @param[in] buffer Data source/destination. + * @param[in] buffer_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 transfer completion + * @param[in] func_out function to call on outbound transfer completion + * @param[in] arg additional parameter to func_in or func_out + * @return Valid pointer if all structures were successfully created, + * NULL otherwise. + * + * Allocates and initializes structures needed by the OHCI hw for the transfer. + */ +usb_transfer_batch_t * batch_get(ddf_fun_t *fun, endpoint_t *ep, + char *buffer, size_t buffer_size, + const 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) +{ +#define CHECK_NULL_DISPOSE_RETURN(ptr, message...) \ + if (ptr == NULL) { \ + usb_log_error(message); \ + if (instance) { \ + usb_transfer_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, ep, buffer, NULL, buffer_size, + NULL, setup_size, func_in, func_out, arg, fun, NULL, + ohci_transfer_batch_dispose); + + const hcd_endpoint_t *hcd_ep = hcd_endpoint_get(ep); + assert(hcd_ep); + + ohci_transfer_batch_t *data = calloc(sizeof(ohci_transfer_batch_t), 1); + CHECK_NULL_DISPOSE_RETURN(data, "Failed to allocate batch data.\n"); + instance->private_data = data; + + data->td_count = + ((buffer_size + OHCI_TD_MAX_TRANSFER - 1) / OHCI_TD_MAX_TRANSFER); + /* Control transfer need Setup and Status stage */ + if (ep->transfer_type == USB_TRANSFER_CONTROL) { + data->td_count += 2; + } + + /* We need an extra place for TD that is currently assigned to hcd_ep*/ + data->tds = calloc(sizeof(td_t*), data->td_count + 1); + CHECK_NULL_DISPOSE_RETURN(data->tds, + "Failed to allocate transfer descriptors.\n"); + + /* Add TD left over by the previous transfer */ + data->tds[0] = hcd_ep->td; + data->leave_td = 0; + unsigned i = 1; + for (; i <= data->td_count; ++i) { + data->tds[i] = malloc32(sizeof(td_t)); + CHECK_NULL_DISPOSE_RETURN(data->tds[i], + "Failed to allocate TD %d.\n", i ); + } + + data->ed = hcd_ep->ed; + + /* NOTE: OHCI is capable of handling buffer that crosses page boundaries + * it is, however, not capable of handling buffer that occupies more + * than two pages (the first page is computed using start pointer, the + * other using the end pointer) */ + if (setup_size + buffer_size > 0) { + data->device_buffer = malloc32(setup_size + buffer_size); + CHECK_NULL_DISPOSE_RETURN(data->device_buffer, + "Failed to allocate device accessible buffer.\n"); + instance->setup_buffer = data->device_buffer; + instance->data_buffer = data->device_buffer + setup_size; + memcpy(instance->setup_buffer, setup_buffer, setup_size); + } + + return instance; +} +/*----------------------------------------------------------------------------*/ +/** Check batch TDs' status. + * + * @param[in] instance Batch structure to use. + * @return False, if there is an active TD, true otherwise. + * + * Walk all TDs (usually there is just one). Stop with false if there is an + * active TD. Stop with true if an error is found. Return true if the walk + * completes with the last TD. + */ +bool batch_is_complete(usb_transfer_batch_t *instance) +{ + assert(instance); + ohci_transfer_batch_t *data = instance->private_data; + assert(data); + usb_log_debug("Batch(%p) checking %zu td(s) for completion.\n", + instance, data->td_count); + usb_log_debug("ED: %x:%x:%x:%x.\n", + data->ed->status, data->ed->td_head, data->ed->td_tail, + data->ed->next); + size_t i = 0; + instance->transfered_size = instance->buffer_size; + for (; i < data->td_count; ++i) { + assert(data->tds[i] != NULL); + usb_log_debug("TD %zu: %x:%x:%x:%x.\n", i, + data->tds[i]->status, data->tds[i]->cbp, data->tds[i]->next, + data->tds[i]->be); + if (!td_is_finished(data->tds[i])) { + return false; + } + instance->error = td_error(data->tds[i]); + if (instance->error != EOK) { + usb_log_debug("Batch(%p) found error TD(%zu):%x.\n", + instance, i, data->tds[i]->status); + /* Make sure TD queue is empty (one TD), + * ED should be marked as halted */ + data->ed->td_tail = + (data->ed->td_head & ED_TDTAIL_PTR_MASK); + ++i; + break; + } + } + data->leave_td = i; + assert(data->leave_td <= data->td_count); + hcd_endpoint_t *hcd_ep = hcd_endpoint_get(instance->ep); + assert(hcd_ep); + hcd_ep->td = data->tds[i]; + assert(i > 0); + for (--i;i < data->td_count; ++i) + instance->transfered_size -= td_remain_size(data->tds[i]); + + /* Clear possible ED HALT */ + data->ed->td_head &= ~ED_TDHEAD_HALTED_FLAG; + const uint32_t pa = addr_to_phys(hcd_ep->td); + assert(pa == (data->ed->td_head & ED_TDHEAD_PTR_MASK)); + assert(pa == (data->ed->td_tail & ED_TDTAIL_PTR_MASK)); + + return true; +} +/*----------------------------------------------------------------------------*/ +/** Starts execution of the TD list + * + * @param[in] instance Batch structure to use + */ +void batch_commit(usb_transfer_batch_t *instance) +{ + assert(instance); + ohci_transfer_batch_t *data = instance->private_data; + assert(data); + ed_set_end_td(data->ed, data->tds[data->td_count]); +} +/*----------------------------------------------------------------------------*/ +/** Prepares control write transfer. + * + * @param[in] instance Batch structure to use. + * + * Uses generic control transfer using direction OUT(data stage) and + * IN(status stage). + */ +void batch_control_write(usb_transfer_batch_t *instance) +{ + assert(instance); + /* We are data out, we are supposed to provide data */ + memcpy(instance->data_buffer, instance->buffer, instance->buffer_size); + instance->next_step = usb_transfer_batch_call_out_and_dispose; + batch_control(instance, USB_DIRECTION_OUT, USB_DIRECTION_IN); + usb_log_debug("Batch(%p) CONTROL WRITE initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepares control read transfer. + * + * @param[in] instance Batch structure to use. + * + * Uses generic control transfer using direction IN(data stage) and + * OUT(status stage). + */ +void batch_control_read(usb_transfer_batch_t *instance) +{ + assert(instance); + instance->next_step = usb_transfer_batch_call_in_and_dispose; + batch_control(instance, USB_DIRECTION_IN, USB_DIRECTION_OUT); + usb_log_debug("Batch(%p) CONTROL READ initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare interrupt in transfer. + * + * @param[in] instance Batch structure to use. + * + * Data transfer. + */ +void batch_interrupt_in(usb_transfer_batch_t *instance) +{ + assert(instance); + instance->next_step = usb_transfer_batch_call_in_and_dispose; + batch_data(instance); + usb_log_debug("Batch(%p) INTERRUPT IN initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare interrupt out transfer. + * + * @param[in] instance Batch structure to use. + * + * Data transfer. + */ +void batch_interrupt_out(usb_transfer_batch_t *instance) +{ + assert(instance); + /* We are data out, we are supposed to provide data */ + memcpy(instance->data_buffer, instance->buffer, instance->buffer_size); + instance->next_step = usb_transfer_batch_call_out_and_dispose; + batch_data(instance); + usb_log_debug("Batch(%p) INTERRUPT OUT initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare bulk in transfer. + * + * @param[in] instance Batch structure to use. + * + * Data transfer. + */ +void batch_bulk_in(usb_transfer_batch_t *instance) +{ + assert(instance); + instance->next_step = usb_transfer_batch_call_in_and_dispose; + batch_data(instance); + usb_log_debug("Batch(%p) BULK IN initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare bulk out transfer. + * + * @param[in] instance Batch structure to use. + * + * Data transfer. + */ +void batch_bulk_out(usb_transfer_batch_t *instance) +{ + assert(instance); + /* We are data out, we are supposed to provide data */ + memcpy(instance->data_buffer, instance->buffer, instance->buffer_size); + instance->next_step = usb_transfer_batch_call_out_and_dispose; + batch_data(instance); + usb_log_debug("Batch(%p) BULK OUT initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare generic control transfer + * + * @param[in] instance Batch structure to use. + * @param[in] data_dir Direction to use for data stage. + * @param[in] status_dir Direction to use for status stage. + * + * Setup stage with toggle 0 and direction BOTH(SETUP_PID) + * Data stage with alternating toggle and direction supplied by parameter. + * Status stage with toggle 1 and direction supplied by parameter. + */ +void batch_control(usb_transfer_batch_t *instance, + usb_direction_t data_dir, usb_direction_t status_dir) +{ + assert(instance); + ohci_transfer_batch_t *data = instance->private_data; + assert(data); + usb_log_debug("Using ED(%p): %x:%x:%x:%x.\n", data->ed, + data->ed->status, data->ed->td_tail, data->ed->td_head, + data->ed->next); + int toggle = 0; + /* setup stage */ + td_init(data->tds[0], USB_DIRECTION_BOTH, instance->setup_buffer, + instance->setup_size, toggle); + td_set_next(data->tds[0], data->tds[1]); + usb_log_debug("Created SETUP TD: %x:%x:%x:%x.\n", data->tds[0]->status, + data->tds[0]->cbp, data->tds[0]->next, data->tds[0]->be); + + /* data stage */ + size_t td_current = 1; + size_t remain_size = instance->buffer_size; + char *buffer = instance->data_buffer; + while (remain_size > 0) { + size_t transfer_size = remain_size > OHCI_TD_MAX_TRANSFER ? + OHCI_TD_MAX_TRANSFER : remain_size; + toggle = 1 - toggle; + + td_init(data->tds[td_current], data_dir, buffer, + transfer_size, toggle); + td_set_next(data->tds[td_current], data->tds[td_current + 1]); + usb_log_debug("Created DATA TD: %x:%x:%x:%x.\n", + data->tds[td_current]->status, data->tds[td_current]->cbp, + data->tds[td_current]->next, data->tds[td_current]->be); + + buffer += transfer_size; + remain_size -= transfer_size; + assert(td_current < data->td_count - 1); + ++td_current; + } + + /* status stage */ + assert(td_current == data->td_count - 1); + td_init(data->tds[td_current], status_dir, NULL, 0, 1); + td_set_next(data->tds[td_current], data->tds[td_current + 1]); + usb_log_debug("Created STATUS TD: %x:%x:%x:%x.\n", + data->tds[td_current]->status, data->tds[td_current]->cbp, + data->tds[td_current]->next, data->tds[td_current]->be); +} +/*----------------------------------------------------------------------------*/ +/** Prepare generic data transfer + * + * @param[in] instance Batch structure to use. + * + * Direction is supplied by the associated ep and toggle is maintained by the + * OHCI hw in ED. + */ +void batch_data(usb_transfer_batch_t *instance) +{ + assert(instance); + ohci_transfer_batch_t *data = instance->private_data; + assert(data); + usb_log_debug("Using ED(%p): %x:%x:%x:%x.\n", data->ed, + data->ed->status, data->ed->td_tail, data->ed->td_head, + data->ed->next); + + size_t td_current = 0; + size_t remain_size = instance->buffer_size; + char *buffer = instance->data_buffer; + while (remain_size > 0) { + const size_t transfer_size = remain_size > OHCI_TD_MAX_TRANSFER + ? OHCI_TD_MAX_TRANSFER : remain_size; + + td_init(data->tds[td_current], instance->ep->direction, + buffer, transfer_size, -1); + td_set_next(data->tds[td_current], data->tds[td_current + 1]); + usb_log_debug("Created DATA TD: %x:%x:%x:%x.\n", + data->tds[td_current]->status, data->tds[td_current]->cbp, + data->tds[td_current]->next, data->tds[td_current]->be); + + buffer += transfer_size; + remain_size -= transfer_size; + assert(td_current < data->td_count); + ++td_current; + } +} +/** + * @} + */ Index: uspace/drv/ohci/batch.h =================================================================== --- uspace/drv/ohci/batch.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/batch.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 USB transaction structure + */ +#ifndef DRV_OHCI_BATCH_H +#define DRV_OHCI_BATCH_H + +#include +#include +#include +#include +#include + +usb_transfer_batch_t * batch_get( + ddf_fun_t *fun, endpoint_t *ep, char *buffer, size_t size, + const 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); + +bool batch_is_complete(usb_transfer_batch_t *instance); + +void batch_commit(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/endpoint_list.c =================================================================== --- uspace/drv/ohci/endpoint_list.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/endpoint_list.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 drvusbohci + * @{ + */ +/** @file + * @brief OHCI driver transfer list implementation + */ +#include +#include +#include + +#include "endpoint_list.h" + +/** 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 ed_t structure. + */ +int endpoint_list_init(endpoint_list_t *instance, const char *name) +{ + assert(instance); + instance->name = name; + instance->list_head = malloc32(sizeof(ed_t)); + if (!instance->list_head) { + usb_log_error("Failed to allocate list head.\n"); + return ENOMEM; + } + instance->list_head_pa = addr_to_phys(instance->list_head); + usb_log_debug2("Transfer list %s setup with ED: %p(0x%0" PRIx32 ")).\n", + name, instance->list_head, instance->list_head_pa); + + ed_init(instance->list_head, NULL); + list_initialize(&instance->endpoint_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. + * + * Does not check whether this replaces an existing list. + */ +void endpoint_list_set_next(endpoint_list_t *instance, endpoint_list_t *next) +{ + assert(instance); + assert(next); + ed_append_ed(instance->list_head, next->list_head); +} +/*----------------------------------------------------------------------------*/ +/** Add endpoint to the list and queue. + * + * @param[in] instance List to use. + * @param[in] endpoint Endpoint to add. + * + * The endpoint is added to the end of the list and queue. + */ +void endpoint_list_add_ep(endpoint_list_t *instance, hcd_endpoint_t *hcd_ep) +{ + assert(instance); + assert(hcd_ep); + usb_log_debug2("Queue %s: Adding endpoint(%p).\n", + instance->name, hcd_ep); + + fibril_mutex_lock(&instance->guard); + + ed_t *last_ed = NULL; + /* Add to the hardware queue. */ + if (list_empty(&instance->endpoint_list)) { + /* There are no active EDs */ + last_ed = instance->list_head; + } else { + /* There are active EDs, get the last one */ + hcd_endpoint_t *last = list_get_instance( + instance->endpoint_list.prev, hcd_endpoint_t, link); + assert(last); + last_ed = last->ed; + } + /* Keep link */ + hcd_ep->ed->next = last_ed->next; + /* Make sure ED is written to the memory */ + write_barrier(); + + /* Add ed to the hw queue */ + ed_append_ed(last_ed, hcd_ep->ed); + /* Make sure ED is updated */ + write_barrier(); + + /* Add to the sw list */ + list_append(&hcd_ep->link, &instance->endpoint_list); + + hcd_endpoint_t *first = list_get_instance( + instance->endpoint_list.next, hcd_endpoint_t, link); + usb_log_debug("HCD EP(%p) added to list %s, first is %p(%p).\n", + hcd_ep, instance->name, first, first->ed); + if (last_ed == instance->list_head) { + usb_log_debug2("%s head ED(%p-0x%0" PRIx32 "): %x:%x:%x:%x.\n", + instance->name, last_ed, instance->list_head_pa, + last_ed->status, last_ed->td_tail, last_ed->td_head, + last_ed->next); + } + fibril_mutex_unlock(&instance->guard); +} +/*----------------------------------------------------------------------------*/ +/** Remove endpoint from the list and queue. + * + * @param[in] instance List to use. + * @param[in] endpoint Endpoint to remove. + */ +void endpoint_list_remove_ep(endpoint_list_t *instance, hcd_endpoint_t *hcd_ep) +{ + assert(instance); + assert(instance->list_head); + assert(hcd_ep); + assert(hcd_ep->ed); + + fibril_mutex_lock(&instance->guard); + + usb_log_debug2( + "Queue %s: removing endpoint(%p).\n", instance->name, hcd_ep); + + const char *qpos = NULL; + ed_t *prev_ed; + /* Remove from the hardware queue */ + if (instance->endpoint_list.next == &hcd_ep->link) { + /* I'm the first one here */ + prev_ed = instance->list_head; + qpos = "FIRST"; + } else { + hcd_endpoint_t *prev = + list_get_instance(hcd_ep->link.prev, hcd_endpoint_t, link); + prev_ed = prev->ed; + qpos = "NOT FIRST"; + } + assert((prev_ed->next & ED_NEXT_PTR_MASK) == addr_to_phys(hcd_ep->ed)); + prev_ed->next = hcd_ep->ed->next; + /* Make sure ED is updated */ + write_barrier(); + + usb_log_debug("HCD EP(%p) removed (%s) from %s, next %x.\n", + hcd_ep, qpos, instance->name, hcd_ep->ed->next); + + /* Remove from the endpoint list */ + list_remove(&hcd_ep->link); + fibril_mutex_unlock(&instance->guard); +} +/** + * @} + */ Index: uspace/drv/ohci/endpoint_list.h =================================================================== --- uspace/drv/ohci/endpoint_list.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/endpoint_list.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,76 @@ +/* + * 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 transfer list structure + */ +#ifndef DRV_OHCI_ENDPOINT_LIST_H +#define DRV_OHCI_ENDPOINT_LIST_H + +#include + +#include "hcd_endpoint.h" +#include "hw_struct/endpoint_descriptor.h" +#include "utils/malloc32.h" + +/** Structure maintains both OHCI queue and software list of active endpoints.*/ +typedef struct endpoint_list { + /** Guard against add/remove races */ + fibril_mutex_t guard; + /** OHCI hw structure at the beginning of the queue */ + ed_t *list_head; + /** Physical address of the first(dummy) ED */ + uint32_t list_head_pa; + /** Assigned name, provides nicer debug output */ + const char *name; + /** Sw list of all active EDs */ + link_t endpoint_list; +} endpoint_list_t; + +/** Dispose transfer list structures. + * + * @param[in] instance Memory place to use. + * + * Frees memory of the internal ed_t structure. + */ +static inline void endpoint_list_fini(endpoint_list_t *instance) +{ + assert(instance); + free32(instance->list_head); +} + +int endpoint_list_init(endpoint_list_t *instance, const char *name); +void endpoint_list_set_next(endpoint_list_t *instance, endpoint_list_t *next); +void endpoint_list_add_ep(endpoint_list_t *instance, hcd_endpoint_t *hcd_ep); +void endpoint_list_remove_ep(endpoint_list_t *instance, hcd_endpoint_t *hcd_ep); +#endif +/** + * @} + */ Index: uspace/drv/ohci/hc.c =================================================================== --- uspace/drv/ohci/hc.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/hc.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,624 @@ +/* + * 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 "hc.h" +#include "hcd_endpoint.h" + +#define OHCI_USED_INTERRUPTS \ + (I_SO | I_WDH | I_UE | I_RHSC) +static int interrupt_emulator(hc_t *instance); +static void hc_gain_control(hc_t *instance); +static int hc_init_transfer_lists(hc_t *instance); +static int hc_init_memory(hc_t *instance); +/*----------------------------------------------------------------------------*/ +/** Announce OHCI root hub to the DDF + * + * @param[in] instance OHCI driver intance + * @param[in] hub_fun DDF fuction representing OHCI root hub + * @return Error code + */ +int hc_register_hub(hc_t *instance, ddf_fun_t *hub_fun) +{ + assert(instance); + assert(hub_fun); + + const usb_address_t hub_address = + device_keeper_get_free_address(&instance->manager, USB_SPEED_FULL); + if (hub_address <= 0) { + usb_log_error("Failed(%d) to get OHCI root hub address.\n", + hub_address); + return hub_address; + } + instance->rh.address = hub_address; + usb_device_keeper_bind( + &instance->manager, hub_address, hub_fun->handle); + +#define CHECK_RET_RELEASE(ret, message...) \ +if (ret != EOK) { \ + usb_log_error(message); \ + hc_remove_endpoint(instance, hub_address, 0, USB_DIRECTION_BOTH); \ + usb_device_keeper_release(&instance->manager, hub_address); \ + return ret; \ +} else (void)0 + + int ret = hc_add_endpoint(instance, hub_address, 0, USB_SPEED_FULL, + USB_TRANSFER_CONTROL, USB_DIRECTION_BOTH, 64, 0, 0); + CHECK_RET_RELEASE(ret, "Failed(%d) to add OHCI rh endpoint 0.\n", ret); + + char *match_str = NULL; + /* DDF needs heap allocated string */ + ret = asprintf(&match_str, "usb&class=hub"); + ret = ret > 0 ? 0 : ret; + CHECK_RET_RELEASE(ret, "Failed(%d) to create match-id string.\n", ret); + + ret = ddf_fun_add_match_id(hub_fun, match_str, 100); + CHECK_RET_RELEASE(ret, "Failed(%d) add root hub match-id.\n", ret); + + ret = ddf_fun_bind(hub_fun); + CHECK_RET_RELEASE(ret, "Failed(%d) to bind root hub function.\n", ret); + + return EOK; +#undef CHECK_RET_RELEASE +} +/*----------------------------------------------------------------------------*/ +/** Initialize OHCI hc driver structure + * + * @param[in] instance Memory place for the structure. + * @param[in] regs Address of the memory mapped I/O registers. + * @param[in] reg_size Size of the memory mapped area. + * @param[in] interrupts True if w interrupts should be used + * @return Error code + */ +int hc_init(hc_t *instance, uintptr_t regs, size_t reg_size, bool interrupts) +{ + assert(instance); + int ret = EOK; +#define CHECK_RET_RETURN(ret, message...) \ +if (ret != EOK) { \ + usb_log_error(message); \ + return ret; \ +} else (void)0 + + ret = pio_enable((void*)regs, reg_size, (void**)&instance->registers); + CHECK_RET_RETURN(ret, + "Failed(%d) to gain access to device registers: %s.\n", + ret, str_error(ret)); + + list_initialize(&instance->pending_batches); + usb_device_keeper_init(&instance->manager); + ret = usb_endpoint_manager_init(&instance->ep_manager, + BANDWIDTH_AVAILABLE_USB11); + CHECK_RET_RETURN(ret, "Failed to initialize endpoint manager: %s.\n", + str_error(ret)); + + ret = hc_init_memory(instance); + CHECK_RET_RETURN(ret, "Failed to create OHCI memory structures: %s.\n", + str_error(ret)); +#undef CHECK_RET_RETURN + + fibril_mutex_initialize(&instance->guard); + hc_gain_control(instance); + + rh_init(&instance->rh, instance->registers); + + if (!interrupts) { + instance->interrupt_emulator = + fibril_create((int(*)(void*))interrupt_emulator, instance); + fibril_add_ready(instance->interrupt_emulator); + } + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Create end register endpoint structures + * + * @param[in] instance OHCI driver structure. + * @param[in] address USB address of the device. + * @param[in] endpoint USB endpoint number. + * @param[in] speed Communication speeed of the device. + * @param[in] type Endpoint's transfer type. + * @param[in] direction Endpoint's direction. + * @param[in] mps Maximum packet size the endpoint accepts. + * @param[in] size Maximum allowed buffer size. + * @param[in] interval Time between transfers(interrupt transfers only). + * @return Error code + */ +int hc_add_endpoint( + hc_t *instance, usb_address_t address, usb_endpoint_t endpoint, + usb_speed_t speed, usb_transfer_type_t type, usb_direction_t direction, + size_t mps, size_t size, unsigned interval) +{ + endpoint_t *ep = malloc(sizeof(endpoint_t)); + if (ep == NULL) + return ENOMEM; + int ret = + endpoint_init(ep, address, endpoint, direction, type, speed, mps); + if (ret != EOK) { + free(ep); + return ret; + } + + hcd_endpoint_t *hcd_ep = hcd_endpoint_assign(ep); + if (hcd_ep == NULL) { + endpoint_destroy(ep); + return ENOMEM; + } + + ret = usb_endpoint_manager_register_ep(&instance->ep_manager, ep, size); + if (ret != EOK) { + hcd_endpoint_clear(ep); + endpoint_destroy(ep); + return ret; + } + + /* Enqueue hcd_ep */ + switch (ep->transfer_type) { + case USB_TRANSFER_CONTROL: + instance->registers->control &= ~C_CLE; + endpoint_list_add_ep( + &instance->lists[ep->transfer_type], hcd_ep); + instance->registers->control_current = 0; + instance->registers->control |= C_CLE; + break; + case USB_TRANSFER_BULK: + instance->registers->control &= ~C_BLE; + endpoint_list_add_ep( + &instance->lists[ep->transfer_type], hcd_ep); + instance->registers->control |= C_BLE; + break; + case USB_TRANSFER_ISOCHRONOUS: + case USB_TRANSFER_INTERRUPT: + instance->registers->control &= (~C_PLE & ~C_IE); + endpoint_list_add_ep( + &instance->lists[ep->transfer_type], hcd_ep); + instance->registers->control |= C_PLE | C_IE; + break; + default: + break; + } + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Dequeue and delete endpoint structures + * + * @param[in] instance OHCI hc driver structure. + * @param[in] address USB address of the device. + * @param[in] endpoint USB endpoint number. + * @param[in] direction Direction of the endpoint. + * @return Error code + */ +int hc_remove_endpoint(hc_t *instance, usb_address_t address, + usb_endpoint_t endpoint, usb_direction_t direction) +{ + assert(instance); + fibril_mutex_lock(&instance->guard); + endpoint_t *ep = usb_endpoint_manager_get_ep(&instance->ep_manager, + address, endpoint, direction, NULL); + if (ep == NULL) { + usb_log_error("Endpoint unregister failed: No such EP.\n"); + fibril_mutex_unlock(&instance->guard); + return ENOENT; + } + + hcd_endpoint_t *hcd_ep = hcd_endpoint_get(ep); + if (hcd_ep) { + /* Dequeue hcd_ep */ + switch (ep->transfer_type) { + case USB_TRANSFER_CONTROL: + instance->registers->control &= ~C_CLE; + endpoint_list_remove_ep( + &instance->lists[ep->transfer_type], hcd_ep); + instance->registers->control_current = 0; + instance->registers->control |= C_CLE; + break; + case USB_TRANSFER_BULK: + instance->registers->control &= ~C_BLE; + endpoint_list_remove_ep( + &instance->lists[ep->transfer_type], hcd_ep); + instance->registers->control |= C_BLE; + break; + case USB_TRANSFER_ISOCHRONOUS: + case USB_TRANSFER_INTERRUPT: + instance->registers->control &= (~C_PLE & ~C_IE); + endpoint_list_remove_ep( + &instance->lists[ep->transfer_type], hcd_ep); + instance->registers->control |= C_PLE | C_IE; + break; + default: + break; + } + hcd_endpoint_clear(ep); + } else { + usb_log_warning("Endpoint without hcd equivalent structure.\n"); + } + int ret = usb_endpoint_manager_unregister_ep(&instance->ep_manager, + address, endpoint, direction); + fibril_mutex_unlock(&instance->guard); + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Get access to endpoint structures + * + * @param[in] instance OHCI hc driver structure. + * @param[in] address USB address of the device. + * @param[in] endpoint USB endpoint number. + * @param[in] direction Direction of the endpoint. + * @param[out] bw Reserved bandwidth. + * @return Error code + */ +endpoint_t * hc_get_endpoint(hc_t *instance, usb_address_t address, + usb_endpoint_t endpoint, usb_direction_t direction, size_t *bw) +{ + assert(instance); + fibril_mutex_lock(&instance->guard); + endpoint_t *ep = usb_endpoint_manager_get_ep(&instance->ep_manager, + address, endpoint, direction, bw); + fibril_mutex_unlock(&instance->guard); + return ep; +} +/*----------------------------------------------------------------------------*/ +/** Add USB transfer to the schedule. + * + * @param[in] instance OHCI hc driver structure. + * @param[in] batch Batch representing the transfer. + * @return Error code. + */ +int hc_schedule(hc_t *instance, usb_transfer_batch_t *batch) +{ + assert(instance); + assert(batch); + assert(batch->ep); + + /* Check for root hub communication */ + if (batch->ep->address == instance->rh.address) { + return rh_request(&instance->rh, batch); + } + + fibril_mutex_lock(&instance->guard); + list_append(&batch->link, &instance->pending_batches); + batch_commit(batch); + + /* Control and bulk schedules need a kick to start working */ + switch (batch->ep->transfer_type) + { + case USB_TRANSFER_CONTROL: + instance->registers->command_status |= CS_CLF; + break; + case USB_TRANSFER_BULK: + instance->registers->command_status |= CS_BLF; + break; + default: + break; + } + fibril_mutex_unlock(&instance->guard); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Interrupt handling routine + * + * @param[in] instance OHCI hc driver structure. + * @param[in] status Value of the status register at the time of interrupt. + */ +void hc_interrupt(hc_t *instance, uint32_t status) +{ + assert(instance); + if ((status & ~I_SF) == 0) /* ignore sof status */ + return; + usb_log_debug2("OHCI(%p) interrupt: %x.\n", instance, status); + if (status & I_RHSC) + rh_interrupt(&instance->rh); + + if (status & I_WDH) { + fibril_mutex_lock(&instance->guard); + usb_log_debug2("HCCA: %p-%#" PRIx32 " (%p).\n", instance->hcca, + instance->registers->hcca, + (void *) addr_to_phys(instance->hcca)); + usb_log_debug2("Periodic current: %#" PRIx32 ".\n", + instance->registers->periodic_current); + + link_t *current = instance->pending_batches.next; + while (current != &instance->pending_batches) { + link_t *next = current->next; + usb_transfer_batch_t *batch = + usb_transfer_batch_from_link(current); + + if (batch_is_complete(batch)) { + list_remove(current); + usb_transfer_batch_finish(batch); + } + current = next; + } + fibril_mutex_unlock(&instance->guard); + } + + if (status & I_UE) { + hc_start_hw(instance); + } + +} +/*----------------------------------------------------------------------------*/ +/** Check status register regularly + * + * @param[in] instance OHCI hc driver structure. + * @return Error code + */ +int interrupt_emulator(hc_t *instance) +{ + assert(instance); + usb_log_info("Started interrupt emulator.\n"); + while (1) { + const uint32_t status = instance->registers->interrupt_status; + instance->registers->interrupt_status = status; + hc_interrupt(instance, status); + async_usleep(10000); + } + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Turn off any (BIOS)driver that might be in control of the device. + * + * @param[in] instance OHCI hc driver structure. + */ +void hc_gain_control(hc_t *instance) +{ + assert(instance); + usb_log_debug("Requesting OHCI control.\n"); + /* Turn off legacy emulation */ + volatile uint32_t *ohci_emulation_reg = + (uint32_t*)((char*)instance->registers + 0x100); + usb_log_debug("OHCI legacy register %p: %x.\n", + ohci_emulation_reg, *ohci_emulation_reg); + /* Do not change A20 state */ + *ohci_emulation_reg &= 0x100; + usb_log_debug("OHCI legacy register %p: %x.\n", + ohci_emulation_reg, *ohci_emulation_reg); + + /* Interrupt routing enabled => smm driver is active */ + if (instance->registers->control & C_IR) { + usb_log_debug("SMM driver: request ownership change.\n"); + instance->registers->command_status |= CS_OCR; + while (instance->registers->control & C_IR) { + async_usleep(1000); + } + usb_log_info("SMM driver: Ownership taken.\n"); + instance->registers->control &= (C_HCFS_RESET << C_HCFS_SHIFT); + async_usleep(50000); + return; + } + + const unsigned hc_status = + (instance->registers->control >> C_HCFS_SHIFT) & C_HCFS_MASK; + /* Interrupt routing disabled && status != USB_RESET => BIOS active */ + if (hc_status != C_HCFS_RESET) { + usb_log_debug("BIOS driver found.\n"); + if (hc_status == C_HCFS_OPERATIONAL) { + usb_log_info("BIOS driver: HC operational.\n"); + return; + } + /* HC is suspended assert resume for 20ms */ + instance->registers->control &= (C_HCFS_RESUME << C_HCFS_SHIFT); + async_usleep(20000); + usb_log_info("BIOS driver: HC resumed.\n"); + return; + } + + /* HC is in reset (hw startup) => no other driver + * maintain reset for at least the time specified in USB spec (50 ms)*/ + usb_log_info("HC found in reset.\n"); + async_usleep(50000); +} +/*----------------------------------------------------------------------------*/ +/** OHCI hw initialization routine. + * + * @param[in] instance OHCI hc driver structure. + */ +void hc_start_hw(hc_t *instance) +{ + /* OHCI guide page 42 */ + assert(instance); + usb_log_debug2("Started hc initialization routine.\n"); + + /* Save contents of fm_interval register */ + const uint32_t fm_interval = instance->registers->fm_interval; + usb_log_debug2("Old value of HcFmInterval: %x.\n", fm_interval); + + /* Reset hc */ + usb_log_debug2("HC reset.\n"); + size_t time = 0; + instance->registers->command_status = CS_HCR; + while (instance->registers->command_status & CS_HCR) { + async_usleep(10); + time += 10; + } + usb_log_debug2("HC reset complete in %zu us.\n", time); + + /* Restore fm_interval */ + instance->registers->fm_interval = fm_interval; + assert((instance->registers->command_status & CS_HCR) == 0); + + /* hc is now in suspend state */ + usb_log_debug2("HC should be in suspend state(%x).\n", + instance->registers->control); + + /* Use HCCA */ + instance->registers->hcca = addr_to_phys(instance->hcca); + + /* Use queues */ + instance->registers->bulk_head = + instance->lists[USB_TRANSFER_BULK].list_head_pa; + usb_log_debug2("Bulk HEAD set to: %p (%#" PRIx32 ").\n", + instance->lists[USB_TRANSFER_BULK].list_head, + instance->lists[USB_TRANSFER_BULK].list_head_pa); + + instance->registers->control_head = + instance->lists[USB_TRANSFER_CONTROL].list_head_pa; + usb_log_debug2("Control HEAD set to: %p (%#" PRIx32 ").\n", + instance->lists[USB_TRANSFER_CONTROL].list_head, + instance->lists[USB_TRANSFER_CONTROL].list_head_pa); + + /* Enable queues */ + instance->registers->control |= (C_PLE | C_IE | C_CLE | C_BLE); + usb_log_debug2("All queues enabled(%x).\n", + instance->registers->control); + + /* Enable interrupts */ + instance->registers->interrupt_enable = OHCI_USED_INTERRUPTS; + usb_log_debug2("Enabled interrupts: %x.\n", + instance->registers->interrupt_enable); + instance->registers->interrupt_enable = I_MI; + + /* Set periodic start to 90% */ + uint32_t frame_length = ((fm_interval >> FMI_FI_SHIFT) & FMI_FI_MASK); + instance->registers->periodic_start = (frame_length / 10) * 9; + usb_log_debug2("All periodic start set to: %x(%u - 90%% of %d).\n", + instance->registers->periodic_start, + instance->registers->periodic_start, frame_length); + + instance->registers->control &= (C_HCFS_OPERATIONAL << C_HCFS_SHIFT); + usb_log_info("OHCI HC up and running(%x).\n", + instance->registers->control); +} +/*----------------------------------------------------------------------------*/ +/** Initialize schedule queues + * + * @param[in] instance OHCI hc driver structure + * @return Error code + */ +int hc_init_transfer_lists(hc_t *instance) +{ + assert(instance); +#define SETUP_ENDPOINT_LIST(type) \ +do { \ + const char *name = usb_str_transfer_type(type); \ + int ret = endpoint_list_init(&instance->lists[type], name); \ + if (ret != EOK) { \ + usb_log_error("Failed(%d) to setup %s endpoint list.\n", \ + ret, name); \ + endpoint_list_fini(&instance->lists[USB_TRANSFER_ISOCHRONOUS]);\ + endpoint_list_fini(&instance->lists[USB_TRANSFER_INTERRUPT]); \ + endpoint_list_fini(&instance->lists[USB_TRANSFER_CONTROL]); \ + endpoint_list_fini(&instance->lists[USB_TRANSFER_BULK]); \ + return ret; \ + } \ +} while (0) + + SETUP_ENDPOINT_LIST(USB_TRANSFER_ISOCHRONOUS); + SETUP_ENDPOINT_LIST(USB_TRANSFER_INTERRUPT); + SETUP_ENDPOINT_LIST(USB_TRANSFER_CONTROL); + SETUP_ENDPOINT_LIST(USB_TRANSFER_BULK); +#undef SETUP_ENDPOINT_LIST + endpoint_list_set_next(&instance->lists[USB_TRANSFER_INTERRUPT], + &instance->lists[USB_TRANSFER_ISOCHRONOUS]); + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Initialize memory structures used by the OHCI hcd. + * + * @param[in] instance OHCI hc driver structure. + * @return Error code. + */ +int hc_init_memory(hc_t *instance) +{ + assert(instance); + + bzero(&instance->rh, sizeof(instance->rh)); + /* Init queues */ + const int ret = hc_init_transfer_lists(instance); + if (ret != EOK) { + return ret; + } + + /*Init HCCA */ + instance->hcca = malloc32(sizeof(hcca_t)); + if (instance->hcca == NULL) + return ENOMEM; + bzero(instance->hcca, sizeof(hcca_t)); + usb_log_debug2("OHCI HCCA initialized at %p.\n", instance->hcca); + + unsigned i = 0; + for (; i < 32; ++i) { + instance->hcca->int_ep[i] = + instance->lists[USB_TRANSFER_INTERRUPT].list_head_pa; + } + usb_log_debug2("Interrupt HEADs set to: %p (%#" PRIx32 ").\n", + instance->lists[USB_TRANSFER_INTERRUPT].list_head, + instance->lists[USB_TRANSFER_INTERRUPT].list_head_pa); + + /* Init interrupt code */ + instance->interrupt_code.cmds = instance->interrupt_commands; + instance->interrupt_code.cmdcount = OHCI_NEEDED_IRQ_COMMANDS; + { + /* Read status register */ + instance->interrupt_commands[0].cmd = CMD_MEM_READ_32; + instance->interrupt_commands[0].dstarg = 1; + instance->interrupt_commands[0].addr = + (void*)&instance->registers->interrupt_status; + + /* Test whether we are the interrupt cause */ + instance->interrupt_commands[1].cmd = CMD_BTEST; + instance->interrupt_commands[1].value = + OHCI_USED_INTERRUPTS; + instance->interrupt_commands[1].srcarg = 1; + instance->interrupt_commands[1].dstarg = 2; + + /* Predicate cleaning and accepting */ + instance->interrupt_commands[2].cmd = CMD_PREDICATE; + instance->interrupt_commands[2].value = 2; + instance->interrupt_commands[2].srcarg = 2; + + /* Write-clean status register */ + instance->interrupt_commands[3].cmd = CMD_MEM_WRITE_A_32; + instance->interrupt_commands[3].srcarg = 1; + instance->interrupt_commands[3].addr = + (void*)&instance->registers->interrupt_status; + + /* Accept interrupt */ + instance->interrupt_commands[4].cmd = CMD_ACCEPT; + } + + return EOK; +} +/** + * @} + */ Index: uspace/drv/ohci/hc.h =================================================================== --- uspace/drv/ohci/hc.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/hc.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,120 @@ +/* + * 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 + +#include "batch.h" +#include "ohci_regs.h" +#include "root_hub.h" +#include "endpoint_list.h" +#include "hw_struct/hcca.h" + +#define OHCI_NEEDED_IRQ_COMMANDS 5 + +/** Main OHCI drier structure */ +typedef struct hc { + /** USB bus driver, devices and addresses */ + usb_device_keeper_t manager; + /** USB bus driver, endpoints */ + usb_endpoint_manager_t ep_manager; + + /** Memory mapped I/O registers area */ + ohci_regs_t *registers; + /** Host controller communication area structure */ + hcca_t *hcca; + + /** Transfer schedules */ + endpoint_list_t lists[4]; + /** List of active transfers */ + link_t pending_batches; + + /** Fibril for periodic checks if interrupts can't be used */ + fid_t interrupt_emulator; + + /** Guards schedule and endpoint manipulation */ + fibril_mutex_t guard; + + /** Code to be executed in kernel interrupt handler */ + irq_code_t interrupt_code; + + /** Commands that form interrupt code */ + irq_cmd_t interrupt_commands[OHCI_NEEDED_IRQ_COMMANDS]; + + /** USB hub emulation structure */ + rh_t rh; +} hc_t; + +int hc_register_hub(hc_t *instance, ddf_fun_t *hub_fun); +int hc_init(hc_t *instance, uintptr_t regs, size_t reg_size, bool interrupts); +void hc_start_hw(hc_t *instance); + +/** Safely dispose host controller internal structures + * + * @param[in] instance Host controller structure to use. + */ +static inline void hc_fini(hc_t *instance) + { /* TODO: implement*/ }; + +int hc_add_endpoint(hc_t *instance, usb_address_t address, usb_endpoint_t ep, + usb_speed_t speed, usb_transfer_type_t type, usb_direction_t direction, + size_t max_packet_size, size_t size, unsigned interval); +int hc_remove_endpoint(hc_t *instance, usb_address_t address, + usb_endpoint_t endpoint, usb_direction_t direction); +endpoint_t * hc_get_endpoint(hc_t *instance, usb_address_t address, + usb_endpoint_t endpoint, usb_direction_t direction, size_t *bw); + +int hc_schedule(hc_t *instance, usb_transfer_batch_t *batch); +void hc_interrupt(hc_t *instance, uint32_t status); + +/** 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 fun->driver_data; } +#endif +/** + * @} + */ Index: uspace/drv/ohci/hcd_endpoint.c =================================================================== --- uspace/drv/ohci/hcd_endpoint.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/hcd_endpoint.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,110 @@ +/* + * 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 "utils/malloc32.h" +#include "hcd_endpoint.h" + +/** Callback to set toggle on ED. + * + * @param[in] hcd_ep hcd endpoint structure + * @param[in] toggle new value of toggle bit + */ +static void hcd_ep_toggle_set(void *hcd_ep, int toggle) +{ + hcd_endpoint_t *instance = hcd_ep; + assert(instance); + assert(instance->ed); + ed_toggle_set(instance->ed, toggle); +} +/*----------------------------------------------------------------------------*/ +/** Callback to get value of toggle bit. + * + * @param[in] hcd_ep hcd endpoint structure + * @return Current value of toggle bit. + */ +static int hcd_ep_toggle_get(void *hcd_ep) +{ + hcd_endpoint_t *instance = hcd_ep; + assert(instance); + assert(instance->ed); + return ed_toggle_get(instance->ed); +} +/*----------------------------------------------------------------------------*/ +/** Creates new hcd endpoint representation. + * + * @param[in] ep USBD endpoint structure + * @return pointer to a new hcd endpoint structure, NULL on failure. + */ +hcd_endpoint_t * hcd_endpoint_assign(endpoint_t *ep) +{ + assert(ep); + hcd_endpoint_t *hcd_ep = malloc(sizeof(hcd_endpoint_t)); + if (hcd_ep == NULL) + return NULL; + + hcd_ep->ed = malloc32(sizeof(ed_t)); + if (hcd_ep->ed == NULL) { + free(hcd_ep); + return NULL; + } + + hcd_ep->td = malloc32(sizeof(td_t)); + if (hcd_ep->td == NULL) { + free32(hcd_ep->ed); + free(hcd_ep); + return NULL; + } + + ed_init(hcd_ep->ed, ep); + ed_set_td(hcd_ep->ed, hcd_ep->td); + endpoint_set_hc_data(ep, hcd_ep, hcd_ep_toggle_get, hcd_ep_toggle_set); + + return hcd_ep; +} +/*----------------------------------------------------------------------------*/ +/** Disposes assigned hcd endpoint structure + * + * @param[in] ep USBD endpoint structure + */ +void hcd_endpoint_clear(endpoint_t *ep) +{ + assert(ep); + hcd_endpoint_t *hcd_ep = ep->hc_data.data; + assert(hcd_ep); + free32(hcd_ep->ed); + free32(hcd_ep->td); + free(hcd_ep); +} +/** + * @} + */ Index: uspace/drv/ohci/hcd_endpoint.h =================================================================== --- uspace/drv/ohci/hcd_endpoint.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/hcd_endpoint.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,70 @@ +/* + * 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_HCD_ENDPOINT_H +#define DRV_OHCI_HCD_ENDPOINT_H + +#include +#include +#include + +#include "hw_struct/endpoint_descriptor.h" +#include "hw_struct/transfer_descriptor.h" + +/** Connector structure linking ED to to prepared TD. */ +typedef struct hcd_endpoint { + /** OHCI endpoint descriptor */ + ed_t *ed; + /** Currently enqueued transfer descriptor */ + td_t *td; + /** Linked list used by driver software */ + link_t link; +} hcd_endpoint_t; + +hcd_endpoint_t * hcd_endpoint_assign(endpoint_t *ep); +void hcd_endpoint_clear(endpoint_t *ep); + +/** Get and convert assigned hcd_endpoint_t structure + * @param[in] ep USBD endpoint structure. + * @return Pointer to assigned hcd endpoint structure + */ +static inline hcd_endpoint_t * hcd_endpoint_get(endpoint_t *ep) +{ + assert(ep); + return ep->hc_data.data; +} + +#endif +/** + * @} + */ Index: uspace/drv/ohci/hw_struct/completion_codes.h =================================================================== --- uspace/drv/ohci/hw_struct/completion_codes.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/hw_struct/completion_codes.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,91 @@ +/* + * 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_HW_STRUCT_COMPLETION_CODES_H +#define DRV_OHCI_HW_STRUCT_COMPLETION_CODES_H + +#include + +#define CC_NOERROR (0x0) +#define CC_CRC (0x1) +#define CC_BITSTUFF (0x2) +#define CC_TOGGLE (0x3) +#define CC_STALL (0x4) +#define CC_NORESPONSE (0x5) +#define CC_PIDFAIL (0x6) +#define CC_PIDUNEXPECTED (0x7) +#define CC_DATAOVERRRUN (0x8) +#define CC_DATAUNDERRRUN (0x9) +#define CC_BUFFEROVERRRUN (0xc) +#define CC_BUFFERUNDERRUN (0xd) +#define CC_NOACCESS1 (0xe) +#define CC_NOACCESS2 (0xf) + +inline static int cc_to_rc(int cc) +{ + switch (cc) { + case CC_NOERROR: + return EOK; + + case CC_CRC: + return EBADCHECKSUM; + + case CC_PIDUNEXPECTED: + case CC_PIDFAIL: + case CC_BITSTUFF: + return EIO; + + case CC_TOGGLE: + case CC_STALL: + return ESTALL; + + case CC_NORESPONSE: + return ETIMEOUT; + + case CC_DATAOVERRRUN: + case CC_DATAUNDERRRUN: + case CC_BUFFEROVERRRUN: + case CC_BUFFERUNDERRUN: + return EOVERFLOW; + + case CC_NOACCESS1: + case CC_NOACCESS2: + default: + return ENOTSUP; + } +} + +#endif +/** + * @} + */ Index: uspace/drv/ohci/hw_struct/endpoint_descriptor.c =================================================================== --- uspace/drv/ohci/hw_struct/endpoint_descriptor.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/hw_struct/endpoint_descriptor.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,66 @@ +/* + * 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 "endpoint_descriptor.h" + +static unsigned direc[3] = + { ED_STATUS_D_IN, ED_STATUS_D_OUT, ED_STATUS_D_TRANSFER }; + +void ed_init(ed_t *instance, endpoint_t *ep) +{ + assert(instance); + bzero(instance, sizeof(ed_t)); + if (ep == NULL) { + instance->status = ED_STATUS_K_FLAG; + return; + } + assert(ep); + instance->status = 0 + | ((ep->address & ED_STATUS_FA_MASK) << ED_STATUS_FA_SHIFT) + | ((ep->endpoint & ED_STATUS_EN_MASK) << ED_STATUS_EN_SHIFT) + | ((direc[ep->direction] & ED_STATUS_D_MASK) << ED_STATUS_D_SHIFT) + | ((ep->max_packet_size & ED_STATUS_MPS_MASK) + << ED_STATUS_MPS_SHIFT); + + + if (ep->speed == USB_SPEED_LOW) + instance->status |= ED_STATUS_S_FLAG; + if (ep->transfer_type == USB_TRANSFER_ISOCHRONOUS) + instance->status |= ED_STATUS_F_FLAG; + + if (ep->toggle) + instance->td_head |= ED_TDHEAD_TOGGLE_CARRY; +} +/** + * @} + */ Index: uspace/drv/ohci/hw_struct/endpoint_descriptor.h =================================================================== --- uspace/drv/ohci/hw_struct/endpoint_descriptor.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/hw_struct/endpoint_descriptor.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 drvusbohci + * @{ + */ +/** @file + * @brief OHCI driver + */ +#ifndef DRV_OHCI_HW_STRUCT_ENDPOINT_DESCRIPTOR_H +#define DRV_OHCI_HW_STRUCT_ENDPOINT_DESCRIPTOR_H + +#include +#include + +#include + +#include "../utils/malloc32.h" +#include "transfer_descriptor.h" + +#include "completion_codes.h" + +typedef struct ed { + volatile uint32_t status; +#define ED_STATUS_FA_MASK (0x7f) /* USB device address */ +#define ED_STATUS_FA_SHIFT (0) +#define ED_STATUS_EN_MASK (0xf) /* USB endpoint address */ +#define ED_STATUS_EN_SHIFT (7) +#define ED_STATUS_D_MASK (0x3) /* direction */ +#define ED_STATUS_D_SHIFT (11) +#define ED_STATUS_D_OUT (0x1) +#define ED_STATUS_D_IN (0x2) +#define ED_STATUS_D_TRANSFER (0x3) + +#define ED_STATUS_S_FLAG (1 << 13) /* speed flag: 1 = low */ +#define ED_STATUS_K_FLAG (1 << 14) /* skip flag (no not execute this ED) */ +#define ED_STATUS_F_FLAG (1 << 15) /* format: 1 = isochronous*/ +#define ED_STATUS_MPS_MASK (0x3ff) /* max_packet_size*/ +#define ED_STATUS_MPS_SHIFT (16) + + volatile uint32_t td_tail; +#define ED_TDTAIL_PTR_MASK (0xfffffff0) +#define ED_TDTAIL_PTR_SHIFT (0) + + volatile uint32_t td_head; +#define ED_TDHEAD_PTR_MASK (0xfffffff0) +#define ED_TDHEAD_PTR_SHIFT (0) +#define ED_TDHEAD_ZERO_MASK (0x3) +#define ED_TDHEAD_ZERO_SHIFT (2) +#define ED_TDHEAD_TOGGLE_CARRY (0x2) +#define ED_TDHEAD_HALTED_FLAG (0x1) + + volatile uint32_t next; +#define ED_NEXT_PTR_MASK (0xfffffff0) +#define ED_NEXT_PTR_SHIFT (0) +} __attribute__((packed)) ed_t; + +void ed_init(ed_t *instance, endpoint_t *ep); + +static inline void ed_set_td(ed_t *instance, td_t *td) +{ + assert(instance); + uintptr_t pa = addr_to_phys(td); + instance->td_head = + ((pa & ED_TDHEAD_PTR_MASK) + | (instance->td_head & ~ED_TDHEAD_PTR_MASK)); + instance->td_tail = pa & ED_TDTAIL_PTR_MASK; +} + +static inline void ed_set_end_td(ed_t *instance, td_t *td) +{ + assert(instance); + uintptr_t pa = addr_to_phys(td); + instance->td_tail = pa & ED_TDTAIL_PTR_MASK; +} + +static inline void ed_append_ed(ed_t *instance, ed_t *next) +{ + assert(instance); + assert(next); + uint32_t pa = addr_to_phys(next); + assert((pa & ED_NEXT_PTR_MASK) << ED_NEXT_PTR_SHIFT == pa); + instance->next = pa; +} + +static inline int ed_toggle_get(ed_t *instance) +{ + assert(instance); + return (instance->td_head & ED_TDHEAD_TOGGLE_CARRY) ? 1 : 0; +} + +static inline void ed_toggle_set(ed_t *instance, int toggle) +{ + assert(instance); + assert(toggle == 0 || toggle == 1); + if (toggle == 1) { + instance->td_head |= ED_TDHEAD_TOGGLE_CARRY; + } else { + /* clear halted flag when reseting toggle */ + instance->td_head &= ~ED_TDHEAD_TOGGLE_CARRY; + instance->td_head &= ~ED_TDHEAD_HALTED_FLAG; + } +} +#endif +/** + * @} + */ Index: uspace/drv/ohci/hw_struct/hcca.h =================================================================== --- uspace/drv/ohci/hw_struct/hcca.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/hw_struct/hcca.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,54 @@ +/* + * 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_HW_STRUCT_HCCA_H +#define DRV_OHCI_HW_STRUCT_HCCA_H + +#include + +/** Host controller communication area. + * Shared memory used for communication between the controller and the driver. + */ +typedef struct hcca { + uint32_t int_ep[32]; + uint16_t frame_number; + uint16_t pad1; + uint32_t done_head; + uint32_t reserved[29]; +} __attribute__((packed, aligned)) hcca_t; + +#endif +/** + * @} + */ + Index: uspace/drv/ohci/hw_struct/iso_transfer_descriptor.h =================================================================== --- uspace/drv/ohci/hw_struct/iso_transfer_descriptor.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/hw_struct/iso_transfer_descriptor.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 + */ +#ifndef DRV_OHCI_HW_STRUCT_ISO_TRANSFER_DESCRIPTOR_H +#define DRV_OHCI_HW_STRUCT_ISO_TRANSFER_DESCRIPTOR_H + +#include + +#include "completion_codes.h" + +typedef struct itd { + volatile uint32_t status; +#define ITD_STATUS_SF_MASK (0xffff) /* starting frame */ +#define ITD_STATUS_SF_SHIFT (0) +#define ITD_STATUS_DI_MASK (0x7) /* delay int, wait DI frames before int */ +#define ITD_STATUS_DI_SHIFT (21) +#define ITD_STATUS_DI_NO_INTERRUPT (0x7) +#define ITD_STATUS_FC_MASK (0x7) /* frame count */ +#define ITD_STATUS_FC_SHIFT (24) +#define ITD_STATUS_CC_MASK (0xf) /* condition code */ +#define ITD_STATUS_CC_SHIFT (28) + + volatile uint32_t page; /* page number of the first byte in buffer */ +#define ITD_PAGE_BP0_MASK (0xfffff000) +#define ITD_PAGE_BP0_SHIFT (0) + + volatile uint32_t next; +#define ITD_NEXT_PTR_MASK (0xfffffff0) +#define ITD_NEXT_PTR_SHIFT (0) + + volatile uint32_t be; /* buffer end, address of the last byte */ + + volatile uint16_t offset[8]; +#define ITD_OFFSET_SIZE_MASK (0x3ff) +#define ITD_OFFSET_SIZE_SHIFT (0) +#define ITD_OFFSET_CC_MASK (0xf) +#define ITD_OFFSET_CC_SHIFT (12) + +} __attribute__((packed)) itd_t; +#endif +/** + * @} + */ + + Index: uspace/drv/ohci/hw_struct/transfer_descriptor.c =================================================================== --- uspace/drv/ohci/hw_struct/transfer_descriptor.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/hw_struct/transfer_descriptor.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,64 @@ +/* + * 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 "transfer_descriptor.h" + +static unsigned dp[3] = + { TD_STATUS_DP_IN, TD_STATUS_DP_OUT, TD_STATUS_DP_SETUP }; +static unsigned togg[2] = { TD_STATUS_T_0, TD_STATUS_T_1 }; + +void td_init( + td_t *instance, usb_direction_t dir, void *buffer, size_t size, int toggle) +{ + assert(instance); + bzero(instance, sizeof(td_t)); + instance->status = 0 + | ((dp[dir] & TD_STATUS_DP_MASK) << TD_STATUS_DP_SHIFT) + | ((CC_NOACCESS2 & TD_STATUS_CC_MASK) << TD_STATUS_CC_SHIFT); + if (toggle == 0 || toggle == 1) { + instance->status |= togg[toggle] << TD_STATUS_T_SHIFT; + } + if (dir == USB_DIRECTION_IN) { + instance->status |= TD_STATUS_ROUND_FLAG; + } + if (buffer != NULL) { + assert(size != 0); + instance->cbp = addr_to_phys(buffer); + instance->be = addr_to_phys(buffer + size - 1); + } +} +/** + * @} + */ + Index: uspace/drv/ohci/hw_struct/transfer_descriptor.h =================================================================== --- uspace/drv/ohci/hw_struct/transfer_descriptor.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/hw_struct/transfer_descriptor.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,118 @@ +/* + * 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_HW_STRUCT_TRANSFER_DESCRIPTOR_H +#define DRV_OHCI_HW_STRUCT_TRANSFER_DESCRIPTOR_H + +#include +#include +#include "../utils/malloc32.h" + +#include "completion_codes.h" + +/* OHCI TDs can handle up to 8KB buffers, however, it can use max 2 pages. + * Using 4KB buffers guarantees the page count condition. + * (OHCI assumes 4KB pages) */ +#define OHCI_TD_MAX_TRANSFER (4 * 1024) + +typedef struct td { + volatile uint32_t status; +#define TD_STATUS_ROUND_FLAG (1 << 18) +#define TD_STATUS_DP_MASK (0x3) /* direction/PID */ +#define TD_STATUS_DP_SHIFT (19) +#define TD_STATUS_DP_SETUP (0x0) +#define TD_STATUS_DP_OUT (0x1) +#define TD_STATUS_DP_IN (0x2) +#define TD_STATUS_DI_MASK (0x7) /* delay interrupt, wait DI frames before int */ +#define TD_STATUS_DI_SHIFT (21) +#define TD_STATUS_DI_NO_INTERRUPT (0x7) +#define TD_STATUS_T_MASK (0x3) /* data toggle 1x = use ED toggle carry */ +#define TD_STATUS_T_SHIFT (24) +#define TD_STATUS_T_0 (0x2) +#define TD_STATUS_T_1 (0x3) +#define TD_STATUS_T_ED (0) +#define TD_STATUS_EC_MASK (0x3) /* error count */ +#define TD_STATUS_EC_SHIFT (26) +#define TD_STATUS_CC_MASK (0xf) /* condition code */ +#define TD_STATUS_CC_SHIFT (28) + + volatile uint32_t cbp; /* current buffer ptr, data to be transfered */ + volatile uint32_t next; +#define TD_NEXT_PTR_MASK (0xfffffff0) +#define TD_NEXT_PTR_SHIFT (0) + + volatile uint32_t be; /* buffer end, address of the last byte */ +} __attribute__((packed)) td_t; + +void td_init( + td_t *instance, usb_direction_t dir, void *buffer, size_t size, int toggle); + +inline static void td_set_next(td_t *instance, td_t *next) +{ + assert(instance); + instance->next = addr_to_phys(next) & TD_NEXT_PTR_MASK; +} + +inline static bool td_is_finished(td_t *instance) +{ + assert(instance); + int cc = (instance->status >> TD_STATUS_CC_SHIFT) & TD_STATUS_CC_MASK; + /* something went wrong, error code is set */ + if (cc != CC_NOACCESS1 && cc != CC_NOACCESS2) { + return true; + } + /* everything done */ + if (cc == CC_NOERROR && instance->cbp == 0) { + return true; + } + return false; +} + +static inline int td_error(td_t *instance) +{ + assert(instance); + int cc = (instance->status >> TD_STATUS_CC_SHIFT) & TD_STATUS_CC_MASK; + return cc_to_rc(cc); +} + +static inline size_t td_remain_size(td_t *instance) +{ + assert(instance); + if (instance->cbp == 0) + return 0; + return instance->be - instance->cbp + 1; +} +#endif +/** + * @} + */ Index: uspace/drv/ohci/iface.c =================================================================== --- uspace/drv/ohci/iface.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/iface.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,441 @@ +/* + * 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 drvusbohci + * @{ + */ +/** @file + * @brief OHCI driver hc interface implementation + */ +#include +#include + +#include +#include + +#include "iface.h" +#include "hc.h" + +static inline int setup_batch( + ddf_fun_t *fun, usb_target_t target, usb_direction_t direction, + void *data, size_t size, void * setup_data, size_t setup_size, + usbhc_iface_transfer_in_callback_t in, + usbhc_iface_transfer_out_callback_t out, void *arg, const char* name, + hc_t **hc, usb_transfer_batch_t **batch) +{ + assert(hc); + assert(batch); + assert(fun); + *hc = fun_to_hc(fun); + assert(*hc); + + size_t res_bw; + endpoint_t *ep = hc_get_endpoint(*hc, + target.address, target.endpoint, direction, &res_bw); + if (ep == NULL) { + usb_log_error("Endpoint(%d:%d) not registered for %s.\n", + target.address, target.endpoint, name); + return ENOENT; + } + + usb_log_debug("%s %d:%d %zu(%zu).\n", + name, target.address, target.endpoint, size, ep->max_packet_size); + + const size_t bw = bandwidth_count_usb11( + ep->speed, ep->transfer_type, size, ep->max_packet_size); + if (res_bw < bw) { + usb_log_error("Endpoint(%d:%d) %s needs %zu bw " + "but only %zu is reserved.\n", + target.address, target.endpoint, name, bw, res_bw); + return ENOSPC; + } + + *batch = batch_get( + fun, ep, data, size, setup_data, setup_size, in, out, arg); + if (!*batch) + return ENOMEM; + 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-%" PRIun ".\n", address, handle); + usb_device_keeper_bind(&hc->manager, address, handle); + return EOK; +} + + +/** Find device handle by address interface function. + * + * @param[in] fun DDF function that was called. + * @param[in] address Address in question. + * @param[out] handle Where to store device handle if found. + * @return Error code. + */ +static int find_by_address(ddf_fun_t *fun, usb_address_t address, + devman_handle_t *handle) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + bool found = + usb_device_keeper_find_by_address(&hc->manager, address, handle); + return found ? EOK : ENOENT; +} + +/*----------------------------------------------------------------------------*/ +/** 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; +} +/*----------------------------------------------------------------------------*/ +/** 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] ep_speed Endpoint speed (invalid means to use device one). + * @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_speed_t ep_speed, usb_endpoint_t endpoint, + usb_transfer_type_t transfer_type, usb_direction_t direction, + size_t max_packet_size, unsigned int interval) +{ + hc_t *hc = fun_to_hc(fun); + assert(hc); + + usb_speed_t speed = usb_device_keeper_get_speed(&hc->manager, address); + if (speed >= USB_SPEED_MAX) { + speed = ep_speed; + } + const size_t size = max_packet_size; + + usb_log_debug("Register endpoint %d:%d %s %s(%d) %zu(%zu) %u.\n", + address, endpoint, usb_str_transfer_type(transfer_type), + usb_str_speed(speed), direction, size, max_packet_size, interval); + + return hc_add_endpoint(hc, address, endpoint, speed, transfer_type, + direction, max_packet_size, size, interval); +} +/*----------------------------------------------------------------------------*/ +static int unregister_endpoint( + ddf_fun_t *fun, usb_address_t address, + usb_endpoint_t endpoint, usb_direction_t direction) +{ + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_log_debug("Unregister endpoint %d:%d %d.\n", + address, endpoint, direction); + return hc_remove_endpoint(hc, address, endpoint, direction); +} +/*----------------------------------------------------------------------------*/ +/** 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] 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, void *data, + size_t size, usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + usb_transfer_batch_t *batch = NULL; + hc_t *hc = NULL; + int ret = setup_batch(fun, target, USB_DIRECTION_OUT, data, size, + NULL, 0, NULL, callback, arg, "Interrupt OUT", &hc, &batch); + if (ret != EOK) + return ret; + batch_interrupt_out(batch); + ret = hc_schedule(hc, batch); + if (ret != EOK) { + usb_transfer_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] 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, void *data, + size_t size, usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + usb_transfer_batch_t *batch = NULL; + hc_t *hc = NULL; + int ret = setup_batch(fun, target, USB_DIRECTION_IN, data, size, + NULL, 0, callback, NULL, arg, "Interrupt IN", &hc, &batch); + if (ret != EOK) + return ret; + batch_interrupt_in(batch); + ret = hc_schedule(hc, batch); + if (ret != EOK) { + usb_transfer_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] 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, void *data, + size_t size, usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + usb_transfer_batch_t *batch = NULL; + hc_t *hc = NULL; + int ret = setup_batch(fun, target, USB_DIRECTION_OUT, data, size, + NULL, 0, NULL, callback, arg, "Bulk OUT", &hc, &batch); + if (ret != EOK) + return ret; + batch_bulk_out(batch); + ret = hc_schedule(hc, batch); + if (ret != EOK) { + usb_transfer_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] 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, void *data, + size_t size, usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + usb_transfer_batch_t *batch = NULL; + hc_t *hc = NULL; + int ret = setup_batch(fun, target, USB_DIRECTION_IN, data, size, + NULL, 0, callback, NULL, arg, "Bulk IN", &hc, &batch); + if (ret != EOK) + return ret; + batch_bulk_in(batch); + ret = hc_schedule(hc, batch); + if (ret != EOK) { + usb_transfer_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] setup_packet Setup packet buffer (in USB endianess, allocated + * and deallocated by the caller). + * @param[in] setup_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] 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, + void *setup_data, size_t setup_size, void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + usb_transfer_batch_t *batch = NULL; + hc_t *hc = NULL; + int ret = setup_batch(fun, target, USB_DIRECTION_BOTH, data, size, + setup_data, setup_size, NULL, callback, arg, "Control WRITE", + &hc, &batch); + if (ret != EOK) + return ret; + usb_endpoint_manager_reset_if_need(&hc->ep_manager, target, setup_data); + batch_control_write(batch); + ret = hc_schedule(hc, batch); + if (ret != EOK) { + usb_transfer_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] setup_packet Setup packet buffer (in USB endianess, allocated + * and deallocated by the caller). + * @param[in] setup_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] 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, + void *setup_data, size_t setup_size, void *data, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + usb_transfer_batch_t *batch = NULL; + hc_t *hc = NULL; + int ret = setup_batch(fun, target, USB_DIRECTION_BOTH, data, size, + setup_data, setup_size, callback, NULL, arg, "Control READ", + &hc, &batch); + if (ret != EOK) + return ret; + batch_control_read(batch); + ret = hc_schedule(hc, batch); + if (ret != EOK) { + usb_transfer_batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +usbhc_iface_t hc_iface = { + .request_address = request_address, + .bind_address = bind_address, + .find_by_address = find_by_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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/iface.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,45 @@ +/* + * 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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/main.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,90 @@ +/* + * 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" + +/** Initializes a new ddf driver instance of OHCI hcd. + * + * @param[in] device DDF instance of the device to initialize. + * @return Error code. + */ +static int ohci_add_device(ddf_dev_t *device) +{ + usb_log_debug("ohci_add_device() called\n"); + assert(device); + + int ret = device_setup_ohci(device); + if (ret != EOK) { + usb_log_error("Failed to initialize OHCI driver: %s.\n", + str_error(ret)); + return ret; + } + usb_log_info("Controlling new OHCI device '%s'.\n", device->name); + + return EOK; +} +/*----------------------------------------------------------------------------*/ +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 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(&ohci_driver); +} +/** + * @} + */ Index: uspace/drv/ohci/ohci.c =================================================================== --- uspace/drv/ohci/ohci.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/ohci.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,247 @@ +/* + * 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" +#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; + +static inline ohci_t * dev_to_ohci(ddf_dev_t *dev) +{ + assert(dev); + assert(dev->driver_data); + return dev->driver_data; +} + +/** 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) +{ + hc_t *hc = &dev_to_ohci(dev)->hc; + assert(hc); + const uint16_t status = IPC_GET_ARG1(*call); + 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 = &dev_to_ohci(fun->dev)->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(fun); + ddf_fun_t *hc_fun = dev_to_ohci(fun->dev)->hc_fun; + assert(hc_fun); + + if (handle != NULL) + *handle = hc_fun->handle; + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Root hub USB interface */ +static usb_iface_t usb_iface = { + .get_hc_handle = usb_iface_get_hc_handle, + .get_address = usb_iface_get_address +}; +/*----------------------------------------------------------------------------*/ +/** Standard USB HC options (HC interface) */ +static ddf_dev_ops_t hc_ops = { + .interfaces[USBHC_DEV_IFACE] = &hc_iface, /* see iface.h/c */ +}; +/*----------------------------------------------------------------------------*/ +/** Standard USB RH options (RH interface) */ +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] device DDF instance of the device to use. + * @param[in] instance OHCI structure 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 device_setup_ohci(ddf_dev_t *device) +{ + ohci_t *instance = malloc(sizeof(ohci_t)); + if (instance == NULL) { + usb_log_error("Failed to allocate OHCI driver.\n"); + return ENOMEM; + } + +#define CHECK_RET_DEST_FREE_RETURN(ret, message...) \ +if (ret != EOK) { \ + if (instance->hc_fun) { \ + instance->hc_fun->ops = NULL; \ + instance->hc_fun->driver_data = NULL; \ + ddf_fun_destroy(instance->hc_fun); \ + } \ + if (instance->rh_fun) { \ + instance->rh_fun->ops = NULL; \ + instance->rh_fun->driver_data = NULL; \ + ddf_fun_destroy(instance->rh_fun); \ + } \ + free(instance); \ + usb_log_error(message); \ + return ret; \ +} else (void)0 + + instance->rh_fun = NULL; + instance->hc_fun = ddf_fun_create(device, fun_exposed, "ohci-hc"); + int ret = instance->hc_fun ? EOK : ENOMEM; + CHECK_RET_DEST_FREE_RETURN(ret, "Failed to create OHCI HC function.\n"); + instance->hc_fun->ops = &hc_ops; + instance->hc_fun->driver_data = &instance->hc; + + instance->rh_fun = ddf_fun_create(device, fun_inner, "ohci-rh"); + ret = instance->rh_fun ? EOK : ENOMEM; + CHECK_RET_DEST_FREE_RETURN(ret, "Failed to create OHCI RH function.\n"); + instance->rh_fun->ops = &rh_ops; + + uintptr_t reg_base = 0; + size_t reg_size = 0; + int irq = 0; + + ret = pci_get_my_registers(device, ®_base, ®_size, &irq); + CHECK_RET_DEST_FREE_RETURN(ret, + "Failed to get memory addresses for %" PRIun ": %s.\n", + device->handle, str_error(ret)); + usb_log_debug("Memory mapped regs at %p (size %zu), IRQ %d.\n", + (void *) reg_base, reg_size, irq); + + 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 + + ret = hc_init(&instance->hc, reg_base, reg_size, interrupts); + CHECK_RET_DEST_FREE_RETURN(ret, "Failed(%d) to init ohci-hcd.\n", ret); + +#define CHECK_RET_FINI_RETURN(ret, message...) \ +if (ret != EOK) { \ + hc_fini(&instance->hc); \ + CHECK_RET_DEST_FREE_RETURN(ret, message); \ +} else (void)0 + + /* 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); + + ret = ddf_fun_bind(instance->hc_fun); + CHECK_RET_FINI_RETURN(ret, + "Failed(%d) to bind OHCI device function: %s.\n", + ret, str_error(ret)); + + ret = ddf_fun_add_to_class(instance->hc_fun, USB_HC_DDF_CLASS_NAME); + CHECK_RET_FINI_RETURN(ret, + "Failed to add OHCI to HC class: %s.\n", str_error(ret)); + + device->driver_data = instance; + + hc_start_hw(&instance->hc); + hc_register_hub(&instance->hc, instance->rh_fun); + return EOK; + +#undef CHECK_RET_DEST_FUN_RETURN +#undef CHECK_RET_FINI_RETURN +} +/** + * @} + */ Index: uspace/drv/ohci/ohci.h =================================================================== --- uspace/drv/ohci/ohci.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/ohci.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,44 @@ +/* + * 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 + +int device_setup_ohci(ddf_dev_t *device); + +#endif +/** + * @} + */ Index: uspace/drv/ohci/ohci.ma =================================================================== --- uspace/drv/ohci/ohci.ma (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/ohci.ma (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,11 @@ +10 pci/ven=106b&dev=003f +10 pci/ven=10de&dev=0aa5 + +10 pci/ven=1002&dev=4374 +10 pci/ven=1002&dev=4375 + +10 pci/ven=1002&dev=4387 +10 pci/ven=1002&dev=4388 +10 pci/ven=1002&dev=4389 +10 pci/ven=1002&dev=438a +10 pci/ven=1002&dev=438b Index: uspace/drv/ohci/ohci_regs.h =================================================================== --- uspace/drv/ohci/ohci_regs.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/ohci_regs.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,219 @@ +/* + * 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 + +/** OHCI memory mapped registers structure */ +typedef struct ohci_regs { + const volatile uint32_t revision; + volatile uint32_t control; +#define C_CSBR_MASK (0x3) /* Control-bulk service ratio */ +#define C_CSBR_1_1 (0x0) +#define C_CSBR_1_2 (0x1) +#define C_CSBR_1_3 (0x2) +#define C_CSBR_1_4 (0x3) +#define C_CSBR_SHIFT (0) + +#define C_PLE (1 << 2) /* Periodic list enable */ +#define C_IE (1 << 3) /* Isochronous enable */ +#define C_CLE (1 << 4) /* Control list enable */ +#define C_BLE (1 << 5) /* Bulk list enable */ + +#define C_HCFS_MASK (0x3) /* Host controller functional state */ +#define C_HCFS_RESET (0x0) +#define C_HCFS_RESUME (0x1) +#define C_HCFS_OPERATIONAL (0x2) +#define C_HCFS_SUSPEND (0x3) +#define C_HCFS_SHIFT (6) + +#define C_IR (1 << 8) /* Interrupt routing, make sure it's 0 */ +#define C_RWC (1 << 9) /* Remote wakeup connected, host specific */ +#define C_RWE (1 << 10) /* Remote wakeup enable */ + + volatile uint32_t command_status; +#define CS_HCR (1 << 0) /* Host controller reset */ +#define CS_CLF (1 << 1) /* Control list filled */ +#define CS_BLF (1 << 2) /* Bulk list filled */ +#define CS_OCR (1 << 3) /* Ownership change request */ +#define CS_SOC_MASK (0x3) /* Scheduling overrun count */ +#define CS_SOC_SHIFT (16) + + /** Interupt enable/disable/status, + * reads give the same value, + * writing causes enable/disable, + * status is write-clean (writing 1 clears the bit*/ + volatile uint32_t interrupt_status; + volatile uint32_t interrupt_enable; + volatile uint32_t interrupt_disable; +#define I_SO (1 << 0) /* Scheduling overrun */ +#define I_WDH (1 << 1) /* Done head write-back */ +#define I_SF (1 << 2) /* Start of frame */ +#define I_RD (1 << 3) /* Resume detect */ +#define I_UE (1 << 4) /* Unrecoverable error */ +#define I_FNO (1 << 5) /* Frame number overflow */ +#define I_RHSC (1 << 6) /* Root hub status change */ +#define I_OC (1 << 30) /* Ownership change */ +#define I_MI (1 << 31) /* Master interrupt (all/any interrupts) */ + + /** HCCA pointer (see hw_struct hcca.h) */ + volatile uint32_t hcca; +#define HCCA_PTR_MASK 0xffffff00 /* HCCA is 256B aligned */ + + /** Currently executed periodic endpoint */ + const volatile uint32_t periodic_current; + + /** The first control endpoint */ + volatile uint32_t control_head; + + /** Currently executed control endpoint */ + volatile uint32_t control_current; + + /** The first bulk endpoint */ + volatile uint32_t bulk_head; + + /** Currently executed bulk endpoint */ + volatile uint32_t bulk_current; + + /** Done TD list, this value is periodically written to HCCA */ + const volatile uint32_t done_head; + + /** Frame time and max packet size for all transfers */ + volatile uint32_t fm_interval; +#define FMI_FI_MASK (0x3fff) /* Frame interval in bit times (should be 11999)*/ +#define FMI_FI_SHIFT (0) +#define FMI_FSMPS_MASK (0x7fff) /* Full speed max packet size */ +#define FMI_FSMPS_SHIFT (16) +#define FMI_TOGGLE_FLAG (1 << 31) + + /** Bit times remaining in current frame */ + const volatile uint32_t fm_remaining; +#define FMR_FR_MASK FMI_FI_MASK +#define FMR_FR_SHIFT FMI_FI_SHIFT +#define FMR_TOGGLE_FLAG FMI_TOGGLE_FLAG + + /** Frame number */ + const volatile uint32_t fm_number; +#define FMN_NUMBER_MASK (0xffff) + + /** Remaining bit time in frame to start periodic transfers */ + volatile uint32_t periodic_start; +#define PS_PS_MASK (0x3fff) /* bit time when periodic get priority (0x3e67) */ + + /** Threshold for starting LS transaction */ + volatile uint32_t ls_threshold; +#define LST_LST_MASK (0x7fff) + + /** The first root hub control register */ + volatile uint32_t rh_desc_a; +#define RHDA_NDS_MASK (0xff) /* Number of downstream ports, max 15 */ +#define RHDA_NDS_SHIFT (0) +#define RHDA_PSM_FLAG (1 << 8) /* Power switching mode: 0-global, 1-per port*/ +#define RHDA_NPS_FLAG (1 << 9) /* No power switch: 1-power on, 0-use PSM*/ +#define RHDA_DT_FLAG (1 << 10) /* 1-Compound device, must be 0 */ +#define RHDA_OCPM_FLAG (1 << 11) /* Over-current mode: 0-global, 1-per port */ +#define RHDA_NOCP (1 << 12) /* OC control: 0-use OCPM, 1-OC off */ +#define RHDA_POTPGT_MASK (0xff) /* Power on to power good time */ +#define RHDA_POTPGT_SHIFT (24) + + /** The other root hub control register */ + volatile uint32_t rh_desc_b; +#define RHDB_DR_MASK (0xffff) /* Device removable mask */ +#define RHDB_DR_SHIFT (0) +#define RHDB_PCC_MASK (0xffff) /* Power control mask */ +#define RHDB_PCC_SHIFT (16) + +/* Port device removable status */ +#define RHDB_DR_FLAG(port) (((1 << port) & RHDB_DR_MASK) << RHDB_DR_SHIFT) +/* Port power control status: 1-per port power control, 0-global power switch */ +#define RHDB_PPC_FLAG(port) (((1 << port) & RHDB_DR_MASK) << RHDB_DR_SHIFT) + + /** Root hub status register */ + volatile uint32_t rh_status; +#define RHS_LPS_FLAG (1 << 0)/* read: 0, + * write: 0-no effect, + * 1-turn off port power for ports + * specified in PPCM(RHDB), or all ports, + * if power is set globally */ +#define RHS_CLEAR_PORT_POWER RHS_LPS_FLAG /* synonym for the above */ +#define RHS_OCI_FLAG (1 << 1)/* Over-current indicator, if per-port: 0 */ +#define RHS_DRWE_FLAG (1 << 15)/* read: 0-connect status change does not wake HC + * 1-connect status change wakes HC + * write: 1-set DRWE, 0-no effect */ +#define RHS_SET_DRWE RHS_DRWE_FLAG +#define RHS_LPSC_FLAG (1 << 16)/* read: 0, + * write: 0-no effect + * 1-turn on port power for ports + * specified in PPCM(RHDB), or all ports, + * if power is set globally */ +#define RHS_SET_PORT_POWER RHS_LPSC_FLAG /* synonym for the above */ +#define RHS_OCIC_FLAG (1 << 17)/* Over-current indicator change */ +#define RHS_CLEAR_DRWE (1 << 31) + + /** Root hub per port status */ + volatile uint32_t rh_port_status[]; +#define RHPS_CCS_FLAG (1 << 0) /* r: current connect status, + * w: 1-clear port enable, 0-nothing */ +#define RHPS_CLEAR_PORT_ENABLE RHPS_CCS_FLAG +#define RHPS_PES_FLAG (1 << 1) /* r: port enable status + * w: 1-set port enable, 0-nothing */ +#define RHPS_SET_PORT_ENABLE RHPS_PES_FLAG +#define RHPS_PSS_FLAG (1 << 2) /* r: port suspend status + * w: 1-set port suspend, 0-nothing */ +#define RHPS_SET_PORT_SUSPEND RHPS_PSS_FLAG +#define RHPS_POCI_FLAG (1 << 3) /* r: port over-current (if reports are per-port + * w: 1-clear port suspend (start resume + * if suspened) + * 0-nothing */ +#define RHPS_CLEAR_PORT_SUSPEND RHPS_POCI_FLAG +#define RHPS_PRS_FLAG (1 << 4) /* r: port reset status + * w: 1-set port reset, 0-nothing */ +#define RHPS_SET_PORT_RESET RHPS_PRS_FLAG +#define RHPS_PPS_FLAG (1 << 8) /* r: port power status + * w: 1-set port power, 0-nothing */ +#define RHPS_SET_PORT_POWER RHPS_PPS_FLAG +#define RHPS_LSDA_FLAG (1 << 9) /* r: low speed device attached + * w: 1-clear port power, 0-nothing */ +#define RHPS_CLEAR_PORT_POWER RHPS_LSDA_FLAG +#define RHPS_CSC_FLAG (1 << 16) /* connect status change Write-Clean */ +#define RHPS_PESC_FLAG (1 << 17) /* port enable status change WC */ +#define RHPS_PSSC_FLAG (1 << 18) /* port suspend status change WC */ +#define RHPS_OCIC_FLAG (1 << 19) /* port over-current change WC */ +#define RHPS_PRSC_FLAG (1 << 20) /* port reset status change WC */ +#define RHPS_CHANGE_WC_MASK 0x1f0000 +} __attribute__((packed)) ohci_regs_t; +#endif +/** + * @} + */ Index: uspace/drv/ohci/pci.c =================================================================== --- uspace/drv/ohci/pci.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/pci.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,147 @@ +/* + * 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" + +/** 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); + assert(mem_reg_address); + assert(mem_reg_size); + assert(irq_no); + + 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: %p %zu.\n", + (void *) 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; +} +/** + * @} + */ + +/** + * @} + */ Index: uspace/drv/ohci/pci.h =================================================================== --- uspace/drv/ohci/pci.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/pci.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,47 @@ +/* + * 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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/root_hub.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,944 @@ +/* + * 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 +#include +#include "ohci_regs.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), + .max_packet_size = 8, + .vendor_id = 0x16db, + .product_id = 0x0001, + .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 = { + .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, + .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, +}; + +/** + * bitmask of hub features that are valid to be cleared + */ +static const uint32_t hub_clear_feature_valid_mask = + RHS_OCIC_FLAG | + RHS_CLEAR_PORT_POWER; + +/** + * bitmask of hub features that are cleared by writing 1 (and not 0) + */ +static const uint32_t hub_clear_feature_by_writing_one_mask = + RHS_CLEAR_PORT_POWER; + +/** + * bitmask of hub features that are valid to be set + */ +static const uint32_t hub_set_feature_valid_mask = + RHS_LPSC_FLAG | + RHS_OCIC_FLAG; + +/** + * bitmask of hub features that are set by writing 1 and cleared by writing 0 + */ +static const uint32_t hub_set_feature_direct_mask = + RHS_SET_PORT_POWER; + +/** + * bitmask of port features that are valid to be set + */ +static const uint32_t port_set_feature_valid_mask = + RHPS_SET_PORT_ENABLE | + RHPS_SET_PORT_SUSPEND | + RHPS_SET_PORT_RESET | + RHPS_SET_PORT_POWER; + +/** + * bitmask of port features that can be cleared + */ +static const uint32_t port_clear_feature_valid_mask = + RHPS_CCS_FLAG | + RHPS_SET_PORT_SUSPEND | + RHPS_POCI_FLAG | + RHPS_SET_PORT_POWER | + RHPS_CSC_FLAG | + RHPS_PESC_FLAG | + RHPS_PSSC_FLAG | + RHPS_OCIC_FLAG | + RHPS_PRSC_FLAG; + +//note that USB_HUB_FEATURE_PORT_POWER bit is translated into +//USB_HUB_FEATURE_PORT_LOW_SPEED for port set feature request + +/** + * bitmask with port status changes + */ +static const uint32_t port_status_change_mask = RHPS_CHANGE_WC_MASK; + +static int create_serialized_hub_descriptor(rh_t *instance); + +static int rh_init_descriptors(rh_t *instance); + +static int process_get_port_status_request(rh_t *instance, uint16_t port, + usb_transfer_batch_t * request); + +static int process_get_hub_status_request(rh_t *instance, + usb_transfer_batch_t * request); + +static int process_get_status_request(rh_t *instance, + usb_transfer_batch_t * request); + +static void create_interrupt_mask_in_instance(rh_t *instance); + +static int process_get_descriptor_request(rh_t *instance, + usb_transfer_batch_t *request); + +static int process_get_configuration_request(rh_t *instance, + usb_transfer_batch_t *request); + +static int process_hub_feature_set_request(rh_t *instance, uint16_t feature); + +static int process_hub_feature_clear_request(rh_t *instance, + uint16_t feature); + +static int process_port_feature_set_request(rh_t *instance, + uint16_t feature, uint16_t port); + +static int process_port_feature_clear_request(rh_t *instance, + uint16_t feature, uint16_t port); + +static int process_address_set_request(rh_t *instance, + uint16_t address); + +static int process_request_with_output(rh_t *instance, + usb_transfer_batch_t *request); + +static int process_request_with_input(rh_t *instance, + usb_transfer_batch_t *request); + +static int process_request_without_data(rh_t *instance, + usb_transfer_batch_t *request); + +static int process_ctrl_request(rh_t *instance, usb_transfer_batch_t *request); + +static int process_interrupt_mask_in_instance(rh_t *instance, usb_transfer_batch_t * request); + +static bool is_zeros(void * buffer, size_t size); + +/** Root hub initialization + * @return Error code. + */ +int rh_init(rh_t *instance, ohci_regs_t *regs) { + assert(instance); + instance->registers = regs; + instance->port_count = + (instance->registers->rh_desc_a >> RHDA_NDS_SHIFT) & RHDA_NDS_MASK; + int opResult = rh_init_descriptors(instance); + if (opResult != EOK) { + return opResult; + } + // set port power mode to no-power-switching + instance->registers->rh_desc_a |= RHDA_NPS_FLAG; + instance->unfinished_interrupt_transfer = NULL; + instance->interrupt_mask_size = (instance->port_count + 8) / 8; + instance->interrupt_buffer = malloc(instance->interrupt_mask_size); + if (!instance->interrupt_buffer) + return ENOMEM; + + usb_log_info("OHCI root hub with %zu ports initialized.\n", + instance->port_count); + + return EOK; +} +/*----------------------------------------------------------------------------*/ + +/** + * 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->ep->transfer_type == USB_TRANSFER_CONTROL) { + usb_log_info("Root hub got CONTROL packet\n"); + opResult = process_ctrl_request(instance, request); + usb_transfer_batch_finish_error(request, opResult); + } else if (request->ep->transfer_type == USB_TRANSFER_INTERRUPT) { + usb_log_info("Root hub got INTERRUPT packet\n"); + create_interrupt_mask_in_instance(instance); + if (is_zeros(instance->interrupt_buffer, + instance->interrupt_mask_size)) { + usb_log_debug("No changes..\n"); + instance->unfinished_interrupt_transfer = request; + //will be finished later + } else { + usb_log_debug("Processing changes..\n"); + process_interrupt_mask_in_instance(instance, request); + } + opResult = EOK; + } else { + + opResult = EINVAL; + usb_transfer_batch_finish_error(request, opResult); + } + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +/** + * process interrupt on a hub + * + * If there is no pending interrupt transfer, nothing happens. + * @param instance + */ +void rh_interrupt(rh_t *instance) { + if (!instance->unfinished_interrupt_transfer) { + return; + } + usb_log_debug("Finalizing interrupt transfer\n"); + create_interrupt_mask_in_instance(instance); + process_interrupt_mask_in_instance(instance, + instance->unfinished_interrupt_transfer); +} +/*----------------------------------------------------------------------------*/ + +/** + * 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 + * @return error code + */ +static int create_serialized_hub_descriptor(rh_t *instance) { + size_t size = 7 + + ((instance->port_count + 7) / 8) * 2; + size_t var_size = (instance->port_count + 7) / 8; + uint8_t * result = (uint8_t*) malloc(size); + if (!result) return ENOMEM; + + 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; + + size_t port; + for (port = 1; port <= instance->port_count; ++port) { + uint8_t is_non_removable = + instance->registers->rh_desc_b >> port % 2; + result[7 + port / 8] += + is_non_removable << (port % 8); + } + size_t i; + for (i = 0; i < var_size; ++i) { + result[7 + var_size + i] = 255; + } + instance->hub_descriptor = result; + instance->descriptor_size = size; + + return EOK; +} +/*----------------------------------------------------------------------------*/ + +/** initialize hub descriptors + * + * Initialized are device and full configuration descriptor. These need to + * be initialized only once per hub. + * @instance root hub instance + * @return error code + */ +static int 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)); + + int opResult = create_serialized_hub_descriptor(instance); + if (opResult != EOK) { + return opResult; + } + descriptor.total_length = + sizeof (usb_standard_configuration_descriptor_t) + + sizeof (usb_standard_endpoint_descriptor_t) + + sizeof (usb_standard_interface_descriptor_t) + + instance->descriptor_size; + + uint8_t * full_config_descriptor = + (uint8_t*) malloc(descriptor.total_length); + if (!full_config_descriptor) { + return ENOMEM; + } + 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), + instance->hub_descriptor, instance->descriptor_size); + + instance->descriptors.configuration = full_config_descriptor; + instance->descriptors.configuration_size = descriptor.total_length; + + return EOK; +} +/*----------------------------------------------------------------------------*/ + +/** + * create answer to port status_request + * + * Copy content of corresponding port status register to answer buffer. The + * format of the port status register and port status data is the same ( + * see OHCI root hub and USB hub documentation). + * + * @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; + request->transfered_size = 4; + uint32_t data = instance->registers->rh_port_status[port - 1]; + memcpy(request->data_buffer, &data, 4); + return EOK; +} +/*----------------------------------------------------------------------------*/ + +/** + * create answer to port status_request + * + * This copies flags in hub status register into the buffer. The format of the + * status register and status message is the same, according to USB hub + * specification and OHCI root hub specification. + * + * @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) { + request->transfered_size = 4; + //bits, 0,1,16,17 + uint32_t mask = 1 | (1 << 1) | (1 << 16) | (1 << 17); + uint32_t data = mask & instance->registers->rh_status; + memcpy(request->data_buffer, &data, 4); + + 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) { + 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 + * (chapter 11.13.4). + * Uses instance`s interrupt buffer to store the interrupt information. + * @param instance root hub instance + */ +static void create_interrupt_mask_in_instance(rh_t * instance) { + uint8_t * bitmap = (uint8_t*) (instance->interrupt_buffer); + uint32_t mask = (1 << (USB_HUB_FEATURE_C_HUB_LOCAL_POWER + 16)) + | (1 << (USB_HUB_FEATURE_C_HUB_OVER_CURRENT + 16)); + bzero(bitmap, instance->interrupt_mask_size); + if ((instance->registers->rh_status & mask) != 0) { + bitmap[0] = 1; + } + size_t port; + mask = port_status_change_mask; + for (port = 1; port <= instance->port_count; ++port) { + if ((mask & instance->registers->rh_port_status[port - 1]) != 0) { + + bitmap[(port) / 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); + switch (setup_request_value) { + case USB_DESCTYPE_HUB: + { + usb_log_debug("USB_DESCTYPE_HUB\n"); + result_descriptor = instance->hub_descriptor; + size = instance->descriptor_size; + 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->data_buffer, result_descriptor, size); + + 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->data_buffer[0] = 1; + request->transfered_size = 1; + + return EOK; +} +/*----------------------------------------------------------------------------*/ + +/** + * process feature-enabling request on hub + * + * @param instance root hub instance + * @param feature feature selector + * @return error code + */ +static int process_hub_feature_set_request(rh_t *instance, + uint16_t feature) { + if (!((1 << feature) & hub_set_feature_valid_mask)) + return EINVAL; + if (feature == USB_HUB_FEATURE_C_HUB_LOCAL_POWER) + feature = USB_HUB_FEATURE_C_HUB_LOCAL_POWER << 16; + instance->registers->rh_status = + (instance->registers->rh_status | (1 << feature)) + & (~hub_clear_feature_by_writing_one_mask); + + return EOK; +} +/*----------------------------------------------------------------------------*/ + +/** + * process feature-disabling request on hub + * + * @param instance root hub instance + * @param feature feature selector + * @return error code + */ +static int process_hub_feature_clear_request(rh_t *instance, + uint16_t feature) { + if (!((1 << feature) & hub_clear_feature_valid_mask)) + return EINVAL; + //is the feature cleared directly? + if ((1 << feature) & hub_set_feature_direct_mask) { + instance->registers->rh_status = + (instance->registers->rh_status & (~(1 << feature))) + & (~hub_clear_feature_by_writing_one_mask); + } else {//the feature is cleared by writing '1' + + instance->registers->rh_status = + (instance->registers->rh_status + & (~hub_clear_feature_by_writing_one_mask)) + | (1 << feature); + } + return EOK; +} +/*----------------------------------------------------------------------------*/ + +/** + * process feature-enabling request on hub + * + * @param instance root hub instance + * @param feature feature selector + * @param port port number, counted from 1 + * @param enable enable or disable the specified feature + * @return error code + */ +static int process_port_feature_set_request(rh_t *instance, + uint16_t feature, uint16_t port) { + if (!((1 << feature) & port_set_feature_valid_mask)) + return EINVAL; + if (port < 1 || port > instance->port_count) + return EINVAL; + instance->registers->rh_port_status[port - 1] = + (instance->registers->rh_port_status[port - 1] | (1 << feature)) + & (~port_clear_feature_valid_mask); + return EOK; +} +/*----------------------------------------------------------------------------*/ + +/** + * process feature-disabling request on hub + * + * @param instance root hub instance + * @param feature feature selector + * @param port port number, counted from 1 + * @param enable enable or disable the specified feature + * @return error code + */ +static int process_port_feature_clear_request(rh_t *instance, + uint16_t feature, uint16_t port) { + if (!((1 << feature) & port_clear_feature_valid_mask)) + return EINVAL; + if (port < 1 || port > instance->port_count) + return EINVAL; + if (feature == USB_HUB_FEATURE_PORT_POWER) + feature = USB_HUB_FEATURE_PORT_LOW_SPEED; + if (feature == USB_HUB_FEATURE_PORT_SUSPEND) + feature = USB_HUB_FEATURE_PORT_OVER_CURRENT; + instance->registers->rh_port_status[port - 1] = + (instance->registers->rh_port_status[port - 1] + & (~port_clear_feature_valid_mask)) + | (1 << feature); + + return EOK; +} +/*----------------------------------------------------------------------------*/ + +/** + * register address to this device + * + * @param instance root hub instance + * @param address new address + * @return error code + */ +static int process_address_set_request(rh_t *instance, + uint16_t address) { + return ENOTSUP; +} +/*----------------------------------------------------------------------------*/ + +/** + * 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) { + 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_clear_request(instance, + setup_request->value); + } + 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_clear_request(instance, + setup_request->value, + setup_request->index); + } + usb_log_debug("USB_HUB_REQ_TYPE_INVALID %d\n", + setup_request->request_type); + return EINVAL; + } + if (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); + } + 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); + } + 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) { + if (!request->setup_buffer) { + usb_log_error("root hub received empty transaction?"); + return EINVAL; + } + int opResult; + 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; + switch (setup_request->request) { + case USB_DEVREQ_GET_STATUS: + case USB_DEVREQ_GET_DESCRIPTOR: + case USB_DEVREQ_GET_CONFIGURATION: + usb_log_debug("Processing request with output\n"); + opResult = process_request_with_output( + instance, request); + break; + case USB_DEVREQ_CLEAR_FEATURE: + case USB_DEVREQ_SET_FEATURE: + case USB_DEVREQ_SET_ADDRESS: + usb_log_debug("Processing request without " + "additional data\n"); + opResult = process_request_without_data( + instance, request); + break; + case USB_DEVREQ_SET_DESCRIPTOR: + case USB_DEVREQ_SET_CONFIGURATION: + usb_log_debug("Processing request with " + "input\n"); + opResult = process_request_with_input( + instance, request); + + break; + default: + usb_log_warning("Received unsuported request: " + "%d\n", + setup_request->request + ); + opResult = ENOTSUP; + } + return opResult; +} +/*----------------------------------------------------------------------------*/ + +/** + * process hanging interrupt request + * + * If an interrupt transfer has been received and there was no change, + * the driver stores the transfer information and waits for change to occcur. + * This routine is called when that happens and it finalizes the interrupt + * transfer. + * + * @param instance hub instance + * @param request batch request to be processed + * + * @return + */ +static int process_interrupt_mask_in_instance(rh_t *instance, + usb_transfer_batch_t * request) { + memcpy(request->data_buffer, instance->interrupt_buffer, + instance->interrupt_mask_size); + request->transfered_size = instance->interrupt_mask_size; + instance->unfinished_interrupt_transfer = NULL; + usb_transfer_batch_finish_error(request, EOK); + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +/** + * return whether the buffer is full of zeros + * + * Convenience function. + * @param buffer + * @param size + * @return + */ +static bool is_zeros(void *buffer, size_t size) { + if (!buffer) return true; + if (!size) return true; + size_t i; + for (i = 0; i < size; ++i) { + if (((char*) buffer)[i]) + return false; + } + return true; +} + +/** + * @} + */ Index: uspace/drv/ohci/root_hub.h =================================================================== --- uspace/drv/ohci/root_hub.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/root_hub.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 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; + /** hub port count */ + size_t port_count; + /** hubs descriptors */ + usb_device_descriptors_t descriptors; + /** interrupt transfer waiting for an actual interrupt to occur */ + usb_transfer_batch_t * unfinished_interrupt_transfer; + /** pre-allocated interrupt mask + * + * This is allocated when initializing instance, so that memory + * allocation is not needed when processing request. Buffer is used for + * interrupt bitmask. + */ + uint8_t * interrupt_buffer; + /** size of interrupt buffer */ + size_t interrupt_mask_size; + /** instance`s descriptor*/ + uint8_t * hub_descriptor; + /** size of hub descriptor */ + size_t descriptor_size; + + +} rh_t; + +int rh_init(rh_t *instance, 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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/ohci/utils/malloc32.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,75 @@ +/* + * 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 drvusbohci + * @{ + */ +/** @file + * @brief OHCI driver + */ +#ifndef DRV_OHCI_UTILS_MALLOC32_H +#define DRV_OHCI_UTILS_MALLOC32_H + +#include +#include +#include +#include +#include + +/** 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 aligned and big enough memory place, NULL on failure. + */ +static inline void * malloc32(size_t size) + { return memalign(size, size); } +/*----------------------------------------------------------------------------*/ +/** Physical mallocator simulator + * + * @param[in] addr Address of the place allocated by malloc32 + */ +static inline void free32(void *addr) + { if (addr) free(addr); } +#endif +/** + * @} + */ Index: uspace/drv/pciintel/pci.c =================================================================== --- uspace/drv/pciintel/pci.c (revision 5d1b3aa2ae833977640704ed7cf0ed0ad531bb41) +++ uspace/drv/pciintel/pci.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -52,8 +52,13 @@ #include #include +#include +#include +#include +#include #include #include #include #include +#include #include "pci.h" @@ -84,7 +89,92 @@ 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 = 0; + hw_resource_list_t *res = &dev_data->hw_resources; + for (; i < res->count; i++) { + if (res->resources[i].type == INTERRUPT) { + const int irq = res->resources[i].res.interrupt.irq; + const 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 +184,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 +390,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 +415,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 +665,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 +737,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 5d1b3aa2ae833977640704ed7cf0ed0ad531bb41) +++ uspace/drv/rootvirt/devices.def (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -26,2 +26,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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,53 @@ +# +# 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 = \ + $(LIBUSBHOST_PREFIX)/libusbhost.a \ + $(LIBUSB_PREFIX)/libusb.a \ + $(LIBDRV_PREFIX)/libdrv.a +EXTRA_CFLAGS += \ + -I$(LIBUSB_PREFIX)/include \ + -I$(LIBUSBHOST_PREFIX)/include \ + -I$(LIBDRV_PREFIX)/include + +BINARY = uhci-hcd + +SOURCES = \ + iface.c \ + main.c \ + transfer_list.c \ + uhci.c \ + hc.c \ + root_hub.c \ + hw_struct/transfer_descriptor.c \ + pci.c \ + batch.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/uhci-hcd/batch.c =================================================================== --- uspace/drv/uhci-hcd/batch.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/batch.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,424 @@ +/* + * 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 transfer 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 + +/** UHCI specific data required for USB transfer */ +typedef struct uhci_transfer_batch { + /** Queue head + * This QH is used to maintain UHCI schedule structure and the element + * pointer points to the first TD of this batch. + */ + qh_t *qh; + /** List of TDs needed for the transfer */ + td_t *tds; + /** Number of TDs used by the transfer */ + size_t td_count; + /** Data buffer, must be accessible by the UHCI hw */ + void *device_buffer; +} uhci_transfer_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); +/*----------------------------------------------------------------------------*/ +/** Safely destructs uhci_transfer_batch_t structure + * + * @param[in] uhci_batch Instance to destroy. + */ +static void uhci_transfer_batch_dispose(void *uhci_batch) +{ + uhci_transfer_batch_t *instance = uhci_batch; + assert(instance); + free32(instance->device_buffer); + free(instance); +} +/*----------------------------------------------------------------------------*/ +/** Allocate memory and initialize internal data structure. + * + * @param[in] fun DDF function to pass to callback. + * @param[in] ep Communication target + * @param[in] buffer Data source/destination. + * @param[in] buffer_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 transfer completion + * @param[in] func_out function to call on outbound transfer completion + * @param[in] arg additional parameter to func_in or func_out + * @return Valid pointer if all structures were successfully created, + * NULL otherwise. + * + * Determines the number of needed transfer descriptors (TDs). + * Prepares a transport buffer (that is accessible by the hardware). + * Initializes parameters needed for the transfer and callback. + */ +usb_transfer_batch_t * batch_get(ddf_fun_t *fun, endpoint_t *ep, + char *buffer, size_t buffer_size, + const 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) +{ + assert(ep); + 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 (uhci_data) { \ + uhci_transfer_batch_dispose(uhci_data); \ + } \ + return NULL; \ + } else (void)0 + + uhci_transfer_batch_t *uhci_data = + malloc(sizeof(uhci_transfer_batch_t)); + CHECK_NULL_DISPOSE_RETURN(uhci_data, + "Failed to allocate UHCI batch.\n"); + bzero(uhci_data, sizeof(uhci_transfer_batch_t)); + + uhci_data->td_count = + (buffer_size + ep->max_packet_size - 1) / ep->max_packet_size; + if (ep->transfer_type == USB_TRANSFER_CONTROL) { + uhci_data->td_count += 2; + } + + assert((sizeof(td_t) % 16) == 0); + const size_t total_size = (sizeof(td_t) * uhci_data->td_count) + + sizeof(qh_t) + setup_size + buffer_size; + uhci_data->device_buffer = malloc32(total_size); + CHECK_NULL_DISPOSE_RETURN(uhci_data->device_buffer, + "Failed to allocate UHCI buffer.\n"); + bzero(uhci_data->device_buffer, total_size); + + uhci_data->tds = uhci_data->device_buffer; + uhci_data->qh = + (uhci_data->device_buffer + (sizeof(td_t) * uhci_data->td_count)); + + qh_init(uhci_data->qh); + qh_set_element_td(uhci_data->qh, uhci_data->tds); + + usb_transfer_batch_t *instance = malloc(sizeof(usb_transfer_batch_t)); + CHECK_NULL_DISPOSE_RETURN(instance, + "Failed to allocate batch instance.\n"); + void *setup = + uhci_data->device_buffer + (sizeof(td_t) * uhci_data->td_count) + + sizeof(qh_t); + void *data_buffer = setup + setup_size; + usb_target_t target = + { .address = ep->address, .endpoint = ep->endpoint }; + usb_transfer_batch_init(instance, ep, buffer, data_buffer, buffer_size, + setup, setup_size, func_in, func_out, arg, fun, + uhci_data, uhci_transfer_batch_dispose); + + 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 TD + * is reached. + */ +bool batch_is_complete(usb_transfer_batch_t *instance) +{ + assert(instance); + uhci_transfer_batch_t *data = instance->private_data; + assert(data); + + usb_log_debug2("Batch(%p) checking %zu transfer(s) for completion.\n", + instance, data->td_count); + instance->transfered_size = 0; + size_t i = 0; + for (;i < data->td_count; ++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(%zu):%" + PRIx32 ".\n", instance, i, data->tds[i].status); + td_print_status(&data->tds[i]); + + assert(instance->ep != NULL); + endpoint_toggle_set(instance->ep, + 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 transfer. + * + * @param[in] instance Batch structure to use. + * + * Uses generic 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->data_buffer, instance->buffer, instance->buffer_size); + batch_control(instance, USB_PID_OUT, USB_PID_IN); + instance->next_step = usb_transfer_batch_call_out_and_dispose; + usb_log_debug("Batch(%p) CONTROL WRITE initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepares control read transfer. + * + * @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 = usb_transfer_batch_call_in_and_dispose; + usb_log_debug("Batch(%p) CONTROL READ initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare interrupt in transfer. + * + * @param[in] instance Batch structure to use. + * + * Data transfer with PID_IN. + */ +void batch_interrupt_in(usb_transfer_batch_t *instance) +{ + assert(instance); + batch_data(instance, USB_PID_IN); + instance->next_step = usb_transfer_batch_call_in_and_dispose; + usb_log_debug("Batch(%p) INTERRUPT IN initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare interrupt out transfer. + * + * @param[in] instance Batch structure to use. + * + * Data transfer with PID_OUT. + */ +void batch_interrupt_out(usb_transfer_batch_t *instance) +{ + assert(instance); + /* We are data out, we are supposed to provide data */ + memcpy(instance->data_buffer, instance->buffer, instance->buffer_size); + batch_data(instance, USB_PID_OUT); + instance->next_step = usb_transfer_batch_call_out_and_dispose; + usb_log_debug("Batch(%p) INTERRUPT OUT initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare bulk in transfer. + * + * @param[in] instance Batch structure to use. + * + * Data transfer with PID_IN. + */ +void batch_bulk_in(usb_transfer_batch_t *instance) +{ + assert(instance); + batch_data(instance, USB_PID_IN); + instance->next_step = usb_transfer_batch_call_in_and_dispose; + usb_log_debug("Batch(%p) BULK IN initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare bulk out transfer. + * + * @param[in] instance Batch structure to use. + * + * Data transfer with PID_OUT. + */ +void batch_bulk_out(usb_transfer_batch_t *instance) +{ + assert(instance); + /* We are data out, we are supposed to provide data */ + memcpy(instance->data_buffer, instance->buffer, instance->buffer_size); + batch_data(instance, USB_PID_OUT); + instance->next_step = usb_transfer_batch_call_out_and_dispose; + usb_log_debug("Batch(%p) BULK OUT initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare generic data transfer + * + * @param[in] instance Batch structure to use. + * @param[in] pid Pid to use for data transactions. + * + * Transactions 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_transfer_batch_t *data = instance->private_data; + assert(data); + + const bool low_speed = instance->ep->speed == USB_SPEED_LOW; + int toggle = endpoint_toggle_get(instance->ep); + assert(toggle == 0 || toggle == 1); + + size_t td = 0; + size_t remain_size = instance->buffer_size; + char *buffer = instance->data_buffer; + while (remain_size > 0) { + const size_t packet_size = + (instance->ep->max_packet_size > remain_size) ? + remain_size : instance->ep->max_packet_size; + + td_t *next_td = (td + 1 < data->td_count) + ? &data->tds[td + 1] : NULL; + + + usb_target_t target = + { instance->ep->address, instance->ep->endpoint }; + + assert(td < data->td_count); + td_init( + &data->tds[td], DEFAULT_ERROR_COUNT, packet_size, + toggle, false, low_speed, target, pid, buffer, next_td); + + ++td; + toggle = 1 - toggle; + buffer += packet_size; + assert(packet_size <= remain_size); + remain_size -= packet_size; + } + td_set_ioc(&data->tds[td - 1]); + endpoint_toggle_set(instance->ep, toggle); +} +/*----------------------------------------------------------------------------*/ +/** Prepare generic control transfer + * + * @param[in] instance Batch structure to use. + * @param[in] data_stage Pid to use for data tds. + * @param[in] status_stage Pid to use for data tds. + * + * 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_transfer_batch_t *data = instance->private_data; + assert(data); + assert(data->td_count >= 2); + + const bool low_speed = instance->ep->speed == USB_SPEED_LOW; + const usb_target_t target = + { instance->ep->address, instance->ep->endpoint }; + + /* setup stage */ + td_init( + data->tds, DEFAULT_ERROR_COUNT, instance->setup_size, 0, false, + low_speed, target, USB_PID_SETUP, instance->setup_buffer, + &data->tds[1]); + + /* data stage */ + size_t td = 1; + unsigned toggle = 1; + size_t remain_size = instance->buffer_size; + char *buffer = instance->data_buffer; + while (remain_size > 0) { + const size_t packet_size = + (instance->ep->max_packet_size > remain_size) ? + remain_size : instance->ep->max_packet_size; + + td_init( + &data->tds[td], DEFAULT_ERROR_COUNT, packet_size, + toggle, false, low_speed, target, data_stage, + buffer, &data->tds[td + 1]); + + ++td; + toggle = 1 - toggle; + buffer += packet_size; + assert(td < data->td_count); + assert(packet_size <= remain_size); + remain_size -= packet_size; + } + + /* status stage */ + assert(td == data->td_count - 1); + + td_init( + &data->tds[td], DEFAULT_ERROR_COUNT, 0, 1, false, low_speed, + target, status_stage, NULL, NULL); + td_set_ioc(&data->tds[td]); + + usb_log_debug2("Control last TD status: %x.\n", + data->tds[td].status); +} +/*----------------------------------------------------------------------------*/ +/** Provides access to QH data structure. + * + * @param[in] instance Batch pointer to use. + * @return Pointer to the QH used by the batch. + */ +qh_t * batch_qh(usb_transfer_batch_t *instance) +{ + assert(instance); + uhci_transfer_batch_t *data = instance->private_data; + assert(data); + return data->qh; +} +/** + * @} + */ Index: uspace/drv/uhci-hcd/batch.h =================================================================== --- uspace/drv/uhci-hcd/batch.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/batch.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,65 @@ +/* + * 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 tranfer helper functions + */ +#ifndef DRV_UHCI_BATCH_H +#define DRV_UHCI_BATCH_H + +#include + +#include "hw_struct/queue_head.h" + +usb_transfer_batch_t * batch_get( + ddf_fun_t *fun, endpoint_t *ep, char *buffer, size_t size, + const 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); + +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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/hc.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,474 @@ +/* + * 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 "hc.h" + +#define UHCI_INTR_ALLOW_INTERRUPTS \ + (UHCI_INTR_CRC | UHCI_INTR_COMPLETE | UHCI_INTR_SHORT_PACKET) +#define UHCI_STATUS_USED_INTERRUPTS \ + (UHCI_STATUS_INTERRUPT | UHCI_STATUS_ERROR_INTERRUPT) + + +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); +/*----------------------------------------------------------------------------*/ +/** Initialize UHCI hc driver structure + * + * @param[in] instance Memory place to initialize. + * @param[in] regs Address of I/O control registers. + * @param[in] reg_size Size of I/O control registers. + * @param[in] interrupts True if hw interrupts should be used. + * @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, void *regs, size_t reg_size, bool interrupts) +{ + assert(reg_size >= sizeof(regs_t)); + int ret; + +#define CHECK_RET_RETURN(ret, message...) \ + if (ret != EOK) { \ + usb_log_error(message); \ + return ret; \ + } else (void) 0 + + instance->hw_interrupts = interrupts; + instance->hw_failures = 0; + + /* allow access to hc control registers */ + regs_t *io; + ret = pio_enable(regs, reg_size, (void **)&io); + CHECK_RET_RETURN(ret, + "Failed(%d) to gain access to registers at %p: %s.\n", + ret, io, str_error(ret)); + instance->registers = io; + usb_log_debug("Device registers at %p (%zuB) accessible.\n", + io, reg_size); + + ret = hc_init_mem_structures(instance); + CHECK_RET_RETURN(ret, + "Failed(%d) to initialize UHCI memory structures: %s.\n", + ret, str_error(ret)); + + hc_init_hw(instance); + if (!interrupts) { + instance->interrupt_emulator = + fibril_create(hc_interrupt_emulator, instance); + fibril_add_ready(instance->interrupt_emulator); + } + (void)hc_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_ALLOW_INTERRUPTS); + } + + const 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_RETURN(ret, message...) \ + if (ret != EOK) { \ + usb_log_error(message); \ + return ret; \ + } else (void) 0 + + /* Init interrupt code */ + instance->interrupt_code.cmds = instance->interrupt_commands; + { + /* Read status register */ + instance->interrupt_commands[0].cmd = CMD_PIO_READ_16; + instance->interrupt_commands[0].dstarg = 1; + instance->interrupt_commands[0].addr = + &instance->registers->usbsts; + + /* Test whether we are the interrupt cause */ + instance->interrupt_commands[1].cmd = CMD_BTEST; + instance->interrupt_commands[1].value = + UHCI_STATUS_USED_INTERRUPTS | UHCI_STATUS_NM_INTERRUPTS; + instance->interrupt_commands[1].srcarg = 1; + instance->interrupt_commands[1].dstarg = 2; + + /* Predicate cleaning and accepting */ + instance->interrupt_commands[2].cmd = CMD_PREDICATE; + instance->interrupt_commands[2].value = 2; + instance->interrupt_commands[2].srcarg = 2; + + /* Write clean status register */ + instance->interrupt_commands[3].cmd = CMD_PIO_WRITE_A_16; + instance->interrupt_commands[3].srcarg = 1; + instance->interrupt_commands[3].addr = + &instance->registers->usbsts; + + /* Accept interrupt */ + instance->interrupt_commands[4].cmd = CMD_ACCEPT; + + instance->interrupt_code.cmdcount = UHCI_NEEDED_IRQ_COMMANDS; + } + + /* Init transfer lists */ + int ret = hc_init_transfer_lists(instance); + CHECK_RET_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->frame_list ? EOK : ENOMEM; + CHECK_RET_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 = LINK_POINTER_QH( + addr_to_phys(instance->transfers_interrupt.queue_head)); + + 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"); + + ret = usb_endpoint_manager_init(&instance->ep_manager, + BANDWIDTH_AVAILABLE_USB11); + CHECK_RET_RETURN(ret, "Failed to initialize endpoint manager: %s.\n", + str_error(ret)); + + return EOK; +#undef CHECK_RET_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 SETUP_TRANSFER_LIST(type, name) \ +do { \ + int ret = transfer_list_init(&instance->transfers_##type, name); \ + if (ret != EOK) { \ + usb_log_error("Failed(%d) to setup %s transfer list: %s.\n", \ + ret, name, str_error(ret)); \ + 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; \ + } \ +} while (0) + + SETUP_TRANSFER_LIST(bulk_full, "BULK FULL"); + SETUP_TRANSFER_LIST(control_full, "CONTROL FULL"); + SETUP_TRANSFER_LIST(control_slow, "CONTROL LOW"); + SETUP_TRANSFER_LIST(interrupt, "INTERRUPT"); +#undef SETUP_TRANSFER_LIST + /* Connect lists into one schedule */ + 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, This feature is not needed (adds no benefit) and is supposedly + * buggy on certain hw, enable at your own risk. */ +#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); + + transfer_list_t *list = + instance->transfers[batch->ep->speed][batch->ep->transfer_type]; + assert(list); + 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); + /* Lower 2 bits are transaction error and transaction complete */ + if (status & (UHCI_STATUS_INTERRUPT | UHCI_STATUS_ERROR_INTERRUPT)) { + 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); + usb_transfer_batch_finish(batch); + } + } + /* Resume interrupts are not supported */ + if (status & UHCI_STATUS_RESUME) { + usb_log_error("Resume interrupt!\n"); + } + + /* Bits 4 and 5 indicate hc error */ + if (status & (UHCI_STATUS_PROCESS_ERROR | UHCI_STATUS_SYSTEM_ERROR)) { + 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 = arg; + assert(instance); + + while (1) { + /* Read and clear status register */ + uint16_t status = pio_read_16(&instance->registers->usbsts); + pio_write_16(&instance->registers->usbsts, status); + if (status != 0) + usb_log_debug2("UHCI status: %x.\n", status); +// Qemu fails to report stalled communication +// see https://bugs.launchpad.net/qemu/+bug/757654 +// This is a simple workaround to force queue processing every time + // status |= 1; + hc_interrupt(instance, status); + async_usleep(UHCI_INT_EMULATOR_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 = 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); + } + + const 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", + (void *) frame_list, + (void *) 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", + (void *) expected_pa, frnum, (void *) 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", + (void *) expected_pa, (void *) 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", + (void *) expected_pa, (void *) 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", + (void *) expected_pa, (void *) real_pa); + } + async_usleep(UHCI_DEBUGER_TIMEOUT); + } + return EOK; +#undef QH +} +/** + * @} + */ Index: uspace/drv/uhci-hcd/hc.h =================================================================== --- uspace/drv/uhci-hcd/hc.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/hc.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,160 @@ +/* + * 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_HC_H +#define DRV_UHCI_HC_H + +#include +#include + +#include +#include +#include + +#include "transfer_list.h" + +/** UHCI I/O registers layout */ +typedef struct uhci_regs { + /** Command register, controls HC behaviour */ + 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) + + /** Status register, 1 means interrupt is asserted (if enabled) */ + 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) +#define UHCI_STATUS_NM_INTERRUPTS \ + (UHCI_STATUS_PROCESS_ERROR | UHCI_STATUS_SYSTEM_ERROR) + + /** Interrupt enabled registers */ + 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) + + /** Register stores frame number used in SOF packet */ + uint16_t frnum; + + /** Pointer(physical) to the Frame List */ + uint32_t flbaseadd; + + /** SOF modification to match external timers */ + uint8_t sofmod; +} regs_t; + +#define UHCI_FRAME_LIST_COUNT 1024 +#define UHCI_INT_EMULATOR_TIMEOUT 10000 +#define UHCI_DEBUGER_TIMEOUT 5000000 +#define UHCI_ALLOWED_HW_FAIL 5 +#define UHCI_NEEDED_IRQ_COMMANDS 5 + +/** Main UHCI driver structure */ +typedef struct hc { + /** USB bus driver, devices and addresses */ + usb_device_keeper_t manager; + /** USB bus driver, endpoints */ + usb_endpoint_manager_t ep_manager; + + /** Addresses of I/O registers */ + regs_t *registers; + + /** Frame List contains 1024 link pointers */ + link_pointer_t *frame_list; + + /** List and queue of interrupt transfers */ + transfer_list_t transfers_interrupt; + /** List and queue of low speed control transfers */ + transfer_list_t transfers_control_slow; + /** List and queue of full speed bulk transfers */ + transfer_list_t transfers_bulk_full; + /** List and queue of full speed control transfers */ + transfer_list_t transfers_control_full; + + /** Pointer table to the above lists, helps during scheduling */ + transfer_list_t *transfers[2][4]; + + /** Code to be executed in kernel interrupt handler */ + irq_code_t interrupt_code; + + /** Commands that form interrupt code */ + irq_cmd_t interrupt_commands[UHCI_NEEDED_IRQ_COMMANDS]; + + /** Fibril periodically checking status register*/ + fid_t interrupt_emulator; + + /** Indicator of hw interrupts availability */ + bool hw_interrupts; + + /** Number of hw failures detected. */ + unsigned hw_failures; +} hc_t; + +int hc_init(hc_t *instance, 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) +{ + assert(fun); + return fun->driver_data; +} +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/hw_struct/link_pointer.h =================================================================== --- uspace/drv/uhci-hcd/hw_struct/link_pointer.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/hw_struct/link_pointer.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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_HW_STRUCT_LINK_POINTER_H +#define DRV_UHCI_HW_STRUCT_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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/hw_struct/queue_head.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,100 @@ +/* + * 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_HW_STRUCT_QH_H +#define DRV_UHCI_HW_STRUCT_QH_H +#include + +#include "link_pointer.h" +#include "transfer_descriptor.h" +#include "../utils/malloc32.h" + +/** This structure is defined in UHCI design guide p. 31 */ +typedef struct queue_head { + /** Pointer to the next entity (another QH or TD */ + volatile link_pointer_t next; + /** Pointer to the contained entities (execution controlled by vertical flag*/ + 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] next Address of the next queue. + * + * Adds proper flag. If the pointer is NULL, sets next to terminal NULL. + */ +static inline void qh_set_next_qh(qh_t *instance, qh_t *next) +{ + uint32_t pa = addr_to_phys(next); + if (pa) { + instance->next = LINK_POINTER_QH(pa); + } else { + instance->next = LINK_POINTER_TERM; + } +} +/*----------------------------------------------------------------------------*/ +/** Set queue head element pointer + * + * @param[in] instance qh_t structure to use. + * @param[in] td Transfer descriptor to set as the first element. + * + * Adds proper flag. If the pointer is NULL, sets element to terminal NULL. + */ +static inline void qh_set_element_td(qh_t *instance, td_t *td) +{ + uint32_t pa = addr_to_phys(td); + if (pa) { + 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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 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 transactions 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. If 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(%#" PRIx32 "):%s %d,%s%s%s%s%s%s%s%s%s%s%s %zu.\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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,166 @@ +/* + * 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_HW_STRUCT_TRANSFER_DESCRIPTOR_H +#define DRV_UHCI_HW_STRUCT_TRANSFER_DESCRIPTOR_H + +#include +#include + +#include "link_pointer.h" + +/** Transfer Descriptor, defined in UHCI design guide p. 26 */ +typedef struct transfer_descriptor { + /** Pointer to the next entity (TD or QH) */ + link_pointer_t next; + + /** Status doubleword */ + 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 + + /* double word with USB device specific info */ + 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 + + /** Pointer(physical) to the beginning of the transaction's buffer */ + volatile uint32_t buffer_ptr; + + /* According to UHCI design guide, there is 16 bytes of + * data available here. + * 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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/iface.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,404 @@ +/* + * 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 + +#include "iface.h" +#include "batch.h" +#include "hc.h" + +static inline int setup_batch( + ddf_fun_t *fun, usb_target_t target, usb_direction_t direction, + void *data, size_t size, void * setup_data, size_t setup_size, + usbhc_iface_transfer_in_callback_t in, + usbhc_iface_transfer_out_callback_t out, void *arg, const char* name, + hc_t **hc, usb_transfer_batch_t **batch) +{ + assert(hc); + assert(batch); + assert(fun); + *hc = fun_to_hc(fun); + assert(*hc); + + size_t res_bw; + endpoint_t *ep = usb_endpoint_manager_get_ep(&(*hc)->ep_manager, + target.address, target.endpoint, direction, &res_bw); + if (ep == NULL) { + usb_log_error("Endpoint(%d:%d) not registered for %s.\n", + target.address, target.endpoint, name); + return ENOENT; + } + + usb_log_debug("%s %d:%d %zu(%zu).\n", + name, target.address, target.endpoint, size, ep->max_packet_size); + + const size_t bw = bandwidth_count_usb11( + ep->speed, ep->transfer_type, size, ep->max_packet_size); + if (res_bw < bw) { + usb_log_error("Endpoint(%d:%d) %s needs %zu bw " + "but only %zu is reserved.\n", + target.address, target.endpoint, name, bw, res_bw); + return ENOSPC; + } + + *batch = batch_get( + fun, ep, data, size, setup_data, setup_size, in, out, arg); + if (!*batch) + return ENOMEM; + 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-%" PRIun ".\n", address, handle); + usb_device_keeper_bind(&hc->manager, address, handle); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Find device handle by address interface function. + * + * @param[in] fun DDF function that was called. + * @param[in] address Address in question. + * @param[out] handle Where to store device handle if found. + * @return Error code. + */ +static int find_by_address(ddf_fun_t *fun, usb_address_t address, + devman_handle_t *handle) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + const bool found = + usb_device_keeper_find_by_address(&hc->manager, address, handle); + return found ? EOK : ENOENT; +} +/*----------------------------------------------------------------------------*/ +/** 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; +} +/*----------------------------------------------------------------------------*/ +static int register_endpoint( + ddf_fun_t *fun, usb_address_t address, usb_speed_t ep_speed, + usb_endpoint_t endpoint, + usb_transfer_type_t transfer_type, usb_direction_t direction, + size_t max_packet_size, unsigned int interval) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + const size_t size = max_packet_size; + usb_speed_t speed = usb_device_keeper_get_speed(&hc->manager, address); + if (speed >= USB_SPEED_MAX) { + speed = ep_speed; + } + usb_log_debug("Register endpoint %d:%d %s %s(%d) %zu(%zu) %u.\n", + address, endpoint, usb_str_transfer_type(transfer_type), + usb_str_speed(speed), direction, size, max_packet_size, interval); + + return usb_endpoint_manager_add_ep(&hc->ep_manager, address, endpoint, + direction, transfer_type, speed, max_packet_size, size); +} +/*----------------------------------------------------------------------------*/ +static int unregister_endpoint( + ddf_fun_t *fun, usb_address_t address, + usb_endpoint_t endpoint, usb_direction_t direction) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_log_debug("Unregister endpoint %d:%d %d.\n", + address, endpoint, direction); + return usb_endpoint_manager_unregister_ep(&hc->ep_manager, address, + endpoint, direction); +} +/*----------------------------------------------------------------------------*/ +/** Interrupt out transaction interface function + * + * @param[in] fun DDF function that was called. + * @param[in] target USB device to write to. + * @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, void *data, + size_t size, usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + usb_transfer_batch_t *batch = NULL; + hc_t *hc = NULL; + int ret = setup_batch(fun, target, USB_DIRECTION_OUT, data, size, + NULL, 0, NULL, callback, arg, "Interrupt OUT", &hc, &batch); + if (ret != EOK) + return ret; + assert(batch); + assert(hc); + batch_interrupt_out(batch); + ret = hc_schedule(hc, batch); + if (ret != EOK) { + usb_transfer_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[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, void *data, + size_t size, usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + usb_transfer_batch_t *batch = NULL; + hc_t *hc = NULL; + int ret = setup_batch(fun, target, USB_DIRECTION_IN, data, size, + NULL, 0, callback, NULL, arg, "Interrupt IN", &hc, &batch); + if (ret != EOK) + return ret; + assert(batch); + assert(hc); + batch_interrupt_in(batch); + ret = hc_schedule(hc, batch); + if (ret != EOK) { + usb_transfer_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] 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, void *data, + size_t size, usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + usb_transfer_batch_t *batch = NULL; + hc_t *hc = NULL; + int ret = setup_batch(fun, target, USB_DIRECTION_OUT, data, size, + NULL, 0, NULL, callback, arg, "Bulk OUT", &hc, &batch); + if (ret != EOK) + return ret; + assert(batch); + assert(hc); + batch_bulk_out(batch); + ret = hc_schedule(hc, batch); + if (ret != EOK) { + usb_transfer_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[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, void *data, + size_t size, usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + usb_transfer_batch_t *batch = NULL; + hc_t *hc = NULL; + int ret = setup_batch(fun, target, USB_DIRECTION_IN, data, size, + NULL, 0, callback, NULL, arg, "Bulk IN", &hc, &batch); + if (ret != EOK) + return ret; + assert(batch); + assert(hc); + batch_bulk_in(batch); + ret = hc_schedule(hc, batch); + if (ret != EOK) { + usb_transfer_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] 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, + void *setup_data, size_t setup_size, void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + usb_transfer_batch_t *batch = NULL; + hc_t *hc = NULL; + int ret = setup_batch(fun, target, USB_DIRECTION_BOTH, data, size, + setup_data, setup_size, NULL, callback, arg, "Control WRITE", + &hc, &batch); + if (ret != EOK) + return ret; + assert(batch); + assert(hc); + usb_endpoint_manager_reset_if_need(&hc->ep_manager, target, setup_data); + batch_control_write(batch); + ret = hc_schedule(hc, batch); + if (ret != EOK) { + usb_transfer_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] 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, + void *setup_data, size_t setup_size, void *data, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + usb_transfer_batch_t *batch = NULL; + hc_t *hc = NULL; + int ret = setup_batch(fun, target, USB_DIRECTION_BOTH, data, size, + setup_data, setup_size, callback, NULL, arg, "Control READ", + &hc, &batch); + if (ret != EOK) + return ret; + assert(batch); + assert(hc); + batch_control_read(batch); + ret = hc_schedule(hc, batch); + if (ret != EOK) { + usb_transfer_batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +usbhc_iface_t hc_iface = { + .request_address = request_address, + .bind_address = bind_address, + .find_by_address = find_by_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/uhci-hcd/iface.h =================================================================== --- uspace/drv/uhci-hcd/iface.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/iface.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/main.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,94 @@ +/* + * 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 "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_debug2("uhci_add_device() called\n"); + assert(device); + + int ret = device_setup_uhci(device); + if (ret != EOK) { + usb_log_error("Failed to initialize UHCI driver: %s.\n", + str_error(ret)); + return ret; + } + usb_log_info("Controlling new UHCI device '%s'.\n", device->name); + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Initialize global driver structures (NONE). + * + * @param[in] argc Number 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"); + 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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/pci.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,166 @@ +/* + * 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 I/O 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(const ddf_dev_t *dev, + uintptr_t *io_reg_address, size_t *io_reg_size, int *irq_no) +{ + assert(dev); + assert(io_reg_address); + assert(io_reg_size); + assert(irq_no); + + int parent_phone = + devman_parent_device_connect(dev->handle, IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + + hw_resource_list_t hw_resources; + int rc = hw_res_get_resource_list(parent_phone, &hw_resources); + if (rc != EOK) { + async_hangup(parent_phone); + return rc; + } + + 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++) { + const 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: %" PRIx64" %zu.\n", + res->res.io_range.address, res->res.io_range.size); + io_found = true; + break; + + default: + break; + } + } + async_hangup(parent_phone); + + if (!io_found || !irq_found) + return ENOENT; + + *io_reg_address = io_address; + *io_reg_size = io_size; + *irq_no = irq; + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Call the PCI driver with a request to enable interrupts + * + * @param[in] device Device asking for interrupts + * @return Error code. + */ +int pci_enable_interrupts(const ddf_dev_t *device) +{ + const int parent_phone = + devman_parent_device_connect(device->handle, IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + const 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(const ddf_dev_t *device) +{ + assert(device); + const 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 p.45, + * write all WC bits in USB legacy register */ + const sysarg_t address = 0xc0; + const sysarg_t value = 0xaf00; + + const 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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/pci.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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(const ddf_dev_t *, uintptr_t *, size_t *, int *); +int pci_enable_interrupts(const ddf_dev_t *); +int pci_disable_legacy(const ddf_dev_t *); + +#endif +/** + * @} + */ + Index: uspace/drv/uhci-hcd/root_hub.c =================================================================== --- uspace/drv/uhci-hcd/root_hub.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/root_hub.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 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(%d) to create root hub match string: %s.\n", + ret, str_error(ret)); + return ret; + } + assert(match_str); + + ret = ddf_fun_add_match_id(fun, match_str, 100); + if (ret != EOK) { + free(match_str); + usb_log_error("Failed(%d) to add root hub match id: %s\n", + ret, str_error(ret)); + return ret; + } + + /* Initialize resource structure */ + instance->resource_list.count = 1; + instance->resource_list.resources = &instance->io_regs; + + 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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/root_hub.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,55 @@ +/* + * 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_RH_H +#define DRV_UHCI_RH_H + +#include +#include + +/** DDF support structure for uhci-rhd driver, provides I/O resources */ +typedef struct rh { + /** List of resources available to the root hub. */ + hw_resource_list_t resource_list; + /** The only resource in the RH 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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/transfer_list.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,241 @@ +/* + * 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 + + +#include "transfer_list.h" +#include "batch.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; + } + const uint32_t queue_head_pa = addr_to_phys(instance->queue_head); + usb_log_debug2("Transfer list %s setup with QH: %p (%#" PRIx32" ).\n", + name, instance->queue_head, queue_head_pa); + + qh_init(instance->queue_head); + list_initialize(&instance->batch_list); + fibril_mutex_initialize(&instance->guard); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Dispose transfer list structures. + * + * @param[in] instance Memory place to use. + * + * Frees memory of the internal qh_t structure. + */ +void transfer_list_fini(transfer_list_t *instance) +{ + assert(instance); + free32(instance->queue_head); +} +/** 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(instance->queue_head); + assert(next); + /* Set queue_head.next to point to the follower */ + qh_set_next_qh(instance->queue_head, next->queue_head); +} +/*----------------------------------------------------------------------------*/ +/** Add transfer batch to the list and queue. + * + * @param[in] instance List to use. + * @param[in] batch Transfer batch to submit. + * + * 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 = + usb_transfer_batch_from_link(instance->batch_list.prev); + last_qh = batch_qh(last); + } + const uint32_t pa = addr_to_phys(batch_qh(batch)); + assert((pa & LINK_POINTER_ADDRESS_MASK) == pa); + + /* Make sure all data in the batch are written */ + write_barrier(); + + /* keep link */ + batch_qh(batch)->next = last_qh->next; + qh_set_next_qh(last_qh, batch_qh(batch)); + + /* Make sure the pointer is updated */ + write_barrier(); + + /* Add to the driver's 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); +} +/*----------------------------------------------------------------------------*/ +/** Add completed bantches to the provided list. + * + * @param[in] instance List to use. + * @param[in] done list to fill + */ +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 * const next = current->next; + usb_transfer_batch_t *batch = + usb_transfer_batch_from_link(current); + + if (batch_is_complete(batch)) { + /* Save for processing */ + transfer_list_remove_batch(instance, batch); + list_append(current, done); + } + current = next; + } + fibril_mutex_unlock(&instance->guard); +} +/*----------------------------------------------------------------------------*/ +/** Walk the list and finish all batches with EINTR. + * + * @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 * const current = instance->batch_list.next; + usb_transfer_batch_t *batch = + usb_transfer_batch_from_link(current); + transfer_list_remove_batch(instance, batch); + usb_transfer_batch_finish_error(batch, EINTR); + } + 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. + * + * 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; + qh_t *prev_qh = NULL; + /* Remove from the hardware queue */ + if (instance->batch_list.next == &batch->link) { + /* I'm the first one here */ + prev_qh = instance->queue_head; + qpos = "FIRST"; + } else { + /* The thing before me is a batch too */ + usb_transfer_batch_t *prev = + usb_transfer_batch_from_link(batch->link.prev); + prev_qh = batch_qh(prev); + qpos = "NOT FIRST"; + } + assert((prev_qh->next & LINK_POINTER_ADDRESS_MASK) + == addr_to_phys(batch_qh(batch))); + prev_qh->next = batch_qh(batch)->next; + + /* Make sure the pointer is updated */ + write_barrier(); + + /* 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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/transfer_list.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,66 @@ +/* + * 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 + +#include "hw_struct/queue_head.h" + +/** Structure maintaining both hw queue and software list + * of currently executed transfers + */ +typedef struct transfer_list { + /** Guard against multiple add/remove races */ + fibril_mutex_t guard; + /** UHCI hw structure represeting this queue */ + qh_t *queue_head; + /** Assigned name, for nicer debug output */ + const char *name; + /** List of all batches in this list */ + link_t batch_list; +} transfer_list_t; + +void transfer_list_fini(transfer_list_t *instance); +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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/transfers.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/uhci-hcd.ma (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,25 @@ +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 + +10 pci/ven=8086&dev=24c2 +10 pci/ven=8086&dev=24c4 +10 pci/ven=8086&dev=24c7 Index: uspace/drv/uhci-hcd/uhci.c =================================================================== --- uspace/drv/uhci-hcd/uhci.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/uhci.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,286 @@ +/* + * 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" + +#include "hc.h" +#include "root_hub.h" + +/** Structure representing both functions of UHCI hc, USB host controller + * and USB root hub */ +typedef struct uhci { + /** Pointer to DDF represenation of UHCI host controller */ + ddf_fun_t *hc_fun; + /** Pointer to DDF represenation of UHCI root hub */ + ddf_fun_t *rh_fun; + + /** Internal driver's represenation of UHCI host controller */ + hc_t hc; + /** Internal driver's represenation of UHCI root hub */ + rh_t rh; +} uhci_t; + +static inline uhci_t * dev_to_uhci(const ddf_dev_t *dev) +{ + assert(dev); + assert(dev->driver_data); + return dev->driver_data; +} +/*----------------------------------------------------------------------------*/ +/** IRQ handling callback, forward status from call to diver structure. + * + * @param[in] dev DDF instance of the device to use. + * @param[in] iid (Unused). + * @param[in] call Pointer to the call from kernel. + */ +static void irq_handler(ddf_dev_t *dev, ipc_callid_t iid, ipc_call_t *call) +{ + assert(dev); + uhci_t *uhci = dev_to_uhci(dev); + hc_t *hc = &uhci->hc; + const uint16_t status = IPC_GET_ARG1(*call); + assert(hc); + hc_interrupt(hc, status); +} +/*----------------------------------------------------------------------------*/ +/** Operations supported by the HC driver */ +static ddf_dev_ops_t hc_ops = { + .interfaces[USBHC_DEV_IFACE] = &hc_iface, /* see iface.h/c */ +}; +/*----------------------------------------------------------------------------*/ +/** Get address of the device identified by handle. + * + * @param[in] fun DDF instance of the function to use. + * @param[in] handle DDF handle of the driver seeking its USB address. + * @param[out] address Found address. + */ +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 = &dev_to_uhci(fun->dev)->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. + * + * @param[in] fun DDF function of uhci device. + * @param[out] handle Host cotnroller handle. + * @return Error code. + */ +static int usb_iface_get_hc_handle(ddf_fun_t *fun, devman_handle_t *handle) +{ + assert(fun); + ddf_fun_t *hc_fun = dev_to_uhci(fun->dev)->hc_fun; + assert(hc_fun); + + if (handle != NULL) + *handle = hc_fun->handle; + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** USB interface implementation used by RH */ +static usb_iface_t usb_iface = { + .get_hc_handle = usb_iface_get_hc_handle, + .get_address = usb_iface_get_address +}; +/*----------------------------------------------------------------------------*/ +/** 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); + rh_t *rh = fun->driver_data; + assert(rh); + return &rh->resource_list; +} +/*----------------------------------------------------------------------------*/ +/** Interface to provide the root hub driver with hw info */ +static hw_res_ops_t hw_res_iface = { + .get_resource_list = get_resource_list, + .enable_interrupt = NULL, +}; +/*----------------------------------------------------------------------------*/ +/** RH function support for uhci-rhd */ +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] device DDF instance of the device to use. + * + * This function does all the preparatory work for hc and rh drivers: + * - gets device's hw resources + * - disables UHCI legacy support (PCI config space) + * - attempts to enable interrupts + * - registers interrupt handler + */ +int device_setup_uhci(ddf_dev_t *device) +{ + assert(device); + uhci_t *instance = malloc(sizeof(uhci_t)); + if (instance == NULL) { + usb_log_error("Failed to allocate OHCI driver.\n"); + return ENOMEM; + } + +#define CHECK_RET_DEST_FREE_RETURN(ret, message...) \ +if (ret != EOK) { \ + if (instance->hc_fun) \ + instance->hc_fun->ops = NULL; \ + instance->hc_fun->driver_data = NULL; \ + ddf_fun_destroy(instance->hc_fun); \ + if (instance->rh_fun) {\ + instance->rh_fun->ops = NULL; \ + instance->rh_fun->driver_data = NULL; \ + ddf_fun_destroy(instance->rh_fun); \ + } \ + free(instance); \ + usb_log_error(message); \ + return ret; \ +} else (void)0 + + instance->rh_fun = NULL; + instance->hc_fun = ddf_fun_create(device, fun_exposed, "uhci-hc"); + int ret = (instance->hc_fun == NULL) ? ENOMEM : EOK; + CHECK_RET_DEST_FREE_RETURN(ret, "Failed to create UHCI HC function.\n"); + instance->hc_fun->ops = &hc_ops; + instance->hc_fun->driver_data = &instance->hc; + + instance->rh_fun = ddf_fun_create(device, fun_inner, "uhci-rh"); + ret = (instance->rh_fun == NULL) ? ENOMEM : EOK; + CHECK_RET_DEST_FREE_RETURN(ret, "Failed to create UHCI RH function.\n"); + instance->rh_fun->ops = &rh_ops; + instance->rh_fun->driver_data = &instance->rh; + + uintptr_t reg_base = 0; + size_t reg_size = 0; + int irq = 0; + + ret = pci_get_my_registers(device, ®_base, ®_size, &irq); + CHECK_RET_DEST_FREE_RETURN(ret, + "Failed to get I/O addresses for %" PRIun ": %s.\n", + device->handle, str_error(ret)); + usb_log_debug("I/O regs at 0x%p (size %zu), IRQ %d.\n", + (void *) reg_base, reg_size, irq); + + ret = pci_disable_legacy(device); + CHECK_RET_DEST_FREE_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 + + + ret = hc_init(&instance->hc, (void*)reg_base, reg_size, interrupts); + CHECK_RET_DEST_FREE_RETURN(ret, + "Failed(%d) to init uhci-hcd: %s.\n", ret, str_error(ret)); + +#define CHECK_RET_FINI_RETURN(ret, message...) \ +if (ret != EOK) { \ + hc_fini(&instance->hc); \ + CHECK_RET_DEST_FREE_RETURN(ret, message); \ + return ret; \ +} else (void)0 + + /* 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: %s.\n", + ret, str_error(ret)); + + ret = ddf_fun_bind(instance->hc_fun); + CHECK_RET_FINI_RETURN(ret, + "Failed(%d) to bind UHCI device function: %s.\n", + ret, str_error(ret)); + + ret = ddf_fun_add_to_class(instance->hc_fun, USB_HC_DDF_CLASS_NAME); + CHECK_RET_FINI_RETURN(ret, + "Failed to add UHCI to HC class: %s.\n", str_error(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: %s.\n", ret, str_error(ret)); + + ret = ddf_fun_bind(instance->rh_fun); + CHECK_RET_FINI_RETURN(ret, + "Failed(%d) to register UHCI root hub: %s.\n", ret, str_error(ret)); + + device->driver_data = instance; + return EOK; +#undef CHECK_RET_FINI_RETURN +} +/** + * @} + */ Index: uspace/drv/uhci-hcd/uhci.h =================================================================== --- uspace/drv/uhci-hcd/uhci.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/uhci.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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. + */ + +/** @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 + +int device_setup_uhci(ddf_dev_t *device); +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/utils/malloc32.h =================================================================== --- uspace/drv/uhci-hcd/utils/malloc32.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-hcd/utils/malloc32.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,114 @@ +/* + * 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 drvusbuhci + * @{ + */ +/** @file + * @brief UHCI driver + */ +#ifndef DRV_UHCI_UTILS_MALLOC32_H +#define DRV_UHCI_UTILS_MALLOC32_H + +#include +#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) +{ + if (addr == NULL) + return 0; + + uintptr_t result; + const 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) { + /* This works only when the host has less than 4GB of memory as + * physical address needs to fit into 32 bits */ + + /* If we need more than one page there is no guarantee that the + * memory will be continuous */ + if (size > PAGE_SIZE) + return NULL; + /* Calculate alignment to make sure the block won't cross page + * boundary */ + size_t alignment = UHCI_STRCUTURES_ALIGNMENT; + while (alignment < size) + alignment *= 2; + return memalign(alignment, size); +} +/*----------------------------------------------------------------------------*/ +/** Physical mallocator simulator + * + * @param[in] addr Address of the place allocated by malloc32 + */ +static inline void free32(void *addr) { + if (!addr) + return; + 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); + 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-rhd/Makefile =================================================================== --- uspace/drv/uhci-rhd/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-rhd/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,47 @@ +# +# 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 = \ + $(LIBUSBDEV_PREFIX)/libusbdev.a \ + $(LIBUSB_PREFIX)/libusb.a \ + $(LIBDRV_PREFIX)/libdrv.a +EXTRA_CFLAGS += \ + -I$(LIBUSB_PREFIX)/include \ + -I$(LIBUSBDEV_PREFIX)/include \ + -I$(LIBDRV_PREFIX)/include + +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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-rhd/main.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,178 @@ +/* + * 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 initialization routines + */ +#include +#include +#include +#include +#include + +#include +#include +#include + +#include "root_hub.h" + +#define NAME "uhci-rhd" + +static int hc_get_my_registers(const ddf_dev_t *dev, + uintptr_t *io_reg_address, size_t *io_reg_size); +/*----------------------------------------------------------------------------*/ +static int uhci_rh_add_device(ddf_dev_t *device); +/*----------------------------------------------------------------------------*/ +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); +} +/*----------------------------------------------------------------------------*/ +/** 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 EINVAL; + + usb_log_debug2("uhci_rh_add_device(handle=%" PRIun ")\n", + device->handle); + + uintptr_t io_regs = 0; + size_t io_size = 0; + uhci_root_hub_t *rh = NULL; + int ret = EOK; + +#define CHECK_RET_FREE_RH_RETURN(ret, message...) \ +if (ret != EOK) { \ + usb_log_error(message); \ + if (rh) \ + free(rh); \ + return ret; \ +} else (void)0 + + ret = hc_get_my_registers(device, &io_regs, &io_size); + CHECK_RET_FREE_RH_RETURN(ret, + "Failed to get registers from HC: %s.\n", str_error(ret)); + usb_log_debug("I/O regs at %p (size %zuB).\n", + (void *) io_regs, io_size); + + rh = malloc(sizeof(uhci_root_hub_t)); + ret = (rh == NULL) ? ENOMEM : EOK; + CHECK_RET_FREE_RH_RETURN(ret, + "Failed to allocate rh driver instance.\n"); + + ret = uhci_root_hub_init(rh, (void*)io_regs, io_size, device); + CHECK_RET_FREE_RH_RETURN(ret, + "Failed(%d) to initialize rh driver instance: %s.\n", + ret, str_error(ret)); + + device->driver_data = rh; + usb_log_info("Controlling root hub '%s' (%" PRIun ").\n", + device->name, device->handle); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** 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( + const ddf_dev_t *dev, uintptr_t *io_reg_address, size_t *io_reg_size) +{ + assert(dev); + + const int parent_phone = devman_parent_device_connect(dev->handle, + IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + + hw_resource_list_t hw_resources; + const int ret = hw_res_get_resource_list(parent_phone, &hw_resources); + if (ret != EOK) { + async_hangup(parent_phone); + return ret; + } + + uintptr_t io_address = 0; + size_t io_size = 0; + bool io_found = false; + + size_t i = 0; + for (; i < hw_resources.count; i++) { + hw_resource_t *res = &hw_resources.resources[i]; + if (res->type == IO_RANGE) { + io_address = res->res.io_range.address; + io_size = res->res.io_range.size; + io_found = true; + } + } + async_hangup(parent_phone); + + if (!io_found) { + return ENOENT; + } + if (io_reg_address != NULL) { + *io_reg_address = io_address; + } + if (io_reg_size != NULL) { + *io_reg_size = io_size; + } + return EOK; +} +/** + * @} + */ Index: uspace/drv/uhci-rhd/port.c =================================================================== --- uspace/drv/uhci-rhd/port.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-rhd/port.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,355 @@ +/* + * 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 /* async_usleep */ +#include +#include +#include + +#include /* usb_address_t */ +#include /* usb_hc_new_device_wrapper */ +#include + +#include "port.h" + +static int uhci_port_check(void *port); +static int uhci_port_reset_enable(int portno, void *arg); +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 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] val New register value. + * @return Error code. (Always EOK) + */ +static inline void uhci_port_write_status(uhci_port_t *port, port_status_t val) +{ + assert(port); + pio_write_16(port->address, val); +} +/*----------------------------------------------------------------------------*/ +/** Initialize UHCI root hub port instance. + * + * @param[in] port Memory structure to use. + * @param[in] address Address of I/O register. + * @param[in] number Port number. + * @param[in] usec Polling interval. + * @param[in] rh Pointer to ddf instance of 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); + char *id_string; + asprintf(&id_string, "Port (%p - %u)", port, number); + if (id_string == NULL) { + return ENOMEM; + } + + port->id_string = id_string; + port->address = address; + port->number = number; + port->wait_period_usec = usec; + port->attached_device = 0; + port->rh = rh; + + int ret = + usb_hc_connection_initialize_from_device(&port->hc_connection, rh); + if (ret != EOK) { + usb_log_error("%s: failed to initialize connection to HC.", + port->id_string); + free(id_string); + return ret; + } + + port->checker = fibril_create(uhci_port_check, port); + if (port->checker == 0) { + usb_log_error("%s: failed to create polling fibril.", + port->id_string); + free(id_string); + return ENOMEM; + } + + fibril_add_ready(port->checker); + usb_log_debug("%s: Started polling fibril (%" PRIun ").\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 */ + const 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); + + /* Remove any old device */ + if (instance->attached_device) { + usb_log_debug2("%s: Removing device.\n", + instance->id_string); + uhci_port_remove_device(instance); + } + + int ret = + usb_hc_connection_open(&instance->hc_connection); + if (ret != EOK) { + usb_log_error("%s: Failed to connect to HC.", + instance->id_string); + continue; + } + + 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); + } + + ret = usb_hc_connection_close(&instance->hc_connection); + if (ret != 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 = arg; + assert(port); + + usb_log_debug2("%s: new_device_enable_port.\n", port->id_string); + + /* + * Resets from root ports should be nominally 50ms (USB spec 7.1.7.3) + */ + { + 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); + while (uhci_port_read_status(port) & STATUS_IN_RESET); + } + /* PIO delay, should not be longer than 3ms as the device might + * enter suspend state. */ + udelay(10); + /* 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); + + int ret, count = 0; + usb_address_t dev_addr; + do { + ret = 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); + } while (ret != EOK && ++count < 4); + + if (ret != EOK) { + usb_log_error("%s: Failed(%d) to add device: %s.\n", + port->id_string, ret, str_error(ret)); + uhci_port_set_enabled(port, false); + return ret; + } + + usb_log_info("New device at port %u, address %d (handle %" PRIun ").\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 %" PRIun ".\n", + port->id_string, port->attached_device); + port->attached_device = 0; + return ENOTSUP; +} +/*----------------------------------------------------------------------------*/ +/** 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); + + /* Wait for port to become enabled */ + do { + port_status = uhci_port_read_status(port); + } while ((port_status & STATUS_CONNECTED) && + !(port_status & STATUS_ENABLED)); + + 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" : " ERR: NO ALWAYS ONE" + ); +} +/** + * @} + */ Index: uspace/drv/uhci-rhd/port.h =================================================================== --- uspace/drv/uhci-rhd/port.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-rhd/port.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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) + +/** UHCI port structure */ +typedef struct uhci_port { + const 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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-rhd/root_hub.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,97 @@ +/* + * 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 + +#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); + + /* Allow access to root hub port registers */ + assert(sizeof(port_status_t) * UHCI_ROOT_HUB_PORT_COUNT <= size); + port_status_t *regs; + int ret = pio_enable(addr, size, (void**)®s); + if (ret < 0) { + usb_log_error( + "Failed(%d) to gain access to port registers at %p: %s.\n", + ret, regs, str_error(ret)); + return ret; + } + + /* Initialize root hub ports */ + unsigned i = 0; + for (; i < UHCI_ROOT_HUB_PORT_COUNT; ++i) { + ret = uhci_port_init( + &instance->ports[i], ®s[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. + */ +void 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]); + } +} +/*----------------------------------------------------------------------------*/ +/** + * @} + */ Index: uspace/drv/uhci-rhd/root_hub.h =================================================================== --- uspace/drv/uhci-rhd/root_hub.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-rhd/root_hub.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,57 @@ +/* + * 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 250000 /* 250 miliseconds */ + +/** UHCI root hub drvier structure */ +typedef struct root_hub { + /** Ports provided by the hub */ + uhci_port_t ports[UHCI_ROOT_HUB_PORT_COUNT]; +} uhci_root_hub_t; + +int uhci_root_hub_init( + uhci_root_hub_t *instance, void *addr, size_t size, ddf_dev_t *rh); + +void 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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/uhci-rhd/uhci-rhd.ma (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,1 @@ +10 usb&uhci&root-hub Index: uspace/drv/usbflbk/Makefile =================================================================== --- uspace/drv/usbflbk/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbflbk/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,45 @@ +# +# 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 = \ + $(LIBUSBDEV_PREFIX)/libusbdev.a \ + $(LIBUSB_PREFIX)/libusb.a \ + $(LIBDRV_PREFIX)/libdrv.a +EXTRA_CFLAGS += \ + -I$(LIBUSB_PREFIX)/include \ + -I$(LIBUSBDEV_PREFIX)/include \ + -I$(LIBDRV_PREFIX)/include + +BINARY = usbflbk + +SOURCES = \ + main.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/usbflbk/main.c =================================================================== --- uspace/drv/usbflbk/main.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbflbk/main.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 %" PRIun ").\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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbflbk/usbflbk.ma (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,2 @@ +10 usb&fallback +10 usb&interface&fallback Index: uspace/drv/usbhid/Makefile =================================================================== --- uspace/drv/usbhid/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,70 @@ +# +# 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 = \ + $(LIBUSBHID_PREFIX)/libusbhid.a \ + $(LIBUSBDEV_PREFIX)/libusbdev.a \ + $(LIBUSB_PREFIX)/libusb.a \ + $(LIBDRV_PREFIX)/libdrv.a +EXTRA_CFLAGS += \ + -I. \ + -I$(LIBUSB_PREFIX)/include \ + -I$(LIBUSBDEV_PREFIX)/include \ + -I$(LIBUSBHID_PREFIX)/include \ + -I$(LIBDRV_PREFIX)/include + +BINARY = usbhid + +STOLEN_LAYOUT_SOURCES = \ + kbd/layout/us_qwerty.c \ + kbd/layout/us_dvorak.c \ + kbd/layout/cz.c + +SOURCES = \ + main.c \ + usbhid.c \ + subdrivers.c \ + kbd/conv.c \ + kbd/kbddev.c \ + kbd/kbdrepeat.c \ + generic/hiddev.c \ + mouse/mousedev.c \ + multimedia/multimedia.c \ + multimedia/keymap.c \ + $(STOLEN_LAYOUT_SOURCES) + +EXTRA_CLEAN = $(STOLEN_LAYOUT_SOURCES) + +SRV_KBD = $(USPACE_PREFIX)/srv/hid/kbd + +include $(USPACE_PREFIX)/Makefile.common + +kbd/layout/%.c: $(SRV_KBD)/layout/%.c + ln -sfn ../../$< $@ Index: uspace/drv/usbhid/generic/hiddev.c =================================================================== --- uspace/drv/usbhid/generic/hiddev.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/generic/hiddev.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,244 @@ +/* + * 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 driver API. + */ + +#include +#include +#include +#include +#include + +#include + +#include "hiddev.h" +#include "usbhid.h" + +/*----------------------------------------------------------------------------*/ + +usb_endpoint_description_t usb_hid_generic_poll_endpoint_description = { + .transfer_type = USB_TRANSFER_INTERRUPT, + .direction = USB_DIRECTION_IN, + .interface_class = USB_CLASS_HID, + .flags = 0 +}; + +const char *HID_GENERIC_FUN_NAME = "hid"; +const char *HID_GENERIC_CLASS_NAME = "hid"; + +/*----------------------------------------------------------------------------*/ + +static size_t usb_generic_hid_get_event_length(ddf_fun_t *fun); + +static int usb_generic_hid_get_event(ddf_fun_t *fun, uint8_t *buffer, + size_t size, size_t *act_size, int *event_nr, unsigned int flags); + +static int usb_generic_hid_client_connected(ddf_fun_t *fun); + +static size_t usb_generic_get_report_descriptor_length(ddf_fun_t *fun); + +static int usb_generic_get_report_descriptor(ddf_fun_t *fun, uint8_t *desc, + size_t size, size_t *actual_size); + +/*----------------------------------------------------------------------------*/ + +static usbhid_iface_t usb_generic_iface = { + .get_event = usb_generic_hid_get_event, + .get_event_length = usb_generic_hid_get_event_length, + .get_report_descriptor_length = usb_generic_get_report_descriptor_length, + .get_report_descriptor = usb_generic_get_report_descriptor +}; + +static ddf_dev_ops_t usb_generic_hid_ops = { + .interfaces[USBHID_DEV_IFACE] = &usb_generic_iface, + .open = usb_generic_hid_client_connected +}; + +/*----------------------------------------------------------------------------*/ + +static size_t usb_generic_hid_get_event_length(ddf_fun_t *fun) +{ + usb_log_debug2("Generic HID: Get event length (fun: %p, " + "fun->driver_data: %p.\n", fun, fun->driver_data); + + if (fun == NULL || fun->driver_data == NULL) { + return 0; + } + + usb_hid_dev_t *hid_dev = (usb_hid_dev_t *)fun->driver_data; + + usb_log_debug2("hid_dev: %p, Max input report size (%zu).\n", + hid_dev, hid_dev->max_input_report_size); + + return hid_dev->max_input_report_size; +} + +/*----------------------------------------------------------------------------*/ + +static int usb_generic_hid_get_event(ddf_fun_t *fun, uint8_t *buffer, + size_t size, size_t *act_size, int *event_nr, unsigned int flags) +{ + usb_log_debug2("Generic HID: Get event.\n"); + + if (fun == NULL || fun->driver_data == NULL || buffer == NULL + || act_size == NULL || event_nr == NULL) { + usb_log_debug("No function"); + return EINVAL; + } + + usb_hid_dev_t *hid_dev = (usb_hid_dev_t *)fun->driver_data; + + if (hid_dev->input_report_size > size) { + usb_log_debug("input_report_size > size (%zu, %zu)\n", + hid_dev->input_report_size, size); + return EINVAL; // TODO: other error code + } + + /*! @todo This should probably be somehow atomic. */ + memcpy(buffer, hid_dev->input_report, + hid_dev->input_report_size); + *act_size = hid_dev->input_report_size; + *event_nr = usb_hid_report_number(hid_dev); + + usb_log_debug2("OK\n"); + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +static size_t usb_generic_get_report_descriptor_length(ddf_fun_t *fun) +{ + usb_log_debug("Generic HID: Get report descriptor length.\n"); + + if (fun == NULL || fun->driver_data == NULL) { + usb_log_debug("No function"); + return EINVAL; + } + + usb_hid_dev_t *hid_dev = (usb_hid_dev_t *)fun->driver_data; + + usb_log_debug2("hid_dev->report_desc_size = %zu\n", + hid_dev->report_desc_size); + + return hid_dev->report_desc_size; +} + +/*----------------------------------------------------------------------------*/ + +static int usb_generic_get_report_descriptor(ddf_fun_t *fun, uint8_t *desc, + size_t size, size_t *actual_size) +{ + usb_log_debug2("Generic HID: Get report descriptor.\n"); + + if (fun == NULL || fun->driver_data == NULL) { + usb_log_debug("No function"); + return EINVAL; + } + + usb_hid_dev_t *hid_dev = (usb_hid_dev_t *)fun->driver_data; + + if (hid_dev->report_desc_size > size) { + return EINVAL; + } + + memcpy(desc, hid_dev->report_desc, hid_dev->report_desc_size); + *actual_size = hid_dev->report_desc_size; + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +static int usb_generic_hid_client_connected(ddf_fun_t *fun) +{ + usb_log_debug("Generic HID: Client connected.\n"); + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +static int usb_generic_hid_create_function(usb_hid_dev_t *hid_dev) +{ + /* Create the function exposed under /dev/devices. */ + /** @todo Generate numbers for the devices? */ + usb_log_debug("Creating DDF function %s...\n", HID_GENERIC_FUN_NAME); + ddf_fun_t *fun = ddf_fun_create(hid_dev->usb_dev->ddf_dev, fun_exposed, + HID_GENERIC_FUN_NAME); + if (fun == NULL) { + usb_log_error("Could not create DDF function node.\n"); + return ENOMEM; + } + + fun->ops = &usb_generic_hid_ops; + fun->driver_data = hid_dev; + + int rc = ddf_fun_bind(fun); + if (rc != EOK) { + usb_log_error("Could not bind DDF function: %s.\n", + str_error(rc)); + ddf_fun_destroy(fun); + return rc; + } + + usb_log_debug("HID function created. Handle: %" PRIun "\n", fun->handle); + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +int usb_generic_hid_init(usb_hid_dev_t *hid_dev, void **data) +{ + if (hid_dev == NULL) { + return EINVAL; + } + + return usb_generic_hid_create_function(hid_dev); +} + +/*----------------------------------------------------------------------------*/ + +bool usb_generic_hid_polling_callback(usb_hid_dev_t *hid_dev, void *data, + uint8_t *buffer, size_t buffer_size) +{ + usb_log_debug2("usb_hid_polling_callback(%p, %p, %zu)\n", + hid_dev, buffer, buffer_size); + usb_debug_str_buffer(buffer, buffer_size, 0); + return true; +} + +/** + * @} + */ Index: uspace/drv/usbhid/generic/hiddev.h =================================================================== --- uspace/drv/usbhid/generic/hiddev.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/generic/hiddev.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,59 @@ +/* + * 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 driver API. + */ + +#ifndef USB_HID_HIDDDEV_H_ +#define USB_HID_HIDDDEV_H_ + +#include + +struct usb_hid_dev; + +usb_endpoint_description_t usb_hid_generic_poll_endpoint_description; + +const char *HID_GENERIC_FUN_NAME; +const char *HID_GENERIC_CLASS_NAME; + +/*----------------------------------------------------------------------------*/ + +int usb_generic_hid_init(struct usb_hid_dev *hid_dev, void **data); + +bool usb_generic_hid_polling_callback(struct usb_hid_dev *hid_dev, void *data, + uint8_t *buffer, size_t buffer_size); + +#endif // USB_HID_HIDDDEV_H_ + +/** + * @} + */ Index: uspace/drv/usbhid/kbd.h =================================================================== --- uspace/drv/usbhid/kbd.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/kbd.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,5 @@ +/* + * Dummy file because of shared layout sources. + * + * Do not delete. + */ Index: uspace/drv/usbhid/kbd/conv.c =================================================================== --- uspace/drv/usbhid/kbd/conv.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/kbd/conv.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,194 @@ +/* + * 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 same as 0x31 - backslash + [0x32] = KC_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/usbhid/kbd/conv.h =================================================================== --- uspace/drv/usbhid/kbd/conv.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/kbd/conv.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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_HID_CONV_H_ +#define USB_HID_CONV_H_ + +unsigned int usbhid_parse_scancode(int scancode); + +#endif /* USB_HID_CONV_H_ */ + +/** + * @} + */ Index: uspace/drv/usbhid/kbd/kbddev.c =================================================================== --- uspace/drv/usbhid/kbd/kbddev.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/kbd/kbddev.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,969 @@ +/* + * 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" + +#include "../usbhid.h" + +/*----------------------------------------------------------------------------*/ +/** Default modifiers when the keyboard is initialized. */ +static const unsigned DEFAULT_ACTIVE_MODS = KM_NUM_LOCK; + +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. */ +usb_endpoint_description_t usb_hid_kbd_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 +}; + +const char *HID_KBD_FUN_NAME = "keyboard"; +const char *HID_KBD_CLASS_NAME = "keyboard"; + +/*----------------------------------------------------------------------------*/ + +enum { + USB_KBD_BOOT_REPORT_DESCRIPTOR_SIZE = 63 +}; + +static const uint8_t USB_KBD_BOOT_REPORT_DESCRIPTOR[ + USB_KBD_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; + +/*----------------------------------------------------------------------------*/ +/* IPC method handler */ +/*----------------------------------------------------------------------------*/ + +static void default_connection_handler(ddf_fun_t *, ipc_callid_t, ipc_call_t *); + +/** + * 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. + */ +static 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; + if (kbd_dev == NULL) { + usb_log_debug("default_connection_handler: " + "Missing parameter.\n"); + async_answer_0(icallid, EINVAL); + return; + } + + if (method == IPC_M_CONNECT_TO_ME) { + int callback = IPC_GET_ARG5(*icall); + + if (kbd_dev->console_phone != -1) { + usb_log_debug("default_connection_handler: " + "console phone already set\n"); + async_answer_0(icallid, ELIMIT); + return; + } + + kbd_dev->console_phone = callback; + + usb_log_debug("default_connection_handler: OK\n"); + async_answer_0(icallid, EOK); + return; + } + + usb_log_debug("default_connection_handler: Wrong function.\n"); + 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_hid_dev_t *hid_dev, usb_kbd_t *kbd_dev) +{ + if (kbd_dev->output_size == 0) { + return; + } + + /* Reset the LED data. */ + memset(kbd_dev->led_data, 0, kbd_dev->led_output_size * sizeof(int32_t)); + usb_log_debug("Creating output report:\n"); + + usb_hid_report_field_t *field = usb_hid_report_get_sibling( + hid_dev->report, NULL, kbd_dev->led_path, + USB_HID_PATH_COMPARE_END | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY, + USB_HID_REPORT_TYPE_OUTPUT); + + while (field != NULL) { + + if ((field->usage == USB_HID_LED_NUM_LOCK) + && (kbd_dev->mods & KM_NUM_LOCK)){ + field->value = 1; + } + + if ((field->usage == USB_HID_LED_CAPS_LOCK) + && (kbd_dev->mods & KM_CAPS_LOCK)){ + field->value = 1; + } + + if ((field->usage == USB_HID_LED_SCROLL_LOCK) + && (kbd_dev->mods & KM_SCROLL_LOCK)){ + field->value = 1; + } + + field = usb_hid_report_get_sibling(hid_dev->report, field, + kbd_dev->led_path, + USB_HID_PATH_COMPARE_END | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY, + USB_HID_REPORT_TYPE_OUTPUT); + } + + // TODO: what about the Report ID? + int rc = usb_hid_report_output_translate(hid_dev->report, 0, + kbd_dev->output_buffer, kbd_dev->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(&hid_dev->usb_dev->ctrl_pipe, + hid_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_hid_dev_t *hid_dev, 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 + && hid_dev != NULL) { // ugly hack + usb_kbd_set_led(hid_dev, 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_hid_dev_t *hid_dev, + usb_kbd_t *kbd_dev) +{ + 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 < kbd_dev->key_count && kbd_dev->keys[i] != ERROR_ROLLOVER) { + ++i; + } + if (i != kbd_dev->key_count) { + usb_log_debug("Phantom state occured.\n"); + // phantom state, do nothing + return; + } + + /* + * 1) Key releases + */ + for (j = 0; j < kbd_dev->key_count; ++j) { + // try to find the old key in the new key list + i = 0; + while (i < kbd_dev->key_count + && kbd_dev->keys[i] != kbd_dev->keys_old[j]) { + ++i; + } + + if (i == kbd_dev->key_count) { + // not found, i.e. the key was released + key = usbhid_parse_scancode(kbd_dev->keys_old[j]); + if (!usb_kbd_is_lock(key)) { + usb_kbd_repeat_stop(kbd_dev, key); + } + usb_kbd_push_ev(hid_dev, 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 < kbd_dev->key_count + && kbd_dev->keys_old[j] != kbd_dev->keys[i]) { + ++j; + } + + if (j == kbd_dev->key_count) { + // not found, i.e. new key pressed + key = usbhid_parse_scancode(kbd_dev->keys[i]); + usb_log_debug2("Key pressed: %d (keycode: %d)\n", key, + kbd_dev->keys[i]); + if (!usb_kbd_is_lock(key)) { + usb_kbd_repeat_start(kbd_dev, key); + } + usb_kbd_push_ev(hid_dev, kbd_dev, KEY_PRESS, key); + } else { + // found, nothing happens + } + } + + memcpy(kbd_dev->keys_old, kbd_dev->keys, kbd_dev->key_count * 4); + + usb_log_debug2("New stored keys: "); + for (i = 0; i < kbd_dev->key_count; ++i) { + usb_log_debug2("%d ", kbd_dev->keys_old[i]); + } + usb_log_debug2("\n"); +} + +/*----------------------------------------------------------------------------*/ +/* 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_hid_dev_t *hid_dev, usb_kbd_t *kbd_dev, + uint8_t *buffer, size_t actual_size) +{ + assert(hid_dev->report != NULL); + assert(hid_dev != NULL); + assert(kbd_dev != NULL); + + usb_log_debug("Calling usb_hid_parse_report() with " + "buffer %s\n", usb_debug_str_buffer(buffer, actual_size, 0)); + + usb_hid_report_path_t *path = usb_hid_report_path(); + usb_hid_report_path_append_item(path, USB_HIDUT_PAGE_KEYBOARD, 0); + + uint8_t report_id; + int rc = usb_hid_parse_report(hid_dev->report, buffer, actual_size, + &report_id); + + if (rc != EOK) { + usb_log_warning("Error in usb_hid_parse_report():" + "%s\n", str_error(rc)); + } + + usb_hid_report_path_set_report_id (path, report_id); + + // fill in the currently pressed keys + + usb_hid_report_field_t *field = usb_hid_report_get_sibling( + hid_dev->report, NULL, path, + USB_HID_PATH_COMPARE_END | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY, + USB_HID_REPORT_TYPE_INPUT); + unsigned i = 0; + + while (field != NULL) { + usb_log_debug2("FIELD (%p) - VALUE(%d) USAGE(%u)\n", + field, field->value, field->usage); + + assert(i < kbd_dev->key_count); + + // save the key usage + if (field->value != 0) { + kbd_dev->keys[i] = field->usage; + } + else { + kbd_dev->keys[i] = 0; + } + usb_log_debug2("Saved %u. key usage %d\n", i, kbd_dev->keys[i]); + + ++i; + field = usb_hid_report_get_sibling(hid_dev->report, field, path, + USB_HID_PATH_COMPARE_END + | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY, + USB_HID_REPORT_TYPE_INPUT); + } + + usb_hid_report_path_free(path); + + usb_kbd_check_key_changes(hid_dev, kbd_dev); +} + +/*----------------------------------------------------------------------------*/ +/* HID/KBD structure manipulation */ +/*----------------------------------------------------------------------------*/ + +static void usb_kbd_mark_unusable(usb_kbd_t *kbd_dev) +{ + kbd_dev->initialized = USB_KBD_STATUS_TO_DESTROY; +} + +/*----------------------------------------------------------------------------*/ + +/** + * 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). + */ +static usb_kbd_t *usb_kbd_new(void) +{ + usb_kbd_t *kbd_dev = + (usb_kbd_t *)calloc(1, sizeof(usb_kbd_t)); + + if (kbd_dev == NULL) { + usb_log_fatal("No memory!\n"); + return NULL; + } + + kbd_dev->console_phone = -1; + kbd_dev->initialized = USB_KBD_STATUS_UNINITIALIZED; + + return kbd_dev; +} + +/*----------------------------------------------------------------------------*/ + +static int usb_kbd_create_function(usb_hid_dev_t *hid_dev, usb_kbd_t *kbd_dev) +{ + assert(hid_dev != NULL); + assert(hid_dev->usb_dev != NULL); + assert(kbd_dev != NULL); + + /* Create the function exposed under /dev/devices. */ + usb_log_debug("Creating DDF function %s...\n", HID_KBD_FUN_NAME); + ddf_fun_t *fun = ddf_fun_create(hid_dev->usb_dev->ddf_dev, fun_exposed, + HID_KBD_FUN_NAME); + if (fun == NULL) { + usb_log_error("Could not create DDF function node.\n"); + return ENOMEM; + } + + /* + * Store the initialized HID device and HID ops + * to the DDF function. + */ + fun->ops = &kbd_dev->ops; + fun->driver_data = kbd_dev; + + int rc = ddf_fun_bind(fun); + if (rc != EOK) { + usb_log_error("Could not bind DDF function: %s.\n", + str_error(rc)); + ddf_fun_destroy(fun); + return rc; + } + + usb_log_debug("%s function created. Handle: %" PRIun "\n", + HID_KBD_FUN_NAME, fun->handle); + + usb_log_debug("Adding DDF function to class %s...\n", + HID_KBD_CLASS_NAME); + rc = ddf_fun_add_to_class(fun, HID_KBD_CLASS_NAME); + if (rc != EOK) { + usb_log_error( + "Could not add DDF function to class %s: %s.\n", + HID_KBD_CLASS_NAME, str_error(rc)); + ddf_fun_destroy(fun); + return rc; + } + + return EOK; +} + +/*----------------------------------------------------------------------------*/ +/* API functions */ +/*----------------------------------------------------------------------------*/ +/** + * 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_hid_dev_t *hid_dev, void **data) +{ + usb_log_debug("Initializing HID/KBD structure...\n"); + + if (hid_dev == NULL) { + usb_log_error("Failed to init keyboard structure: no structure" + " given.\n"); + return EINVAL; + } + + usb_kbd_t *kbd_dev = usb_kbd_new(); + if (kbd_dev == NULL) { + usb_log_error("Error while creating USB/HID KBD device " + "structure.\n"); + return ENOMEM; // TODO: some other code?? + } + + /* + * 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); + + usb_hid_report_path_set_report_id(path, 0); + + kbd_dev->key_count = usb_hid_report_size( + hid_dev->report, 0, USB_HID_REPORT_TYPE_INPUT); + usb_hid_report_path_free(path); + + usb_log_debug("Size of the input report: %zu\n", kbd_dev->key_count); + + kbd_dev->keys = (int32_t *)calloc(kbd_dev->key_count, sizeof(int32_t)); + + if (kbd_dev->keys == NULL) { + usb_log_fatal("No memory!\n"); + free(kbd_dev); + return ENOMEM; + } + + kbd_dev->keys_old = + (int32_t *)calloc(kbd_dev->key_count, sizeof(int32_t)); + + if (kbd_dev->keys_old == NULL) { + usb_log_fatal("No memory!\n"); + free(kbd_dev->keys); + free(kbd_dev); + return ENOMEM; + } + + /* + * Output report + */ + kbd_dev->output_size = 0; + kbd_dev->output_buffer = usb_hid_report_output(hid_dev->report, + &kbd_dev->output_size, 0); + if (kbd_dev->output_buffer == NULL) { + usb_log_warning("Error creating output report buffer.\n"); + free(kbd_dev->keys); + return ENOMEM; + } + + 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_size(hid_dev->report, + 0, USB_HID_REPORT_TYPE_OUTPUT); + + 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); + free(kbd_dev); + 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); + usb_hid_report_output_free(kbd_dev->output_buffer); + free(kbd_dev); + return ENOMEM; + } + + fibril_mutex_initialize(kbd_dev->repeat_mtx); + + // save the KBD device structure into the HID device structure + *data = kbd_dev; + + // set handler for incoming calls + kbd_dev->ops.default_handler = default_connection_handler; + + /* + * Set LEDs according to initial setup. + * Set Idle rate + */ + usb_kbd_set_led(hid_dev, kbd_dev); + + usbhid_req_set_idle(&hid_dev->usb_dev->ctrl_pipe, + hid_dev->usb_dev->interface_no, IDLE_RATE); + + /* + * 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); + + kbd_dev->initialized = USB_KBD_STATUS_INITIALIZED; + usb_log_debug("HID/KBD device structure initialized.\n"); + + usb_log_debug("Creating KBD function...\n"); + int rc = usb_kbd_create_function(hid_dev, kbd_dev); + if (rc != EOK) { + usb_kbd_free(&kbd_dev); + return rc; + } + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +bool usb_kbd_polling_callback(usb_hid_dev_t *hid_dev, void *data, + uint8_t *buffer, size_t buffer_size) +{ + if (hid_dev == NULL || buffer == NULL || data == NULL) { + // do not continue polling (???) + return false; + } + + usb_kbd_t *kbd_dev = (usb_kbd_t *)data; + assert(kbd_dev != NULL); + + // TODO: add return value from this function + usb_kbd_process_data(hid_dev, kbd_dev, buffer, buffer_size); + + return true; +} + +/*----------------------------------------------------------------------------*/ + +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)->repeat_mtx != NULL) { + //assert(!fibril_mutex_is_locked((*kbd_dev)->repeat_mtx)); + while (fibril_mutex_is_locked((*kbd_dev)->repeat_mtx)) {} + free((*kbd_dev)->repeat_mtx); + } + + // free all buffers + if ((*kbd_dev)->keys != NULL) { + free((*kbd_dev)->keys); + } + if ((*kbd_dev)->keys_old != NULL) { + free((*kbd_dev)->keys_old); + } + if ((*kbd_dev)->led_data != NULL) { + free((*kbd_dev)->led_data); + } + if ((*kbd_dev)->led_path != NULL) { + usb_hid_report_path_free((*kbd_dev)->led_path); + } + if ((*kbd_dev)->output_buffer != NULL) { + usb_hid_report_output_free((*kbd_dev)->output_buffer); + } + + free(*kbd_dev); + *kbd_dev = NULL; +} + +/*----------------------------------------------------------------------------*/ + +void usb_kbd_deinit(usb_hid_dev_t *hid_dev, void *data) +{ + if (hid_dev == NULL) { + return; + } + + if (data != NULL) { + usb_kbd_t *kbd_dev = (usb_kbd_t *)data; + if (usb_kbd_is_initialized(kbd_dev)) { + usb_kbd_mark_unusable(kbd_dev); + } else { + usb_kbd_free(&kbd_dev); + } + } +} + +/*----------------------------------------------------------------------------*/ + +int usb_kbd_set_boot_protocol(usb_hid_dev_t *hid_dev) +{ + int rc = usb_hid_parse_report_descriptor(hid_dev->report, + USB_KBD_BOOT_REPORT_DESCRIPTOR, + USB_KBD_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(&hid_dev->usb_dev->ctrl_pipe, + hid_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; + } + + return EOK; +} + +/** + * @} + */ Index: uspace/drv/usbhid/kbd/kbddev.h =================================================================== --- uspace/drv/usbhid/kbd/kbddev.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/kbd/kbddev.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,144 @@ +/* + * 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_HID_KBDDEV_H_ +#define USB_HID_KBDDEV_H_ + +#include + +#include + +#include +#include +#include +#include +#include + +#include "kbdrepeat.h" + +struct usb_hid_dev; + +/*----------------------------------------------------------------------------*/ +/** + * 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 { + /** Previously pressed keys (not translated to key codes). */ + int32_t *keys_old; + /** Currently pressed keys (not translated to key codes). */ + int32_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; + + /** @todo What is this actually? */ + ddf_dev_ops_t ops; + + /** Information for auto-repeat of keys. */ + usb_kbd_repeat_t repeat; + + /** Mutex for accessing the information about auto-repeat. */ + fibril_mutex_t *repeat_mtx; + + uint8_t *output_buffer; + + size_t output_size; + + size_t led_output_size; + + usb_hid_report_path_t *led_path; + + int32_t *led_data; + + /** State of the structure (for checking before use). + * + * 0 - not initialized + * 1 - initialized + * -1 - ready for destroying + */ + int initialized; +} usb_kbd_t; + +/*----------------------------------------------------------------------------*/ + +usb_endpoint_description_t usb_hid_kbd_poll_endpoint_description; + +const char *HID_KBD_FUN_NAME; +const char *HID_KBD_CLASS_NAME; + +/*----------------------------------------------------------------------------*/ + +int usb_kbd_init(struct usb_hid_dev *hid_dev, void **data); + +bool usb_kbd_polling_callback(struct usb_hid_dev *hid_dev, void *data, + uint8_t *buffer, size_t buffer_size); + +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(struct usb_hid_dev *hid_dev, usb_kbd_t *kbd_dev, + int type, unsigned int key); + +void usb_kbd_deinit(struct usb_hid_dev *hid_dev, void *data); + +int usb_kbd_set_boot_protocol(struct usb_hid_dev *hid_dev); + +#endif /* USB_HID_KBDDEV_H_ */ + +/** + * @} + */ Index: uspace/drv/usbhid/kbd/kbdrepeat.c =================================================================== --- uspace/drv/usbhid/kbd/kbdrepeat.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/kbd/kbdrepeat.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,186 @@ +/* + * 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); + // ugly hack with the NULL + usb_kbd_push_ev(NULL, 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/usbhid/kbd/kbdrepeat.h =================================================================== --- uspace/drv/usbhid/kbd/kbdrepeat.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/kbd/kbdrepeat.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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_HID_KBDREPEAT_H_ +#define USB_HID_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_HID_KBDREPEAT_H_ */ + +/** + * @} + */ Index: uspace/drv/usbhid/kbd/layout.h =================================================================== --- uspace/drv/usbhid/kbd/layout.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/kbd/layout.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,1 @@ +../layout.h Index: uspace/drv/usbhid/kbd/main.c =================================================================== --- uspace/drv/usbhid/kbd/main.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/kbd/main.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,244 @@ +/* + * 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 KBD 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 usb_kbd_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)); + ddf_fun_destroy(kbd_fun); + usb_kbd_free(&kbd_dev); + return rc; + } + + /* 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; + } + + /* + * 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 usb_kbd_add_device(usb_device_t *dev) +{ + usb_log_debug("usb_kbd_add_device()\n"); + + if (dev->interface_no < 0) { + usb_log_warning("Device is not a supported keyboard.\n"); + usb_log_error("Failed to add USB KBD device: endpoint not " + "found.\n"); + return ENOTSUP; + } + + int rc = usb_kbd_try_add_device(dev); + + if (rc != EOK) { + usb_log_warning("Device is not a supported keyboard.\n"); + usb_log_error("Failed to add KBD 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 usb_kbd_driver_ops = { + .add_device = usb_kbd_add_device, +}; + + +/* The driver itself. */ +static usb_driver_t usb_kbd_driver = { + .name = NAME, + .ops = &usb_kbd_driver_ops, + .endpoints = usb_kbd_endpoints +}; + +/*----------------------------------------------------------------------------*/ + +int main(int argc, char *argv[]) +{ + printf(NAME ": HelenOS USB KBD driver.\n"); + + usb_log_enable(USB_LOG_LEVEL_DEBUG, NAME); + + return usb_driver_main(&usb_kbd_driver); +} + +/** + * @} + */ Index: uspace/drv/usbhid/layout.h =================================================================== --- uspace/drv/usbhid/layout.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/layout.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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_HID_LAYOUT_H_ +#define USB_HID_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/usbhid/main.c =================================================================== --- uspace/drv/usbhid/main.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/main.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,211 @@ +/* + * 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 + +#include "usbhid.h" + +/*----------------------------------------------------------------------------*/ + +#define NAME "usbhid" + +/** + * 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(). + */ +static int usb_hid_try_add_device(usb_device_t *dev) +{ + assert(dev != NULL); + + /* + * Initialize device (get and process descriptors, get address, etc.) + */ + usb_log_debug("Initializing USB/HID device...\n"); + + usb_hid_dev_t *hid_dev = usb_hid_new(); + if (hid_dev == NULL) { + usb_log_error("Error while creating USB/HID device " + "structure.\n"); + return ENOMEM; + } + + int rc = usb_hid_init(hid_dev, dev); + + if (rc != EOK) { + usb_log_error("Failed to initialize USB/HID device.\n"); + usb_hid_free(&hid_dev); + return rc; + } + + usb_log_debug("USB/HID device structure initialized.\n"); + + /* + * 1) subdriver vytvori vlastnu ddf_fun, vlastne ddf_dev_ops, ktore da + * do nej. + * 2) do tych ops do .interfaces[DEV_IFACE_USBHID (asi)] priradi + * vyplnenu strukturu usbhid_iface_t. + * 3) klientska aplikacia - musi si rucne vytvorit telefon + * (devman_device_connect() - cesta k zariadeniu (/hw/pci0/...) az + * k tej fcii. + * pouzit usb/classes/hid/iface.h - prvy int je telefon + */ + + /* 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. */ + hid_dev->poll_pipe_index, + /* Callback when data arrives. */ + usb_hid_polling_callback, + /* How much data to request. */ + dev->pipes[hid_dev->poll_pipe_index].pipe->max_packet_size, + /* Callback when the polling ends. */ + usb_hid_polling_ended_callback, + /* Custom argument. */ + hid_dev); + + + if (rc != EOK) { + usb_log_error("Failed to start polling fibril for `%s'.\n", + dev->ddf_dev->name); + return rc; + } + + /* + * 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 usb_hid_add_device(usb_device_t *dev) +{ + usb_log_debug("usb_hid_add_device()\n"); + + if (dev == NULL) { + usb_log_warning("Wrong parameter given for add_device().\n"); + return EINVAL; + } + + if (dev->interface_no < 0) { + usb_log_warning("Device is not a supported HID device.\n"); + usb_log_error("Failed to add HID device: endpoints not found." + "\n"); + return ENOTSUP; + } + + int rc = usb_hid_try_add_device(dev); + + if (rc != EOK) { + usb_log_warning("Device is not a supported HID device.\n"); + usb_log_error("Failed to add HID device: %s.\n", + str_error(rc)); + return rc; + } + + usb_log_info("HID device `%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 usb_hid_driver_ops = { + .add_device = usb_hid_add_device, +}; + + +/* The driver itself. */ +static usb_driver_t usb_hid_driver = { + .name = NAME, + .ops = &usb_hid_driver_ops, + .endpoints = usb_hid_endpoints +}; + +/*----------------------------------------------------------------------------*/ + +int main(int argc, char *argv[]) +{ + printf(NAME ": HelenOS USB HID driver.\n"); + + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + + return usb_driver_main(&usb_hid_driver); +} + +/** + * @} + */ Index: uspace/drv/usbhid/mouse/mousedev.c =================================================================== --- uspace/drv/usbhid/mouse/mousedev.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/mouse/mousedev.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,562 @@ +/* + * Copyright (c) 2011 Lubos Slovak, 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 drvusbhid + * @{ + */ +/** + * @file + * USB Mouse driver API. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include + +#include "mousedev.h" +#include "../usbhid.h" + +#define NAME "mouse" + +/*----------------------------------------------------------------------------*/ + +usb_endpoint_description_t usb_hid_mouse_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 +}; + +const char *HID_MOUSE_FUN_NAME = "mouse"; +const char *HID_MOUSE_WHEEL_FUN_NAME = "mouse-wheel"; +const char *HID_MOUSE_CLASS_NAME = "mouse"; +const char *HID_MOUSE_WHEEL_CLASS_NAME = "keyboard"; + +/** Default idle rate for mouses. */ +static const uint8_t IDLE_RATE = 0; +static const size_t USB_MOUSE_BUTTON_COUNT = 3; + +/*----------------------------------------------------------------------------*/ + +enum { + USB_MOUSE_BOOT_REPORT_DESCRIPTOR_SIZE = 63 +}; + +static const uint8_t USB_MOUSE_BOOT_REPORT_DESCRIPTOR[ + USB_MOUSE_BOOT_REPORT_DESCRIPTOR_SIZE] = { + 0x05, 0x01, // USAGE_PAGE (Generic Desktop) + 0x09, 0x02, // USAGE (Mouse) + 0xa1, 0x01, // COLLECTION (Application) + 0x09, 0x01, // USAGE (Pointer) + 0xa1, 0x00, // COLLECTION (Physical) + 0x95, 0x03, // REPORT_COUNT (3) + 0x75, 0x01, // REPORT_SIZE (1) + 0x05, 0x09, // USAGE_PAGE (Button) + 0x19, 0x01, // USAGE_MINIMUM (Button 1) + 0x29, 0x03, // USAGE_MAXIMUM (Button 3) + 0x15, 0x00, // LOGICAL_MINIMUM (0) + 0x25, 0x01, // LOGICAL_MAXIMUM (1) + 0x81, 0x02, // INPUT (Data,Var,Abs) + 0x95, 0x01, // REPORT_COUNT (1) + 0x75, 0x05, // REPORT_SIZE (5) + 0x81, 0x01, // INPUT (Cnst) + 0x75, 0x08, // REPORT_SIZE (8) + 0x95, 0x02, // REPORT_COUNT (2) + 0x05, 0x01, // USAGE_PAGE (Generic Desktop) + 0x09, 0x30, // USAGE (X) + 0x09, 0x31, // USAGE (Y) + 0x15, 0x81, // LOGICAL_MINIMUM (-127) + 0x25, 0x7f, // LOGICAL_MAXIMUM (127) + 0x81, 0x06, // INPUT (Data,Var,Rel) + 0xc0, // END_COLLECTION + 0xc0 // END_COLLECTION +}; + +/*----------------------------------------------------------------------------*/ + +/** Default handler for IPC methods not handled by DDF. + * + * @param fun Device function handling the call. + * @param icallid Call id. + * @param icall Call data. + */ +static 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_dev = (usb_mouse_t *)fun->driver_data; + + if (mouse_dev == NULL) { + usb_log_debug("default_connection_handler: Missing " + "parameters.\n"); + async_answer_0(icallid, EINVAL); + return; + } + + usb_log_debug("default_connection_handler: fun->name: %s\n", + fun->name); + usb_log_debug("default_connection_handler: mouse_phone: %d, wheel " + "phone: %d\n", mouse_dev->mouse_phone, mouse_dev->wheel_phone); + + int *phone = (str_cmp(fun->name, HID_MOUSE_FUN_NAME) == 0) + ? &mouse_dev->mouse_phone : &mouse_dev->wheel_phone; + + if (method == IPC_M_CONNECT_TO_ME) { + int callback = IPC_GET_ARG5(*icall); + + if (*phone != -1) { + usb_log_debug("default_connection_handler: Console " + "phone to mouse already set.\n"); + async_answer_0(icallid, ELIMIT); + return; + } + + *phone = callback; + usb_log_debug("Console phone to mouse set ok (%d).\n", *phone); + async_answer_0(icallid, EOK); + return; + } + + usb_log_debug("default_connection_handler: Invalid function.\n"); + async_answer_0(icallid, EINVAL); +} + +/*----------------------------------------------------------------------------*/ + +static usb_mouse_t *usb_mouse_new(void) +{ + usb_mouse_t *mouse = calloc(1, sizeof(usb_mouse_t)); + if (mouse == NULL) { + return NULL; + } + mouse->mouse_phone = -1; + mouse->wheel_phone = -1; + + return mouse; +} + +/*----------------------------------------------------------------------------*/ + +static void usb_mouse_free(usb_mouse_t **mouse_dev) +{ + assert(mouse_dev != NULL && *mouse_dev != NULL); + + // hangup phone to the console + if ((*mouse_dev)->mouse_phone >= 0) { + async_hangup((*mouse_dev)->mouse_phone); + } + + if ((*mouse_dev)->wheel_phone >= 0) { + async_hangup((*mouse_dev)->wheel_phone); + } + + free(*mouse_dev); + *mouse_dev = NULL; +} + +/*----------------------------------------------------------------------------*/ + +static void usb_mouse_send_wheel(const usb_mouse_t *mouse_dev, int wheel) +{ + console_event_t ev; + + ev.type = KEY_PRESS; + ev.key = (wheel > 0) ? KC_UP : (wheel < 0) ? KC_DOWN : 0; + ev.mods = 0; + ev.c = 0; + + if (mouse_dev->wheel_phone < 0) { + usb_log_warning( + "Connection to console not ready, key discarded.\n"); + return; + } + + int count = (wheel < 0) ? -wheel : wheel; + int i; + + for (i = 0; i < count * 3; ++i) { + usb_log_debug2("Sending key %d to the console\n", ev.key); + async_msg_4(mouse_dev->wheel_phone, KBD_EVENT, ev.type, + ev.key, ev.mods, ev.c); + // send key release right away + async_msg_4(mouse_dev->wheel_phone, KBD_EVENT, KEY_RELEASE, + ev.key, ev.mods, ev.c); + } +} + +/*----------------------------------------------------------------------------*/ + +static bool usb_mouse_process_report(usb_hid_dev_t *hid_dev, + usb_mouse_t *mouse_dev, uint8_t *buffer, + size_t buffer_size) +{ + assert(mouse_dev != NULL); + + usb_log_debug2("got buffer: %s.\n", + usb_debug_str_buffer(buffer, buffer_size, 0)); + + if (mouse_dev->mouse_phone < 0) { + usb_log_warning(NAME " No console phone.\n"); + return true; + } + + /* + * parse the input report + */ + + usb_log_debug(NAME " Calling usb_hid_parse_report() with " + "buffer %s\n", usb_debug_str_buffer(buffer, buffer_size, 0)); + + uint8_t report_id; + + int rc = usb_hid_parse_report(hid_dev->report, buffer, buffer_size, + &report_id); + + if (rc != EOK) { + usb_log_warning(NAME "Error in usb_hid_parse_report(): %s\n", + str_error(rc)); + return true; + } + + /* + * X + */ + int shift_x = 0; + + usb_hid_report_path_t *path = usb_hid_report_path(); + usb_hid_report_path_append_item(path, USB_HIDUT_PAGE_GENERIC_DESKTOP, + USB_HIDUT_USAGE_GENERIC_DESKTOP_X); + + usb_hid_report_path_set_report_id(path, report_id); + + usb_hid_report_field_t *field = usb_hid_report_get_sibling( + hid_dev->report, NULL, path, USB_HID_PATH_COMPARE_END, + USB_HID_REPORT_TYPE_INPUT); + + if (field != NULL) { + usb_log_debug(NAME " VALUE(%X) USAGE(%X)\n", field->value, + field->usage); + shift_x = field->value; + } + + usb_hid_report_path_free(path); + + /* + * Y + */ + int shift_y = 0; + + path = usb_hid_report_path(); + usb_hid_report_path_append_item(path, USB_HIDUT_PAGE_GENERIC_DESKTOP, + USB_HIDUT_USAGE_GENERIC_DESKTOP_Y); + + usb_hid_report_path_set_report_id(path, report_id); + + field = usb_hid_report_get_sibling( + hid_dev->report, NULL, path, USB_HID_PATH_COMPARE_END, + USB_HID_REPORT_TYPE_INPUT); + + if (field != NULL) { + usb_log_debug(NAME " VALUE(%X) USAGE(%X)\n", field->value, + field->usage); + shift_y = field->value; + } + + usb_hid_report_path_free(path); + + if ((shift_x != 0) || (shift_y != 0)) { + async_req_2_0(mouse_dev->mouse_phone, + MEVENT_MOVE, shift_x, shift_y); + } + + /* + * Wheel + */ + int wheel = 0; + + path = usb_hid_report_path(); + usb_hid_report_path_append_item(path, USB_HIDUT_PAGE_GENERIC_DESKTOP, + USB_HIDUT_USAGE_GENERIC_DESKTOP_WHEEL); + + usb_hid_report_path_set_report_id(path, report_id); + + field = usb_hid_report_get_sibling( + hid_dev->report, NULL, path, USB_HID_PATH_COMPARE_END, + USB_HID_REPORT_TYPE_INPUT); + + if (field != NULL) { + usb_log_debug(NAME " VALUE(%X) USAGE(%X)\n", field->value, + field->usage); + wheel = field->value; + } + + usb_hid_report_path_free(path); + + // send arrow up for positive direction and arrow down for negative + // direction; three arrows for difference of 1 + usb_mouse_send_wheel(mouse_dev, wheel); + + + /* + * Buttons + */ + path = usb_hid_report_path(); + usb_hid_report_path_append_item(path, USB_HIDUT_PAGE_BUTTON, 0); + usb_hid_report_path_set_report_id(path, report_id); + + field = usb_hid_report_get_sibling( + hid_dev->report, NULL, path, USB_HID_PATH_COMPARE_END + | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY, + USB_HID_REPORT_TYPE_INPUT); + + while (field != NULL) { + usb_log_debug(NAME " VALUE(%X) USAGE(%X)\n", field->value, + field->usage); + + if (mouse_dev->buttons[field->usage - field->usage_minimum] == 0 + && field->value != 0) { + async_req_2_0(mouse_dev->mouse_phone, + MEVENT_BUTTON, field->usage, 1); + mouse_dev->buttons[field->usage - field->usage_minimum] + = field->value; + } else if ( + mouse_dev->buttons[field->usage - field->usage_minimum] != 0 + && field->value == 0) { + async_req_2_0(mouse_dev->mouse_phone, + MEVENT_BUTTON, field->usage, 0); + mouse_dev->buttons[field->usage - field->usage_minimum] + = field->value; + } + + field = usb_hid_report_get_sibling( + hid_dev->report, field, path, USB_HID_PATH_COMPARE_END + | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY, + USB_HID_REPORT_TYPE_INPUT); + } + + usb_hid_report_path_free(path); + + return true; +} + +/*----------------------------------------------------------------------------*/ + +static int usb_mouse_create_function(usb_hid_dev_t *hid_dev, usb_mouse_t *mouse) +{ + assert(hid_dev != NULL); + assert(mouse != NULL); + + /* Create the function exposed under /dev/devices. */ + usb_log_debug("Creating DDF function %s...\n", HID_MOUSE_FUN_NAME); + ddf_fun_t *fun = ddf_fun_create(hid_dev->usb_dev->ddf_dev, fun_exposed, + HID_MOUSE_FUN_NAME); + if (fun == NULL) { + usb_log_error("Could not create DDF function node.\n"); + return ENOMEM; + } + + fun->ops = &mouse->ops; + fun->driver_data = mouse; + + int rc = ddf_fun_bind(fun); + if (rc != EOK) { + usb_log_error("Could not bind DDF function: %s.\n", + str_error(rc)); + ddf_fun_destroy(fun); + return rc; + } + + usb_log_debug("Adding DDF function to class %s...\n", + HID_MOUSE_CLASS_NAME); + rc = ddf_fun_add_to_class(fun, HID_MOUSE_CLASS_NAME); + if (rc != EOK) { + usb_log_error( + "Could not add DDF function to class %s: %s.\n", + HID_MOUSE_CLASS_NAME, str_error(rc)); + ddf_fun_destroy(fun); + return rc; + } + + /* + * Special function for acting as keyboard (wheel) + */ + usb_log_debug("Creating DDF function %s...\n", + HID_MOUSE_WHEEL_FUN_NAME); + fun = ddf_fun_create(hid_dev->usb_dev->ddf_dev, fun_exposed, + HID_MOUSE_WHEEL_FUN_NAME); + if (fun == NULL) { + usb_log_error("Could not create DDF function node.\n"); + return ENOMEM; + } + + /* + * Store the initialized HID device and HID ops + * to the DDF function. + */ + fun->ops = &mouse->ops; + fun->driver_data = mouse; + + rc = ddf_fun_bind(fun); + if (rc != EOK) { + usb_log_error("Could not bind DDF function: %s.\n", + str_error(rc)); + ddf_fun_destroy(fun); + return rc; + } + + usb_log_debug("Adding DDF function to class %s...\n", + HID_MOUSE_WHEEL_CLASS_NAME); + rc = ddf_fun_add_to_class(fun, HID_MOUSE_WHEEL_CLASS_NAME); + if (rc != EOK) { + usb_log_error( + "Could not add DDF function to class %s: %s.\n", + HID_MOUSE_WHEEL_CLASS_NAME, str_error(rc)); + ddf_fun_destroy(fun); + return rc; + } + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +int usb_mouse_init(usb_hid_dev_t *hid_dev, void **data) +{ + usb_log_debug("Initializing HID/Mouse structure...\n"); + + if (hid_dev == NULL) { + usb_log_error("Failed to init keyboard structure: no structure" + " given.\n"); + return EINVAL; + } + + usb_mouse_t *mouse_dev = usb_mouse_new(); + if (mouse_dev == NULL) { + usb_log_error("Error while creating USB/HID Mouse device " + "structure.\n"); + return ENOMEM; + } + + mouse_dev->buttons = (int32_t *)calloc(USB_MOUSE_BUTTON_COUNT, + sizeof(int32_t)); + + if (mouse_dev->buttons == NULL) { + usb_log_fatal("No memory!\n"); + free(mouse_dev); + return ENOMEM; + } + + // save the Mouse device structure into the HID device structure + *data = mouse_dev; + + // set handler for incoming calls + mouse_dev->ops.default_handler = default_connection_handler; + + // TODO: how to know if the device supports the request??? + usbhid_req_set_idle(&hid_dev->usb_dev->ctrl_pipe, + hid_dev->usb_dev->interface_no, IDLE_RATE); + + int rc = usb_mouse_create_function(hid_dev, mouse_dev); + if (rc != EOK) { + usb_mouse_free(&mouse_dev); + return rc; + } + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +bool usb_mouse_polling_callback(usb_hid_dev_t *hid_dev, void *data, + uint8_t *buffer, size_t buffer_size) +{ + usb_log_debug("usb_mouse_polling_callback()\n"); + usb_debug_str_buffer(buffer, buffer_size, 0); + + if (hid_dev == NULL || data == NULL) { + usb_log_error("Missing argument to the mouse polling callback." + "\n"); + return false; + } + + usb_mouse_t *mouse_dev = (usb_mouse_t *)data; + + return usb_mouse_process_report(hid_dev, mouse_dev, buffer, + buffer_size); +} + +/*----------------------------------------------------------------------------*/ + +void usb_mouse_deinit(usb_hid_dev_t *hid_dev, void *data) +{ + if (data != NULL) { + usb_mouse_free((usb_mouse_t **)&data); + } +} + +/*----------------------------------------------------------------------------*/ + +int usb_mouse_set_boot_protocol(usb_hid_dev_t *hid_dev) +{ + int rc = usb_hid_parse_report_descriptor(hid_dev->report, + USB_MOUSE_BOOT_REPORT_DESCRIPTOR, + USB_MOUSE_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(&hid_dev->usb_dev->ctrl_pipe, + hid_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; + } + + return EOK; +} + +/** + * @} + */ Index: uspace/drv/usbhid/mouse/mousedev.h =================================================================== --- uspace/drv/usbhid/mouse/mousedev.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/mouse/mousedev.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,80 @@ +/* + * 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 Mouse driver API. + */ + +#ifndef USB_HID_MOUSEDEV_H_ +#define USB_HID_MOUSEDEV_H_ + +#include + +struct usb_hid_dev; + +/*----------------------------------------------------------------------------*/ + +/** Container for USB mouse device. */ +typedef struct { + /** IPC phone to console (consumer). */ + int mouse_phone; + int wheel_phone; + + int32_t *buttons; + + ddf_dev_ops_t ops; +} usb_mouse_t; + +/*----------------------------------------------------------------------------*/ + +usb_endpoint_description_t usb_hid_mouse_poll_endpoint_description; + +const char *HID_MOUSE_FUN_NAME; +const char *HID_MOUSE_CLASS_NAME; + +/*----------------------------------------------------------------------------*/ + +int usb_mouse_init(struct usb_hid_dev *hid_dev, void **data); + +bool usb_mouse_polling_callback(struct usb_hid_dev *hid_dev, void *data, + uint8_t *buffer, size_t buffer_size); + +void usb_mouse_deinit(struct usb_hid_dev *hid_dev, void *data); + +int usb_mouse_set_boot_protocol(struct usb_hid_dev *hid_dev); + +/*----------------------------------------------------------------------------*/ + +#endif // USB_HID_MOUSEDEV_H_ + +/** + * @} + */ Index: uspace/drv/usbhid/multimedia/keymap.c =================================================================== --- uspace/drv/usbhid/multimedia/keymap.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/multimedia/keymap.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,94 @@ +/* + * 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 + * UUSB multimedia key to keycode mapping. + */ + +#include +#include +#include +#include +#include "keymap.h" + +/** + * Mapping between USB HID multimedia usages (from HID Usage Tables) and + * corresponding HelenOS key codes. + * + * Currently only Usages used by Logitech UltraX keyboard are present. All other + * should result in 0. + */ +static int usb_hid_keymap_consumer[0x29c] = { + [0xb5] = 0, /* Scan Next Track */ + [0xb6] = 0, /* Scan Previous Track */ + [0xb7] = 0, /* Stop */ + [0xb8] = 0, /* Eject */ + [0xcd] = 0/*KC_F2*/, /* Play/Pause */ + [0xe2] = 0/*KC_F3*/, /* Mute */ + [0xe9] = 0/*KC_F5*/, /* Volume Increment */ + [0xea] = 0/*KC_F4*/, /* Volume Decrement */ + [0x183] = 0/*KC_F1*/, /* AL Consumer Control Configuration */ + [0x18a] = 0, /* AL Email Reader */ + [0x192] = 0, /* AL Calculator */ + [0x221] = 0, /* AC Search */ + [0x223] = 0/*KC_F6*/, /* AC Home */ + [0x224] = 0, /* AC Back */ + [0x225] = 0, /* AC Forward */ + [0x226] = 0, /* AC Stop */ + [0x227] = 0, /* AC Refresh */ + [0x22a] = 0 /* AC Bookmarks */ +}; + +/** + * Translates USB HID Usages from the Consumer Page into HelenOS keycodes. + * + * @param usage USB HID Consumer Page Usage number. + * + * @retval HelenOS key code corresponding to the given USB Consumer Page Usage. + */ +unsigned int usb_multimedia_map_usage(int usage) +{ + unsigned int key; + int *map = usb_hid_keymap_consumer; + size_t map_length = sizeof(usb_hid_keymap_consumer) / sizeof(int); + + if ((usage < 0) || ((size_t)usage >= map_length)) + return -1; + + /*! @todo What if the usage is not in the table? */ + key = map[usage]; + + return key; +} + +/** + * @} + */ Index: uspace/drv/usbhid/multimedia/keymap.h =================================================================== --- uspace/drv/usbhid/multimedia/keymap.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/multimedia/keymap.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 multimedia key to keycode mapping. + */ + +#ifndef USB_HID_MULTIMEDIA_KEYMAP_H_ +#define USB_HID_MULTIMEDIA_KEYMAP_H_ + +unsigned int usb_multimedia_map_usage(int usage); + +#endif /* USB_HID_MULTIMEDIA_KEYMAP_H_ */ + +/** + * @} + */ Index: uspace/drv/usbhid/multimedia/multimedia.c =================================================================== --- uspace/drv/usbhid/multimedia/multimedia.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/multimedia/multimedia.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,337 @@ +/* + * Copyright (c) 2011 Lubos Slovak, 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 drvusbhid + * @{ + */ +/** + * @file + * USB Keyboard multimedia keys subdriver. + */ + + +#include "multimedia.h" +#include "../usbhid.h" +#include "keymap.h" + +#include +#include +#include +#include + +#include +#include + +#include +#include + +#define NAME "multimedia-keys" + +/*----------------------------------------------------------------------------*/ +/** + * Logitech UltraX device type. + */ +typedef struct usb_multimedia_t { + /** Previously pressed keys (not translated to key codes). */ + //int32_t *keys_old; + /** Currently pressed keys (not translated to key codes). */ + //int32_t *keys; + /** Count of stored keys (i.e. number of keys in the report). */ + //size_t key_count; + /** IPC phone to the console device (for sending key events). */ + int console_phone; +} usb_multimedia_t; + + +/*----------------------------------------------------------------------------*/ +/** + * 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. + */ +static void default_connection_handler(ddf_fun_t *fun, + ipc_callid_t icallid, ipc_call_t *icall) +{ + usb_log_debug(NAME " default_connection_handler()\n"); + + sysarg_t method = IPC_GET_IMETHOD(*icall); + + usb_multimedia_t *multim_dev = (usb_multimedia_t *)fun->driver_data; + //usb_hid_dev_t *hid_dev = (usb_hid_dev_t *)fun->driver_data; + + if (multim_dev == NULL) { + async_answer_0(icallid, EINVAL); + return; + } + + if (method == IPC_M_CONNECT_TO_ME) { + int callback = IPC_GET_ARG5(*icall); + + if (multim_dev->console_phone != -1) { + async_answer_0(icallid, ELIMIT); + return; + } + + multim_dev->console_phone = callback; + usb_log_debug(NAME " Saved phone to console: %d\n", callback); + async_answer_0(icallid, EOK); + return; + } + + async_answer_0(icallid, EINVAL); +} + +/*----------------------------------------------------------------------------*/ + +static ddf_dev_ops_t multimedia_ops = { + .default_handler = default_connection_handler +}; + +/*----------------------------------------------------------------------------*/ +/** + * 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 hid_dev + * @param lgtch_dev + * @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. + */ +static void usb_multimedia_push_ev(usb_hid_dev_t *hid_dev, + usb_multimedia_t *multim_dev, int type, unsigned int key) +{ + assert(hid_dev != NULL); + assert(multim_dev != NULL); + + console_event_t ev; + + ev.type = type; + ev.key = key; + ev.mods = 0; + ev.c = 0; + + usb_log_debug2(NAME " Sending key %d to the console\n", ev.key); + if (multim_dev->console_phone < 0) { + usb_log_warning( + "Connection to console not ready, key discarded.\n"); + return; + } + + async_msg_4(multim_dev->console_phone, KBD_EVENT, ev.type, ev.key, + ev.mods, ev.c); +} + +/*----------------------------------------------------------------------------*/ + +static void usb_multimedia_free(usb_multimedia_t **multim_dev) +{ + if (multim_dev == NULL || *multim_dev == NULL) { + return; + } + + // hangup phone to the console + async_hangup((*multim_dev)->console_phone); + + free(*multim_dev); + *multim_dev = NULL; +} + +/*----------------------------------------------------------------------------*/ + +static int usb_multimedia_create_function(usb_hid_dev_t *hid_dev, + usb_multimedia_t *multim_dev) +{ + /* Create the function exposed under /dev/devices. */ + ddf_fun_t *fun = ddf_fun_create(hid_dev->usb_dev->ddf_dev, fun_exposed, + NAME); + if (fun == NULL) { + usb_log_error("Could not create DDF function node.\n"); + return ENOMEM; + } + + fun->ops = &multimedia_ops; + fun->driver_data = multim_dev; // TODO: maybe change to hid_dev->data + + int rc = ddf_fun_bind(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(fun); + return rc; + } + + usb_log_debug("%s function created (jandle: %" PRIun ").\n", + NAME, fun->handle); + + rc = ddf_fun_add_to_class(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(fun); + return rc; + } + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +int usb_multimedia_init(struct usb_hid_dev *hid_dev, void **data) +{ + if (hid_dev == NULL || hid_dev->usb_dev == NULL) { + return EINVAL; /*! @todo Other return code? */ + } + + usb_log_debug(NAME " Initializing HID/multimedia structure...\n"); + + usb_multimedia_t *multim_dev = (usb_multimedia_t *)malloc( + sizeof(usb_multimedia_t)); + if (multim_dev == NULL) { + return ENOMEM; + } + + multim_dev->console_phone = -1; + + /*! @todo Autorepeat */ + + // save the KBD device structure into the HID device structure + *data = multim_dev; + + usb_log_debug(NAME " HID/multimedia device structure initialized.\n"); + + int rc = usb_multimedia_create_function(hid_dev, multim_dev); + if (rc != EOK) { + usb_multimedia_free(&multim_dev); + return rc; + } + + usb_log_debug(NAME " HID/multimedia structure initialized.\n"); + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +void usb_multimedia_deinit(struct usb_hid_dev *hid_dev, void *data) +{ + if (hid_dev == NULL) { + return; + } + + if (data != NULL) { + usb_multimedia_t *multim_dev = (usb_multimedia_t *)data; + usb_multimedia_free(&multim_dev); + } +} + +/*----------------------------------------------------------------------------*/ + +bool usb_multimedia_polling_callback(struct usb_hid_dev *hid_dev, void *data, + uint8_t *buffer, size_t buffer_size) +{ + // TODO: checks + if (hid_dev == NULL || data == NULL || buffer == NULL) { + return false; + } + + usb_log_debug(NAME " usb_lgtch_polling_callback(%p, %p, %zu)\n", + hid_dev, buffer, buffer_size); + + usb_multimedia_t *multim_dev = (usb_multimedia_t *)data; + + usb_log_debug(NAME " Calling usb_hid_parse_report() with " + "buffer %s\n", usb_debug_str_buffer(buffer, buffer_size, 0)); + + usb_hid_report_path_t *path = usb_hid_report_path(); + usb_hid_report_path_append_item(path, USB_HIDUT_PAGE_CONSUMER, 0); + + uint8_t report_id; + + int rc = usb_hid_parse_report(hid_dev->report, buffer, buffer_size, + &report_id); + + if (rc != EOK) { + usb_log_warning(NAME "Error in usb_hid_parse_report(): %s\n", + str_error(rc)); + return true; + } + + usb_hid_report_path_set_report_id(path, report_id); + + usb_hid_report_field_t *field = usb_hid_report_get_sibling( + hid_dev->report, NULL, path, USB_HID_PATH_COMPARE_END + | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY, + USB_HID_REPORT_TYPE_INPUT); + + /*! @todo Is this iterating OK if done multiple times? + * @todo The parsing is not OK + */ + while (field != NULL) { + if(field->value != 0) { + usb_log_debug(NAME " KEY VALUE(%X) USAGE(%X)\n", + field->value, field->usage); + unsigned int key = + usb_multimedia_map_usage(field->usage); + const char *key_str = + usbhid_multimedia_usage_to_str(field->usage); + usb_log_info("Pressed key: %s\n", key_str); + usb_multimedia_push_ev(hid_dev, multim_dev, KEY_PRESS, + key); + } + + field = usb_hid_report_get_sibling( + hid_dev->report, field, path, USB_HID_PATH_COMPARE_END + | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY, + USB_HID_REPORT_TYPE_INPUT); + } + + usb_hid_report_path_free(path); + + return true; +} + +/** + * @} + */ Index: uspace/drv/usbhid/multimedia/multimedia.h =================================================================== --- uspace/drv/usbhid/multimedia/multimedia.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/multimedia/multimedia.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,58 @@ +/* + * 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 Keyboard multimedia keys subdriver. + */ + +#ifndef USB_HID_MULTIMEDIA_H_ +#define USB_HID_MULTIMEDIA_H_ + +#include + +struct usb_hid_dev; + +/*----------------------------------------------------------------------------*/ + +int usb_multimedia_init(struct usb_hid_dev *hid_dev, void **data); + +void usb_multimedia_deinit(struct usb_hid_dev *hid_dev, void *data); + +bool usb_multimedia_polling_callback(struct usb_hid_dev *hid_dev, void *data, + uint8_t *buffer, size_t buffer_size); + +/*----------------------------------------------------------------------------*/ + +#endif // USB_HID_MULTIMEDIA_H_ + +/** + * @} + */ Index: uspace/drv/usbhid/subdrivers.c =================================================================== --- uspace/drv/usbhid/subdrivers.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/subdrivers.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,106 @@ +/* + * 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 subdriver mappings. + */ + +#include "subdrivers.h" +#include +#include + +#include "multimedia/multimedia.h" +#include "mouse/mousedev.h" +#include "generic/hiddev.h" + +static usb_hid_subdriver_usage_t path_kbd[] = { + {USB_HIDUT_PAGE_GENERIC_DESKTOP, + USB_HIDUT_USAGE_GENERIC_DESKTOP_KEYBOARD}, + {0, 0} +}; + +static usb_hid_subdriver_usage_t path_mouse[] = { + {USB_HIDUT_PAGE_GENERIC_DESKTOP, USB_HIDUT_USAGE_GENERIC_DESKTOP_MOUSE}, + {0, 0} +}; + +static usb_hid_subdriver_usage_t multim_key_path[] = { + {USB_HIDUT_PAGE_CONSUMER, USB_HIDUT_USAGE_CONSUMER_CONSUMER_CONTROL}, + {0, 0} +}; + +const usb_hid_subdriver_mapping_t usb_hid_subdrivers[] = { + { + path_kbd, + 0, + USB_HID_PATH_COMPARE_BEGIN, + -1, + -1, + { + .init = usb_kbd_init, + .deinit = usb_kbd_deinit, + .poll = usb_kbd_polling_callback, + .poll_end = NULL + }, + + }, + { + multim_key_path, + 1, + USB_HID_PATH_COMPARE_BEGIN, + -1, + -1, + { + .init = usb_multimedia_init, + .deinit = usb_multimedia_deinit, + .poll = usb_multimedia_polling_callback, + .poll_end = NULL + } + }, + { + path_mouse, + 0, + USB_HID_PATH_COMPARE_BEGIN, + -1, + -1, + { + .init = usb_mouse_init, + .deinit = usb_mouse_deinit, + .poll = usb_mouse_polling_callback, + .poll_end = NULL + } + }, + {NULL, -1, 0, -1, -1, {NULL, NULL, NULL, NULL, NULL}} +}; + +/** + * @} + */ Index: uspace/drv/usbhid/subdrivers.h =================================================================== --- uspace/drv/usbhid/subdrivers.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/subdrivers.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,73 @@ +/* + * 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 subdriver mappings. + */ + +#ifndef USB_HID_SUBDRIVERS_H_ +#define USB_HID_SUBDRIVERS_H_ + +#include "usbhid.h" +#include "kbd/kbddev.h" + +/*----------------------------------------------------------------------------*/ + +typedef struct usb_hid_subdriver_usage { + int usage_page; + int usage; +} usb_hid_subdriver_usage_t; + +/*----------------------------------------------------------------------------*/ + +/* TODO: This mapping must contain some other information to get the proper + * interface. + */ +typedef struct usb_hid_subdriver_mapping { + const usb_hid_subdriver_usage_t *usage_path; + int report_id; + int compare; + int vendor_id; + int product_id; + usb_hid_subdriver_t subdriver; +} usb_hid_subdriver_mapping_t; + +/*----------------------------------------------------------------------------*/ + +extern const usb_hid_subdriver_mapping_t usb_hid_subdrivers[]; + +/*----------------------------------------------------------------------------*/ + +#endif /* USB_HID_SUBDRIVERS_H_ */ + +/** + * @} + */ Index: uspace/drv/usbhid/usbhid.c =================================================================== --- uspace/drv/usbhid/usbhid.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/usbhid.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,678 @@ +/* + * 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 driver API. + */ + +#include +#include +#include +#include +#include +#include +#include +#include + +#include "usbhid.h" + +#include "kbd/kbddev.h" +#include "generic/hiddev.h" +#include "mouse/mousedev.h" +#include "subdrivers.h" + +/*----------------------------------------------------------------------------*/ + +/* Array of endpoints expected on the device, NULL terminated. */ +usb_endpoint_description_t *usb_hid_endpoints[USB_HID_POLL_EP_COUNT + 1] = { + &usb_hid_kbd_poll_endpoint_description, + &usb_hid_mouse_poll_endpoint_description, + &usb_hid_generic_poll_endpoint_description, + NULL +}; + +static const int USB_HID_MAX_SUBDRIVERS = 10; + +/*----------------------------------------------------------------------------*/ + +static int usb_hid_set_boot_kbd_subdriver(usb_hid_dev_t *hid_dev) +{ + assert(hid_dev != NULL && hid_dev->subdriver_count == 0); + + hid_dev->subdrivers = (usb_hid_subdriver_t *)malloc( + sizeof(usb_hid_subdriver_t)); + if (hid_dev->subdrivers == NULL) { + return ENOMEM; + } + + assert(hid_dev->subdriver_count >= 0); + + // set the init callback + hid_dev->subdrivers[hid_dev->subdriver_count].init = usb_kbd_init; + + // set the polling callback + hid_dev->subdrivers[hid_dev->subdriver_count].poll = + usb_kbd_polling_callback; + + // set the polling ended callback + hid_dev->subdrivers[hid_dev->subdriver_count].poll_end = NULL; + + // set the deinit callback + hid_dev->subdrivers[hid_dev->subdriver_count].deinit = usb_kbd_deinit; + + // set subdriver count + ++hid_dev->subdriver_count; + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +static int usb_hid_set_boot_mouse_subdriver(usb_hid_dev_t *hid_dev) +{ + assert(hid_dev != NULL && hid_dev->subdriver_count == 0); + + hid_dev->subdrivers = (usb_hid_subdriver_t *)malloc( + sizeof(usb_hid_subdriver_t)); + if (hid_dev->subdrivers == NULL) { + return ENOMEM; + } + + assert(hid_dev->subdriver_count >= 0); + + // set the init callback + hid_dev->subdrivers[hid_dev->subdriver_count].init = usb_mouse_init; + + // set the polling callback + hid_dev->subdrivers[hid_dev->subdriver_count].poll = + usb_mouse_polling_callback; + + // set the polling ended callback + hid_dev->subdrivers[hid_dev->subdriver_count].poll_end = NULL; + + // set the deinit callback + hid_dev->subdrivers[hid_dev->subdriver_count].deinit = usb_mouse_deinit; + + // set subdriver count + ++hid_dev->subdriver_count; + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +static int usb_hid_set_generic_hid_subdriver(usb_hid_dev_t *hid_dev) +{ + assert(hid_dev != NULL && hid_dev->subdriver_count == 0); + + hid_dev->subdrivers = (usb_hid_subdriver_t *)malloc( + sizeof(usb_hid_subdriver_t)); + if (hid_dev->subdrivers == NULL) { + return ENOMEM; + } + + assert(hid_dev->subdriver_count >= 0); + + // set the init callback + hid_dev->subdrivers[hid_dev->subdriver_count].init = + usb_generic_hid_init; + + // set the polling callback + hid_dev->subdrivers[hid_dev->subdriver_count].poll = + usb_generic_hid_polling_callback; + + // set the polling ended callback + hid_dev->subdrivers[hid_dev->subdriver_count].poll_end = NULL; + + // set the deinit callback + hid_dev->subdrivers[hid_dev->subdriver_count].deinit = NULL; + + // set subdriver count + ++hid_dev->subdriver_count; + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +static bool usb_hid_ids_match(usb_hid_dev_t *hid_dev, + const usb_hid_subdriver_mapping_t *mapping) +{ + assert(hid_dev != NULL); + assert(hid_dev->usb_dev != NULL); + + return (hid_dev->usb_dev->descriptors.device.vendor_id + == mapping->vendor_id + && hid_dev->usb_dev->descriptors.device.product_id + == mapping->product_id); +} + +/*----------------------------------------------------------------------------*/ + +static bool usb_hid_path_matches(usb_hid_dev_t *hid_dev, + const usb_hid_subdriver_mapping_t *mapping) +{ + assert(hid_dev != NULL); + assert(mapping != NULL); + + usb_hid_report_path_t *usage_path = usb_hid_report_path(); + if (usage_path == NULL) { + usb_log_debug("Failed to create usage path.\n"); + return false; + } + int i = 0; + while (mapping->usage_path[i].usage != 0 + || mapping->usage_path[i].usage_page != 0) { + if (usb_hid_report_path_append_item(usage_path, + mapping->usage_path[i].usage_page, + mapping->usage_path[i].usage) != EOK) { + usb_log_debug("Failed to append to usage path.\n"); + usb_hid_report_path_free(usage_path); + return false; + } + ++i; + } + + assert(hid_dev->report != NULL); + + usb_log_debug("Compare flags: %d\n", mapping->compare); + + bool matches = false; + uint8_t report_id = mapping->report_id; + + do { + usb_log_debug("Trying report id %u\n", report_id); + + if (report_id != 0) { + usb_hid_report_path_set_report_id(usage_path, + report_id); + } + + usb_hid_report_field_t *field = usb_hid_report_get_sibling( + hid_dev->report, + NULL, usage_path, mapping->compare, + USB_HID_REPORT_TYPE_INPUT); + + usb_log_debug("Field: %p\n", field); + + if (field != NULL) { + matches = true; + break; + } + + report_id = usb_hid_get_next_report_id( + hid_dev->report, report_id, + USB_HID_REPORT_TYPE_INPUT); + } while (!matches && report_id != 0); + + usb_hid_report_path_free(usage_path); + + return matches; +} + +/*----------------------------------------------------------------------------*/ + +static int usb_hid_save_subdrivers(usb_hid_dev_t *hid_dev, + const usb_hid_subdriver_t **subdrivers, int count) +{ + int i; + + if (count <= 0) { + hid_dev->subdriver_count = 0; + hid_dev->subdrivers = NULL; + return EOK; + } + + // add one generic HID subdriver per device + + hid_dev->subdrivers = (usb_hid_subdriver_t *)malloc((count + 1) * + sizeof(usb_hid_subdriver_t)); + if (hid_dev->subdrivers == NULL) { + return ENOMEM; + } + + for (i = 0; i < count; ++i) { + hid_dev->subdrivers[i].init = subdrivers[i]->init; + hid_dev->subdrivers[i].deinit = subdrivers[i]->deinit; + hid_dev->subdrivers[i].poll = subdrivers[i]->poll; + hid_dev->subdrivers[i].poll_end = subdrivers[i]->poll_end; + } + + hid_dev->subdrivers[count].init = usb_generic_hid_init; + hid_dev->subdrivers[count].poll = usb_generic_hid_polling_callback; + hid_dev->subdrivers[count].deinit = NULL; + hid_dev->subdrivers[count].poll_end = NULL; + + hid_dev->subdriver_count = count + 1; + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +static int usb_hid_find_subdrivers(usb_hid_dev_t *hid_dev) +{ + assert(hid_dev != NULL); + + const usb_hid_subdriver_t *subdrivers[USB_HID_MAX_SUBDRIVERS]; + + int i = 0, count = 0; + const usb_hid_subdriver_mapping_t *mapping = &usb_hid_subdrivers[i]; + + bool ids_matched; + bool matched; + + while (count < USB_HID_MAX_SUBDRIVERS && + (mapping->usage_path != NULL + || mapping->vendor_id >= 0 || mapping->product_id >= 0)) { + // check the vendor & product ID + if (mapping->vendor_id >= 0 && mapping->product_id < 0) { + usb_log_warning("Missing Product ID for Vendor ID %d\n", + mapping->vendor_id); + return EINVAL; + } + if (mapping->product_id >= 0 && mapping->vendor_id < 0) { + usb_log_warning("Missing Vendor ID for Product ID %d\n", + mapping->product_id); + return EINVAL; + } + + ids_matched = false; + matched = false; + + if (mapping->vendor_id >= 0) { + assert(mapping->product_id >= 0); + usb_log_debug("Comparing device against vendor ID %u" + " and product ID %u.\n", mapping->vendor_id, + mapping->product_id); + if (usb_hid_ids_match(hid_dev, mapping)) { + usb_log_debug("IDs matched.\n"); + ids_matched = true; + } + } + + if (mapping->usage_path != NULL) { + usb_log_debug("Comparing device against usage path.\n"); + if (usb_hid_path_matches(hid_dev, mapping)) { + // does not matter if IDs were matched + matched = true; + } + } else { + // matched only if IDs were matched and there is no path + matched = ids_matched; + } + + if (matched) { + usb_log_debug("Subdriver matched.\n"); + subdrivers[count++] = &mapping->subdriver; + } + + mapping = &usb_hid_subdrivers[++i]; + } + + // we have all subdrivers determined, save them into the hid device + return usb_hid_save_subdrivers(hid_dev, subdrivers, count); +} + +/*----------------------------------------------------------------------------*/ + +static int usb_hid_check_pipes(usb_hid_dev_t *hid_dev, usb_device_t *dev) +{ + assert(hid_dev != NULL && dev != NULL); + + int rc = EOK; + + if (dev->pipes[USB_HID_KBD_POLL_EP_NO].present) { + usb_log_debug("Found keyboard endpoint.\n"); + // save the pipe index + hid_dev->poll_pipe_index = USB_HID_KBD_POLL_EP_NO; + } else if (dev->pipes[USB_HID_MOUSE_POLL_EP_NO].present) { + usb_log_debug("Found mouse endpoint.\n"); + // save the pipe index + hid_dev->poll_pipe_index = USB_HID_MOUSE_POLL_EP_NO; + } else if (dev->pipes[USB_HID_GENERIC_POLL_EP_NO].present) { + usb_log_debug("Found generic HID endpoint.\n"); + // save the pipe index + hid_dev->poll_pipe_index = USB_HID_GENERIC_POLL_EP_NO; + } else { + usb_log_error("None of supported endpoints found - probably" + " not a supported device.\n"); + rc = ENOTSUP; + } + + return rc; +} + +/*----------------------------------------------------------------------------*/ + +static int usb_hid_init_report(usb_hid_dev_t *hid_dev) +{ + assert(hid_dev != NULL && hid_dev->report != NULL); + + uint8_t report_id = 0; + size_t size; + + size_t max_size = 0; + + do { + usb_log_debug("Getting size of the report.\n"); + size = usb_hid_report_byte_size(hid_dev->report, report_id, + USB_HID_REPORT_TYPE_INPUT); + usb_log_debug("Report ID: %u, size: %zu\n", report_id, size); + max_size = (size > max_size) ? size : max_size; + usb_log_debug("Getting next report ID\n"); + report_id = usb_hid_get_next_report_id(hid_dev->report, + report_id, USB_HID_REPORT_TYPE_INPUT); + } while (report_id != 0); + + usb_log_debug("Max size of input report: %zu\n", max_size); + + hid_dev->max_input_report_size = max_size; + assert(hid_dev->input_report == NULL); + + hid_dev->input_report = malloc(max_size); + if (hid_dev->input_report == NULL) { + return ENOMEM; + } + memset(hid_dev->input_report, 0, max_size); + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +usb_hid_dev_t *usb_hid_new(void) +{ + usb_hid_dev_t *hid_dev = (usb_hid_dev_t *)calloc(1, + sizeof(usb_hid_dev_t)); + + if (hid_dev == NULL) { + usb_log_fatal("No memory!\n"); + return NULL; + } + + hid_dev->report = (usb_hid_report_t *)(malloc(sizeof( + usb_hid_report_t))); + if (hid_dev->report == NULL) { + usb_log_fatal("No memory!\n"); + free(hid_dev); + return NULL; + } + + hid_dev->poll_pipe_index = -1; + + return hid_dev; +} + +/*----------------------------------------------------------------------------*/ + +int usb_hid_init(usb_hid_dev_t *hid_dev, usb_device_t *dev) +{ + int rc, i; + + usb_log_debug("Initializing HID structure...\n"); + + if (hid_dev == NULL) { + usb_log_error("Failed to init HID structure: no structure given" + ".\n"); + return EINVAL; + } + + if (dev == NULL) { + usb_log_error("Failed to init HID structure: no USB device" + " given.\n"); + return EINVAL; + } + + /* The USB device should already be initialized, save it in structure */ + hid_dev->usb_dev = dev; + + rc = usb_hid_check_pipes(hid_dev, dev); + if (rc != EOK) { + return rc; + } + + /* Get the report descriptor and parse it. */ + rc = usb_hid_process_report_descriptor(hid_dev->usb_dev, + hid_dev->report, &hid_dev->report_desc, &hid_dev->report_desc_size); + + bool fallback = false; + + if (rc == EOK) { + // try to find subdrivers that may want to handle this device + rc = usb_hid_find_subdrivers(hid_dev); + if (rc != EOK || hid_dev->subdriver_count == 0) { + // try to fall back to the boot protocol if available + usb_log_info("No subdrivers found to handle this" + " device.\n"); + fallback = true; + assert(hid_dev->subdrivers == NULL); + assert(hid_dev->subdriver_count == 0); + } + } else { + usb_log_error("Failed to parse Report descriptor.\n"); + // try to fall back to the boot protocol if available + fallback = true; + } + + if (fallback) { + // fall back to boot protocol + switch (hid_dev->poll_pipe_index) { + case USB_HID_KBD_POLL_EP_NO: + usb_log_info("Falling back to kbd boot protocol.\n"); + rc = usb_kbd_set_boot_protocol(hid_dev); + if (rc == EOK) { + rc = usb_hid_set_boot_kbd_subdriver(hid_dev); + } + break; + case USB_HID_MOUSE_POLL_EP_NO: + usb_log_info("Falling back to mouse boot protocol.\n"); + rc = usb_mouse_set_boot_protocol(hid_dev); + if (rc == EOK) { + rc = usb_hid_set_boot_mouse_subdriver(hid_dev); + } + break; + default: + assert(hid_dev->poll_pipe_index + == USB_HID_GENERIC_POLL_EP_NO); + + usb_log_info("Falling back to generic HID driver.\n"); + rc = usb_hid_set_generic_hid_subdriver(hid_dev); + } + } + + if (rc != EOK) { + usb_log_error("No subdriver for handling this device could be" + " initialized: %s.\n", str_error(rc)); + usb_log_debug("Subdriver count: %d\n", + hid_dev->subdriver_count); + + } else { + bool ok = false; + + usb_log_debug("Subdriver count: %d\n", + hid_dev->subdriver_count); + + for (i = 0; i < hid_dev->subdriver_count; ++i) { + if (hid_dev->subdrivers[i].init != NULL) { + usb_log_debug("Initializing subdriver %d.\n",i); + rc = hid_dev->subdrivers[i].init(hid_dev, + &hid_dev->subdrivers[i].data); + if (rc != EOK) { + usb_log_warning("Failed to initialize" + " HID subdriver structure.\n"); + } else { + // at least one subdriver initialized + ok = true; + } + } else { + ok = true; + } + } + + rc = (ok) ? EOK : -1; // what error to report + } + + + if (rc == EOK) { + // save max input report size and allocate space for the report + rc = usb_hid_init_report(hid_dev); + if (rc != EOK) { + usb_log_error("Failed to initialize input report buffer" + ".\n"); + } + } + + + return rc; +} + +/*----------------------------------------------------------------------------*/ + +bool usb_hid_polling_callback(usb_device_t *dev, uint8_t *buffer, + size_t buffer_size, void *arg) +{ + int i; + + if (dev == NULL || arg == NULL || buffer == NULL) { + usb_log_error("Missing arguments to polling callback.\n"); + return false; + } + + usb_hid_dev_t *hid_dev = (usb_hid_dev_t *)arg; + + assert(hid_dev->input_report != NULL); + usb_log_debug("Max input report size: %zu, buffer size: %zu\n", + hid_dev->max_input_report_size, buffer_size); + + if (hid_dev->max_input_report_size >= buffer_size) { + /*! @todo This should probably be atomic. */ + memcpy(hid_dev->input_report, buffer, buffer_size); + hid_dev->input_report_size = buffer_size; + usb_hid_new_report(hid_dev); + } + + bool cont = false; + + // continue if at least one of the subdrivers want to continue + for (i = 0; i < hid_dev->subdriver_count; ++i) { + if (hid_dev->subdrivers[i].poll != NULL + && hid_dev->subdrivers[i].poll(hid_dev, + hid_dev->subdrivers[i].data, buffer, buffer_size)) { + cont = true; + } + } + + return cont; +} + +/*----------------------------------------------------------------------------*/ + +void usb_hid_polling_ended_callback(usb_device_t *dev, bool reason, + void *arg) +{ + int i; + + if (dev == NULL || arg == NULL) { + return; + } + + usb_hid_dev_t *hid_dev = (usb_hid_dev_t *)arg; + + for (i = 0; i < hid_dev->subdriver_count; ++i) { + if (hid_dev->subdrivers[i].poll_end != NULL) { + hid_dev->subdrivers[i].poll_end(hid_dev, + hid_dev->subdrivers[i].data, reason); + } + } + + usb_hid_free(&hid_dev); +} + +/*----------------------------------------------------------------------------*/ + +void usb_hid_new_report(usb_hid_dev_t *hid_dev) +{ + ++hid_dev->report_nr; +} + +/*----------------------------------------------------------------------------*/ + +int usb_hid_report_number(usb_hid_dev_t *hid_dev) +{ + return hid_dev->report_nr; +} + +/*----------------------------------------------------------------------------*/ + +void usb_hid_free(usb_hid_dev_t **hid_dev) +{ + int i; + + if (hid_dev == NULL || *hid_dev == NULL) { + return; + } + + usb_log_debug("Subdrivers: %p, subdriver count: %d\n", + (*hid_dev)->subdrivers, (*hid_dev)->subdriver_count); + + assert((*hid_dev)->subdrivers != NULL + || (*hid_dev)->subdriver_count == 0); + + for (i = 0; i < (*hid_dev)->subdriver_count; ++i) { + if ((*hid_dev)->subdrivers[i].deinit != NULL) { + (*hid_dev)->subdrivers[i].deinit(*hid_dev, + (*hid_dev)->subdrivers[i].data); + } + } + + // free the subdrivers info + if ((*hid_dev)->subdrivers != NULL) { + free((*hid_dev)->subdrivers); + } + + // destroy the parser + if ((*hid_dev)->report != NULL) { + usb_hid_free_report((*hid_dev)->report); + } + + if ((*hid_dev)->report_desc != NULL) { + free((*hid_dev)->report_desc); + } + + free(*hid_dev); + *hid_dev = NULL; +} + +/** + * @} + */ Index: uspace/drv/usbhid/usbhid.h =================================================================== --- uspace/drv/usbhid/usbhid.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/usbhid.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,137 @@ +/* + * 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 driver API. + */ + +#ifndef USB_HID_USBHID_H_ +#define USB_HID_USBHID_H_ + +#include + +#include +#include +#include +#include +#include +#include + +struct usb_hid_dev; + +typedef int (*usb_hid_driver_init_t)(struct usb_hid_dev *, void **data); +typedef void (*usb_hid_driver_deinit_t)(struct usb_hid_dev *, void *data); +typedef bool (*usb_hid_driver_poll)(struct usb_hid_dev *, void *data, uint8_t *, + size_t); +typedef int (*usb_hid_driver_poll_ended)(struct usb_hid_dev *, void *data, + bool reason); + +typedef struct usb_hid_subdriver { + /** Function to be called when initializing HID device. */ + usb_hid_driver_init_t init; + /** Function to be called when destroying the HID device structure. */ + usb_hid_driver_deinit_t deinit; + /** Function to be called when data arrives from the device. */ + usb_hid_driver_poll poll; + /** Function to be called when polling ends. */ + usb_hid_driver_poll_ended poll_end; + /** Arbitrary data needed by the subdriver. */ + void *data; +} usb_hid_subdriver_t; + +/*----------------------------------------------------------------------------*/ +/** + * Structure for holding general HID device data. + */ +typedef struct usb_hid_dev { + /** Structure holding generic USB device information. */ + usb_device_t *usb_dev; + + /** Index of the polling pipe in usb_hid_endpoints array. */ + int poll_pipe_index; + + /** Subdrivers. */ + usb_hid_subdriver_t *subdrivers; + + /** Number of subdrivers. */ + int subdriver_count; + + /** Report descriptor. */ + uint8_t *report_desc; + + /** Report descriptor size. */ + size_t report_desc_size; + + /** HID Report parser. */ + usb_hid_report_t *report; + + uint8_t *input_report; + + size_t input_report_size; + size_t max_input_report_size; + + int report_nr; +} usb_hid_dev_t; + +/*----------------------------------------------------------------------------*/ + +enum { + USB_HID_KBD_POLL_EP_NO = 0, + USB_HID_MOUSE_POLL_EP_NO = 1, + USB_HID_GENERIC_POLL_EP_NO = 2, + USB_HID_POLL_EP_COUNT = 3 +}; + +usb_endpoint_description_t *usb_hid_endpoints[USB_HID_POLL_EP_COUNT + 1]; + +/*----------------------------------------------------------------------------*/ + +usb_hid_dev_t *usb_hid_new(void); + +int usb_hid_init(usb_hid_dev_t *hid_dev, usb_device_t *dev); + +bool usb_hid_polling_callback(usb_device_t *dev, uint8_t *buffer, + size_t buffer_size, void *arg); + +void usb_hid_polling_ended_callback(usb_device_t *dev, bool reason, + void *arg); + +void usb_hid_new_report(usb_hid_dev_t *hid_dev); + +int usb_hid_report_number(usb_hid_dev_t *hid_dev); + +void usb_hid_free(usb_hid_dev_t **hid_dev); + +#endif /* USB_HID_USBHID_H_ */ + +/** + * @} + */ Index: uspace/drv/usbhid/usbhid.ma =================================================================== --- uspace/drv/usbhid/usbhid.ma (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhid/usbhid.ma (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,3 @@ +100 usb&interface&class=HID&subclass=0x01&protocol=0x01 +1000 usb&interface&class=HID&subclass=0x01&protocol=0x02 +100 usb&interface&class=HID Index: uspace/drv/usbhub/Makefile =================================================================== --- uspace/drv/usbhub/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhub/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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. +# + +USPACE_PREFIX = ../.. + +LIBS = \ + $(LIBUSBDEV_PREFIX)/libusbdev.a \ + $(LIBUSB_PREFIX)/libusb.a \ + $(LIBDRV_PREFIX)/libdrv.a +EXTRA_CFLAGS += \ + -I$(LIBUSB_PREFIX)/include \ + -I$(LIBUSBDEV_PREFIX)/include \ + -I$(LIBDRV_PREFIX)/include + +BINARY = usbhub + +SOURCES = \ + main.c \ + utils.c \ + usbhub.c \ + ports.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/usbhub/main.c =================================================================== --- uspace/drv/usbhub/main.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhub/main.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,96 @@ +/* + * 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 +}; + +/** + * usb hub driver operations + * + * The most important one is add_device, which is set to usb_hub_add_device. + */ +static usb_driver_ops_t usb_hub_driver_ops = { + .add_device = usb_hub_add_device +}; + +/** + * hub endpoints, excluding control endpoint + */ +static usb_endpoint_description_t *usb_hub_endpoints[] = { + &hub_status_change_endpoint_description, + NULL +}; + +/** + * static usb hub driver information + */ +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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhub/port_status.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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; + +/** + * structure holding hub status and changes flags. + * should not be accessed directly, use supplied getter/setter methods. + * + * For more information refer to table 11.16.2.5 in + * "Universal Serial Bus Specification Revision 1.1" + * + */ +typedef uint32_t usb_hub_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; +} + +/** + * set values in request to be it a port status request + * @param request + * @param port + */ +static inline void usb_hub_set_hub_status_request( + usb_device_request_setup_packet_t *request) { + request->index = 0; + request->request_type = USB_HUB_REQ_TYPE_GET_HUB_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 = + malloc(sizeof (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 feature clear request + * @param request + * @param port + * @param feature_selector + */ +static inline void usb_hub_set_disable_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_CLEAR_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 = + malloc(sizeof (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 = + malloc(sizeof (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 = + malloc(sizeof (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 + * + * @param status + * @param idx + * @return + */ +static inline bool usb_port_is_status(usb_port_status_t status, int idx) { + return (status & (1 << idx)) != 0; +} + +/** + * set i`th bit of port status + * + * @param status + * @param idx + * @param value + */ +static inline void usb_port_status_set_bit( + usb_port_status_t * status, int idx, bool value) { + (*status) = value ? + ((*status) | (1 << (idx))) : + ((*status)&(~(1 << (idx)))); +} + +/** + * get i`th bit of hub status + * + * @param status + * @param idx + * @return + */ +static inline bool usb_hub_is_status(usb_hub_status_t status, int idx) { + return (status & (1 << idx)) != 0; +} + +/** + * set i`th bit of hub status + * + * @param status + * @param idx + * @param value + */ +static inline void usb_hub_status_set_bit( + usb_hub_status_t *status, int idx, bool value) { + (*status) = value ? + ((*status) | (1 << (idx))) : + ((*status)&(~(1 << (idx)))); +} + +/** + * low speed device on the port indicator + * + * @param status + * @return true if low speed device is attached + */ +static inline bool usb_port_low_speed(usb_port_status_t status) { + return usb_port_is_status(status, 9); +} + +/** + * set low speed device connected bit in port status + * + * @param status + * @param low_speed value of the bit + */ +static inline void usb_port_set_low_speed(usb_port_status_t *status, bool low_speed) { + usb_port_status_set_bit(status, 9, low_speed); +} + +//high speed device attached + +/** + * high speed device on the port indicator + * + * @param status + * @return true if high speed device is on port + */ +static inline bool usb_port_high_speed(usb_port_status_t status) { + return usb_port_is_status(status, 10); +} + +/** + * set high speed device bit in port status + * + * @param status + * @param high_speed value of the bit + */ +static inline void usb_port_set_high_speed(usb_port_status_t *status, bool high_speed) { + usb_port_status_set_bit(status, 10, high_speed); +} + +/** + * speed getter for port status + * + * @param status + * @return speed of usb device (for more see usb specification) + */ +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; +} + + + +#endif /* HUB_PORT_STATUS_H */ + +/** + * @} + */ Index: uspace/drv/usbhub/ports.c =================================================================== --- uspace/drv/usbhub/ports.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhub/ports.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,465 @@ +/* + * 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 drvusbhub + * @{ + */ +/** @file + * Hub ports functions. + */ + +#include +#include +#include +#include +#include + +#include + +#include "ports.h" +#include "usbhub.h" +#include "usbhub_private.h" +#include "port_status.h" + +/** Information for fibril for device discovery. */ +struct add_device_phase1 { + usb_hub_info_t *hub; + size_t port; + usb_speed_t speed; +}; + +/** + * count of port status changes that are not explicitly handled by + * any function here and must be cleared by hand + */ +static const unsigned int non_handled_changes_count = 2; + +/** + * port status changes that are not explicitly handled by + * any function here and must be cleared by hand + */ +static const int non_handled_changes[] = { + USB_HUB_FEATURE_C_PORT_ENABLE, + USB_HUB_FEATURE_C_PORT_SUSPEND +}; + +static void usb_hub_removed_device( + usb_hub_info_t *hub, uint16_t port); + +static void usb_hub_port_reset_completed(usb_hub_info_t *hub, + uint16_t port, uint32_t status); + +static void usb_hub_port_over_current(usb_hub_info_t *hub, + uint16_t port, uint32_t status); + +static int get_port_status(usb_pipe_t *ctrl_pipe, size_t port, + usb_port_status_t *status); + +static int enable_port_callback(int port_no, void *arg); + +static int add_device_phase1_worker_fibril(void *arg); + +static int create_add_device_fibril(usb_hub_info_t *hub, size_t port, + usb_speed_t speed); + +/** + * 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 + */ +void usb_hub_process_port_interrupt(usb_hub_info_t *hub, + uint16_t port) { + usb_log_debug("Interrupt at port %zu\n", (size_t) port); + //determine type of change + //usb_pipe_t *pipe = hub->control_pipe; + + int opResult; + + usb_port_status_t status; + opResult = get_port_status(&hub->usb_device->ctrl_pipe, port, &status); + if (opResult != EOK) { + usb_log_error("Failed to get port %zu status: %s.\n", + (size_t) port, str_error(opResult)); + return; + } + //connection change + if (usb_port_is_status(status, USB_HUB_FEATURE_C_PORT_CONNECTION)) { + bool device_connected = usb_port_is_status(status, + USB_HUB_FEATURE_PORT_CONNECTION); + usb_log_debug("Connection change on port %zu: %s.\n", + (size_t) port, + device_connected ? "device attached" : "device removed"); + + if (device_connected) { + opResult = create_add_device_fibril(hub, port, + usb_port_speed(status)); + if (opResult != EOK) { + usb_log_error( + "Cannot handle change on port %zu: %s.\n", + (size_t) port, str_error(opResult)); + } + } else { + usb_hub_removed_device(hub, port); + } + } + //over current + if (usb_port_is_status(status, USB_HUB_FEATURE_C_PORT_OVER_CURRENT)) { + //check if it was not auto-resolved + usb_log_debug("Overcurrent change on port\n"); + usb_hub_port_over_current(hub, port, status); + } + //port reset + if (usb_port_is_status(status, USB_HUB_FEATURE_C_PORT_RESET)) { + usb_hub_port_reset_completed(hub, port, status); + } + usb_log_debug("Status x%x : %d\n ", status, status); + + usb_port_status_set_bit( + &status, USB_HUB_FEATURE_C_PORT_CONNECTION, false); + usb_port_status_set_bit( + &status, USB_HUB_FEATURE_C_PORT_RESET, false); + usb_port_status_set_bit( + &status, USB_HUB_FEATURE_C_PORT_OVER_CURRENT, false); + + //clearing not yet handled changes + unsigned int feature_idx; + for (feature_idx = 0; + feature_idx < non_handled_changes_count; + ++feature_idx) { + unsigned int bit_idx = non_handled_changes[feature_idx]; + if (status & (1 << bit_idx)) { + usb_log_info( + "There was not yet handled change on port %d: %d" + ";clearing it\n", + port, bit_idx); + int opResult = usb_hub_clear_port_feature( + hub->control_pipe, + port, bit_idx); + if (opResult != EOK) { + usb_log_warning( + "Could not clear port flag %d: %s\n", + bit_idx, str_error(opResult) + ); + } + usb_port_status_set_bit( + &status, bit_idx, false); + } + } + if (status >> 16) { + usb_log_info("There is still some unhandled change %X\n", + status); + } +} + +/** + * 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 + + usb_hub_port_t *the_port = hub->ports + port; + + fibril_mutex_lock(&hub->port_mutex); + + if (the_port->attached_device.address >= 0) { + usb_log_warning("Device unplug on `%s' (port %zu): " \ + "not implemented.\n", hub->usb_device->ddf_dev->name, + (size_t) port); + the_port->attached_device.address = -1; + the_port->attached_device.handle = 0; + } else { + usb_log_warning("Device removed before being registered.\n"); + + /* + * Device was removed before port reset completed. + * We will announce a failed port reset to unblock the + * port reset callback from new device wrapper. + */ + fibril_mutex_lock(&the_port->reset_mutex); + the_port->reset_completed = true; + the_port->reset_okay = false; + fibril_condvar_broadcast(&the_port->reset_cv); + fibril_mutex_unlock(&the_port->reset_mutex); + } + + fibril_mutex_unlock(&hub->port_mutex); +} + +/** + * Process port reset change + * + * After this change port should be enabled, unless some problem occured. + * This functions triggers second phase of enabling new device. + * @param hub + * @param port + * @param status + */ +static void usb_hub_port_reset_completed(usb_hub_info_t *hub, + uint16_t port, uint32_t status) { + usb_log_debug("Port %zu reset complete.\n", (size_t) port); + if (usb_port_is_status(status, USB_HUB_FEATURE_PORT_ENABLE)) { + /* Finalize device adding. */ + usb_hub_port_t *the_port = hub->ports + port; + fibril_mutex_lock(&the_port->reset_mutex); + the_port->reset_completed = true; + the_port->reset_okay = true; + fibril_condvar_broadcast(&the_port->reset_cv); + fibril_mutex_unlock(&the_port->reset_mutex); + } else { + usb_log_warning( + "Port %zu reset complete but port not enabled.\n", + (size_t) port); + } + /* Clear the port reset change. */ + int rc = usb_hub_clear_port_feature(hub->control_pipe, + port, USB_HUB_FEATURE_C_PORT_RESET); + if (rc != EOK) { + usb_log_error("Failed to clear port %d reset feature: %s.\n", + port, str_error(rc)); + } +} + +/** + * 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_port_over_current(usb_hub_info_t *hub, + uint16_t port, uint32_t status) { + int opResult; + if (usb_port_is_status(status, USB_HUB_FEATURE_PORT_OVER_CURRENT)) { + 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; %s\n", + port, str_error(opResult)); + } + } else { + opResult = usb_hub_set_port_feature(hub->control_pipe, + port, USB_HUB_FEATURE_PORT_POWER); + if (opResult != EOK) { + usb_log_error("Cannot power on port %d; %s\n", + port, str_error(opResult)); + } + } +} + +/** Retrieve port status. + * + * @param[in] ctrl_pipe Control pipe to use. + * @param[in] port Port number (starting at 1). + * @param[out] status Where to store the port status. + * @return Error code. + */ +static int get_port_status(usb_pipe_t *ctrl_pipe, size_t port, + usb_port_status_t *status) { + size_t recv_size; + usb_device_request_setup_packet_t request; + usb_port_status_t status_tmp; + + usb_hub_set_port_status_request(&request, port); + int rc = usb_pipe_control_read(ctrl_pipe, + &request, sizeof (usb_device_request_setup_packet_t), + &status_tmp, sizeof (status_tmp), &recv_size); + if (rc != EOK) { + return rc; + } + + if (recv_size != sizeof (status_tmp)) { + return ELIMIT; + } + + if (status != NULL) { + *status = status_tmp; + } + + return EOK; +} + +/** Callback for enabling a specific port. + * + * We wait on a CV until port is reseted. + * That is announced via change on interrupt pipe. + * + * @param port_no Port number (starting at 1). + * @param arg Custom argument, points to @c usb_hub_info_t. + * @return Error code. + */ +static int enable_port_callback(int port_no, void *arg) { + usb_hub_info_t *hub = arg; + int rc; + usb_device_request_setup_packet_t request; + usb_hub_port_t *my_port = hub->ports + port_no; + + usb_hub_set_reset_port_request(&request, port_no); + rc = usb_pipe_control_write(hub->control_pipe, + &request, sizeof (request), NULL, 0); + if (rc != EOK) { + usb_log_warning("Port reset failed: %s.\n", str_error(rc)); + return rc; + } + + /* + * Wait until reset completes. + */ + fibril_mutex_lock(&my_port->reset_mutex); + while (!my_port->reset_completed) { + fibril_condvar_wait(&my_port->reset_cv, &my_port->reset_mutex); + } + fibril_mutex_unlock(&my_port->reset_mutex); + + if (my_port->reset_okay) { + return EOK; + } else { + return ESTALL; + } +} + +/** Fibril for adding a new device. + * + * Separate fibril is needed because the port reset completion is announced + * via interrupt pipe and thus we cannot block here. + * + * @param arg Pointer to struct add_device_phase1. + * @return 0 Always. + */ +static int add_device_phase1_worker_fibril(void *arg) { + struct add_device_phase1 *data + = (struct add_device_phase1 *) arg; + + usb_address_t new_address; + devman_handle_t child_handle; + + int rc = usb_hc_new_device_wrapper(data->hub->usb_device->ddf_dev, + &data->hub->connection, data->speed, + enable_port_callback, (int) data->port, data->hub, + &new_address, &child_handle, + NULL, NULL, NULL); + + if (rc != EOK) { + usb_log_error("Failed registering device on port %zu: %s.\n", + data->port, str_error(rc)); + goto leave; + } + + fibril_mutex_lock(&data->hub->port_mutex); + data->hub->ports[data->port].attached_device.handle = child_handle; + data->hub->ports[data->port].attached_device.address = new_address; + fibril_mutex_unlock(&data->hub->port_mutex); + + usb_log_info("Detected new device on `%s' (port %zu), " + "address %d (handle %" PRIun ").\n", + data->hub->usb_device->ddf_dev->name, data->port, + new_address, child_handle); + +leave: + free(arg); + + fibril_mutex_lock(&data->hub->pending_ops_mutex); + assert(data->hub->pending_ops_count > 0); + data->hub->pending_ops_count--; + fibril_condvar_signal(&data->hub->pending_ops_cv); + fibril_mutex_unlock(&data->hub->pending_ops_mutex); + + + return EOK; +} + +/** Start device adding when connection change is detected. + * + * This fires a new fibril to complete the device addition. + * + * @param hub Hub where the change occured. + * @param port Port index (starting at 1). + * @param speed Speed of the device. + * @return Error code. + */ +static int create_add_device_fibril(usb_hub_info_t *hub, size_t port, + usb_speed_t speed) { + struct add_device_phase1 *data + = malloc(sizeof (struct add_device_phase1)); + if (data == NULL) { + return ENOMEM; + } + data->hub = hub; + data->port = port; + data->speed = speed; + + usb_hub_port_t *the_port = hub->ports + port; + + fibril_mutex_lock(&the_port->reset_mutex); + the_port->reset_completed = false; + fibril_mutex_unlock(&the_port->reset_mutex); + + int rc = usb_hub_clear_port_feature(hub->control_pipe, port, + USB_HUB_FEATURE_C_PORT_CONNECTION); + if (rc != EOK) { + free(data); + usb_log_warning("Failed to clear port change flag: %s.\n", + str_error(rc)); + return rc; + } + + fid_t fibril = fibril_create(add_device_phase1_worker_fibril, data); + if (fibril == 0) { + free(data); + return ENOMEM; + } + fibril_mutex_lock(&hub->pending_ops_mutex); + hub->pending_ops_count++; + fibril_mutex_unlock(&hub->pending_ops_mutex); + fibril_add_ready(fibril); + + return EOK; +} + +/** + * @} + */ Index: uspace/drv/usbhub/ports.h =================================================================== --- uspace/drv/usbhub/ports.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhub/ports.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,80 @@ +/* + * 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 drvusbhub + * @{ + */ +/** @file + * Hub ports related functions. + */ +#ifndef DRV_USBHUB_PORTS_H +#define DRV_USBHUB_PORTS_H + +#include +#include + +typedef struct usb_hub_info_t usb_hub_info_t; + +/** Information about single port on a hub. */ +typedef struct { + /** Mutex needed by CV for checking port reset. */ + fibril_mutex_t reset_mutex; + /** CV for waiting to port reset completion. */ + fibril_condvar_t reset_cv; + /** Whether port reset is completed. + * Guarded by @c reset_mutex. + */ + bool reset_completed; + /** Whether to announce the port reset as successful. */ + bool reset_okay; + + /** Information about attached device. */ + usb_hc_attached_device_t attached_device; +} usb_hub_port_t; + +/** Initialize hub port information. + * + * @param port Port to be initialized. + */ +static inline void usb_hub_port_init(usb_hub_port_t *port) { + port->attached_device.address = -1; + port->attached_device.handle = 0; + fibril_mutex_initialize(&port->reset_mutex); + fibril_condvar_initialize(&port->reset_cv); +} + + +void usb_hub_process_port_interrupt(usb_hub_info_t *hub, + uint16_t port); + + + +#endif +/** + * @} + */ Index: uspace/drv/usbhub/usbhub.c =================================================================== --- uspace/drv/usbhub/usbhub.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhub/usbhub.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,522 @@ +/* + * 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 +#include + +#include "usbhub.h" +#include "usbhub_private.h" +#include "port_status.h" +#include +#include +#include + + +static usb_hub_info_t * usb_hub_info_create(usb_device_t *usb_dev); + +static int usb_hub_process_hub_specific_info(usb_hub_info_t *hub_info); + +static int usb_hub_set_configuration(usb_hub_info_t *hub_info); + +static int usb_hub_start_hub_fibril(usb_hub_info_t *hub_info); + +static int usb_process_hub_over_current(usb_hub_info_t *hub_info, + usb_hub_status_t status); + +static int usb_process_hub_local_power_change(usb_hub_info_t *hub_info, + usb_hub_status_t status); + +static void usb_hub_process_global_interrupt(usb_hub_info_t *hub_info); + +static void usb_hub_polling_terminated_callback(usb_device_t *device, + bool was_error, void *data); + + +//********************************************* +// +// hub driver code, initialization +// +//********************************************* + +/** + * 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, " + " %s\n", + str_error(opResult)); + free(hub_info); + return opResult; + } + + //set hub configuration + opResult = usb_hub_set_configuration(hub_info); + if (opResult != EOK) { + usb_log_error("Could not set hub configuration, %s\n", + str_error(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 process hub specific info, %s\n", + str_error(opResult)); + free(hub_info); + return opResult; + } + + usb_log_debug("Creating 'hub' function in DDF.\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; + + opResult = ddf_fun_bind(hub_fun); + assert(opResult == EOK); + opResult = ddf_fun_add_to_class(hub_fun, "hub"); + assert(opResult == EOK); + + opResult = usb_hub_start_hub_fibril(hub_info); + if (opResult != EOK) + free(hub_info); + return opResult; +} + +/** Callback for polling hub for changes. + * + * @param dev Device where the change occured. + * @param change_bitmap Bitmap of changed ports. + * @param change_bitmap_size Size of the bitmap in bytes. + * @param arg Custom argument, points to @c usb_hub_info_t. + * @return Whether to continue polling. + */ +bool hub_port_changes_callback(usb_device_t *dev, + uint8_t *change_bitmap, size_t change_bitmap_size, void *arg) { + usb_log_debug("hub_port_changes_callback\n"); + usb_hub_info_t *hub = (usb_hub_info_t *) arg; + + /* FIXME: check that we received enough bytes. */ + if (change_bitmap_size == 0) { + goto leave; + } + + bool change; + change = ((uint8_t*) change_bitmap)[0] & 1; + if (change) { + usb_hub_process_global_interrupt(hub); + } + + size_t port; + for (port = 1; port < hub->port_count + 1; port++) { + bool change = (change_bitmap[port / 8] >> (port % 8)) % 2; + if (change) { + usb_hub_process_port_interrupt(hub, port); + } + } +leave: + /* FIXME: proper interval. */ + async_usleep(1000 * 250); + + return true; +} + + +//********************************************* +// +// support functions +// +//********************************************* + +/** + * 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 = malloc(sizeof (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; + + result->ports = NULL; + result->port_count = (size_t) - 1; + fibril_mutex_initialize(&result->port_mutex); + + fibril_mutex_initialize(&result->pending_ops_mutex); + fibril_condvar_initialize(&result->pending_ops_cv); + result->pending_ops_count = 0; + 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"); + uint8_t serialized_descriptor[USB_HUB_MAX_DESCRIPTOR_SIZE]; + usb_hub_descriptor_t * descriptor; + int opResult; + + size_t received_size; + opResult = usb_request_get_descriptor(hub_info->control_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, " + "%s\n", + str_error(opResult)); + free(serialized_descriptor); + return opResult; + } + usb_log_debug2("Deserializing descriptor\n"); + descriptor = usb_create_deserialized_hub_desriptor( + serialized_descriptor); + if (descriptor == NULL) { + usb_log_warning("could not deserialize descriptor \n"); + return ENOMEM; + } + usb_log_debug("setting port count to %d\n", descriptor->ports_count); + hub_info->port_count = descriptor->ports_count; + bool is_power_switched = + ((descriptor->hub_characteristics & 1) == 0); + bool has_individual_port_powering = + ((descriptor->hub_characteristics & 1) != 0); + hub_info->ports = malloc( + sizeof (usb_hub_port_t) * (hub_info->port_count + 1)); + if (!hub_info->ports) { + return ENOMEM; + } + size_t port; + for (port = 0; port < hub_info->port_count + 1; ++port) { + usb_hub_port_init(&hub_info->ports[port]); + } + if (is_power_switched) { + usb_log_debug("Hub power switched\n"); + + if (!has_individual_port_powering) { + //this setting actually makes no difference + usb_log_debug("Hub has global powering\n"); + } + + for (port = 1; port <= hub_info->port_count; ++port) { + usb_log_debug("Powering port %zu.\n", port); + opResult = usb_hub_set_port_feature(hub_info->control_pipe, + port, USB_HUB_FEATURE_PORT_POWER); + if (opResult != EOK) { + usb_log_error("Cannot power on port %zu: %s.\n", + port, str_error(opResult)); + } + } + + } else { + usb_log_debug("Power not switched, not going to be powered\n"); + } + usb_log_debug2("Freeing data\n"); + 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; +} + +/** + * create and start fibril with hub control loop + * + * Before the fibril is started, the control pipe and host controller + * connection of the hub is open. + * + * @param hub_info hub representing structure + * @return error code + */ +static int usb_hub_start_hub_fibril(usb_hub_info_t *hub_info) { + int rc; + + rc = usb_device_auto_poll(hub_info->usb_device, 0, + hub_port_changes_callback, ((hub_info->port_count + 1) / 8) + 1, + usb_hub_polling_terminated_callback, hub_info); + if (rc != EOK) { + usb_log_error("Failed to create polling fibril: %s.\n", + str_error(rc)); + free(hub_info); + return rc; + } + + usb_log_info("Controlling hub `%s' (%zu ports).\n", + hub_info->usb_device->ddf_dev->name, hub_info->port_count); + return EOK; +} + +//********************************************* +// +// change handling functions +// +//********************************************* + +/** + * process hub over current change + * + * This means either to power off the hub or power it on. + * @param hub_info hub instance + * @param status hub status bitmask + * @return error code + */ +static int usb_process_hub_over_current(usb_hub_info_t *hub_info, + usb_hub_status_t status) { + int opResult; + if (usb_hub_is_status(status, USB_HUB_FEATURE_HUB_OVER_CURRENT)) { + //poweroff all ports + unsigned int port; + for (port = 1; port <= hub_info->port_count; ++port) { + opResult = usb_hub_clear_port_feature( + hub_info->control_pipe, port, + USB_HUB_FEATURE_PORT_POWER); + if (opResult != EOK) { + usb_log_warning( + "Cannot power off port %d; %s\n", + port, str_error(opResult)); + } + } + } else { + //power all ports + unsigned int port; + for (port = 1; port <= hub_info->port_count; ++port) { + opResult = usb_hub_set_port_feature( + hub_info->control_pipe, port, + USB_HUB_FEATURE_PORT_POWER); + if (opResult != EOK) { + usb_log_warning( + "Cannot power off port %d; %s\n", + port, str_error(opResult)); + } + } + } + return opResult; +} + +/** + * process hub local power change + * + * This change is ignored. + * @param hub_info hub instance + * @param status hub status bitmask + * @return error code + */ +static int usb_process_hub_local_power_change(usb_hub_info_t *hub_info, + usb_hub_status_t status) { + int opResult = EOK; + opResult = usb_hub_clear_feature(hub_info->control_pipe, + USB_HUB_FEATURE_C_HUB_LOCAL_POWER); + if (opResult != EOK) { + usb_log_error("Cannnot clear hub power change flag: " + "%s\n", + str_error(opResult)); + } + return opResult; +} + +/** + * process hub interrupts + * + * The change can be either in the over-current condition or + * local-power change. + * @param hub_info hub instance + */ +static void usb_hub_process_global_interrupt(usb_hub_info_t *hub_info) { + usb_log_debug("Global interrupt on a hub\n"); + usb_pipe_t *pipe = hub_info->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_hub_status_request(&request); + //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 hub status: %s\n", + str_error(opResult)); + return; + } + if (rcvd_size != sizeof (usb_port_status_t)) { + usb_log_error("Received status has incorrect size\n"); + return; + } + //port reset + if ( + usb_hub_is_status(status, 16 + USB_HUB_FEATURE_C_HUB_OVER_CURRENT)) { + usb_process_hub_over_current(hub_info, status); + } + if ( + usb_hub_is_status(status, 16 + USB_HUB_FEATURE_C_HUB_LOCAL_POWER)) { + usb_process_hub_local_power_change(hub_info, status); + } +} + +/** + * callback called from hub polling fibril when the fibril terminates + * + * Should perform a cleanup - deletes hub_info. + * @param device usb device afected + * @param was_error indicates that the fibril is stoped due to an error + * @param data pointer to usb_hub_info_t structure + */ +static void usb_hub_polling_terminated_callback(usb_device_t *device, + bool was_error, void *data) { + usb_hub_info_t * hub = data; + assert(hub); + + fibril_mutex_lock(&hub->pending_ops_mutex); + + /* The device is dead. However there might be some pending operations + * that we need to wait for. + * One of them is device adding in progress. + * The respective fibril is probably waiting for status change + * in port reset (port enable) callback. + * Such change would never come (otherwise we would not be here). + * Thus, we would flush all pending port resets. + */ + if (hub->pending_ops_count > 0) { + fibril_mutex_lock(&hub->port_mutex); + size_t port; + for (port = 0; port < hub->port_count; port++) { + usb_hub_port_t *the_port = hub->ports + port; + fibril_mutex_lock(&the_port->reset_mutex); + the_port->reset_completed = true; + the_port->reset_okay = false; + fibril_condvar_broadcast(&the_port->reset_cv); + fibril_mutex_unlock(&the_port->reset_mutex); + } + fibril_mutex_unlock(&hub->port_mutex); + } + /* And now wait for them. */ + while (hub->pending_ops_count > 0) { + fibril_condvar_wait(&hub->pending_ops_cv, + &hub->pending_ops_mutex); + } + fibril_mutex_unlock(&hub->pending_ops_mutex); + + usb_device_destroy(hub->usb_device); + + free(hub->ports); + free(hub); +} + + + + +/** + * @} + */ Index: uspace/drv/usbhub/usbhub.h =================================================================== --- uspace/drv/usbhub/usbhub.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhub/usbhub.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 drvusbhub + * @{ + */ +/** @file + * @brief Hub driver. + */ +#ifndef DRV_USBHUB_USBHUB_H +#define DRV_USBHUB_USBHUB_H + +#include +#include + +#include +#include + +#include +#include + +#include + +#define NAME "usbhub" + +#include "ports.h" + +/** Information about attached hub. */ +struct usb_hub_info_t { + /** Number of ports. */ + size_t port_count; + + /** attached device handles, for each port one */ + usb_hub_port_t *ports; + + fibril_mutex_t port_mutex; + + /** 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; + + /** Number of pending operations on the mutex to prevent shooting + * ourselves in the foot. + * When the hub is disconnected but we are in the middle of some + * operation, we cannot destroy this structure right away because + * the pending operation might use it. + */ + size_t pending_ops_count; + /** Guard for pending_ops_count. */ + fibril_mutex_t pending_ops_mutex; + /** Condition variable for pending_ops_count. */ + fibril_condvar_t pending_ops_cv; + +}; + +int usb_hub_add_device(usb_device_t *usb_dev); + +bool hub_port_changes_callback(usb_device_t *dev, + uint8_t *change_bitmap, size_t change_bitmap_size, void *arg); + +#endif +/** + * @} + */ Index: uspace/drv/usbhub/usbhub.ma =================================================================== --- uspace/drv/usbhub/usbhub.ma (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhub/usbhub.ma (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhub/usbhub_private.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,184 @@ +/* + * 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 +#include +#include +#include + +#include +#include +#include +#include + +//************ +// +// convenience define for malloc +// +//************ + + +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); +} + +/** + * 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_set_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_SET_PORT_FEATURE, + .request = USB_DEVREQ_SET_FEATURE, + .length = 0, + .index = port_index + }; + clear_request.value = feature; + return usb_pipe_control_write(pipe, &clear_request, + sizeof (clear_request), NULL, 0); +} + +/** + * Clear feature on hub port. + * + * @param pipe pipe to hub control endpoint + * @param feature Feature selector + * @return Operation result + */ +static inline int usb_hub_clear_feature(usb_pipe_t *pipe, + usb_hub_class_feature_t feature) { + + usb_device_request_setup_packet_t clear_request = { + .request_type = USB_HUB_REQ_TYPE_CLEAR_HUB_FEATURE, + .request = USB_DEVREQ_CLEAR_FEATURE, + .length = 0, + .index = 0 + }; + clear_request.value = feature; + return usb_pipe_control_write(pipe, &clear_request, + sizeof (clear_request), NULL, 0); +} + +/** + * Clear feature on hub port. + * + * @param pipe pipe to hub control endpoint + * @param feature Feature selector + * @return Operation result + */ +static inline int usb_hub_set_feature(usb_pipe_t *pipe, + usb_hub_class_feature_t feature) { + + usb_device_request_setup_packet_t clear_request = { + .request_type = USB_HUB_REQ_TYPE_CLEAR_HUB_FEATURE, + .request = USB_DEVREQ_SET_FEATURE, + .length = 0, + .index = 0 + }; + clear_request.value = feature; + return usb_pipe_control_write(pipe, &clear_request, + sizeof (clear_request), NULL, 0); +} + + +void * usb_create_serialized_hub_descriptor(usb_hub_descriptor_t * descriptor); + +void usb_serialize_hub_descriptor(usb_hub_descriptor_t * descriptor, + void * serialized_descriptor); + +usb_hub_descriptor_t * usb_create_deserialized_hub_desriptor( + void * serialized_descriptor); + +void usb_deserialize_hub_desriptor(void * serialized_descriptor, + usb_hub_descriptor_t * descriptor); + + +#endif /* USBHUB_PRIVATE_H */ + +/** + * @} + */ Index: uspace/drv/usbhub/utils.c =================================================================== --- uspace/drv/usbhub/utils.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbhub/utils.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,163 @@ +/* + * 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 + +/** + * create uint8_t array with serialized descriptor + * + * @param descriptor + * @return newly created serializd descriptor pointer + */ +void * usb_create_serialized_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 + 7) / 8; + size += 2 * var_size; + uint8_t * result = malloc(size); + //size + if (result) + usb_serialize_hub_descriptor(descriptor, result); + return result; +} + +/** + * serialize descriptor into given buffer + * + * The buffer size is not checked. + * @param descriptor + * @param serialized_descriptor + */ +void usb_serialize_hub_descriptor(usb_hub_descriptor_t *descriptor, + void * serialized_descriptor) { + //base size + uint8_t * sdescriptor = serialized_descriptor; + size_t size = 7; + //variable size according to port count + size_t var_size = (descriptor->ports_count + 7) / 8; + size += 2 * var_size; + //size + sdescriptor[0] = size; + //descriptor type + sdescriptor[1] = USB_DESCTYPE_HUB; + sdescriptor[2] = descriptor->ports_count; + /// @fixme handling of endianness?? + sdescriptor[3] = descriptor->hub_characteristics / 256; + sdescriptor[4] = descriptor->hub_characteristics % 256; + sdescriptor[5] = descriptor->pwr_on_2_good_time; + sdescriptor[6] = descriptor->current_requirement; + + size_t i; + for (i = 0; i < var_size; ++i) { + sdescriptor[7 + i] = descriptor->devices_removable[i]; + } + for (i = 0; i < var_size; ++i) { + sdescriptor[7 + var_size + i] = 255; + } +} + +/** + * 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_create_deserialized_hub_desriptor( + void *serialized_descriptor) { + uint8_t * sdescriptor = 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 = malloc(sizeof (usb_hub_descriptor_t)); + if (result) + usb_deserialize_hub_desriptor(serialized_descriptor, result); + return result; +} + +/** + * deserialize descriptor into given pointer + * + * @param serialized_descriptor + * @param descriptor + * @return + */ +void usb_deserialize_hub_desriptor( + void * serialized_descriptor, usb_hub_descriptor_t *descriptor) { + uint8_t * sdescriptor = serialized_descriptor; + descriptor->ports_count = sdescriptor[2]; + /// @fixme handling of endianness?? + descriptor->hub_characteristics = sdescriptor[4] + 256 * sdescriptor[3]; + descriptor->pwr_on_2_good_time = sdescriptor[5]; + descriptor->current_requirement = sdescriptor[6]; + size_t var_size = (descriptor->ports_count + 7) / 8; + //descriptor->devices_removable = (uint8_t*) malloc(var_size); + + size_t i; + for (i = 0; i < var_size; ++i) { + descriptor->devices_removable[i] = sdescriptor[7 + i]; + } +} + +/** + * @} + */ Index: uspace/drv/usbmast/Makefile =================================================================== --- uspace/drv/usbmast/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmast/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,47 @@ +# +# 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 = \ + $(LIBUSBDEV_PREFIX)/libusbdev.a \ + $(LIBUSB_PREFIX)/libusb.a \ + $(LIBDRV_PREFIX)/libdrv.a +EXTRA_CFLAGS += \ + -I$(LIBUSB_PREFIX)/include \ + -I$(LIBUSBDEV_PREFIX)/include \ + -I$(LIBDRV_PREFIX)/include + +BINARY = usbmast + +SOURCES = \ + inquiry.c \ + main.c \ + mast.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/usbmast/cmds.h =================================================================== --- uspace/drv/usbmast/cmds.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmast/cmds.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 drvusbmast + * @{ + */ +/** @file + * USB mass storage commands. + */ + +#ifndef USB_USBMAST_CMDS_H_ +#define USB_USBMAST_CMDS_H_ + +#include +#include + +typedef struct { + uint32_t dCBWSignature; + uint32_t dCBWTag; + uint32_t dCBWDataTransferLength; + uint8_t bmCBWFlags; + uint8_t bCBWLUN; + uint8_t bCBWBLength; + uint8_t CBWCB[16]; +} __attribute__((packed)) usb_massstor_cbw_t; + +typedef struct { + uint32_t dCSWSignature; + uint32_t dCSWTag; + uint32_t dCSWDataResidue; + uint8_t dCSWStatus; +} __attribute__((packed)) usb_massstor_csw_t; + +static inline void usb_massstor_cbw_prepare(usb_massstor_cbw_t *cbw, + uint32_t tag, uint32_t transfer_length, usb_direction_t dir, + uint8_t lun, uint8_t cmd_len, uint8_t *cmd) +{ + cbw->dCBWSignature = uint32_host2usb(0x43425355); + cbw->dCBWTag = tag; + cbw->dCBWDataTransferLength = transfer_length; + + cbw->bmCBWFlags = 0; + if (dir == USB_DIRECTION_IN) { + cbw->bmCBWFlags |= (1 << 7); + } + + /* Only lowest 4 bits. */ + cbw->bCBWLUN = lun & 0x0F; + + /* Only lowest 5 bits. */ + cbw->bCBWBLength = cmd_len & 0x1F; + + memcpy(cbw->CBWCB, cmd, cbw->bCBWBLength); +} + +#endif + +/** + * @} + */ Index: uspace/drv/usbmast/inquiry.c =================================================================== --- uspace/drv/usbmast/inquiry.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmast/inquiry.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,193 @@ +/* + * 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 drvusbmast + * @{ + */ +/** + * @file + * Main routines of USB mass storage driver. + */ +#include +#include +#include +#include +#include +#include +#include +#include +#include "cmds.h" +#include "scsi.h" +#include "mast.h" + +#define BITS_GET_MASK(type, bitcount) (((type)(1 << (bitcount)))-1) +#define BITS_GET_MID_MASK(type, bitcount, offset) \ + ((type)( BITS_GET_MASK(type, (bitcount) + (offset)) - BITS_GET_MASK(type, bitcount) )) +#define BITS_GET(type, number, bitcount, offset) \ + ((type)( (number) & (BITS_GET_MID_MASK(type, bitcount, offset)) ) >> (offset)) + +#define INQUIRY_RESPONSE_LENGTH 36 + +#define STR_UNKNOWN "" + +/** String constants for SCSI peripheral device types. */ +static const char *str_peripheral_device_types[] = { + "direct-access device", + "sequential-access device", + "printer device", + "processor device", + "write-once device", + "CDROM device", + "scanner device", + "optical memory device", + "medium changer", + "communications device", + "graphic arts pre-press device", + "graphic arts pre-press device", + "storage array controller device", + "enclosure services device", + "simplified direct-access device", + "optical card reader/writer device", + "bridging expander", + "object-based storage device", + "automation driver interface", + STR_UNKNOWN, // 0x13 + STR_UNKNOWN, // 0x14 + STR_UNKNOWN, // 0x15 + STR_UNKNOWN, // 0x16 + STR_UNKNOWN, // 0x17 + STR_UNKNOWN, // 0x18 + STR_UNKNOWN, // 0x19 + STR_UNKNOWN, // 0x1A + STR_UNKNOWN, // 0x1B + STR_UNKNOWN, // 0x1C + STR_UNKNOWN, // 0x1D + "well-known logical unit", + "uknown or no device state" +}; +#define str_peripheral_device_types_count \ + (sizeof(str_peripheral_device_types)/sizeof(str_peripheral_device_types[0])) + +/** Get string representation for SCSI peripheral device type. + * + * See for example here for a list + * http://en.wikipedia.org/wiki/SCSI_Peripheral_Device_Type. + * + * @param type SCSI peripheral device type code. + * @return String representation. + */ +const char *usb_str_masstor_scsi_peripheral_device_type(int type) +{ + if ((type < 0) + || ((size_t)type >= str_peripheral_device_types_count)) { + return STR_UNKNOWN; + } + return str_peripheral_device_types[type]; +} + +/** Trim trailing spaces from a string (rewrite with string terminator). + * + * @param name String to be trimmed (in-out parameter). + */ +static void trim_trailing_spaces(char *name) +{ + size_t len = str_length(name); + while ((len > 0) && isspace((int) name[len - 1])) { + name[len - 1] = 0; + len--; + } +} + +/** Perform SCSI INQUIRY command on USB mass storage device. + * + * @param dev USB device. + * @param bulk_in_idx Index (in dev->pipes) of bulk in pipe. + * @param bulk_out_idx Index of bulk out pipe. + * @param inquiry_result Where to store parsed inquiry result. + * @return Error code. + */ +int usb_massstor_inquiry(usb_device_t *dev, + size_t bulk_in_idx, size_t bulk_out_idx, + usb_massstor_inquiry_result_t *inquiry_result) +{ + scsi_cmd_inquiry_t inquiry = { + .op_code = 0x12, + .lun_evpd = 0, + .page_code = 0, + .alloc_length = host2uint16_t_be(INQUIRY_RESPONSE_LENGTH), + .ctrl = 0 + }; + size_t response_len; + uint8_t response[INQUIRY_RESPONSE_LENGTH]; + + int rc; + + rc = usb_massstor_data_in(dev, bulk_in_idx, bulk_out_idx, + 0xDEADBEEF, 0, (uint8_t *) &inquiry, sizeof(inquiry), + response, INQUIRY_RESPONSE_LENGTH, &response_len); + + if (rc != EOK) { + usb_log_error("Failed to probe device %s using %s: %s.\n", + dev->ddf_dev->name, "SCSI:INQUIRY", str_error(rc)); + return rc; + } + + if (response_len < 8) { + usb_log_error("The SCSI response is too short.\n"); + return ERANGE; + } + + /* + * This is an ugly part of the code. We will parse the returned + * data by hand and try to get as many useful data as possible. + */ + bzero(inquiry_result, sizeof(*inquiry_result)); + + /* This shall be returned by all devices. */ + inquiry_result->peripheral_device_type + = BITS_GET(uint8_t, response[0], 5, 0); + inquiry_result->removable = BITS_GET(uint8_t, response[1], 1, 7); + + if (response_len < 32) { + return EOK; + } + + str_ncpy(inquiry_result->vendor_id, 9, + (const char *) &response[8], 8); + trim_trailing_spaces(inquiry_result->vendor_id); + + str_ncpy(inquiry_result->product_and_revision, 12, + (const char *) &response[16], 11); + trim_trailing_spaces(inquiry_result->product_and_revision); + + return EOK; +} + +/** + * @} + */ Index: uspace/drv/usbmast/main.c =================================================================== --- uspace/drv/usbmast/main.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmast/main.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,151 @@ +/* + * 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 drvusbmast + * @{ + */ +/** + * @file + * Main routines of USB mass storage driver. + */ +#include +#include +#include +#include +#include +#include +#include "cmds.h" +#include "scsi.h" +#include "mast.h" + +#define NAME "usbmast" + +#define BULK_IN_EP 0 +#define BULK_OUT_EP 1 + +#define GET_BULK_IN(dev) ((dev)->pipes[BULK_IN_EP].pipe) +#define GET_BULK_OUT(dev) ((dev)->pipes[BULK_OUT_EP].pipe) + +static usb_endpoint_description_t bulk_in_ep = { + .transfer_type = USB_TRANSFER_BULK, + .direction = USB_DIRECTION_IN, + .interface_class = USB_CLASS_MASS_STORAGE, + .interface_subclass = USB_MASSSTOR_SUBCLASS_SCSI, + .interface_protocol = USB_MASSSTOR_PROTOCOL_BBB, + .flags = 0 +}; +static usb_endpoint_description_t bulk_out_ep = { + .transfer_type = USB_TRANSFER_BULK, + .direction = USB_DIRECTION_OUT, + .interface_class = USB_CLASS_MASS_STORAGE, + .interface_subclass = USB_MASSSTOR_SUBCLASS_SCSI, + .interface_protocol = USB_MASSSTOR_PROTOCOL_BBB, + .flags = 0 +}; + +usb_endpoint_description_t *mast_endpoints[] = { + &bulk_in_ep, + &bulk_out_ep, + NULL +}; + +/** Callback when new device is attached and recognized as a mass storage. + * + * @param dev Representation of a the USB device. + * @return Error code. + */ +static int usbmast_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 mass storage `%s'.\n", + dev->ddf_dev->name); + usb_log_debug(" Bulk in endpoint: %d [%zuB].\n", + dev->pipes[BULK_IN_EP].pipe->endpoint_no, + (size_t) dev->pipes[BULK_IN_EP].descriptor->max_packet_size); + usb_log_debug("Bulk out endpoint: %d [%zuB].\n", + dev->pipes[BULK_OUT_EP].pipe->endpoint_no, + (size_t) dev->pipes[BULK_OUT_EP].descriptor->max_packet_size); + + size_t lun_count = usb_masstor_get_lun_count(dev); + + usb_massstor_inquiry_result_t inquiry; + rc = usb_massstor_inquiry(dev, BULK_IN_EP, BULK_OUT_EP, &inquiry); + if (rc != EOK) { + usb_log_warning("Failed to inquiry device `%s': %s.\n", + dev->ddf_dev->name, str_error(rc)); + return EOK; + } + + usb_log_info("Mass storage `%s': " \ + "`%s' by `%s' is %s (%s), %zu LUN(s).\n", + dev->ddf_dev->name, + inquiry.product_and_revision, inquiry.vendor_id, + usb_str_masstor_scsi_peripheral_device_type(inquiry.peripheral_device_type), + inquiry.removable ? "removable" : "non-removable", + lun_count); + + return EOK; +} + +/** USB mass storage driver ops. */ +static usb_driver_ops_t usbmast_driver_ops = { + .add_device = usbmast_add_device, +}; + +/** USB mass storage driver. */ +static usb_driver_t usbmast_driver = { + .name = NAME, + .ops = &usbmast_driver_ops, + .endpoints = mast_endpoints +}; + +int main(int argc, char *argv[]) +{ + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + + return usb_driver_main(&usbmast_driver); +} + +/** + * @} + */ Index: uspace/drv/usbmast/mast.c =================================================================== --- uspace/drv/usbmast/mast.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmast/mast.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,222 @@ +/* + * 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 drvusbmast + * @{ + */ +/** + * @file + * Generic functions for USB mass storage (implementation). + */ +#include "mast.h" +#include "cmds.h" +#include +#include +#include +#include +#include + +bool usb_mast_verbose = true; + +#define MASTLOG(format, ...) \ + do { \ + if (usb_mast_verbose) { \ + usb_log_debug("USB cl08: " format, ##__VA_ARGS__); \ + } \ + } while (false) + +/** Request data from mass storage device. + * + * @param bulk_in_pipe Bulk in pipe to the device. + * @param bulk_out_pipe Bulk out pipe to the device. + * @param tag Command block wrapper tag (automatically compared with answer). + * @param lun LUN index. + * @param cmd SCSI command buffer (in SCSI endianness). + * @param cmd_size Length of SCSI command @p cmd in bytes. + * @param in_buffer Buffer where to store the answer (CSW is not returned). + * @param in_buffer_size Size of the buffer (size of the request to the device). + * @param received_size Number of actually received bytes. + * @return Error code. + */ +int usb_massstor_data_in(usb_device_t *dev, + size_t bulk_in_pipe_index, size_t bulk_out_pipe_index, + uint32_t tag, uint8_t lun, void *cmd, size_t cmd_size, + void *in_buffer, size_t in_buffer_size, size_t *received_size) +{ + int rc; + size_t act_size; + usb_pipe_t *bulk_in_pipe = dev->pipes[bulk_in_pipe_index].pipe; + usb_pipe_t *bulk_out_pipe = dev->pipes[bulk_out_pipe_index].pipe; + + /* Prepare CBW - command block wrapper */ + usb_massstor_cbw_t cbw; + usb_massstor_cbw_prepare(&cbw, tag, in_buffer_size, + USB_DIRECTION_IN, lun, cmd_size, cmd); + + /* First, send the CBW. */ + rc = usb_pipe_write(bulk_out_pipe, &cbw, sizeof(cbw)); + MASTLOG("CBW '%s' sent: %s.\n", + usb_debug_str_buffer((uint8_t *) &cbw, sizeof(cbw), 0), + str_error(rc)); + if (rc != EOK) { + return rc; + } + + /* Try to retrieve the data from the device. */ + act_size = 0; + rc = usb_pipe_read(bulk_in_pipe, in_buffer, in_buffer_size, &act_size); + MASTLOG("Received %zuB (%s): %s.\n", act_size, + usb_debug_str_buffer((uint8_t *) in_buffer, act_size, 0), + str_error(rc)); + if (rc != EOK) { + return rc; + } + + /* Read CSW. */ + usb_massstor_csw_t csw; + size_t csw_size; + rc = usb_pipe_read(bulk_in_pipe, &csw, sizeof(csw), &csw_size); + MASTLOG("CSW '%s' received (%zuB): %s.\n", + usb_debug_str_buffer((uint8_t *) &csw, csw_size, 0), csw_size, + str_error(rc)); + if (rc != EOK) { + return rc; + } + if (csw_size != sizeof(csw)) { + return ERANGE; + } + + if (csw.dCSWTag != tag) { + return EBADCHECKSUM; + } + + /* + * Determine the actual return value from the CSW. + */ + if (csw.dCSWStatus != 0) { + // FIXME: better error code + // FIXME: distinguish 0x01 and 0x02 + return EXDEV; + } + + size_t residue = (size_t) uint32_usb2host(csw.dCSWDataResidue); + if (residue > in_buffer_size) { + return ERANGE; + } + if (act_size != in_buffer_size - residue) { + return ERANGE; + } + if (received_size != NULL) { + *received_size = in_buffer_size - residue; + } + + return EOK; +} + +/** Perform bulk-only mass storage reset. + * + * @param dev Device to be reseted. + * @return Error code. + */ +int usb_massstor_reset(usb_device_t *dev) +{ + return usb_control_request_set(&dev->ctrl_pipe, + USB_REQUEST_TYPE_CLASS, USB_REQUEST_RECIPIENT_INTERFACE, + 0xFF, 0, dev->interface_no, NULL, 0); +} + +/** Perform complete reset recovery of bulk-only mass storage. + * + * Notice that no error is reported because if this fails, the error + * would reappear on next transaction somehow. + * + * @param dev Device to be reseted. + * @param bulk_in_idx Index of bulk in pipe. + * @param bulk_out_idx Index of bulk out pipe. + */ +void usb_massstor_reset_recovery(usb_device_t *dev, + size_t bulk_in_idx, size_t bulk_out_idx) +{ + /* We would ignore errors here because if this fails + * we are doomed anyway and any following transaction would fail. + */ + usb_massstor_reset(dev); + usb_pipe_clear_halt(&dev->ctrl_pipe, dev->pipes[bulk_in_idx].pipe); + usb_pipe_clear_halt(&dev->ctrl_pipe, dev->pipes[bulk_out_idx].pipe); +} + +/** Get max LUN of a mass storage device. + * + * @see usb_masstor_get_lun_count + * + * @warning Error from this command does not necessarily indicate malfunction + * of the device. Device does not need to support this request. + * You shall rather use usb_masstor_get_lun_count. + * + * @param dev Mass storage device. + * @return Error code of maximum LUN (index, not count). + */ +int usb_massstor_get_max_lun(usb_device_t *dev) +{ + uint8_t max_lun; + size_t data_recv_len; + int rc = usb_control_request_get(&dev->ctrl_pipe, + USB_REQUEST_TYPE_CLASS, USB_REQUEST_RECIPIENT_INTERFACE, + 0xFE, 0, dev->interface_no, &max_lun, 1, &data_recv_len); + if (rc != EOK) { + return rc; + } + if (data_recv_len != 1) { + return EEMPTY; + } + return (int) max_lun; +} + +/** Get number of LUNs supported by mass storage device. + * + * @warning This function hides any error during the request + * (typically that shall not be a problem). + * + * @param dev Mass storage device. + * @return Number of LUNs. + */ +size_t usb_masstor_get_lun_count(usb_device_t *dev) +{ + int max_lun = usb_massstor_get_max_lun(dev); + if (max_lun < 0) { + max_lun = 1; + } else { + max_lun++; + } + + return (size_t) max_lun; +} + +/** + * @} + */ Index: uspace/drv/usbmast/mast.h =================================================================== --- uspace/drv/usbmast/mast.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmast/mast.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,73 @@ +/* + * 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 drvusbmast + * @{ + */ +/** @file + * Generic functions for USB mass storage. + */ + +#ifndef USB_USBMAST_MAST_H_ +#define USB_USBMAST_MAST_H_ + +#include +#include +#include +#include + +/** Result of SCSI INQUIRY command. + * This is already parsed structure, not the original buffer returned by + * the device. + */ +typedef struct { + /** SCSI peripheral device type. */ + int peripheral_device_type; + /** Whether the device is removable. */ + bool removable; + /** Vendor ID string. */ + char vendor_id[9]; + /** Product ID and product revision string. */ + char product_and_revision[12]; +} usb_massstor_inquiry_result_t; + +int usb_massstor_data_in(usb_device_t *dev, size_t, size_t, + uint32_t, uint8_t, void *, size_t, void *, size_t, size_t *); +int usb_massstor_reset(usb_device_t *); +void usb_massstor_reset_recovery(usb_device_t *, size_t, size_t); +int usb_massstor_get_max_lun(usb_device_t *); +size_t usb_masstor_get_lun_count(usb_device_t *); +int usb_massstor_inquiry(usb_device_t *, size_t, size_t, + usb_massstor_inquiry_result_t *); +const char *usb_str_masstor_scsi_peripheral_device_type(int); + +#endif + +/** + * @} + */ Index: uspace/drv/usbmast/scsi.h =================================================================== --- uspace/drv/usbmast/scsi.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmast/scsi.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,54 @@ +/* + * 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 drvusbmast + * @{ + */ +/** @file + * SCSI related structures. + */ + +#ifndef USB_USBMAST_SCSI_H_ +#define USB_USBMAST_SCSI_H_ + +#include +#include + +typedef struct { + uint8_t op_code; + uint8_t lun_evpd; + uint8_t page_code; + uint16_t alloc_length; + uint8_t ctrl; +} __attribute__((packed)) scsi_cmd_inquiry_t; + +#endif + +/** + * @} + */ Index: uspace/drv/usbmast/usbmast.ma =================================================================== --- uspace/drv/usbmast/usbmast.ma (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmast/usbmast.ma (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,1 @@ +50 usb&interface&class=mass-storage&subclass=0x06&protocol=0x50 Index: uspace/drv/usbmid/Makefile =================================================================== --- uspace/drv/usbmid/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmid/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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. +# + +USPACE_PREFIX = ../.. + +LIBS = \ + $(LIBUSBDEV_PREFIX)/libusbdev.a \ + $(LIBUSB_PREFIX)/libusb.a \ + $(LIBDRV_PREFIX)/libdrv.a +EXTRA_CFLAGS += \ + -I$(LIBUSB_PREFIX)/include \ + -I$(LIBUSBDEV_PREFIX)/include \ + -I$(LIBDRV_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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmid/dump.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmid/explore.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,211 @@ +/* + * 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 +}; + +/** Tell whether given interface is already in the list. + * + * @param list List of usbmid_interface_t members to be searched. + * @param interface_no Interface number caller is looking for. + * @return Interface @p interface_no is already present in the list. + */ +static bool interface_in_list(link_t *list, int interface_no) +{ + link_t *l; + for (l = list->next; l != list; l = l->next) { + usbmid_interface_t *iface + = list_get_instance(l, usbmid_interface_t, link); + if (iface->interface_no == interface_no) { + return true; + } + } + + return false; +} + +/** Create list of interfaces from configuration descriptor. + * + * @param config_descriptor Configuration descriptor. + * @param config_descriptor_size Size of configuration descriptor in bytes. + * @param list List where to add the interfaces. + */ +static void create_interfaces(uint8_t *config_descriptor, + size_t config_descriptor_size, link_t *list) +{ + 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_ptr = usb_dp_get_nested_descriptor(&parser, &data, + data.data); + if (interface_ptr == NULL) { + return; + } + + do { + if (interface_ptr[1] != USB_DESCTYPE_INTERFACE) { + goto next_descriptor; + } + + usb_standard_interface_descriptor_t *interface + = (usb_standard_interface_descriptor_t *) interface_ptr; + + /* Skip alternate interfaces. */ + if (!interface_in_list(list, interface->interface_number)) { + usbmid_interface_t *iface + = malloc(sizeof(usbmid_interface_t)); + if (iface == NULL) { + break; + } + link_initialize(&iface->link); + iface->fun = NULL; + iface->interface_no = interface->interface_number; + iface->interface = interface; + + list_append(&iface->link, list); + } + + /* TODO: add the alternatives and create match ids from them + * as well. + */ + +next_descriptor: + interface_ptr = usb_dp_get_sibling_descriptor(&parser, &data, + data.data, interface_ptr); + + } while (interface_ptr != NULL); + +} + +/** 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; + + /* 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)); + 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"); + 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)); + return false; + } + + /* Create interface children. */ + link_t interface_list; + list_initialize(&interface_list); + create_interfaces(config_descriptor_raw, config_descriptor_size, + &interface_list); + + link_t *link; + for (link = interface_list.next; link != &interface_list; + link = link->next) { + usbmid_interface_t *iface = list_get_instance(link, + usbmid_interface_t, link); + + usb_log_info("Creating child for interface %d (%s).\n", + (int) iface->interface_no, + usb_str_class(iface->interface->interface_class)); + + rc = usbmid_spawn_interface_child(dev, iface, + &dev->descriptors.device, iface->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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmid/main.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,91 @@ +/* + * 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); + + usb_pipe_start_long_transfer(&dev->ctrl_pipe); + + bool accept = usbmid_explore_device(dev); + + usb_pipe_end_long_transfer(&dev->ctrl_pipe); + + 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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmid/usbmid.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 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 +}; + + +/** Spawn new child device from one interface. + * + * @param parent Parent MID device. + * @param iface Interface information. + * @param device_descriptor Device descriptor. + * @param interface_descriptor Interface descriptor. + * @return Error code. + */ +int usbmid_spawn_interface_child(usb_device_t *parent, + usbmid_interface_t *iface, + 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; + 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; + } + + iface->fun = child; + + child->driver_data = iface; + 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); + } + + return rc; +} + +/** + * @} + */ Index: uspace/drv/usbmid/usbmid.h =================================================================== --- uspace/drv/usbmid/usbmid.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmid/usbmid.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 drvusbmid + * @{ + */ +/** @file + * Common definitions. + */ + +#ifndef USBMID_H_ +#define USBMID_H_ + +#include +#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 descriptor. */ + usb_standard_interface_descriptor_t *interface; + /** Interface number. */ + int interface_no; + /** List link. */ + link_t link; +} usbmid_interface_t; + +bool usbmid_explore_device(usb_device_t *); +int usbmid_spawn_interface_child(usb_device_t *, usbmid_interface_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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmid/usbmid.ma (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,1 @@ +100 usb&mid Index: uspace/drv/usbmouse/Makefile =================================================================== --- uspace/drv/usbmouse/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmouse/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,49 @@ +# +# 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 = \ + $(LIBUSBHID_PREFIX)/libusbhid.a \ + $(LIBUSBDEV_PREFIX)/libusbdev.a \ + $(LIBUSB_PREFIX)/libusb.a \ + $(LIBDRV_PREFIX)/libdrv.a +EXTRA_CFLAGS += \ + -I$(LIBUSB_PREFIX)/include \ + -I$(LIBUSBDEV_PREFIX)/include \ + -I$(LIBUSBHID_PREFIX)/include \ + -I$(LIBDRV_PREFIX)/include + +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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmouse/init.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,149 @@ +/* + * 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 +#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; + } + + /* Set the boot protocol. */ + rc = usbhid_req_set_protocol(&dev->ctrl_pipe, dev->interface_no, + USB_HID_PROTOCOL_BOOT); + if (rc != EOK) { + goto leave; + } + + /* Everything all right. */ + 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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmouse/main.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,101 @@ +/* + * 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 +#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 %" PRIun ").\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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmouse/mouse.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 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; + + usb_device_destroy(dev); +} + +/** + * @} + */ Index: uspace/drv/usbmouse/mouse.h =================================================================== --- uspace/drv/usbmouse/mouse.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmouse/mouse.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/usbmouse/usbmouse.ma (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,1 @@ +100 usb&interface&class=HID&subclass=0x01&protocol=0x02 Index: uspace/drv/vhc/Makefile =================================================================== --- uspace/drv/vhc/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/vhc/Makefile (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,55 @@ +# +# 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 = \ + $(LIBUSBDEV_PREFIX)/libusbdev.a \ + $(LIBUSBHOST_PREFIX)/libusbhost.a \ + $(LIBUSB_PREFIX)/libusb.a \ + $(LIBUSBVIRT_PREFIX)/libusbvirt.a \ + $(LIBDRV_PREFIX)/libdrv.a +EXTRA_CFLAGS += \ + -I$(LIBUSBVIRT_PREFIX)/include \ + -I$(LIBUSBDEV_PREFIX)/include \ + -I$(LIBUSBHOST_PREFIX)/include \ + -I$(LIBUSB_PREFIX)/include \ + -I$(LIBDRV_PREFIX)/include +BINARY = vhc + +SOURCES = \ + hub/virthub.c \ + hub/hub.c \ + hub/virthubops.c \ + conndev.c \ + connhost.c \ + devconn.c \ + hub.c \ + main.c \ + transfer.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/vhc/conn.h =================================================================== --- uspace/drv/vhc/conn.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/vhc/conn.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 Connection handling of incoming calls. + */ +#ifndef VHCD_CONN_H_ +#define VHCD_CONN_H_ + +#include +#include +#include +#include "vhcd.h" + +extern usbhc_iface_t vhc_iface; +extern usb_iface_t vhc_usb_iface; +extern usb_iface_t rh_usb_iface; + +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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/vhc/conndev.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,138 @@ +/* + * 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 drvusbvhc + * @{ + */ +/** @file + * Connection handling of calls from virtual device (implementation). + */ + +#include +#include +#include +#include +#include "conn.h" + +static fibril_local uintptr_t plugged_device_handle = 0; +#define PLUGGED_DEVICE_NAME_MAXLEN 256 +static fibril_local char plugged_device_name[PLUGGED_DEVICE_NAME_MAXLEN + 1] = ""; + +/** Receive device name. + * + * @warning Errors are silently ignored. + * + * @param phone Phone to the virtual device. + */ +static void receive_device_name(int phone) +{ + aid_t opening_request = async_send_0(phone, IPC_M_USBVIRT_GET_NAME, NULL); + if (opening_request == 0) { + return; + } + + + ipc_call_t data_request_call; + aid_t data_request = async_data_read(phone, + plugged_device_name, PLUGGED_DEVICE_NAME_MAXLEN, + &data_request_call); + + if (data_request == 0) { + async_wait_for(opening_request, NULL); + return; + } + + 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) || (opening_request_rc != EOK)) { + return; + } + + size_t len = IPC_GET_ARG2(data_request_call); + plugged_device_name[len] = 0; +} + +/** 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) +{ + vhc_data_t *vhc = fun->dev->driver_data; + sysarg_t method = IPC_GET_IMETHOD(*icall); + + if (method == IPC_M_CONNECT_TO_ME) { + int callback = IPC_GET_ARG5(*icall); + int rc = vhc_virtdev_plug(vhc, callback, + &plugged_device_handle); + if (rc != EOK) { + async_answer_0(icallid, rc); + async_hangup(callback); + return; + } + + async_answer_0(icallid, EOK); + + receive_device_name(callback); + + usb_log_info("New virtual device `%s' (id: %" PRIxn ").\n", + plugged_device_name, plugged_device_handle); + + return; + } + + async_answer_0(icallid, EINVAL); +} + +/** Callback when client disconnects. + * + * Used to unplug virtual USB device. + * + * @param fun + */ +void on_client_close(ddf_fun_t *fun) +{ + vhc_data_t *vhc = fun->dev->driver_data; + + if (plugged_device_handle != 0) { + usb_log_info("Virtual device `%s' disconnected (id: %" PRIxn ").\n", + plugged_device_name, plugged_device_handle); + vhc_virtdev_unplug(vhc, plugged_device_handle); + } +} + + +/** + * @} + */ Index: uspace/drv/vhc/connhost.c =================================================================== --- uspace/drv/vhc/connhost.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/vhc/connhost.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,490 @@ +/* + * 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 drvusbvhc + * @{ + */ +/** @file + * Host controller interface implementation. + */ +#include +#include +#include +#include +#include +#include +#include "vhcd.h" + +#define GET_VHC_DATA(fun) \ + ((vhc_data_t *)fun->dev->driver_data) +#define VHC_DATA(vhc, fun) \ + vhc_data_t *vhc = GET_VHC_DATA(fun); assert(vhc->magic == 0xdeadbeef) + +#define UNSUPPORTED(methodname) \ + usb_log_warning("Unsupported interface method `%s()' in %s:%d.\n", \ + methodname, __FILE__, __LINE__) + +/** 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) +{ + VHC_DATA(vhc, fun); + + usb_address_t addr = device_keeper_get_free_address(&vhc->dev_keeper, + USB_SPEED_HIGH); + if (addr < 0) { + return addr; + } + + if (address != NULL) { + *address = addr; + } + + 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) +{ + VHC_DATA(vhc, fun); + usb_log_debug("Binding handle %" PRIun " to address %d.\n", + handle, address); + usb_device_keeper_bind(&vhc->dev_keeper, address, handle); + + return EOK; +} + +/** Find device handle by address interface function. + * + * @param[in] fun DDF function that was called. + * @param[in] address Address in question. + * @param[out] handle Where to store device handle if found. + * @return Error code. + */ +static int find_by_address(ddf_fun_t *fun, usb_address_t address, + devman_handle_t *handle) +{ + VHC_DATA(vhc, fun); + bool found = + usb_device_keeper_find_by_address(&vhc->dev_keeper, address, handle); + return found ? EOK : ENOENT; +} + +/** 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) +{ + VHC_DATA(vhc, fun); + usb_log_debug("Releasing address %d...\n", address); + usb_device_keeper_release(&vhc->dev_keeper, 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] speed Endpoint speed (invalid means to use device one). + * @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_speed_t speed, usb_endpoint_t endpoint, + usb_transfer_type_t transfer_type, usb_direction_t direction, + size_t max_packet_size, unsigned int interval) +{ + VHC_DATA(vhc, fun); + + endpoint_t *ep = malloc(sizeof(endpoint_t)); + if (ep == NULL) { + return ENOMEM; + } + + int rc = endpoint_init(ep, address, endpoint, direction, transfer_type, + USB_SPEED_FULL, 1); + if (rc != EOK) { + free(ep); + return rc; + } + + rc = usb_endpoint_manager_register_ep(&vhc->ep_manager, ep, 1); + if (rc != EOK) { + endpoint_destroy(ep); + return rc; + } + + return EOK; +} + +/** 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) +{ + VHC_DATA(vhc, fun); + + endpoint_t *ep = usb_endpoint_manager_get_ep(&vhc->ep_manager, + address, endpoint, direction, NULL); + if (ep == NULL) { + return ENOENT; + } + + int rc = usb_endpoint_manager_unregister_ep(&vhc->ep_manager, + address, endpoint, direction); + + return rc; +} + +/** 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] 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, + void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + VHC_DATA(vhc, fun); + + vhc_transfer_t *transfer = vhc_transfer_create(target.address, + target.endpoint, USB_DIRECTION_OUT, USB_TRANSFER_INTERRUPT, + fun, arg); + if (transfer == NULL) { + return ENOMEM; + } + + transfer->data_buffer = data; + transfer->data_buffer_size = size; + transfer->callback_out = callback; + + int rc = vhc_virtdev_add_transfer(vhc, transfer); + if (rc != EOK) { + free(transfer); + return rc; + } + + return EOK; +} + +/** 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] 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, + void *data, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + VHC_DATA(vhc, fun); + + vhc_transfer_t *transfer = vhc_transfer_create(target.address, + target.endpoint, USB_DIRECTION_IN, USB_TRANSFER_INTERRUPT, + fun, arg); + if (transfer == NULL) { + return ENOMEM; + } + + transfer->data_buffer = data; + transfer->data_buffer_size = size; + transfer->callback_in = callback; + + int rc = vhc_virtdev_add_transfer(vhc, transfer); + if (rc != EOK) { + free(transfer); + return rc; + } + + return EOK; +} + +/** 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] 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, + 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] 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, + 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] 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, + 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) +{ + VHC_DATA(vhc, fun); + + vhc_transfer_t *transfer = vhc_transfer_create(target.address, + target.endpoint, USB_DIRECTION_OUT, USB_TRANSFER_CONTROL, + fun, arg); + if (transfer == NULL) { + return ENOMEM; + } + + transfer->setup_buffer = setup_packet; + transfer->setup_buffer_size = setup_packet_size; + transfer->data_buffer = data_buffer; + transfer->data_buffer_size = data_buffer_size; + transfer->callback_out = callback; + + int rc = vhc_virtdev_add_transfer(vhc, transfer); + if (rc != EOK) { + free(transfer); + return rc; + } + + return EOK; +} + +/** 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] 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, + 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) +{ + VHC_DATA(vhc, fun); + + vhc_transfer_t *transfer = vhc_transfer_create(target.address, + target.endpoint, USB_DIRECTION_IN, USB_TRANSFER_CONTROL, + fun, arg); + if (transfer == NULL) { + return ENOMEM; + } + + transfer->setup_buffer = setup_packet; + transfer->setup_buffer_size = setup_packet_size; + transfer->data_buffer = data_buffer; + transfer->data_buffer_size = data_buffer_size; + transfer->callback_in = callback; + + int rc = vhc_virtdev_add_transfer(vhc, transfer); + if (rc != EOK) { + free(transfer); + return rc; + } + + return EOK; +} + +static int tell_address(ddf_fun_t *fun, devman_handle_t handle, + usb_address_t *address) +{ + UNSUPPORTED("tell_address"); + + return ENOTSUP; +} + +static int usb_iface_get_hc_handle_rh_impl(ddf_fun_t *root_hub_fun, + devman_handle_t *handle) +{ + VHC_DATA(vhc, root_hub_fun); + + *handle = vhc->hc_fun->handle; + + return EOK; +} + +static int tell_address_rh(ddf_fun_t *root_hub_fun, devman_handle_t handle, + usb_address_t *address) +{ + VHC_DATA(vhc, root_hub_fun); + + if (handle == 0) { + handle = root_hub_fun->handle; + } + + usb_log_debug("tell_address_rh(handle=%" PRIun ")\n", handle); + usb_address_t addr = usb_device_keeper_find(&vhc->dev_keeper, handle); + if (addr < 0) { + return addr; + } else { + *address = addr; + return EOK; + } +} + +usbhc_iface_t vhc_iface = { + .request_address = request_address, + .bind_address = bind_address, + .find_by_address = find_by_address, + .release_address = release_address, + + .register_endpoint = register_endpoint, + .unregister_endpoint = unregister_endpoint, + + .interrupt_out = interrupt_out, + .interrupt_in = interrupt_in, + + .bulk_in = bulk_in, + .bulk_out = bulk_out, + + .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/devconn.c =================================================================== --- uspace/drv/vhc/devconn.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/vhc/devconn.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,86 @@ +#include +#include "vhcd.h" +#include "hub/virthub.h" + + +static vhc_virtdev_t *vhc_virtdev_create() +{ + vhc_virtdev_t *dev = malloc(sizeof(vhc_virtdev_t)); + if (dev == NULL) { + return NULL; + } + dev->address = 0; + dev->dev_phone = -1; + dev->dev_local = NULL; + dev->plugged = true; + link_initialize(&dev->link); + fibril_mutex_initialize(&dev->guard); + list_initialize(&dev->transfer_queue); + + return dev; +} + +static int vhc_virtdev_plug_generic(vhc_data_t *vhc, + int phone, usbvirt_device_t *virtdev, + uintptr_t *handle, bool connect) +{ + vhc_virtdev_t *dev = vhc_virtdev_create(); + if (dev == NULL) { + return ENOMEM; + } + + dev->dev_phone = phone; + dev->dev_local = virtdev; + + fibril_mutex_lock(&vhc->guard); + list_append(&dev->link, &vhc->devices); + fibril_mutex_unlock(&vhc->guard); + + fid_t fibril = fibril_create(vhc_transfer_queue_processor, dev); + if (fibril == 0) { + free(dev); + return ENOMEM; + } + fibril_add_ready(fibril); + + if (handle != NULL) { + *handle = (uintptr_t) dev; + } + + if (connect) { + // FIXME: check status + (void) virthub_connect_device(vhc->hub, dev); + } + + return EOK; +} + +int vhc_virtdev_plug(vhc_data_t *vhc, int phone, uintptr_t *handle) +{ + return vhc_virtdev_plug_generic(vhc, phone, NULL, handle, true); +} + +int vhc_virtdev_plug_local(vhc_data_t *vhc, usbvirt_device_t *dev, uintptr_t *handle) +{ + return vhc_virtdev_plug_generic(vhc, -1, dev, handle, true); +} + +int vhc_virtdev_plug_hub(vhc_data_t *vhc, usbvirt_device_t *dev, uintptr_t *handle) +{ + return vhc_virtdev_plug_generic(vhc, -1, dev, handle, false); +} + +void vhc_virtdev_unplug(vhc_data_t *vhc, uintptr_t handle) +{ + vhc_virtdev_t *dev = (vhc_virtdev_t *) handle; + + // FIXME: check status + (void) virthub_disconnect_device(vhc->hub, dev); + + fibril_mutex_lock(&vhc->guard); + fibril_mutex_lock(&dev->guard); + dev->plugged = false; + list_remove(&dev->link); + fibril_mutex_unlock(&dev->guard); + fibril_mutex_unlock(&vhc->guard); +} Index: uspace/drv/vhc/hub.c =================================================================== --- uspace/drv/vhc/hub.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/vhc/hub.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,135 @@ +/* + * 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 "hub.h" +//#include "hub/virthub.h" +#include "vhcd.h" +#include "conn.h" + +usbvirt_device_t virtual_hub_device = { + .name = "root hub", + .ops = &hub_ops, + .address = 0 +}; + +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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/vhc/hub.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 drvusbvhc + * @{ + */ +/** @file + * @brief Virtual USB hub. + */ +#ifndef VHCD_HUB_H_ +#define VHCD_HUB_H_ + +#include +#include + +#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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/vhc/hub/hub.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,523 @@ +/* + * 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, hub_t *hub, size_t index) +{ + port->connected_device = NULL; + port->index = index; + port->state = HUB_PORT_STATE_NOT_CONFIGURED; + port->status_change = 0; + port->hub = hub; +} + +/** 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], hub, i + 1); + } + hub->custom_data = NULL; + hub->signal_changes = true; + 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; + } + + usb_log_debug("Setting port %zu to state %d.\n", port_index, state); + + 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: + port->state = state; + set_port_state_delayed(hub, port_index, + 10, state, HUB_PORT_STATE_ENABLED); + break; + case HUB_PORT_STATE_RESETTING: + port->state = state; + 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); + uint16_t old_value = port->status_change; + port->status_change |= change; + usb_log_debug("Changing status change on %zu: %04x => %04x\n", + port->index, + (unsigned int) old_value, (unsigned int) port->status_change); + port->hub->signal_changes = true; +} + +/** 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); + port->hub->signal_changes = true; +} + +/** 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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/vhc/hub/hub.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,120 @@ +/* + * 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; + +typedef struct hub hub_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; + /** Containing hub. */ + hub_t *hub; +} hub_port_t; + +/** Hub device type. */ +struct hub { + /** 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; + /** Last value of status change bitmap. */ + bool signal_changes; +}; + +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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/vhc/hub/virthub.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,260 @@ +/* + * 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 "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; + + hub_t *hub = malloc(sizeof(hub_t)); + if (hub == NULL) { + return ENOMEM; + } + + hub_init(hub); + dev->device_data = hub; + + return EOK; +} + +/** 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, vhc_virtdev_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, vhc_virtdev_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 EOK; +} + +/** 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, vhc_virtdev_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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/vhc/hub/virthub.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -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 "../vhcd.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 *, vhc_virtdev_t *); +int virthub_disconnect_device(usbvirt_device_t *, vhc_virtdev_t *); +bool virthub_is_device_enabled(usbvirt_device_t *, vhc_virtdev_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 df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/vhc/hub/virthubops.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,457 @@ +/* + * 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 +#include "virthub.h" +#include "hub.h" + +/** Callback when device changes states. */ +static void on_state_change(usbvirt_device_t *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_status_change_pipe(usbvirt_device_t *dev, + usb_endpoint_t endpoint, usb_transfer_type_t tr_type, + void *buffer, size_t buffer_size, size_t *actual_size) +{ + if (endpoint != HUB_STATUS_CHANGE_PIPE) { + return ESTALL; + } + if (tr_type != USB_TRANSFER_INTERRUPT) { + return ESTALL; + } + + hub_t *hub = dev->device_data; + + hub_acquire(hub); + + if (!hub->signal_changes) { + hub_release(hub); + + return ENAK; + } + + + uint8_t change_map = hub_get_status_change_bitmap(hub); + + uint8_t *b = (uint8_t *) buffer; + if (buffer_size > 0) { + *b = change_map; + *actual_size = 1; + } else { + *actual_size = 0; + } + + hub->signal_changes = false; + + 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, + const usb_device_request_setup_packet_t *request, uint8_t *data, + size_t *act_size) +{ + 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, + const usb_device_request_setup_packet_t *request, uint8_t *data, + size_t *act_size) +{ + 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, + const usb_device_request_setup_packet_t *request, uint8_t *data, + size_t *act_size) +{ + 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, + const usb_device_request_setup_packet_t *request, uint8_t *data, + size_t *act_size) +{ + if (request->value_high == USB_DESCTYPE_HUB) { + usbvirt_control_reply_helper(request, data, act_size, + &hub_descriptor, hub_descriptor.length); + + return EOK; + } + /* 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, + const usb_device_request_setup_packet_t *request, uint8_t *data, + size_t *act_size) +{ + uint32_t hub_status = 0; + + usbvirt_control_reply_helper(request, data, act_size, + &hub_status, sizeof(hub_status)); + + return EOK; +} + +/** 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, + const usb_device_request_setup_packet_t *request, uint8_t *data, + size_t *act_size) +{ + 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); + + usbvirt_control_reply_helper(request, data, act_size, + &status, sizeof(status)); + + return EOK; +} + +/** 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, + const usb_device_request_setup_packet_t *request, uint8_t *data, + size_t *act_size) +{ + 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, + const usb_device_request_setup_packet_t *request, uint8_t *data, + size_t *act_size) +{ + 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 USB_REQUEST_RECIPIENT_OTHER +/** Recipient: device. */ +#define REC_DEVICE USB_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) \ + .req_direction = direction, \ + .req_recipient = recipient, \ + .req_type = USB_REQUEST_TYPE_CLASS, \ + .request = req + +/** Create a standard request. + * + * @param direction Request direction. + * @param recipient Request recipient. + * @param req Request code. + */ +#define STD_REQ(direction, recipient, req) \ + .req_direction = direction, \ + .req_recipient = recipient, \ + .req_type = USB_REQUEST_TYPE_STANDARD, \ + .request = req + +/** Hub operations on control endpoint zero. */ +static usbvirt_control_request_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 + }, + { + .callback = NULL + } +}; + + +/** Hub operations. */ +usbvirt_device_ops_t hub_ops = { + .control = endpoint_zero_handlers, + .data_in[HUB_STATUS_CHANGE_PIPE] = req_on_status_change_pipe, + .state_changed = on_state_change, +}; + +/** + * @} + */ Index: uspace/drv/vhc/main.c =================================================================== --- uspace/drv/vhc/main.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/vhc/main.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,153 @@ +/* + * 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 drvusbvhc + * @{ + */ +/** @file + * Virtual host controller. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include "vhcd.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; + + if (vhc_count > 0) { + return ELIMIT; + } + + vhc_data_t *data = malloc(sizeof(vhc_data_t)); + if (data == NULL) { + usb_log_fatal("Failed to allocate memory.\n"); + return ENOMEM; + } + data->magic = 0xDEADBEEF; + rc = usb_endpoint_manager_init(&data->ep_manager, (size_t) -1); + if (rc != EOK) { + usb_log_fatal("Failed to initialize endpoint manager.\n"); + free(data); + return rc; + } + usb_device_keeper_init(&data->dev_keeper); + + ddf_fun_t *hc = ddf_fun_create(dev, fun_exposed, "hc"); + if (hc == NULL) { + usb_log_fatal("Failed to create device function.\n"); + free(data); + return ENOMEM; + } + + hc->ops = &vhc_ops; + list_initialize(&data->devices); + fibril_mutex_initialize(&data->guard); + data->hub = &virtual_hub_device; + data->hc_fun = hc; + + dev->driver_data = data; + + rc = ddf_fun_bind(hc); + if (rc != EOK) { + usb_log_fatal("Failed to bind HC function: %s.\n", + str_error(rc)); + free(data); + return rc; + } + + rc = ddf_fun_add_to_class(hc, USB_HC_DDF_CLASS_NAME); + if (rc != EOK) { + usb_log_fatal("Failed to add function to HC class: %s.\n", + str_error(rc)); + free(data); + return rc; + } + + 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); + + + + rc = vhc_virtdev_plug_hub(data, data->hub, NULL); + if (rc != EOK) { + usb_log_fatal("Failed to plug root hub: %s.\n", str_error(rc)); + free(data); + return rc; + } + + 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[]) +{ + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + + printf(NAME ": virtual USB host controller driver.\n"); + + return ddf_driver_main(&vhc_driver); +} + + +/** + * @} + */ Index: uspace/drv/vhc/transfer.c =================================================================== --- uspace/drv/vhc/transfer.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/vhc/transfer.c (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,259 @@ +#include +#include +#include +#include +#include "vhcd.h" + +vhc_transfer_t *vhc_transfer_create(usb_address_t address, usb_endpoint_t ep, + usb_direction_t dir, usb_transfer_type_t tr_type, + ddf_fun_t *fun, void *callback_arg) +{ + vhc_transfer_t *result = malloc(sizeof(vhc_transfer_t)); + if (result == NULL) { + return NULL; + } + link_initialize(&result->link); + result->address = address; + result->endpoint = ep; + result->direction = dir; + result->transfer_type = tr_type; + result->setup_buffer = NULL; + result->setup_buffer_size = 0; + result->data_buffer = NULL; + result->data_buffer_size = 0; + result->ddf_fun = fun; + result->callback_arg = callback_arg; + result->callback_in = NULL; + result->callback_out = NULL; + + usb_log_debug2("Created transfer %p (%d.%d %s %s)\n", result, + address, ep, usb_str_transfer_type_short(tr_type), + dir == USB_DIRECTION_IN ? "in" : "out"); + + return result; +} + +static bool is_set_address_transfer(vhc_transfer_t *transfer) +{ + if (transfer->endpoint != 0) { + return false; + } + if (transfer->transfer_type != USB_TRANSFER_CONTROL) { + return false; + } + if (transfer->direction != USB_DIRECTION_OUT) { + return false; + } + if (transfer->setup_buffer_size != sizeof(usb_device_request_setup_packet_t)) { + return false; + } + usb_device_request_setup_packet_t *setup = transfer->setup_buffer; + if (setup->request_type != 0) { + return false; + } + if (setup->request != USB_DEVREQ_SET_ADDRESS) { + return false; + } + + return true; +} + +int vhc_virtdev_add_transfer(vhc_data_t *vhc, vhc_transfer_t *transfer) +{ + fibril_mutex_lock(&vhc->guard); + + bool target_found = false; + list_foreach(vhc->devices, pos) { + vhc_virtdev_t *dev = list_get_instance(pos, vhc_virtdev_t, link); + fibril_mutex_lock(&dev->guard); + if (dev->address == transfer->address) { + if (target_found) { + usb_log_warning("Transfer would be accepted by more devices!\n"); + goto next; + } + target_found = true; + list_append(&transfer->link, &dev->transfer_queue); + } +next: + fibril_mutex_unlock(&dev->guard); + } + + fibril_mutex_unlock(&vhc->guard); + + if (target_found) { + return EOK; + } else { + return ENOENT; + } +} + +static int process_transfer_local(vhc_transfer_t *transfer, + usbvirt_device_t *dev, size_t *actual_data_size) +{ + int rc; + + if (transfer->transfer_type == USB_TRANSFER_CONTROL) { + if (transfer->direction == USB_DIRECTION_IN) { + rc = usbvirt_control_read(dev, + transfer->setup_buffer, transfer->setup_buffer_size, + transfer->data_buffer, transfer->data_buffer_size, + actual_data_size); + } else { + assert(transfer->direction == USB_DIRECTION_OUT); + rc = usbvirt_control_write(dev, + transfer->setup_buffer, transfer->setup_buffer_size, + transfer->data_buffer, transfer->data_buffer_size); + } + } else { + if (transfer->direction == USB_DIRECTION_IN) { + rc = usbvirt_data_in(dev, transfer->transfer_type, + transfer->endpoint, + transfer->data_buffer, transfer->data_buffer_size, + actual_data_size); + } else { + assert(transfer->direction == USB_DIRECTION_OUT); + rc = usbvirt_data_out(dev, transfer->transfer_type, + transfer->endpoint, + transfer->data_buffer, transfer->data_buffer_size); + } + } + + return rc; +} + +static int process_transfer_remote(vhc_transfer_t *transfer, + int phone, size_t *actual_data_size) +{ + int rc; + + if (transfer->transfer_type == USB_TRANSFER_CONTROL) { + if (transfer->direction == USB_DIRECTION_IN) { + rc = usbvirt_ipc_send_control_read(phone, + transfer->setup_buffer, transfer->setup_buffer_size, + transfer->data_buffer, transfer->data_buffer_size, + actual_data_size); + } else { + assert(transfer->direction == USB_DIRECTION_OUT); + rc = usbvirt_ipc_send_control_write(phone, + transfer->setup_buffer, transfer->setup_buffer_size, + transfer->data_buffer, transfer->data_buffer_size); + } + } else { + if (transfer->direction == USB_DIRECTION_IN) { + rc = usbvirt_ipc_send_data_in(phone, transfer->endpoint, + transfer->transfer_type, + transfer->data_buffer, transfer->data_buffer_size, + actual_data_size); + } else { + assert(transfer->direction == USB_DIRECTION_OUT); + rc = usbvirt_ipc_send_data_out(phone, transfer->endpoint, + transfer->transfer_type, + transfer->data_buffer, transfer->data_buffer_size); + } + } + + return rc; +} + +static vhc_transfer_t *dequeue_first_transfer(vhc_virtdev_t *dev) +{ + assert(fibril_mutex_is_locked(&dev->guard)); + assert(!list_empty(&dev->transfer_queue)); + + vhc_transfer_t *transfer = list_get_instance(dev->transfer_queue.next, + vhc_transfer_t, link); + list_remove(&transfer->link); + + return transfer; +} + + +static void execute_transfer_callback_and_free(vhc_transfer_t *transfer, + size_t data_transfer_size, int outcome) +{ + assert(outcome != ENAK); + + usb_log_debug2("Transfer %p ended: %s.\n", + transfer, str_error(outcome)); + + if (transfer->direction == USB_DIRECTION_IN) { + transfer->callback_in(transfer->ddf_fun, outcome, + data_transfer_size, transfer->callback_arg); + } else { + assert(transfer->direction == USB_DIRECTION_OUT); + transfer->callback_out(transfer->ddf_fun, outcome, + transfer->callback_arg); + } + + free(transfer); +} + +int vhc_transfer_queue_processor(void *arg) +{ + vhc_virtdev_t *dev = arg; + fibril_mutex_lock(&dev->guard); + while (dev->plugged) { + if (list_empty(&dev->transfer_queue)) { + fibril_mutex_unlock(&dev->guard); + async_usleep(10 * 1000); + fibril_mutex_lock(&dev->guard); + continue; + } + + vhc_transfer_t *transfer = dequeue_first_transfer(dev); + fibril_mutex_unlock(&dev->guard); + + int rc = EOK; + size_t data_transfer_size = 0; + if (dev->dev_phone > 0) { + rc = process_transfer_remote(transfer, dev->dev_phone, + &data_transfer_size); + } else if (dev->dev_local != NULL) { + rc = process_transfer_local(transfer, dev->dev_local, + &data_transfer_size); + } else { + usb_log_warning("Device has no remote phone nor local node.\n"); + rc = ESTALL; + } + + usb_log_debug2("Transfer %p processed: %s.\n", + transfer, str_error(rc)); + + fibril_mutex_lock(&dev->guard); + if (rc == EOK) { + if (is_set_address_transfer(transfer)) { + usb_device_request_setup_packet_t *setup + = transfer->setup_buffer; + dev->address = setup->value; + usb_log_debug2("Address changed to %d\n", + dev->address); + } + } + if (rc == ENAK) { + // FIXME: this will work only because we do + // not NAK control transfers but this is generally + // a VERY bad idea indeed + list_append(&transfer->link, &dev->transfer_queue); + } + fibril_mutex_unlock(&dev->guard); + + if (rc != ENAK) { + execute_transfer_callback_and_free(transfer, + data_transfer_size, rc); + } + + async_usleep(1000 * 100); + fibril_mutex_lock(&dev->guard); + } + + /* Immediately fail all remaining transfers. */ + while (!list_empty(&dev->transfer_queue)) { + vhc_transfer_t *transfer = dequeue_first_transfer(dev); + execute_transfer_callback_and_free(transfer, 0, EBADCHECKSUM); + } + + fibril_mutex_unlock(&dev->guard); + + return EOK; +} + Index: uspace/drv/vhc/vhc.ma =================================================================== --- uspace/drv/vhc/vhc.ma (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/vhc/vhc.ma (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,2 @@ +10 usb&hc=vhc + Index: uspace/drv/vhc/vhcd.h =================================================================== --- uspace/drv/vhc/vhcd.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) +++ uspace/drv/vhc/vhcd.h (revision df29f24d4abcaa1e1685723e6f90f6acdccb7941) @@ -0,0 +1,96 @@ +/* + * 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 +#include +#include +#include +#include + +#define NAME "vhc" + +typedef struct { + link_t link; + int dev_phone; + usbvirt_device_t *dev_local; + bool plugged; + usb_address_t address; + fibril_mutex_t guard; + link_t transfer_queue; +} vhc_virtdev_t; + +typedef struct { + uint32_t magic; + link_t devices; + fibril_mutex_t guard; + usb_endpoint_manager_t ep_manager; + usb_device_keeper_t dev_keeper; + usbvirt_device_t *hub; + ddf_fun_t *hc_fun; +} vhc_data_t; + +typedef struct { + link_t link; + usb_address_t address; + usb_endpoint_t endpoint; + usb_direction_t direction; + usb_transfer_type_t transfer_type; + void *setup_buffer; + size_t setup_buffer_size; + void *data_buffer; + size_t data_buffer_size; + ddf_fun_t *ddf_fun; + void *callback_arg; + usbhc_iface_transfer_in_callback_t callback_in; + usbhc_iface_transfer_out_callback_t callback_out; +} vhc_transfer_t; + +vhc_transfer_t *vhc_transfer_create(usb_address_t, usb_endpoint_t, + usb_direction_t, usb_transfer_type_t, ddf_fun_t *, void *); +int vhc_virtdev_plug(vhc_data_t *, int, uintptr_t *); +int vhc_virtdev_plug_local(vhc_data_t *, usbvirt_device_t *, uintptr_t *); +int vhc_virtdev_plug_hub(vhc_data_t *, usbvirt_device_t *, uintptr_t *); +void vhc_virtdev_unplug(vhc_data_t *, uintptr_t); +int vhc_virtdev_add_transfer(vhc_data_t *, vhc_transfer_t *); + +int vhc_transfer_queue_processor(void *arg); + + +#endif +/** + * @} + */