Index: uspace/drv/ehci-hcd/Makefile =================================================================== --- uspace/drv/ehci-hcd/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ehci-hcd/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,39 @@ +# +# Copyright (c) 2011 Jan Vesely +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBS = $(LIBDRV_PREFIX)/libdrv.a $(LIBUSB_PREFIX)/libusb.a +EXTRA_CFLAGS += -I$(LIBDRV_PREFIX)/include -I$(LIBUSB_PREFIX)/include -I. +BINARY = ehci-hcd + +SOURCES = \ + hc_iface.c \ + main.c \ + pci.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/ehci-hcd/ehci-hcd.ma =================================================================== --- uspace/drv/ehci-hcd/ehci-hcd.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ehci-hcd/ehci-hcd.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,38 @@ +10 pci/ven=1002&dev=4345 +10 pci/ven=1002&dev=4386 +10 pci/ven=1002&dev=4396 +10 pci/ven=1022&dev=7463 +10 pci/ven=1022&dev=7808 +10 pci/ven=102f&dev=01b5 +10 pci/ven=10cf&dev=1415 +10 pci/ven=10de&dev=00e8 +10 pci/ven=10de&dev=055f +10 pci/ven=10de&dev=056a +10 pci/ven=10de&dev=077c +10 pci/ven=10de&dev=077e +10 pci/ven=10de&dev=0aa6 +10 pci/ven=10de&dev=0aa9 +10 pci/ven=10de&dev=0aaa +10 pci/ven=10de&dev=0d9d +10 pci/ven=1166&dev=0414 +10 pci/ven=1166&dev=0416 +10 pci/ven=1414&dev=5805 +10 pci/ven=1414&dev=5807 +10 pci/ven=15ad&dev=0770 +10 pci/ven=17a0&dev=8084 +10 pci/ven=8086&dev=24cd +10 pci/ven=8086&dev=24dd +10 pci/ven=8086&dev=265c +10 pci/ven=8086&dev=268c +10 pci/ven=8086&dev=27cc +10 pci/ven=8086&dev=2836 +10 pci/ven=8086&dev=283a +10 pci/ven=8086&dev=293a +10 pci/ven=8086&dev=293c +10 pci/ven=8086&dev=3a3a +10 pci/ven=8086&dev=3a3c +10 pci/ven=8086&dev=3a6a +10 pci/ven=8086&dev=3a6c +10 pci/ven=8086&dev=8117 +10 pci/ven=8086&dev=8807 +10 pci/ven=8086&dev=880f Index: uspace/drv/ehci-hcd/ehci.h =================================================================== --- uspace/drv/ehci-hcd/ehci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ehci-hcd/ehci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,48 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbehci + * @{ + */ +/** @file + * Common EHCI definitions. + */ +#ifndef DRV_EHCI_EHCI_H +#define DRV_EHCI_EHCI_H + +#include + +#define NAME "ehci-hcd" + +extern usbhc_iface_t ehci_hc_iface; + +#endif +/** + * @} + */ + Index: uspace/drv/ehci-hcd/hc_iface.c =================================================================== --- uspace/drv/ehci-hcd/hc_iface.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ehci-hcd/hc_iface.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,347 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbehci + * @{ + */ +/** @file + * USB-HC interface implementation. + */ +#include +#include +#include +#include +#include + +#include +#include +#include + +#include "ehci.h" + +#define UNSUPPORTED(methodname) \ + usb_log_warning("Unsupported interface method `%s()' in %s:%d.\n", \ + methodname, __FILE__, __LINE__) + +/** Reserve default address. + * + * This function may block the caller. + * + * @param[in] fun Device function the action was invoked on. + * @param[in] speed Speed of the device for which the default address is + * reserved. + * @return Error code. + */ +static int reserve_default_address(ddf_fun_t *fun, usb_speed_t speed) +{ + UNSUPPORTED("reserve_default_address"); + + return ENOTSUP; +} + +/** Release default address. + * + * @param[in] fun Device function the action was invoked on. + * @return Error code. + */ +static int release_default_address(ddf_fun_t *fun) +{ + UNSUPPORTED("release_default_address"); + + return ENOTSUP; +} + +/** Found free USB address. + * + * @param[in] fun Device function the action was invoked on. + * @param[in] speed Speed of the device that will get this address. + * @param[out] address Non-null pointer where to store the free address. + * @return Error code. + */ +static int request_address(ddf_fun_t *fun, usb_speed_t speed, + usb_address_t *address) +{ + UNSUPPORTED("request_address"); + + return ENOTSUP; +} + +/** Bind USB address with device devman handle. + * + * @param[in] fun Device function the action was invoked on. + * @param[in] address USB address of the device. + * @param[in] handle Devman handle of the device. + * @return Error code. + */ +static int bind_address(ddf_fun_t *fun, + usb_address_t address, devman_handle_t handle) +{ + UNSUPPORTED("bind_address"); + + return ENOTSUP; +} + +/** Release previously requested address. + * + * @param[in] fun Device function the action was invoked on. + * @param[in] address USB address to be released. + * @return Error code. + */ +static int release_address(ddf_fun_t *fun, usb_address_t address) +{ + UNSUPPORTED("release_address"); + + return ENOTSUP; +} + +/** Register endpoint for bandwidth reservation. + * + * @param[in] fun Device function the action was invoked on. + * @param[in] address USB address of the device. + * @param[in] endpoint Endpoint number. + * @param[in] transfer_type USB transfer type. + * @param[in] direction Endpoint data direction. + * @param[in] max_packet_size Max packet size of the endpoint. + * @param[in] interval Polling interval. + * @return Error code. + */ +static int register_endpoint(ddf_fun_t *fun, + usb_address_t address, usb_endpoint_t endpoint, + usb_transfer_type_t transfer_type, usb_direction_t direction, + size_t max_packet_size, unsigned int interval) +{ + UNSUPPORTED("register_endpoint"); + + return ENOTSUP; +} + +/** Unregister endpoint (free some bandwidth reservation). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] address USB address of the device. + * @param[in] endpoint Endpoint number. + * @param[in] direction Endpoint data direction. + * @return Error code. + */ +static int unregister_endpoint(ddf_fun_t *fun, usb_address_t address, + usb_endpoint_t endpoint, usb_direction_t direction) +{ + UNSUPPORTED("unregister_endpoint"); + + return ENOTSUP; +} + +/** Schedule interrupt out transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] data Data to be sent (in USB endianess, allocated and deallocated + * by the caller). + * @param[in] size Size of the @p data buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int interrupt_out(ddf_fun_t *fun, usb_target_t target, + size_t max_packet_size, void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + UNSUPPORTED("interrupt_out"); + + return ENOTSUP; +} + +/** Schedule interrupt in transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] data Buffer where to store the data (in USB endianess, + * allocated and deallocated by the caller). + * @param[in] size Size of the @p data buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int interrupt_in(ddf_fun_t *fun, usb_target_t target, + size_t max_packet_size, void *data, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + UNSUPPORTED("interrupt_in"); + + return ENOTSUP; +} + +/** Schedule bulk out transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] data Data to be sent (in USB endianess, allocated and deallocated + * by the caller). + * @param[in] size Size of the @p data buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int bulk_out(ddf_fun_t *fun, usb_target_t target, + size_t max_packet_size, void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + UNSUPPORTED("bulk_out"); + + return ENOTSUP; +} + +/** Schedule bulk in transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] data Buffer where to store the data (in USB endianess, + * allocated and deallocated by the caller). + * @param[in] size Size of the @p data buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int bulk_in(ddf_fun_t *fun, usb_target_t target, + size_t max_packet_size, void *data, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + UNSUPPORTED("bulk_in"); + + return ENOTSUP; +} + +/** Schedule control write transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] setup_packet Setup packet buffer (in USB endianess, allocated + * and deallocated by the caller). + * @param[in] setup_packet_size Size of @p setup_packet buffer in bytes. + * @param[in] data_buffer Data buffer (in USB endianess, allocated and + * deallocated by the caller). + * @param[in] data_buffer_size Size of @p data_buffer buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int control_write(ddf_fun_t *fun, usb_target_t target, + size_t max_packet_size, + void *setup_packet, size_t setup_packet_size, + void *data_buffer, size_t data_buffer_size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + UNSUPPORTED("control_write"); + + return ENOTSUP; +} + +/** Schedule control read transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] setup_packet Setup packet buffer (in USB endianess, allocated + * and deallocated by the caller). + * @param[in] setup_packet_size Size of @p setup_packet buffer in bytes. + * @param[in] data_buffer Buffer where to store the data (in USB endianess, + * allocated and deallocated by the caller). + * @param[in] data_buffer_size Size of @p data_buffer buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int control_read(ddf_fun_t *fun, usb_target_t target, + size_t max_packet_size, + void *setup_packet, size_t setup_packet_size, + void *data_buffer, size_t data_buffer_size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + UNSUPPORTED("control_read"); + + return ENOTSUP; +} + +/** Host controller interface implementation for EHCI. */ +usbhc_iface_t ehci_hc_iface = { + .reserve_default_address = reserve_default_address, + .release_default_address = release_default_address, + .request_address = request_address, + .bind_address = bind_address, + .release_address = release_address, + + .register_endpoint = register_endpoint, + .unregister_endpoint = unregister_endpoint, + + .interrupt_out = interrupt_out, + .interrupt_in = interrupt_in, + + .bulk_out = bulk_out, + .bulk_in = bulk_in, + + .control_write = control_write, + .control_read = control_read +}; + +/** + * @} + */ Index: uspace/drv/ehci-hcd/main.c =================================================================== --- uspace/drv/ehci-hcd/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ehci-hcd/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,126 @@ +/* + * Copyright (c) 2011 Jan Vesely + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbehci + * @{ + */ +/** @file + * Main routines of EHCI driver. + */ +#include +#include +#include +#include +#include + +#include +#include +#include + +#include "pci.h" +#include "ehci.h" + +static int ehci_add_device(ddf_dev_t *device); +/*----------------------------------------------------------------------------*/ +static driver_ops_t ehci_driver_ops = { + .add_device = ehci_add_device, +}; +/*----------------------------------------------------------------------------*/ +static driver_t ehci_driver = { + .name = NAME, + .driver_ops = &ehci_driver_ops +}; +static ddf_dev_ops_t hc_ops = { + .interfaces[USBHC_DEV_IFACE] = &ehci_hc_iface, +}; + +/*----------------------------------------------------------------------------*/ +/** Initializes a new ddf driver instance of EHCI hcd. + * + * @param[in] device DDF instance of the device to initialize. + * @return Error code. + */ +static int ehci_add_device(ddf_dev_t *device) +{ + assert(device); +#define CHECK_RET_RETURN(ret, message...) \ +if (ret != EOK) { \ + usb_log_error(message); \ + return ret; \ +} + + uintptr_t mem_reg_base = 0; + size_t mem_reg_size = 0; + int irq = 0; + + int ret = + pci_get_my_registers(device, &mem_reg_base, &mem_reg_size, &irq); + CHECK_RET_RETURN(ret, + "Failed(%d) to get memory addresses:.\n", ret, device->handle); + usb_log_info("Memory mapped regs at 0x%X (size %zu), IRQ %d.\n", + mem_reg_base, mem_reg_size, irq); + + ret = pci_disable_legacy(device); + CHECK_RET_RETURN(ret, + "Failed(%d) disable legacy USB: %s.\n", ret, str_error(ret)); + + ddf_fun_t *hc_fun = ddf_fun_create(device, fun_exposed, "ehci-hc"); + if (hc_fun == NULL) { + usb_log_error("Failed to create EHCI function.\n"); + return ENOMEM; + } + hc_fun->ops = &hc_ops; + ret = ddf_fun_bind(hc_fun); + + CHECK_RET_RETURN(ret, + "Failed to bind EHCI function: %s.\n", + str_error(ret)); + + usb_log_info("Controlling new EHCI device `%s' (handle %llu).\n", + device->name, device->handle); + + return EOK; +#undef CHECK_RET_RETURN +} +/*----------------------------------------------------------------------------*/ +/** Initializes global driver structures (NONE). + * + * @param[in] argc Nmber of arguments in argv vector (ignored). + * @param[in] argv Cmdline argument vector (ignored). + * @return Error code. + * + * Driver debug level is set here. + */ +int main(int argc, char *argv[]) +{ + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + return ddf_driver_main(&ehci_driver); +} +/** + * @} + */ Index: uspace/drv/ehci-hcd/pci.c =================================================================== --- uspace/drv/ehci-hcd/pci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ehci-hcd/pci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,315 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** + * @addtogroup drvusbehci + * @{ + */ +/** + * @file + * PCI related functions needed by the EHCI driver. + */ +#include +#include +#include +#include +#include +#include +#include + +#include +#include + +#include "pci.h" + +#define PAGE_SIZE_MASK 0xfffff000 + +#define HCC_PARAMS_OFFSET 0x8 +#define HCC_PARAMS_EECP_MASK 0xff +#define HCC_PARAMS_EECP_OFFSET 8 + +#define CMD_OFFSET 0x0 +#define CONFIGFLAG_OFFSET 0x40 + +#define USBCMD_RUN 1 + +#define USBLEGSUP_OFFSET 0 +#define USBLEGSUP_BIOS_CONTROL (1 << 16) +#define USBLEGSUP_OS_CONTROL (1 << 24) +#define USBLEGCTLSTS_OFFSET 4 + +#define DEFAULT_WAIT 10000 +#define WAIT_STEP 10 + +/** Get address of registers and IRQ for given device. + * + * @param[in] dev Device asking for the addresses. + * @param[out] mem_reg_address Base address of the memory range. + * @param[out] mem_reg_size Size of the memory range. + * @param[out] irq_no IRQ assigned to the device. + * @return Error code. + */ +int pci_get_my_registers(ddf_dev_t *dev, + uintptr_t *mem_reg_address, size_t *mem_reg_size, int *irq_no) +{ + assert(dev != NULL); + + int parent_phone = devman_parent_device_connect(dev->handle, + IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + + int rc; + + hw_resource_list_t hw_resources; + rc = hw_res_get_resource_list(parent_phone, &hw_resources); + if (rc != EOK) { + async_hangup(parent_phone); + return rc; + } + + uintptr_t mem_address = 0; + size_t mem_size = 0; + bool mem_found = false; + + int irq = 0; + bool irq_found = false; + + size_t i; + for (i = 0; i < hw_resources.count; i++) { + hw_resource_t *res = &hw_resources.resources[i]; + switch (res->type) + { + case INTERRUPT: + irq = res->res.interrupt.irq; + irq_found = true; + usb_log_debug2("Found interrupt: %d.\n", irq); + break; + + case MEM_RANGE: + if (res->res.mem_range.address != 0 + && res->res.mem_range.size != 0 ) { + mem_address = res->res.mem_range.address; + mem_size = res->res.mem_range.size; + usb_log_debug2("Found mem: %llx %zu.\n", + mem_address, mem_size); + mem_found = true; + } + default: + break; + } + } + + if (mem_found && irq_found) { + *mem_reg_address = mem_address; + *mem_reg_size = mem_size; + *irq_no = irq; + rc = EOK; + } else { + rc = ENOENT; + } + + async_hangup(parent_phone); + return rc; +} +/*----------------------------------------------------------------------------*/ +/** Calls the PCI driver with a request to enable interrupts + * + * @param[in] device Device asking for interrupts + * @return Error code. + */ +int pci_enable_interrupts(ddf_dev_t *device) +{ + int parent_phone = + devman_parent_device_connect(device->handle, IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + bool enabled = hw_res_enable_interrupt(parent_phone); + async_hangup(parent_phone); + return enabled ? EOK : EIO; +} +/*----------------------------------------------------------------------------*/ +/** Implements BIOS handoff routine as decribed in EHCI spec + * + * @param[in] device Device asking for interrupts + * @return Error code. + */ +int pci_disable_legacy(ddf_dev_t *device) +{ + assert(device); + int parent_phone = devman_parent_device_connect(device->handle, + IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + +#define CHECK_RET_HANGUP_RETURN(ret, message...) \ + if (ret != EOK) { \ + usb_log_error(message); \ + async_hangup(parent_phone); \ + return ret; \ + } else (void)0 + + + /* read register space BASE BAR */ + sysarg_t address = 0x10; + sysarg_t value; + + int ret = async_req_2_1(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), + IPC_M_CONFIG_SPACE_READ_32, address, &value); + CHECK_RET_HANGUP_RETURN(ret, "Failed(%d) to read PCI config space.\n", + ret); + usb_log_info("Register space BAR at %p:%x.\n", address, value); + + /* clear lower byte, it's not part of the BASE address */ + uintptr_t registers = (value & 0xffffff00); + usb_log_info("Memory registers BASE address:%p.\n", registers); + + /* if nothing setup the hc, we don't need to turn it off */ + if (registers == 0) + return ENOTSUP; + + /* map EHCI registers */ + void *regs = as_get_mappable_page(4096); + ret = physmem_map((void*)(registers & PAGE_SIZE_MASK), regs, 1, + AS_AREA_READ | AS_AREA_WRITE); + CHECK_RET_HANGUP_RETURN(ret, "Failed(%d) to map registers %p:%p.\n", + ret, regs, registers); + + /* calculate value of BASE */ + registers = (registers & 0xf00) | (uintptr_t)regs; + + const uint32_t hcc_params = + *(uint32_t*)(registers + HCC_PARAMS_OFFSET); + usb_log_debug("Value of hcc params register: %x.\n", hcc_params); + + /* Read value of EHCI Extended Capabilities Pointer + * (points to PCI config space) */ + uint32_t eecp = + (hcc_params >> HCC_PARAMS_EECP_OFFSET) & HCC_PARAMS_EECP_MASK; + usb_log_debug("Value of EECP: %x.\n", eecp); + + /* Read the second EEC. i.e. Legacy Support and Control register */ + /* TODO: Check capability type here */ + ret = async_req_2_1(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), + IPC_M_CONFIG_SPACE_READ_32, eecp + USBLEGCTLSTS_OFFSET, &value); + CHECK_RET_HANGUP_RETURN(ret, "Failed(%d) to read USBLEGCTLSTS.\n", ret); + usb_log_debug("USBLEGCTLSTS: %x.\n", value); + + /* Read the first EEC. i.e. Legacy Support register */ + /* TODO: Check capability type here */ + ret = async_req_2_1(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), + IPC_M_CONFIG_SPACE_READ_32, eecp + USBLEGSUP_OFFSET, &value); + CHECK_RET_HANGUP_RETURN(ret, "Failed(%d) to read USBLEGSUP.\n", ret); + usb_log_debug2("USBLEGSUP: %x.\n", value); + + /* Request control from firmware/BIOS, by writing 1 to highest byte. + * (OS Control semaphore)*/ + ret = async_req_3_0(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), + IPC_M_CONFIG_SPACE_WRITE_8, eecp + USBLEGSUP_OFFSET + 3, 1); + CHECK_RET_HANGUP_RETURN(ret, "Failed(%d) to request OS EHCI control.\n", + ret); + + size_t wait = 0; + /* Wait for BIOS to release control. */ + while ((wait < DEFAULT_WAIT) && (value & USBLEGSUP_BIOS_CONTROL)) { + async_usleep(WAIT_STEP); + ret = async_req_2_1(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), + IPC_M_CONFIG_SPACE_READ_32, eecp + USBLEGSUP_OFFSET, &value); + wait += WAIT_STEP; + } + + + if ((value & USBLEGSUP_BIOS_CONTROL) == 0) { + usb_log_info("BIOS released control after %d usec.\n", wait); + } else { + /* BIOS failed to hand over control, this should not happen. */ + usb_log_warning( "BIOS failed to release control after " + "%d usecs, force it.\n", wait); + ret = async_req_3_0(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), + IPC_M_CONFIG_SPACE_WRITE_32, eecp + USBLEGSUP_OFFSET, + USBLEGSUP_OS_CONTROL); + CHECK_RET_HANGUP_RETURN(ret, + "Failed(%d) to force OS EHCI control.\n", ret); + } + + /* Zero SMI enables in legacy control register. + * It would prevent pre-OS code from interfering. */ + ret = async_req_3_0(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), + IPC_M_CONFIG_SPACE_WRITE_32, eecp + USBLEGCTLSTS_OFFSET, 0); + CHECK_RET_HANGUP_RETURN(ret, "Failed(%d) zero USBLEGCTLSTS.\n", ret); + usb_log_debug("Zeroed USBLEGCTLSTS register.\n"); + + /* Read again Legacy Support and Control register */ + ret = async_req_2_1(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), + IPC_M_CONFIG_SPACE_READ_32, eecp + USBLEGCTLSTS_OFFSET, &value); + CHECK_RET_HANGUP_RETURN(ret, "Failed(%d) to read USBLEGCTLSTS.\n", ret); + usb_log_debug2("USBLEGCTLSTS: %x.\n", value); + + /* Read again Legacy Support register */ + ret = async_req_2_1(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), + IPC_M_CONFIG_SPACE_READ_32, eecp + USBLEGSUP_OFFSET, &value); + CHECK_RET_HANGUP_RETURN(ret, "Failed(%d) to read USBLEGSUP.\n", ret); + usb_log_debug2("USBLEGSUP: %x.\n", value); + + /* + * TURN OFF EHCI FOR NOW, DRIVER WILL REINITIALIZE IT + */ + + /* Get size of capability registers in memory space. */ + uint8_t operation_offset = *(uint8_t*)registers; + usb_log_debug("USBCMD offset: %d.\n", operation_offset); + + /* Zero USBCMD register. */ + volatile uint32_t *usbcmd = + (uint32_t*)((uint8_t*)registers + operation_offset + CMD_OFFSET); + volatile uint32_t *usbconfigured = + (uint32_t*)((uint8_t*)registers + operation_offset + + CONFIGFLAG_OFFSET); + usb_log_debug("USBCMD value: %x.\n", *usbcmd); + if (*usbcmd & USBCMD_RUN) { + *usbcmd = 0; + *usbconfigured = 0; + usb_log_info("EHCI turned off.\n"); + } else { + usb_log_info("EHCI was not running.\n"); + } + + async_hangup(parent_phone); + return ret; +#undef CHECK_RET_HANGUP_RETURN +} +/*----------------------------------------------------------------------------*/ +/** + * @} + */ + +/** + * @} + */ Index: uspace/drv/ehci-hcd/pci.h =================================================================== --- uspace/drv/ehci-hcd/pci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ehci-hcd/pci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,48 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbehci + * @{ + */ +/** @file + * PCI related functions needed by EHCI driver. + */ +#ifndef DRV_EHCI_PCI_H +#define DRV_EHCI_PCI_H + +#include + +int pci_get_my_registers(ddf_dev_t *, uintptr_t *, size_t *, int *); +int pci_enable_interrupts(ddf_dev_t *); +int pci_disable_legacy(ddf_dev_t *); + +#endif +/** + * @} + */ + Index: uspace/drv/ohci/Makefile =================================================================== --- uspace/drv/ohci/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,43 @@ +# +# Copyright (c) 2011 Jan Vesely +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBS = $(LIBDRV_PREFIX)/libdrv.a $(LIBUSB_PREFIX)/libusb.a +EXTRA_CFLAGS += -I$(LIBDRV_PREFIX)/include -I$(LIBUSB_PREFIX)/include -I. +BINARY = ohci + +SOURCES = \ + iface.c \ + batch.c \ + main.c \ + hc.c \ + ohci.c \ + root_hub.c \ + pci.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/ohci/batch.c =================================================================== --- uspace/drv/ohci/batch.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/batch.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,185 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * @brief OHCI driver USB transaction structure + */ +#include +#include + +#include +#include + +#include "batch.h" +#include "utils/malloc32.h" + +static void batch_call_in_and_dispose(usb_transfer_batch_t *instance); +static void batch_call_out_and_dispose(usb_transfer_batch_t *instance); + +#define DEFAULT_ERROR_COUNT 3 +usb_transfer_batch_t * batch_get( + ddf_fun_t *fun, + usb_target_t target, + usb_transfer_type_t transfer_type, + size_t max_packet_size, + usb_speed_t speed, + char *buffer, + size_t buffer_size, + char *setup_buffer, + size_t setup_size, + usbhc_iface_transfer_in_callback_t func_in, + usbhc_iface_transfer_out_callback_t func_out, + void *arg, + usb_device_keeper_t *manager + ) +{ +#define CHECK_NULL_DISPOSE_RETURN(ptr, message...) \ + if (ptr == NULL) { \ + usb_log_error(message); \ + if (instance) { \ + batch_dispose(instance); \ + } \ + return NULL; \ + } else (void)0 + + usb_transfer_batch_t *instance = malloc(sizeof(usb_transfer_batch_t)); + CHECK_NULL_DISPOSE_RETURN(instance, + "Failed to allocate batch instance.\n"); + usb_transfer_batch_init(instance, target, transfer_type, speed, max_packet_size, + buffer, NULL, buffer_size, NULL, setup_size, func_in, + func_out, arg, fun, NULL); + + if (buffer_size > 0) { + instance->transport_buffer = malloc32(buffer_size); + CHECK_NULL_DISPOSE_RETURN(instance->transport_buffer, + "Failed to allocate device accessible buffer.\n"); + } + + if (setup_size > 0) { + instance->setup_buffer = malloc32(setup_size); + CHECK_NULL_DISPOSE_RETURN(instance->setup_buffer, + "Failed to allocate device accessible setup buffer.\n"); + memcpy(instance->setup_buffer, setup_buffer, setup_size); + } + + + return instance; +} +/*----------------------------------------------------------------------------*/ +void batch_dispose(usb_transfer_batch_t *instance) +{ + assert(instance); + free32(instance->transport_buffer); + free32(instance->setup_buffer); + free(instance); +} +/*----------------------------------------------------------------------------*/ +void batch_control_write(usb_transfer_batch_t *instance) +{ + assert(instance); + /* We are data out, we are supposed to provide data */ + memcpy(instance->transport_buffer, instance->buffer, + instance->buffer_size); + instance->next_step = batch_call_out_and_dispose; + /* TODO: implement */ + usb_log_debug("Batch(%p) CONTROL WRITE initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +void batch_control_read(usb_transfer_batch_t *instance) +{ + assert(instance); + instance->next_step = batch_call_in_and_dispose; + /* TODO: implement */ + usb_log_debug("Batch(%p) CONTROL READ initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +void batch_interrupt_in(usb_transfer_batch_t *instance) +{ + assert(instance); + instance->direction = USB_DIRECTION_IN; + instance->next_step = batch_call_in_and_dispose; + /* TODO: implement */ + usb_log_debug("Batch(%p) INTERRUPT IN initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +void batch_interrupt_out(usb_transfer_batch_t *instance) +{ + assert(instance); + instance->direction = USB_DIRECTION_OUT; + /* We are data out, we are supposed to provide data */ + memcpy(instance->transport_buffer, instance->buffer, + instance->buffer_size); + instance->next_step = batch_call_out_and_dispose; + /* TODO: implement */ + usb_log_debug("Batch(%p) INTERRUPT OUT initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +void batch_bulk_in(usb_transfer_batch_t *instance) +{ + assert(instance); + instance->direction = USB_DIRECTION_IN; + instance->next_step = batch_call_in_and_dispose; + /* TODO: implement */ + usb_log_debug("Batch(%p) BULK IN initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +void batch_bulk_out(usb_transfer_batch_t *instance) +{ + assert(instance); + instance->direction = USB_DIRECTION_IN; + instance->next_step = batch_call_in_and_dispose; + /* TODO: implement */ + usb_log_debug("Batch(%p) BULK IN initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Helper function calls callback and correctly disposes of batch structure. + * + * @param[in] instance Batch structure to use. + */ +void batch_call_in_and_dispose(usb_transfer_batch_t *instance) +{ + assert(instance); + usb_transfer_batch_call_in(instance); + batch_dispose(instance); +} +/*----------------------------------------------------------------------------*/ +/** Helper function calls callback and correctly disposes of batch structure. + * + * @param[in] instance Batch structure to use. + */ +void batch_call_out_and_dispose(usb_transfer_batch_t *instance) +{ + assert(instance); + usb_transfer_batch_call_out(instance); + batch_dispose(instance); +} +/** + * @} + */ Index: uspace/drv/ohci/batch.h =================================================================== --- uspace/drv/ohci/batch.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/batch.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,75 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * @brief OHCI driver USB transaction structure + */ +#ifndef DRV_OHCI_BATCH_H +#define DRV_OHCI_BATCH_H + + +#include +#include +#include +#include + +usb_transfer_batch_t * batch_get( + ddf_fun_t *fun, + usb_target_t target, + usb_transfer_type_t transfer_type, + size_t max_packet_size, + usb_speed_t speed, + char *buffer, + size_t size, + char *setup_buffer, + size_t setup_size, + usbhc_iface_transfer_in_callback_t func_in, + usbhc_iface_transfer_out_callback_t func_out, + void *arg, + usb_device_keeper_t *manager + ); + +void batch_dispose(usb_transfer_batch_t *instance); + +void batch_control_write(usb_transfer_batch_t *instance); + +void batch_control_read(usb_transfer_batch_t *instance); + +void batch_interrupt_in(usb_transfer_batch_t *instance); + +void batch_interrupt_out(usb_transfer_batch_t *instance); + +void batch_bulk_in(usb_transfer_batch_t *instance); + +void batch_bulk_out(usb_transfer_batch_t *instance); +#endif +/** + * @} + */ Index: uspace/drv/ohci/hc.c =================================================================== --- uspace/drv/ohci/hc.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/hc.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,137 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbohcihc + * @{ + */ +/** @file + * @brief OHCI Host controller driver routines + */ +#include +#include +#include +#include + +#include +#include +#include +#include + +#include "hc.h" + +static int interrupt_emulator(hc_t *instance); +/*----------------------------------------------------------------------------*/ +int hc_register_hub(hc_t *instance, ddf_fun_t *hub_fun) +{ + assert(instance); + assert(hub_fun); + + usb_address_t hub_address = + device_keeper_get_free_address(&instance->manager, USB_SPEED_FULL); + instance->rh.address = hub_address; + usb_device_keeper_bind( + &instance->manager, hub_address, hub_fun->handle); + + char *match_str = NULL; + int ret = asprintf(&match_str, "usb&class=hub"); + ret = (match_str == NULL) ? ret : EOK; + if (ret < 0) { + usb_log_error("Failed to create root hub match-id string.\n"); + return ret; + } + + ret = ddf_fun_add_match_id(hub_fun, match_str, 100); + if (ret != EOK) { + usb_log_error("Failed add create root hub match-id.\n"); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +int hc_init(hc_t *instance, ddf_fun_t *fun, ddf_dev_t *dev, + uintptr_t regs, size_t reg_size, bool interrupts) +{ + assert(instance); + int ret = EOK; + + ret = pio_enable((void*)regs, reg_size, (void**)&instance->registers); + if (ret != EOK) { + usb_log_error("Failed to gain access to device registers.\n"); + return ret; + } + instance->ddf_instance = fun; + usb_device_keeper_init(&instance->manager); + + if (!interrupts) { + instance->interrupt_emulator = + fibril_create((int(*)(void*))interrupt_emulator, instance); + fibril_add_ready(instance->interrupt_emulator); + } + + rh_init(&instance->rh, dev, instance->registers); + + /* TODO: implement */ + return EOK; +} +/*----------------------------------------------------------------------------*/ +int hc_schedule(hc_t *instance, usb_transfer_batch_t *batch) +{ + assert(instance); + assert(batch); + if (batch->target.address == instance->rh.address) { + return rh_request(&instance->rh, batch); + } + /* TODO: implement */ + return ENOTSUP; +} +/*----------------------------------------------------------------------------*/ +void hc_interrupt(hc_t *instance, uint32_t status) +{ + assert(instance); + if (status == 0) + return; + if (status & IS_RHSC) + rh_interrupt(&instance->rh); + + /* TODO: Check for further interrupt causes */ + /* TODO: implement */ +} +/*----------------------------------------------------------------------------*/ +int interrupt_emulator(hc_t *instance) +{ + assert(instance); + usb_log_info("Started interrupt emulator.\n"); + while (1) { + uint32_t status = instance->registers->interrupt_status; + instance->registers->interrupt_status = status; + hc_interrupt(instance, status); + async_usleep(1000); + } + return EOK; +} +/** + * @} + */ Index: uspace/drv/ohci/hc.h =================================================================== --- uspace/drv/ohci/hc.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/hc.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,84 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * @brief OHCI host controller driver structure + */ +#ifndef DRV_OHCI_HC_H +#define DRV_OHCI_HC_H + +#include +#include +#include +#include + +#include +#include +#include + +#include "batch.h" +#include "ohci_regs.h" +#include "root_hub.h" + +typedef struct hc { + ohci_regs_t *registers; + usb_address_t rh_address; + rh_t rh; + ddf_fun_t *ddf_instance; + usb_device_keeper_t manager; + fid_t interrupt_emulator; +} hc_t; + +int hc_register_hub(hc_t *instance, ddf_fun_t *hub_fun); + +int hc_init(hc_t *instance, ddf_fun_t *fun, ddf_dev_t *dev, + uintptr_t regs, size_t reg_size, bool interrupts); + +int hc_schedule(hc_t *instance, usb_transfer_batch_t *batch); + +void hc_interrupt(hc_t *instance, uint32_t status); + +/** Safely dispose host controller internal structures + * + * @param[in] instance Host controller structure to use. + */ +static inline void hc_fini(hc_t *instance) { /* TODO: implement*/ }; + +/** Get and cast pointer to the driver data + * + * @param[in] fun DDF function pointer + * @return cast pointer to driver_data + */ +static inline hc_t * fun_to_hc(ddf_fun_t *fun) + { return (hc_t*)fun->driver_data; } +#endif +/** + * @} + */ Index: uspace/drv/ohci/iface.c =================================================================== --- uspace/drv/ohci/iface.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/iface.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,466 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * USB-HC interface implementation. + */ +#include +#include + +#include + +#include "iface.h" +#include "hc.h" + +#define UNSUPPORTED(methodname) \ + usb_log_warning("Unsupported interface method `%s()' in %s:%d.\n", \ + methodname, __FILE__, __LINE__) + +/** Reserve default address. + * + * This function may block the caller. + * + * @param[in] fun Device function the action was invoked on. + * @param[in] speed Speed of the device for which the default address is + * reserved. + * @return Error code. + */ +static int reserve_default_address(ddf_fun_t *fun, usb_speed_t speed) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_log_debug("Default address request with speed %d.\n", speed); + usb_device_keeper_reserve_default_address(&hc->manager, speed); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Release default address. + * + * @param[in] fun Device function the action was invoked on. + * @return Error code. + */ +static int release_default_address(ddf_fun_t *fun) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_log_debug("Default address release.\n"); + usb_device_keeper_release_default_address(&hc->manager); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Found free USB address. + * + * @param[in] fun Device function the action was invoked on. + * @param[in] speed Speed of the device that will get this address. + * @param[out] address Non-null pointer where to store the free address. + * @return Error code. + */ +static int request_address( + ddf_fun_t *fun, usb_speed_t speed, usb_address_t *address) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + assert(address); + + usb_log_debug("Address request with speed %d.\n", speed); + *address = device_keeper_get_free_address(&hc->manager, speed); + usb_log_debug("Address request with result: %d.\n", *address); + if (*address <= 0) + return *address; + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Bind USB address with device devman handle. + * + * @param[in] fun Device function the action was invoked on. + * @param[in] address USB address of the device. + * @param[in] handle Devman handle of the device. + * @return Error code. + */ +static int bind_address( + ddf_fun_t *fun, usb_address_t address, devman_handle_t handle) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_log_debug("Address bind %d-%d.\n", address, handle); + usb_device_keeper_bind(&hc->manager, address, handle); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Release previously requested address. + * + * @param[in] fun Device function the action was invoked on. + * @param[in] address USB address to be released. + * @return Error code. + */ +static int release_address(ddf_fun_t *fun, usb_address_t address) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_log_debug("Address release %d.\n", address); + usb_device_keeper_release(&hc->manager, address); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Register endpoint for bandwidth reservation. + * + * @param[in] fun Device function the action was invoked on. + * @param[in] address USB address of the device. + * @param[in] endpoint Endpoint number. + * @param[in] transfer_type USB transfer type. + * @param[in] direction Endpoint data direction. + * @param[in] max_packet_size Max packet size of the endpoint. + * @param[in] interval Polling interval. + * @return Error code. + */ +static int register_endpoint( + ddf_fun_t *fun, usb_address_t address, usb_endpoint_t endpoint, + usb_transfer_type_t transfer_type, usb_direction_t direction, + size_t max_packet_size, unsigned int interval) +{ + UNSUPPORTED("register_endpoint"); + + return ENOTSUP; +} +/*----------------------------------------------------------------------------*/ +/** Unregister endpoint (free some bandwidth reservation). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] address USB address of the device. + * @param[in] endpoint Endpoint number. + * @param[in] direction Endpoint data direction. + * @return Error code. + */ +static int unregister_endpoint( + ddf_fun_t *fun, usb_address_t address, + usb_endpoint_t endpoint, usb_direction_t direction) +{ + UNSUPPORTED("unregister_endpoint"); + + return ENOTSUP; +} +/*----------------------------------------------------------------------------*/ +/** Schedule interrupt out transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] data Data to be sent (in USB endianess, allocated and deallocated + * by the caller). + * @param[in] size Size of the @p data buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int interrupt_out( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, void *data, + size_t size, usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + + usb_log_debug("Interrupt OUT %d:%d %zu(%zu).\n", + target.address, target.endpoint, size, max_packet_size); + + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_INTERRUPT, max_packet_size, + speed, data, size, NULL, 0, NULL, callback, arg, &hc->manager); + if (!batch) + return ENOMEM; + batch_interrupt_out(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Schedule interrupt in transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] data Buffer where to store the data (in USB endianess, + * allocated and deallocated by the caller). + * @param[in] size Size of the @p data buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int interrupt_in( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, void *data, + size_t size, usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + usb_log_debug("Interrupt IN %d:%d %zu(%zu).\n", + target.address, target.endpoint, size, max_packet_size); + + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_INTERRUPT, max_packet_size, + speed, data, size, NULL, 0, callback, NULL, arg, &hc->manager); + if (!batch) + return ENOMEM; + batch_interrupt_in(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Schedule bulk out transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] data Data to be sent (in USB endianess, allocated and deallocated + * by the caller). + * @param[in] size Size of the @p data buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int bulk_out( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, void *data, + size_t size, usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + + usb_log_debug("Bulk OUT %d:%d %zu(%zu).\n", + target.address, target.endpoint, size, max_packet_size); + + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_BULK, max_packet_size, speed, + data, size, NULL, 0, NULL, callback, arg, &hc->manager); + if (!batch) + return ENOMEM; + batch_bulk_out(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Schedule bulk in transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] data Buffer where to store the data (in USB endianess, + * allocated and deallocated by the caller). + * @param[in] size Size of the @p data buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int bulk_in( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, void *data, + size_t size, usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + usb_log_debug("Bulk IN %d:%d %zu(%zu).\n", + target.address, target.endpoint, size, max_packet_size); + + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_BULK, max_packet_size, speed, + data, size, NULL, 0, callback, NULL, arg, &hc->manager); + if (!batch) + return ENOMEM; + batch_bulk_in(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Schedule control write transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] setup_packet Setup packet buffer (in USB endianess, allocated + * and deallocated by the caller). + * @param[in] setup_packet_size Size of @p setup_packet buffer in bytes. + * @param[in] data_buffer Data buffer (in USB endianess, allocated and + * deallocated by the caller). + * @param[in] data_buffer_size Size of @p data_buffer buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int control_write( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, + void *setup_data, size_t setup_size, void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + usb_log_debug("Control WRITE (%d) %d:%d %zu(%zu).\n", + speed, target.address, target.endpoint, size, max_packet_size); + + if (setup_size != 8) + return EINVAL; + + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_CONTROL, max_packet_size, + speed, data, size, setup_data, setup_size, NULL, callback, arg, + &hc->manager); + if (!batch) + return ENOMEM; + usb_device_keeper_reset_if_need(&hc->manager, target, setup_data); + batch_control_write(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Schedule control read transfer. + * + * The callback is supposed to be called once the transfer (on the wire) is + * complete regardless of the outcome. + * However, the callback could be called only when this function returns + * with success status (i.e. returns EOK). + * + * @param[in] fun Device function the action was invoked on. + * @param[in] target Target pipe (address and endpoint number) specification. + * @param[in] max_packet_size Max packet size for the transfer. + * @param[in] setup_packet Setup packet buffer (in USB endianess, allocated + * and deallocated by the caller). + * @param[in] setup_packet_size Size of @p setup_packet buffer in bytes. + * @param[in] data_buffer Buffer where to store the data (in USB endianess, + * allocated and deallocated by the caller). + * @param[in] data_buffer_size Size of @p data_buffer buffer in bytes. + * @param[in] callback Callback to be issued once the transfer is complete. + * @param[in] arg Pass-through argument to the callback. + * @return Error code. + */ +static int control_read( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, + void *setup_data, size_t setup_size, void *data, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + + usb_log_debug("Control READ(%d) %d:%d %zu(%zu).\n", + speed, target.address, target.endpoint, size, max_packet_size); + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_CONTROL, max_packet_size, + speed, data, size, setup_data, setup_size, callback, NULL, arg, + &hc->manager); + if (!batch) + return ENOMEM; + batch_control_read(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Host controller interface implementation for OHCI. */ +usbhc_iface_t hc_iface = { + .reserve_default_address = reserve_default_address, + .release_default_address = release_default_address, + .request_address = request_address, + .bind_address = bind_address, + .release_address = release_address, + + .register_endpoint = register_endpoint, + .unregister_endpoint = unregister_endpoint, + + .interrupt_out = interrupt_out, + .interrupt_in = interrupt_in, + + .bulk_out = bulk_out, + .bulk_in = bulk_in, + + .control_write = control_write, + .control_read = control_read, +}; + +/** + * @} + */ Index: uspace/drv/ohci/iface.h =================================================================== --- uspace/drv/ohci/iface.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/iface.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,46 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * Common OHCI definitions. + */ +#ifndef DRV_OHCI_IFACE_H +#define DRV_OHCI_IFACE_H + +#include + +extern usbhc_iface_t hc_iface; + +#endif +/** + * @} + */ + Index: uspace/drv/ohci/main.c =================================================================== --- uspace/drv/ohci/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,100 @@ +/* + * Copyright (c) 2011 Jan Vesely + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * Main routines of OHCI driver. + */ +#include +#include +#include + +#include + +#include "ohci.h" + +#define NAME "ohci" + +static int ohci_add_device(ddf_dev_t *device); +/*----------------------------------------------------------------------------*/ +static driver_ops_t ohci_driver_ops = { + .add_device = ohci_add_device, +}; +/*----------------------------------------------------------------------------*/ +static driver_t ohci_driver = { + .name = NAME, + .driver_ops = &ohci_driver_ops +}; +/*----------------------------------------------------------------------------*/ +/** Initializes a new ddf driver instance of OHCI hcd. + * + * @param[in] device DDF instance of the device to initialize. + * @return Error code. + */ +int ohci_add_device(ddf_dev_t *device) +{ + usb_log_debug("ohci_add_device() called\n"); + assert(device); + ohci_t *ohci = malloc(sizeof(ohci_t)); + if (ohci == NULL) { + usb_log_error("Failed to allocate OHCI driver.\n"); + return ENOMEM; + } + + int ret = ohci_init(ohci, device); + if (ret != EOK) { + usb_log_error("Failed to initialize OHCI driver: %s.\n", + str_error(ret)); + return ret; + } + device->driver_data = ohci; + + usb_log_info("Controlling new OHCI device `%s'.\n", device->name); + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Initializes global driver structures (NONE). + * + * @param[in] argc Nmber of arguments in argv vector (ignored). + * @param[in] argv Cmdline argument vector (ignored). + * @return Error code. + * + * Driver debug level is set here. + */ +int main(int argc, char *argv[]) +{ + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + sleep(5); + return ddf_driver_main(&ohci_driver); +} +/** + * @} + */ Index: uspace/drv/ohci/ohci.c =================================================================== --- uspace/drv/ohci/ohci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/ohci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,225 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * @brief OHCI driver + */ +#include +#include +#include +#include +#include +#include +#include + +#include "ohci.h" +#include "iface.h" +#include "pci.h" + +/** IRQ handling callback, identifies device + * + * @param[in] dev DDF instance of the device to use. + * @param[in] iid (Unused). + * @param[in] call Pointer to the call that represents interrupt. + */ +static void irq_handler(ddf_dev_t *dev, ipc_callid_t iid, ipc_call_t *call) +{ + assert(dev); + hc_t *hc = &((ohci_t*)dev->driver_data)->hc; + uint16_t status = IPC_GET_ARG1(*call); + assert(hc); + hc_interrupt(hc, status); +} +/*----------------------------------------------------------------------------*/ +/** Get address of the device identified by handle. + * + * @param[in] dev DDF instance of the device to use. + * @param[in] iid (Unused). + * @param[in] call Pointer to the call that represents interrupt. + */ +static int usb_iface_get_address( + ddf_fun_t *fun, devman_handle_t handle, usb_address_t *address) +{ + assert(fun); + usb_device_keeper_t *manager = &((ohci_t*)fun->dev->driver_data)->hc.manager; + + usb_address_t addr = usb_device_keeper_find(manager, handle); + if (addr < 0) { + return addr; + } + + if (address != NULL) { + *address = addr; + } + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Gets handle of the respective hc (this device, hc function). + * + * @param[in] root_hub_fun Root hub function seeking hc handle. + * @param[out] handle Place to write the handle. + * @return Error code. + */ +static int usb_iface_get_hc_handle( + ddf_fun_t *fun, devman_handle_t *handle) +{ + assert(handle); + ddf_fun_t *hc_fun = ((ohci_t*)fun->dev->driver_data)->hc_fun; + assert(hc_fun != NULL); + + *handle = hc_fun->handle; + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** This iface is generic for both RH and HC. */ +static usb_iface_t usb_iface = { + .get_hc_handle = usb_iface_get_hc_handle, + .get_address = usb_iface_get_address +}; +/*----------------------------------------------------------------------------*/ +static ddf_dev_ops_t hc_ops = { + .interfaces[USBHC_DEV_IFACE] = &hc_iface, /* see iface.h/c */ +}; +/*----------------------------------------------------------------------------*/ +static ddf_dev_ops_t rh_ops = { + .interfaces[USB_DEV_IFACE] = &usb_iface, +}; +/*----------------------------------------------------------------------------*/ +/** Initialize hc and rh ddf structures and their respective drivers. + * + * @param[in] instance OHCI structure to use. + * @param[in] device DDF instance of the device to use. + * + * This function does all the preparatory work for hc and rh drivers: + * - gets device hw resources + * - disables OHCI legacy support + * - asks for interrupt + * - registers interrupt handler + */ +int ohci_init(ohci_t *instance, ddf_dev_t *device) +{ + assert(instance); + instance->hc_fun = NULL; + instance->rh_fun = NULL; +#define CHECK_RET_DEST_FUN_RETURN(ret, message...) \ +if (ret != EOK) { \ + usb_log_error(message); \ + if (instance->hc_fun) \ + ddf_fun_destroy(instance->hc_fun); \ + if (instance->rh_fun) \ + ddf_fun_destroy(instance->rh_fun); \ + return ret; \ +} + + uintptr_t mem_reg_base = 0; + size_t mem_reg_size = 0; + int irq = 0; + + int ret = + pci_get_my_registers(device, &mem_reg_base, &mem_reg_size, &irq); + CHECK_RET_DEST_FUN_RETURN(ret, + "Failed(%d) to get memory addresses:.\n", ret, device->handle); + usb_log_debug("Memory mapped regs at 0x%X (size %zu), IRQ %d.\n", + mem_reg_base, mem_reg_size, irq); + + ret = pci_disable_legacy(device); + CHECK_RET_DEST_FUN_RETURN(ret, + "Failed(%d) to disable legacy USB: %s.\n", ret, str_error(ret)); + + bool interrupts = false; +#ifdef CONFIG_USBHC_NO_INTERRUPTS + usb_log_warning("Interrupts disabled in OS config, " \ + "falling back to polling.\n"); +#else + ret = pci_enable_interrupts(device); + if (ret != EOK) { + usb_log_warning("Failed to enable interrupts: %s.\n", + str_error(ret)); + usb_log_info("HW interrupts not available, " \ + "falling back to polling.\n"); + } else { + usb_log_debug("Hw interrupts enabled.\n"); + interrupts = true; + } +#endif + + instance->hc_fun = ddf_fun_create(device, fun_exposed, "ohci-hc"); + ret = (instance->hc_fun == NULL) ? ENOMEM : EOK; + CHECK_RET_DEST_FUN_RETURN(ret, + "Failed(%d) to create HC function.\n", ret); + + ret = hc_init(&instance->hc, instance->hc_fun, device, + mem_reg_base, mem_reg_size, interrupts); + CHECK_RET_DEST_FUN_RETURN(ret, "Failed(%d) to init ohci-hcd.\n", ret); + instance->hc_fun->ops = &hc_ops; + instance->hc_fun->driver_data = &instance->hc; + ret = ddf_fun_bind(instance->hc_fun); + CHECK_RET_DEST_FUN_RETURN(ret, + "Failed(%d) to bind OHCI device function: %s.\n", + ret, str_error(ret)); +#undef CHECK_RET_HC_RETURN + +#define CHECK_RET_FINI_RETURN(ret, message...) \ +if (ret != EOK) { \ + usb_log_error(message); \ + if (instance->hc_fun) \ + ddf_fun_destroy(instance->hc_fun); \ + if (instance->rh_fun) \ + ddf_fun_destroy(instance->rh_fun); \ + hc_fini(&instance->hc); \ + return ret; \ +} + + /* It does no harm if we register this on polling */ + ret = register_interrupt_handler(device, irq, irq_handler, NULL); + CHECK_RET_FINI_RETURN(ret, + "Failed(%d) to register interrupt handler.\n", ret); + + instance->rh_fun = ddf_fun_create(device, fun_inner, "ohci-rh"); + ret = (instance->rh_fun == NULL) ? ENOMEM : EOK; + CHECK_RET_FINI_RETURN(ret, + "Failed(%d) to create root hub function.\n", ret); + + hc_register_hub(&instance->hc, instance->rh_fun); + + instance->rh_fun->ops = &rh_ops; + instance->rh_fun->driver_data = NULL; + ret = ddf_fun_bind(instance->rh_fun); + CHECK_RET_FINI_RETURN(ret, + "Failed(%d) to register OHCI root hub.\n", ret); + + return EOK; +#undef CHECK_RET_FINI_RETURN +} +/** + * @} + */ Index: uspace/drv/ohci/ohci.h =================================================================== --- uspace/drv/ohci/ohci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/ohci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,56 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * @brief OHCI driver main structure for both host controller and root-hub. + */ +#ifndef DRV_OHCI_OHCI_H +#define DRV_OHCI_OHCI_H +#include +#include + +#include "hc.h" +#include "root_hub.h" + +typedef struct ohci { + ddf_fun_t *hc_fun; + ddf_fun_t *rh_fun; + + hc_t hc; + rh_t rh; +} ohci_t; + +int ohci_init(ohci_t *instance, ddf_dev_t *device); + +#endif +/** + * @} + */ Index: uspace/drv/ohci/ohci.ma =================================================================== --- uspace/drv/ohci/ohci.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/ohci.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,1 @@ +10 pci/ven=106b&dev=003f Index: uspace/drv/ohci/ohci_regs.h =================================================================== --- uspace/drv/ohci/ohci_regs.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/ohci_regs.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,85 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbohcihc + * @{ + */ +/** @file + * @brief OHCI host controller register structure + */ +#ifndef DRV_OHCI_OHCI_REGS_H +#define DRV_OHCI_OHCI_REGS_H +#include + +typedef struct ohci_regs +{ + volatile uint32_t revision; + volatile uint32_t control; + volatile uint32_t command_status; + volatile uint32_t interrupt_status; +#define IS_SO (1 << 0) +#define IS_WDH (1 << 1) +#define IS_SF (1 << 2) +#define IS_RD (1 << 3) +#define IS_UE (1 << 4) +#define IS_FNO (1 << 5) +#define IS_RHSC (1 << 6) +#define IS_OC (1 << 30) + volatile uint32_t interupt_enable; +#define IE_SO (1 << 0) +#define IE_WDH (1 << 1) +#define IE_SF (1 << 2) +#define IE_RD (1 << 3) +#define IE_UE (1 << 4) +#define IE_FNO (1 << 5) +#define IE_RHSC (1 << 6) +#define IE_OC (1 << 30) +#define IE_MIE (1 << 31) + + volatile uint32_t interrupt_disable; + volatile uint32_t hcca; + volatile uint32_t period_corrent; + volatile uint32_t control_head; + volatile uint32_t control_current; + volatile uint32_t bulk_head; + volatile uint32_t bulk_current; + volatile uint32_t done_head; + volatile uint32_t fm_interval; + volatile uint32_t fm_remaining; + volatile uint32_t fm_number; + volatile uint32_t periodic_start; + volatile uint32_t ls_threshold; + volatile uint32_t rh_desc_a; + volatile uint32_t rh_desc_b; + volatile uint32_t rh_status; + volatile uint32_t rh_port_status[]; +} __attribute__((packed)) ohci_regs_t; +#endif +/** + * @} + */ Index: uspace/drv/ohci/pci.c =================================================================== --- uspace/drv/ohci/pci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/pci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,176 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** + * @addtogroup drvusbohci + * @{ + */ +/** + * @file + * PCI related functions needed by the OHCI driver. + */ +#include +#include +#include +#include +#include +#include +#include + +#include +#include + +#include "pci.h" + +#define PAGE_SIZE_MASK 0xfffff000 + +#define HCC_PARAMS_OFFSET 0x8 +#define HCC_PARAMS_EECP_MASK 0xff +#define HCC_PARAMS_EECP_OFFSET 8 + +#define CMD_OFFSET 0x0 +#define CONFIGFLAG_OFFSET 0x40 + +#define USBCMD_RUN 1 + +#define USBLEGSUP_OFFSET 0 +#define USBLEGSUP_BIOS_CONTROL (1 << 16) +#define USBLEGSUP_OS_CONTROL (1 << 24) +#define USBLEGCTLSTS_OFFSET 4 + +#define DEFAULT_WAIT 10000 +#define WAIT_STEP 10 + +/** Get address of registers and IRQ for given device. + * + * @param[in] dev Device asking for the addresses. + * @param[out] mem_reg_address Base address of the memory range. + * @param[out] mem_reg_size Size of the memory range. + * @param[out] irq_no IRQ assigned to the device. + * @return Error code. + */ +int pci_get_my_registers(ddf_dev_t *dev, + uintptr_t *mem_reg_address, size_t *mem_reg_size, int *irq_no) +{ + assert(dev != NULL); + + int parent_phone = devman_parent_device_connect(dev->handle, + IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + + int rc; + + hw_resource_list_t hw_resources; + rc = hw_res_get_resource_list(parent_phone, &hw_resources); + if (rc != EOK) { + async_hangup(parent_phone); + return rc; + } + + uintptr_t mem_address = 0; + size_t mem_size = 0; + bool mem_found = false; + + int irq = 0; + bool irq_found = false; + + size_t i; + for (i = 0; i < hw_resources.count; i++) { + hw_resource_t *res = &hw_resources.resources[i]; + switch (res->type) + { + case INTERRUPT: + irq = res->res.interrupt.irq; + irq_found = true; + usb_log_debug2("Found interrupt: %d.\n", irq); + break; + + case MEM_RANGE: + if (res->res.mem_range.address != 0 + && res->res.mem_range.size != 0 ) { + mem_address = res->res.mem_range.address; + mem_size = res->res.mem_range.size; + usb_log_debug2("Found mem: %llx %zu.\n", + mem_address, mem_size); + mem_found = true; + } + default: + break; + } + } + + if (mem_found && irq_found) { + *mem_reg_address = mem_address; + *mem_reg_size = mem_size; + *irq_no = irq; + rc = EOK; + } else { + rc = ENOENT; + } + + async_hangup(parent_phone); + return rc; +} +/*----------------------------------------------------------------------------*/ +/** Calls the PCI driver with a request to enable interrupts + * + * @param[in] device Device asking for interrupts + * @return Error code. + */ +int pci_enable_interrupts(ddf_dev_t *device) +{ + return ENOTSUP; + int parent_phone = + devman_parent_device_connect(device->handle, IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + bool enabled = hw_res_enable_interrupt(parent_phone); + async_hangup(parent_phone); + return enabled ? EOK : EIO; +} +/*----------------------------------------------------------------------------*/ +/** Implements BIOS handoff routine as decribed in OHCI spec + * + * @param[in] device Device asking for interrupts + * @return Error code. + */ +int pci_disable_legacy(ddf_dev_t *device) +{ + /* TODO: implement */ + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** + * @} + */ + +/** + * @} + */ Index: uspace/drv/ohci/pci.h =================================================================== --- uspace/drv/ohci/pci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/pci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,48 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * PCI related functions needed by OHCI driver. + */ +#ifndef DRV_OHCI_PCI_H +#define DRV_OHCI_PCI_H + +#include + +int pci_get_my_registers(ddf_dev_t *, uintptr_t *, size_t *, int *); +int pci_enable_interrupts(ddf_dev_t *); +int pci_disable_legacy(ddf_dev_t *); + +#endif +/** + * @} + */ + Index: uspace/drv/ohci/root_hub.c =================================================================== --- uspace/drv/ohci/root_hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/root_hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,675 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * @brief OHCI driver + */ +#include +#include +#include + +#include + +#include "root_hub.h" +#include "usb/classes/classes.h" +#include "usb/devdrv.h" +#include +#include + +/** + * standart device descriptor for ohci root hub + */ +static const usb_standard_device_descriptor_t ohci_rh_device_descriptor = +{ + .configuration_count = 1, + .descriptor_type = USB_DESCTYPE_DEVICE, + .device_class = USB_CLASS_HUB, + .device_protocol = 0, + .device_subclass = 0, + .device_version = 0, + .length = sizeof(usb_standard_device_descriptor_t), + /// \TODO this value is guessed + .max_packet_size = 8, + .vendor_id = 0x16db, + .product_id = 0x0001, + /// \TODO these values migt be different + .str_serial_number = 0, + .usb_spec_version = 0x110, +}; + +/** + * standart configuration descriptor with filled common values + * for ohci root hubs + */ +static const usb_standard_configuration_descriptor_t ohci_rh_conf_descriptor = +{ + /// \TODO some values are default or guessed + .attributes = 1<<7, + .configuration_number = 1, + .descriptor_type = USB_DESCTYPE_CONFIGURATION, + .interface_count = 1, + .length = sizeof(usb_standard_configuration_descriptor_t), + .max_power = 100, + .str_configuration = 0, +}; + +/** + * standart ohci root hub interface descriptor + */ +static const usb_standard_interface_descriptor_t ohci_rh_iface_descriptor = +{ + .alternate_setting = 0, + .descriptor_type = USB_DESCTYPE_INTERFACE, + .endpoint_count = 1, + .interface_class = USB_CLASS_HUB, + /// \TODO is this correct? + .interface_number = 1, + .interface_protocol = 0, + .interface_subclass = 0, + .length = sizeof(usb_standard_interface_descriptor_t), + .str_interface = 0, +}; + +/** + * standart ohci root hub endpoint descriptor + */ +static const usb_standard_endpoint_descriptor_t ohci_rh_ep_descriptor = +{ + .attributes = USB_TRANSFER_INTERRUPT, + .descriptor_type = USB_DESCTYPE_ENDPOINT, + .endpoint_address = 1 + (1<<7), + .length = sizeof(usb_standard_endpoint_descriptor_t), + .max_packet_size = 8, + .poll_interval = 255, +}; + +/** + * Create hub descriptor used in hub-driver <-> hub communication + * + * This means creating byt array from data in root hub registers. For more + * info see usb hub specification. + * + * @param instance root hub instance + * @param@out out_result pointer to resultant serialized descriptor + * @param@out out_size size of serialized descriptor + */ +static void usb_create_serialized_hub_descriptor(rh_t *instance, + uint8_t ** out_result, + size_t * out_size) { + //base size + size_t size = 7; + //variable size according to port count + size_t var_size = instance->port_count / 8 + + ((instance->port_count % 8 > 0) ? 1 : 0); + size += 2 * var_size; + uint8_t * result = (uint8_t*) malloc(size); + bzero(result,size); + //size + result[0] = size; + //descriptor type + result[1] = USB_DESCTYPE_HUB; + result[2] = instance->port_count; + uint32_t hub_desc_reg = instance->registers->rh_desc_a; + result[3] = + ((hub_desc_reg >> 8) %2) + + (((hub_desc_reg >> 9) %2) << 1) + + (((hub_desc_reg >> 10) %2) << 2) + + (((hub_desc_reg >> 11) %2) << 3) + + (((hub_desc_reg >> 12) %2) << 4); + result[4] = 0; + result[5] = /*descriptor->pwr_on_2_good_time*/ 50; + result[6] = 50; + + int port; + for (port = 1; port <= instance->port_count; ++port) { + result[7 + port/8] += + ((instance->registers->rh_desc_b >> port)%2) << (port%8); + } + size_t i; + for (i = 0; i < var_size; ++i) { + result[7 + var_size + i] = 255; + } + (*out_result) = result; + (*out_size) = size; +} + + +/** initialize hub descriptors + * + * Initialized are device and full configuration descriptor. These need to + * be initialized only once per hub. + * @instance root hub instance + */ +static void rh_init_descriptors(rh_t *instance){ + memcpy(&instance->descriptors.device, &ohci_rh_device_descriptor, + sizeof(ohci_rh_device_descriptor) + ); + usb_standard_configuration_descriptor_t descriptor; + memcpy(&descriptor,&ohci_rh_conf_descriptor, + sizeof(ohci_rh_conf_descriptor)); + uint8_t * hub_descriptor; + size_t hub_desc_size; + usb_create_serialized_hub_descriptor(instance, &hub_descriptor, + &hub_desc_size); + + descriptor.total_length = + sizeof(usb_standard_configuration_descriptor_t)+ + sizeof(usb_standard_endpoint_descriptor_t)+ + sizeof(usb_standard_interface_descriptor_t)+ + hub_desc_size; + + uint8_t * full_config_descriptor = + (uint8_t*) malloc(descriptor.total_length); + memcpy(full_config_descriptor, &descriptor, sizeof(descriptor)); + memcpy(full_config_descriptor + sizeof(descriptor), + &ohci_rh_iface_descriptor, sizeof(ohci_rh_iface_descriptor)); + memcpy(full_config_descriptor + sizeof(descriptor) + + sizeof(ohci_rh_iface_descriptor), + &ohci_rh_ep_descriptor, sizeof(ohci_rh_ep_descriptor)); + memcpy(full_config_descriptor + sizeof(descriptor) + + sizeof(ohci_rh_iface_descriptor) + + sizeof(ohci_rh_ep_descriptor), + hub_descriptor, hub_desc_size); + + instance->descriptors.configuration = full_config_descriptor; + instance->descriptors.configuration_size = descriptor.total_length; +} + +/** Root hub initialization + * @return Error code. + */ +int rh_init(rh_t *instance, ddf_dev_t *dev, ohci_regs_t *regs) +{ + assert(instance); + instance->address = -1; + instance->registers = regs; + instance->device = dev; + rh_init_descriptors(instance); + + + usb_log_info("OHCI root hub with %d ports.\n", regs->rh_desc_a & 0xff); + + //start generic usb hub driver + + /* TODO: implement */ + return EOK; +} +/*----------------------------------------------------------------------------*/ + +/** + * create answer to port status_request + * + * Copy content of corresponding port status register to answer buffer. + * + * @param instance root hub instance + * @param port port number, counted from 1 + * @param request structure containing both request and response information + * @return error code + */ +static int process_get_port_status_request(rh_t *instance, uint16_t port, + usb_transfer_batch_t * request){ + if(port<1 || port>instance->port_count) + return EINVAL; + uint32_t * uint32_buffer = (uint32_t*)request->buffer; + request->transfered_size = 4; + uint32_buffer[0] = instance->registers->rh_port_status[port -1]; + return EOK; +} + +/** + * create answer to port status_request + * + * Copy content of hub status register to answer buffer. + * + * @param instance root hub instance + * @param request structure containing both request and response information + * @return error code + */ +static int process_get_hub_status_request(rh_t *instance, + usb_transfer_batch_t * request){ + uint32_t * uint32_buffer = (uint32_t*)request->buffer; + //bits, 0,1,16,17 + request->transfered_size = 4; + uint32_t mask = 1 & (1<<1) & (1<<16) & (1<<17); + uint32_buffer[0] = mask & instance->registers->rh_status; + return EOK; + +} + + + +/** + * create answer to status request + * + * This might be either hub status or port status request. If neither, + * ENOTSUP is returned. + * @param instance root hub instance + * @param request structure containing both request and response information + * @return error code + */ +static int process_get_status_request(rh_t *instance, + usb_transfer_batch_t * request) +{ + size_t buffer_size = request->buffer_size; + usb_device_request_setup_packet_t * request_packet = + (usb_device_request_setup_packet_t*) + request->setup_buffer; + + usb_hub_bm_request_type_t request_type = request_packet->request_type; + if(buffer_size<4/*request_packet->length*/){///\TODO + usb_log_warning("requested more data than buffer size\n"); + return EINVAL; + } + + if(request_type == USB_HUB_REQ_TYPE_GET_HUB_STATUS) + return process_get_hub_status_request(instance, request); + if(request_type == USB_HUB_REQ_TYPE_GET_PORT_STATUS) + return process_get_port_status_request(instance, request_packet->index, + request); + return ENOTSUP; +} + +/** + * create answer to status interrupt consisting of change bitmap + * + * Result contains bitmap where bit 0 indicates change on hub and + * bit i indicates change on i`th port (i>0). For more info see + * Hub and Port status bitmap specification in USB specification. + * @param instance root hub instance + * @param@out buffer pointer to created interrupt mas + * @param@out buffer_size size of created interrupt mask + */ +static void create_interrupt_mask(rh_t *instance, void ** buffer, + size_t * buffer_size){ + int bit_count = instance->port_count + 1; + (*buffer_size) = (bit_count / 8) + (bit_count%8==0)?0:1; + (*buffer) = malloc(*buffer_size); + uint8_t * bitmap = (uint8_t*)(*buffer); + uint32_t mask = (1<<16) + (1<<17); + bzero(bitmap,(*buffer_size)); + if(instance->registers->rh_status & mask){ + bitmap[0] = 1; + } + int port; + mask = 0; + int i; + for(i=16;i<=20;++i) + mask += 1<port_count;++port){ + if(mask & instance->registers->rh_port_status[port-1]){ + bitmap[(port+1)/8] += 1<<(port%8); + } + } +} + +/** + * create answer to a descriptor request + * + * This might be a request for standard (configuration, device, endpoint or + * interface) or device specific (hub) descriptor. + * @param instance root hub instance + * @param request structure containing both request and response information + * @return error code + */ +static int process_get_descriptor_request(rh_t *instance, + usb_transfer_batch_t *request){ + usb_device_request_setup_packet_t * setup_request = + (usb_device_request_setup_packet_t*)request->setup_buffer; + size_t size; + const void * result_descriptor = NULL; + const uint16_t setup_request_value = setup_request->value_high; + //(setup_request->value_low << 8); + bool del = false; + switch (setup_request_value) + { + case USB_DESCTYPE_HUB: { + uint8_t * descriptor; + usb_create_serialized_hub_descriptor( + instance, &descriptor, &size); + result_descriptor = descriptor; + if(result_descriptor) del = true; + break; + } + case USB_DESCTYPE_DEVICE: { + usb_log_debug("USB_DESCTYPE_DEVICE\n"); + result_descriptor = &ohci_rh_device_descriptor; + size = sizeof(ohci_rh_device_descriptor); + break; + } + case USB_DESCTYPE_CONFIGURATION: { + usb_log_debug("USB_DESCTYPE_CONFIGURATION\n"); + result_descriptor = instance->descriptors.configuration; + size = instance->descriptors.configuration_size; + break; + } + case USB_DESCTYPE_INTERFACE: { + usb_log_debug("USB_DESCTYPE_INTERFACE\n"); + result_descriptor = &ohci_rh_iface_descriptor; + size = sizeof(ohci_rh_iface_descriptor); + break; + } + case USB_DESCTYPE_ENDPOINT: { + usb_log_debug("USB_DESCTYPE_ENDPOINT\n"); + result_descriptor = &ohci_rh_ep_descriptor; + size = sizeof(ohci_rh_ep_descriptor); + break; + } + default: { + usb_log_debug("USB_DESCTYPE_EINVAL %d \n",setup_request->value); + usb_log_debug("\ttype %d\n\trequest %d\n\tvalue %d\n\tindex %d\n\tlen %d\n ", + setup_request->request_type, + setup_request->request, + setup_request_value, + setup_request->index, + setup_request->length + ); + return EINVAL; + } + } + if(request->buffer_size < size){ + size = request->buffer_size; + } + request->transfered_size = size; + memcpy(request->transport_buffer,result_descriptor,size); + usb_log_debug("sent desctiptor: %s\n", + usb_debug_str_buffer((uint8_t*)request->transport_buffer,size,size)); + if (del) + free(result_descriptor); + return EOK; +} + +/** + * answer to get configuration request + * + * Root hub works independently on the configuration. + * @param instance root hub instance + * @param request structure containing both request and response information + * @return error code + */ +static int process_get_configuration_request(rh_t *instance, + usb_transfer_batch_t *request){ + //set and get configuration requests do not have any meaning, only dummy + //values are returned + if(request->buffer_size != 1) + return EINVAL; + request->buffer[0] = 1; + request->transfered_size = 1; + return EOK; +} + +/** + * process feature-enabling/disabling request on hub + * + * @param instance root hub instance + * @param feature feature selector + * @param enable enable or disable specified feature + * @return error code + */ +static int process_hub_feature_set_request(rh_t *instance, + uint16_t feature, bool enable){ + if(feature > USB_HUB_FEATURE_C_HUB_OVER_CURRENT) + return EINVAL; + instance->registers->rh_status = + enable ? + (instance->registers->rh_status | (1<registers->rh_status & (~(1< USB_HUB_FEATURE_C_PORT_RESET) + return EINVAL; + if(port<1 || port>instance->port_count) + return EINVAL; + instance->registers->rh_port_status[port - 1] = + enable ? + (instance->registers->rh_port_status[port - 1] | (1<registers->rh_port_status[port - 1] & (~(1<address = address; + return EOK; +} + +/** + * process one of requests that requere output data + * + * Request can be one of USB_DEVREQ_GET_STATUS, USB_DEVREQ_GET_DESCRIPTOR or + * USB_DEVREQ_GET_CONFIGURATION. + * @param instance root hub instance + * @param request structure containing both request and response information + * @return error code + */ +static int process_request_with_output(rh_t *instance, + usb_transfer_batch_t *request){ + usb_device_request_setup_packet_t * setup_request = + (usb_device_request_setup_packet_t*)request->setup_buffer; + if(setup_request->request == USB_DEVREQ_GET_STATUS){ + usb_log_debug("USB_DEVREQ_GET_STATUS\n"); + return process_get_status_request(instance, request); + } + if(setup_request->request == USB_DEVREQ_GET_DESCRIPTOR){ + usb_log_debug("USB_DEVREQ_GET_DESCRIPTOR\n"); + return process_get_descriptor_request(instance, request); + } + if(setup_request->request == USB_DEVREQ_GET_CONFIGURATION){ + usb_log_debug("USB_DEVREQ_GET_CONFIGURATION\n"); + return process_get_configuration_request(instance, request); + } + return ENOTSUP; +} + +/** + * process one of requests that carry input data + * + * Request can be one of USB_DEVREQ_SET_DESCRIPTOR or + * USB_DEVREQ_SET_CONFIGURATION. + * @param instance root hub instance + * @param request structure containing both request and response information + * @return error code + */ +static int process_request_with_input(rh_t *instance, + usb_transfer_batch_t *request){ + usb_device_request_setup_packet_t * setup_request = + (usb_device_request_setup_packet_t*)request->setup_buffer; + request->transfered_size = 0; + if(setup_request->request == USB_DEVREQ_SET_DESCRIPTOR){ + return ENOTSUP; + } + if(setup_request->request == USB_DEVREQ_SET_CONFIGURATION){ + //set and get configuration requests do not have any meaning, + //only dummy values are returned + return EOK; + } + return ENOTSUP; +} + +/** + * process one of requests that do not request nor carry additional data + * + * Request can be one of USB_DEVREQ_CLEAR_FEATURE, USB_DEVREQ_SET_FEATURE or + * USB_DEVREQ_SET_ADDRESS. + * @param instance root hub instance + * @param request structure containing both request and response information + * @return error code + */ +static int process_request_without_data(rh_t *instance, + usb_transfer_batch_t *request){ + usb_device_request_setup_packet_t * setup_request = + (usb_device_request_setup_packet_t*)request->setup_buffer; + request->transfered_size = 0; + if(setup_request->request == USB_DEVREQ_CLEAR_FEATURE + || setup_request->request == USB_DEVREQ_SET_FEATURE){ + if(setup_request->request_type == USB_HUB_REQ_TYPE_SET_HUB_FEATURE){ + usb_log_debug("USB_HUB_REQ_TYPE_SET_HUB_FEATURE\n"); + return process_hub_feature_set_request(instance, setup_request->value, + setup_request->request == USB_DEVREQ_SET_FEATURE); + } + if(setup_request->request_type == USB_HUB_REQ_TYPE_SET_PORT_FEATURE){ + usb_log_debug("USB_HUB_REQ_TYPE_SET_PORT_FEATURE\n"); + return process_port_feature_set_request(instance, setup_request->value, + setup_request->index, + setup_request->request == USB_DEVREQ_SET_FEATURE); + } + usb_log_debug("USB_HUB_REQ_TYPE_INVALID %d\n",setup_request->request_type); + return EINVAL; + } + if(setup_request->request == USB_DEVREQ_SET_ADDRESS){ + usb_log_debug("USB_DEVREQ_SET_ADDRESS\n"); + return process_address_set_request(instance, setup_request->value); + } + usb_log_debug("USB_DEVREQ_SET_ENOTSUP %d\n",setup_request->request_type); + return ENOTSUP; +} + +/** + * process hub control request + * + * If needed, writes answer into the request structure. + * Request can be one of + * USB_DEVREQ_GET_STATUS, + * USB_DEVREQ_GET_DESCRIPTOR, + * USB_DEVREQ_GET_CONFIGURATION, + * USB_DEVREQ_CLEAR_FEATURE, + * USB_DEVREQ_SET_FEATURE, + * USB_DEVREQ_SET_ADDRESS, + * USB_DEVREQ_SET_DESCRIPTOR or + * USB_DEVREQ_SET_CONFIGURATION. + * + * @param instance root hub instance + * @param request structure containing both request and response information + * @return error code + */ +static int process_ctrl_request(rh_t *instance, usb_transfer_batch_t *request){ + int opResult; + if (request->setup_buffer) { + if(sizeof(usb_device_request_setup_packet_t)>request->setup_size){ + usb_log_error("setup packet too small\n"); + return EINVAL; + } + usb_log_info("CTRL packet: %s.\n", + usb_debug_str_buffer((const uint8_t *)request->setup_buffer, 8, 8)); + usb_device_request_setup_packet_t * setup_request = + (usb_device_request_setup_packet_t*)request->setup_buffer; + if( + setup_request->request == USB_DEVREQ_GET_STATUS + || setup_request->request == USB_DEVREQ_GET_DESCRIPTOR + || setup_request->request == USB_DEVREQ_GET_CONFIGURATION + ){ + usb_log_debug("processing request with output\n"); + opResult = process_request_with_output(instance,request); + }else if( + setup_request->request == USB_DEVREQ_CLEAR_FEATURE + || setup_request->request == USB_DEVREQ_SET_FEATURE + || setup_request->request == USB_DEVREQ_SET_ADDRESS + ){ + usb_log_debug("processing request without additional data\n"); + opResult = process_request_without_data(instance,request); + }else if(setup_request->request == USB_DEVREQ_SET_DESCRIPTOR + || setup_request->request == USB_DEVREQ_SET_CONFIGURATION + ){ + usb_log_debug("processing request with input\n"); + opResult = process_request_with_input(instance,request); + }else{ + usb_log_warning("received unsuported request: %d\n", + setup_request->request + ); + opResult = ENOTSUP; + } + }else{ + usb_log_error("root hub received empty transaction?"); + opResult = EINVAL; + } + return opResult; +} + +/** + * process root hub request + * + * @param instance root hub instance + * @param request structure containing both request and response information + * @return error code + */ +int rh_request(rh_t *instance, usb_transfer_batch_t *request) +{ + assert(instance); + assert(request); + int opResult; + if(request->transfer_type == USB_TRANSFER_CONTROL){ + usb_log_info("Root hub got CONTROL packet\n"); + opResult = process_ctrl_request(instance,request); + }else if(request->transfer_type == USB_TRANSFER_INTERRUPT){ + usb_log_info("Root hub got INTERRUPT packet\n"); + void * buffer; + create_interrupt_mask(instance, &buffer, + &(request->transfered_size)); + memcpy(request->transport_buffer,buffer, request->transfered_size); + opResult = EOK; + }else{ + opResult = EINVAL; + } + usb_transfer_batch_finish(request, opResult); + return EOK; +} +/*----------------------------------------------------------------------------*/ + + +void rh_interrupt(rh_t *instance) +{ + usb_log_info("Whoa whoa wait, I`m not supposed to receive any interrupts, am I?\n"); + /* TODO: implement? */ +} +/** + * @} + */ Index: uspace/drv/ohci/root_hub.h =================================================================== --- uspace/drv/ohci/root_hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/root_hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,68 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbohci + * @{ + */ +/** @file + * @brief OHCI driver + */ +#ifndef DRV_OHCI_ROOT_HUB_H +#define DRV_OHCI_ROOT_HUB_H + +#include +#include + +#include "ohci_regs.h" +#include "batch.h" + +/** + * ohci root hub representation + */ +typedef struct rh { + /** pointer to ohci driver registers */ + ohci_regs_t *registers; + /** usb address of the root hub */ + usb_address_t address; + /** ddf device information */ + ddf_dev_t *device; + /** hub port count */ + int port_count; + /** hubs descriptors */ + usb_device_descriptors_t descriptors; +} rh_t; + +int rh_init(rh_t *instance, ddf_dev_t *dev, ohci_regs_t *regs); + +int rh_request(rh_t *instance, usb_transfer_batch_t *request); + +void rh_interrupt(rh_t *instance); +#endif +/** + * @} + */ Index: uspace/drv/ohci/utils/malloc32.h =================================================================== --- uspace/drv/ohci/utils/malloc32.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/ohci/utils/malloc32.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,96 @@ +/* + * Copyright (c) 2010 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup usb + * @{ + */ +/** @file + * @brief UHCI driver + */ +#ifndef DRV_UHCI_TRANSLATOR_H +#define DRV_UHCI_TRANSLATOR_H + +#include +#include +#include +#include + +#define UHCI_STRCUTURES_ALIGNMENT 16 +#define UHCI_REQUIRED_PAGE_SIZE 4096 + +/** Get physical address translation + * + * @param[in] addr Virtual address to translate + * @return Physical address if exists, NULL otherwise. + */ +static inline uintptr_t addr_to_phys(void *addr) +{ + uintptr_t result; + int ret = as_get_physical_mapping(addr, &result); + + if (ret != EOK) + return 0; + return (result | ((uintptr_t)addr & 0xfff)); +} +/*----------------------------------------------------------------------------*/ +/** Physical mallocator simulator + * + * @param[in] size Size of the required memory space + * @return Address of the alligned and big enough memory place, NULL on failure. + */ +static inline void * malloc32(size_t size) + { return memalign(UHCI_STRCUTURES_ALIGNMENT, size); } +/*----------------------------------------------------------------------------*/ +/** Physical mallocator simulator + * + * @param[in] addr Address of the place allocated by malloc32 + */ +static inline void free32(void *addr) + { if (addr) free(addr); } +/*----------------------------------------------------------------------------*/ +/** Create 4KB page mapping + * + * @return Address of the mapped page, NULL on failure. + */ +static inline void * get_page(void) +{ + void * free_address = as_get_mappable_page(UHCI_REQUIRED_PAGE_SIZE); + assert(free_address); + if (free_address == 0) + return NULL; + void* ret = + as_area_create(free_address, UHCI_REQUIRED_PAGE_SIZE, + AS_AREA_READ | AS_AREA_WRITE); + if (ret != free_address) + return NULL; + return ret; +} + +#endif +/** + * @} + */ Index: uspace/drv/pciintel/pci.c =================================================================== --- uspace/drv/pciintel/pci.c (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/drv/pciintel/pci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -52,8 +52,13 @@ #include #include +#include +#include +#include +#include #include #include #include #include +#include #include "pci.h" @@ -84,7 +89,90 @@ static bool pciintel_enable_interrupt(ddf_fun_t *fnode) { - /* TODO */ - - return false; + /* This is an old ugly way, copied from ne2000 driver */ + assert(fnode); + pci_fun_t *dev_data = (pci_fun_t *) fnode->driver_data; + + sysarg_t apic; + sysarg_t i8259; + + int irc_phone = ENOTSUP; + + if (((sysinfo_get_value("apic", &apic) == EOK) && (apic)) + || ((sysinfo_get_value("i8259", &i8259) == EOK) && (i8259))) { + irc_phone = service_connect_blocking(SERVICE_IRC, 0, 0); + } + + if (irc_phone < 0) { + return false; + } + + size_t i; + for (i = 0; i < dev_data->hw_resources.count; i++) { + if (dev_data->hw_resources.resources[i].type == INTERRUPT) { + int irq = dev_data->hw_resources.resources[i].res.interrupt.irq; + int rc = async_req_1_0(irc_phone, IRC_ENABLE_INTERRUPT, irq); + if (rc != EOK) { + async_hangup(irc_phone); + return false; + } + } + } + + async_hangup(irc_phone); + return true; +} + +static int pci_config_space_write_32( + ddf_fun_t *fun, uint32_t address, uint32_t data) +{ + if (address > 252) + return EINVAL; + pci_conf_write_32(PCI_FUN(fun), address, data); + return EOK; +} + +static int pci_config_space_write_16( + ddf_fun_t *fun, uint32_t address, uint16_t data) +{ + if (address > 254) + return EINVAL; + pci_conf_write_16(PCI_FUN(fun), address, data); + return EOK; +} + +static int pci_config_space_write_8( + ddf_fun_t *fun, uint32_t address, uint8_t data) +{ + if (address > 255) + return EINVAL; + pci_conf_write_8(PCI_FUN(fun), address, data); + return EOK; +} + +static int pci_config_space_read_32( + ddf_fun_t *fun, uint32_t address, uint32_t *data) +{ + if (address > 252) + return EINVAL; + *data = pci_conf_read_32(PCI_FUN(fun), address); + return EOK; +} + +static int pci_config_space_read_16( + ddf_fun_t *fun, uint32_t address, uint16_t *data) +{ + if (address > 254) + return EINVAL; + *data = pci_conf_read_16(PCI_FUN(fun), address); + return EOK; +} + +static int pci_config_space_read_8( + ddf_fun_t *fun, uint32_t address, uint8_t *data) +{ + if (address > 255) + return EINVAL; + *data = pci_conf_read_8(PCI_FUN(fun), address); + return EOK; } @@ -94,5 +182,17 @@ }; -static ddf_dev_ops_t pci_fun_ops; +static pci_dev_iface_t pci_dev_ops = { + .config_space_read_8 = &pci_config_space_read_8, + .config_space_read_16 = &pci_config_space_read_16, + .config_space_read_32 = &pci_config_space_read_32, + .config_space_write_8 = &pci_config_space_write_8, + .config_space_write_16 = &pci_config_space_write_16, + .config_space_write_32 = &pci_config_space_write_32 +}; + +static ddf_dev_ops_t pci_fun_ops = { + .interfaces[HW_RES_DEV_IFACE] = &pciintel_hw_res_ops, + .interfaces[PCI_DEV_IFACE] = &pci_dev_ops +}; static int pci_add_device(ddf_dev_t *); @@ -288,9 +388,14 @@ /* Get the value of the BAR. */ val = pci_conf_read_32(fun, addr); + +#define IO_MASK (~0x3) +#define MEM_MASK (~0xf) io = (bool) (val & 1); if (io) { addrw64 = false; + mask = IO_MASK; } else { + mask = MEM_MASK; switch ((val >> 1) & 3) { case 0: @@ -308,5 +413,5 @@ /* Get the address mask. */ pci_conf_write_32(fun, addr, 0xffffffff); - mask = pci_conf_read_32(fun, addr); + mask &= pci_conf_read_32(fun, addr); /* Restore the original value. */ @@ -558,4 +663,5 @@ ddf_log_init(NAME, LVL_ERROR); pci_fun_ops.interfaces[HW_RES_DEV_IFACE] = &pciintel_hw_res_ops; + pci_fun_ops.interfaces[PCI_DEV_IFACE] = &pci_dev_ops; } @@ -629,5 +735,6 @@ size_t pci_bar_mask_to_size(uint32_t mask) { - return ((mask & 0xfffffff0) ^ 0xffffffff) + 1; + size_t size = mask & ~(mask - 1); + return size; } Index: uspace/drv/rootvirt/devices.def =================================================================== --- uspace/drv/rootvirt/devices.def (revision ebcb05a569ef3a706553a41bd6a44277cc63277f) +++ uspace/drv/rootvirt/devices.def (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -22,2 +22,9 @@ }, #endif +#ifdef CONFIG_RUN_VIRTUAL_USB_HC +/* Virtual USB host controller. */ +{ + .name = "usbhc", + .match_id = "usb&hc=vhc" +}, +#endif Index: uspace/drv/uhci-hcd/Makefile =================================================================== --- uspace/drv/uhci-hcd/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,46 @@ +# +# Copyright (c) 2010 Vojtech Horky +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBS = $(LIBDRV_PREFIX)/libdrv.a $(LIBUSB_PREFIX)/libusb.a +EXTRA_CFLAGS += -I$(LIBDRV_PREFIX)/include -I$(LIBUSB_PREFIX)/include -I. +BINARY = uhci-hcd + +SOURCES = \ + iface.c \ + main.c \ + transfer_list.c \ + uhci.c \ + hc.c \ + root_hub.c \ + hw_struct/transfer_descriptor.c \ + utils/slab.c \ + pci.c \ + batch.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/uhci-hcd/batch.c =================================================================== --- uspace/drv/uhci-hcd/batch.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/batch.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,462 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver USB transaction structure + */ +#include +#include + +#include +#include + +#include "batch.h" +#include "transfer_list.h" +#include "hw_struct/transfer_descriptor.h" +#include "utils/malloc32.h" + +#define DEFAULT_ERROR_COUNT 3 + +typedef struct uhci_batch { + qh_t *qh; + td_t *tds; + size_t transfers; + usb_device_keeper_t *manager; +} uhci_batch_t; + +static void batch_control(usb_transfer_batch_t *instance, + usb_packet_id data_stage, usb_packet_id status_stage); +static void batch_data(usb_transfer_batch_t *instance, usb_packet_id pid); +static void batch_call_in_and_dispose(usb_transfer_batch_t *instance); +static void batch_call_out_and_dispose(usb_transfer_batch_t *instance); + + +/** Allocate memory and initialize internal data structure. + * + * @param[in] fun DDF function to pass to callback. + * @param[in] target Device and endpoint target of the transaction. + * @param[in] transfer_type Interrupt, Control or Bulk. + * @param[in] max_packet_size maximum allowed size of data transfers. + * @param[in] speed Speed of the transaction. + * @param[in] buffer Data source/destination. + * @param[in] size Size of the buffer. + * @param[in] setup_buffer Setup data source (if not NULL) + * @param[in] setup_size Size of setup_buffer (should be always 8) + * @param[in] func_in function to call on inbound transaction completion + * @param[in] func_out function to call on outbound transaction completion + * @param[in] arg additional parameter to func_in or func_out + * @param[in] manager Pointer to toggle management structure. + * @return Valid pointer if all substructures were successfully created, + * NULL otherwise. + * + * Determines the number of needed transfers (TDs). Prepares a transport buffer + * (that is accessible by the hardware). Initializes parameters needed for the + * transaction and callback. + */ +usb_transfer_batch_t * batch_get(ddf_fun_t *fun, usb_target_t target, + usb_transfer_type_t transfer_type, size_t max_packet_size, + usb_speed_t speed, char *buffer, size_t buffer_size, + char* setup_buffer, size_t setup_size, + usbhc_iface_transfer_in_callback_t func_in, + usbhc_iface_transfer_out_callback_t func_out, void *arg, + usb_device_keeper_t *manager + ) +{ + assert(func_in == NULL || func_out == NULL); + assert(func_in != NULL || func_out != NULL); + +#define CHECK_NULL_DISPOSE_RETURN(ptr, message...) \ + if (ptr == NULL) { \ + usb_log_error(message); \ + if (instance) { \ + batch_dispose(instance); \ + } \ + return NULL; \ + } else (void)0 + + usb_transfer_batch_t *instance = malloc(sizeof(usb_transfer_batch_t)); + CHECK_NULL_DISPOSE_RETURN(instance, + "Failed to allocate batch instance.\n"); + usb_transfer_batch_init(instance, target, transfer_type, speed, max_packet_size, + buffer, NULL, buffer_size, NULL, setup_size, func_in, + func_out, arg, fun, NULL); + + + uhci_batch_t *data = malloc(sizeof(uhci_batch_t)); + CHECK_NULL_DISPOSE_RETURN(instance, + "Failed to allocate batch instance.\n"); + bzero(data, sizeof(uhci_batch_t)); + data->manager = manager; + instance->private_data = data; + + data->transfers = (buffer_size + max_packet_size - 1) / max_packet_size; + if (transfer_type == USB_TRANSFER_CONTROL) { + data->transfers += 2; + } + + data->tds = malloc32(sizeof(td_t) * data->transfers); + CHECK_NULL_DISPOSE_RETURN( + data->tds, "Failed to allocate transfer descriptors.\n"); + bzero(data->tds, sizeof(td_t) * data->transfers); + + data->qh = malloc32(sizeof(qh_t)); + CHECK_NULL_DISPOSE_RETURN(data->qh, + "Failed to allocate batch queue head.\n"); + qh_init(data->qh); + qh_set_element_td(data->qh, addr_to_phys(data->tds)); + + if (buffer_size > 0) { + instance->transport_buffer = malloc32(buffer_size); + CHECK_NULL_DISPOSE_RETURN(instance->transport_buffer, + "Failed to allocate device accessible buffer.\n"); + } + + if (setup_size > 0) { + instance->setup_buffer = malloc32(setup_size); + CHECK_NULL_DISPOSE_RETURN(instance->setup_buffer, + "Failed to allocate device accessible setup buffer.\n"); + memcpy(instance->setup_buffer, setup_buffer, setup_size); + } + + usb_log_debug("Batch(%p) %d:%d memory structures ready.\n", + instance, target.address, target.endpoint); + return instance; +} +/*----------------------------------------------------------------------------*/ +/** Check batch TDs for activity. + * + * @param[in] instance Batch structure to use. + * @return False, if there is an active TD, true otherwise. + * + * Walk all TDs. Stop with false if there is an active one (it is to be + * processed). Stop with true if an error is found. Return true if the last TS + * is reached. + */ +bool batch_is_complete(usb_transfer_batch_t *instance) +{ + assert(instance); + uhci_batch_t *data = instance->private_data; + assert(data); + + usb_log_debug2("Batch(%p) checking %d transfer(s) for completion.\n", + instance, data->transfers); + instance->transfered_size = 0; + size_t i = 0; + for (;i < data->transfers; ++i) { + if (td_is_active(&data->tds[i])) { + return false; + } + + instance->error = td_status(&data->tds[i]); + if (instance->error != EOK) { + usb_log_debug("Batch(%p) found error TD(%d):%x.\n", + instance, i, data->tds[i].status); + td_print_status(&data->tds[i]); + + usb_device_keeper_set_toggle(data->manager, + instance->target, instance->direction, + td_toggle(&data->tds[i])); + if (i > 0) + goto substract_ret; + return true; + } + + instance->transfered_size += td_act_size(&data->tds[i]); + if (td_is_short(&data->tds[i])) + goto substract_ret; + } +substract_ret: + instance->transfered_size -= instance->setup_size; + return true; +} +/*----------------------------------------------------------------------------*/ +/** Prepares control write transaction. + * + * @param[in] instance Batch structure to use. + * + * Uses genercir control function with pids OUT and IN. + */ +void batch_control_write(usb_transfer_batch_t *instance) +{ + assert(instance); + /* We are data out, we are supposed to provide data */ + memcpy(instance->transport_buffer, instance->buffer, + instance->buffer_size); + batch_control(instance, USB_PID_OUT, USB_PID_IN); + instance->next_step = batch_call_out_and_dispose; + usb_log_debug("Batch(%p) CONTROL WRITE initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepares control read transaction. + * + * @param[in] instance Batch structure to use. + * + * Uses generic control with pids IN and OUT. + */ +void batch_control_read(usb_transfer_batch_t *instance) +{ + assert(instance); + batch_control(instance, USB_PID_IN, USB_PID_OUT); + instance->next_step = batch_call_in_and_dispose; + usb_log_debug("Batch(%p) CONTROL READ initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare interrupt in transaction. + * + * @param[in] instance Batch structure to use. + * + * Data transaction with PID_IN. + */ +void batch_interrupt_in(usb_transfer_batch_t *instance) +{ + assert(instance); + instance->direction = USB_DIRECTION_IN; + batch_data(instance, USB_PID_IN); + instance->next_step = batch_call_in_and_dispose; + usb_log_debug("Batch(%p) INTERRUPT IN initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare interrupt out transaction. + * + * @param[in] instance Batch structure to use. + * + * Data transaction with PID_OUT. + */ +void batch_interrupt_out(usb_transfer_batch_t *instance) +{ + assert(instance); + instance->direction = USB_DIRECTION_OUT; + /* We are data out, we are supposed to provide data */ + memcpy(instance->transport_buffer, instance->buffer, + instance->buffer_size); + batch_data(instance, USB_PID_OUT); + instance->next_step = batch_call_out_and_dispose; + usb_log_debug("Batch(%p) INTERRUPT OUT initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare bulk in transaction. + * + * @param[in] instance Batch structure to use. + * + * Data transaction with PID_IN. + */ +void batch_bulk_in(usb_transfer_batch_t *instance) +{ + assert(instance); + batch_data(instance, USB_PID_IN); + instance->direction = USB_DIRECTION_IN; + instance->next_step = batch_call_in_and_dispose; + usb_log_debug("Batch(%p) BULK IN initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare bulk out transaction. + * + * @param[in] instance Batch structure to use. + * + * Data transaction with PID_OUT. + */ +void batch_bulk_out(usb_transfer_batch_t *instance) +{ + assert(instance); + instance->direction = USB_DIRECTION_OUT; + /* We are data out, we are supposed to provide data */ + memcpy(instance->transport_buffer, instance->buffer, + instance->buffer_size); + batch_data(instance, USB_PID_OUT); + instance->next_step = batch_call_out_and_dispose; + usb_log_debug("Batch(%p) BULK OUT initialized.\n", instance); +} +/*----------------------------------------------------------------------------*/ +/** Prepare generic data transaction + * + * @param[in] instance Batch structure to use. + * @param[in] pid Pid to use for data transfers. + * + * Packets with alternating toggle bit and supplied pid value. + * The last transfer is marked with IOC flag. + */ +void batch_data(usb_transfer_batch_t *instance, usb_packet_id pid) +{ + assert(instance); + uhci_batch_t *data = instance->private_data; + assert(data); + + const bool low_speed = instance->speed == USB_SPEED_LOW; + int toggle = usb_device_keeper_get_toggle( + data->manager, instance->target, instance->direction); + assert(toggle == 0 || toggle == 1); + + size_t transfer = 0; + size_t remain_size = instance->buffer_size; + while (remain_size > 0) { + char *trans_data = + instance->transport_buffer + instance->buffer_size + - remain_size; + + const size_t packet_size = + (instance->max_packet_size > remain_size) ? + remain_size : instance->max_packet_size; + + td_t *next_transfer = (transfer + 1 < data->transfers) + ? &data->tds[transfer + 1] : NULL; + + assert(transfer < data->transfers); + assert(packet_size <= remain_size); + + td_init( + &data->tds[transfer], DEFAULT_ERROR_COUNT, packet_size, + toggle, false, low_speed, instance->target, pid, trans_data, + next_transfer); + + + toggle = 1 - toggle; + remain_size -= packet_size; + ++transfer; + } + td_set_ioc(&data->tds[transfer - 1]); + usb_device_keeper_set_toggle(data->manager, instance->target, + instance->direction, toggle); +} +/*----------------------------------------------------------------------------*/ +/** Prepare generic control transaction + * + * @param[in] instance Batch structure to use. + * @param[in] data_stage Pid to use for data transfers. + * @param[in] status_stage Pid to use for data transfers. + * + * Setup stage with toggle 0 and USB_PID_SETUP. + * Data stage with alternating toggle and pid supplied by parameter. + * Status stage with toggle 1 and pid supplied by parameter. + * The last transfer is marked with IOC. + */ +void batch_control(usb_transfer_batch_t *instance, + usb_packet_id data_stage, usb_packet_id status_stage) +{ + assert(instance); + uhci_batch_t *data = instance->private_data; + assert(data); + assert(data->transfers >= 2); + + const bool low_speed = instance->speed == USB_SPEED_LOW; + int toggle = 0; + /* setup stage */ + td_init( + data->tds, DEFAULT_ERROR_COUNT, instance->setup_size, toggle, false, + low_speed, instance->target, USB_PID_SETUP, instance->setup_buffer, + &data->tds[1]); + + /* data stage */ + size_t transfer = 1; + size_t remain_size = instance->buffer_size; + while (remain_size > 0) { + char *control_data = + instance->transport_buffer + instance->buffer_size + - remain_size; + + toggle = 1 - toggle; + + const size_t packet_size = + (instance->max_packet_size > remain_size) ? + remain_size : instance->max_packet_size; + + td_init( + &data->tds[transfer], DEFAULT_ERROR_COUNT, packet_size, + toggle, false, low_speed, instance->target, data_stage, + control_data, &data->tds[transfer + 1]); + + ++transfer; + assert(transfer < data->transfers); + assert(packet_size <= remain_size); + remain_size -= packet_size; + } + + /* status stage */ + assert(transfer == data->transfers - 1); + + td_init( + &data->tds[transfer], DEFAULT_ERROR_COUNT, 0, 1, false, low_speed, + instance->target, status_stage, NULL, NULL); + td_set_ioc(&data->tds[transfer]); + + usb_log_debug2("Control last TD status: %x.\n", + data->tds[transfer].status); +} +/*----------------------------------------------------------------------------*/ +qh_t * batch_qh(usb_transfer_batch_t *instance) +{ + assert(instance); + uhci_batch_t *data = instance->private_data; + assert(data); + return data->qh; +} +/*----------------------------------------------------------------------------*/ +/** Helper function calls callback and correctly disposes of batch structure. + * + * @param[in] instance Batch structure to use. + */ +void batch_call_in_and_dispose(usb_transfer_batch_t *instance) +{ + assert(instance); + usb_transfer_batch_call_in(instance); + batch_dispose(instance); +} +/*----------------------------------------------------------------------------*/ +/** Helper function calls callback and correctly disposes of batch structure. + * + * @param[in] instance Batch structure to use. + */ +void batch_call_out_and_dispose(usb_transfer_batch_t *instance) +{ + assert(instance); + usb_transfer_batch_call_out(instance); + batch_dispose(instance); +} +/*----------------------------------------------------------------------------*/ +/** Correctly dispose all used data structures. + * + * @param[in] instance Batch structure to use. + */ +void batch_dispose(usb_transfer_batch_t *instance) +{ + assert(instance); + uhci_batch_t *data = instance->private_data; + assert(data); + usb_log_debug("Batch(%p) disposing.\n", instance); + /* free32 is NULL safe */ + free32(data->tds); + free32(data->qh); + free32(instance->setup_buffer); + free32(instance->transport_buffer); + free(data); + free(instance); +} +/** + * @} + */ Index: uspace/drv/uhci-hcd/batch.h =================================================================== --- uspace/drv/uhci-hcd/batch.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/batch.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,82 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver USB transaction structure + */ +#ifndef DRV_UHCI_BATCH_H +#define DRV_UHCI_BATCH_H + +#include + +#include +#include +#include +#include + +#include "hw_struct/queue_head.h" + +usb_transfer_batch_t * batch_get( + ddf_fun_t *fun, + usb_target_t target, + usb_transfer_type_t transfer_type, + size_t max_packet_size, + usb_speed_t speed, + char *buffer, + size_t size, + char *setup_buffer, + size_t setup_size, + usbhc_iface_transfer_in_callback_t func_in, + usbhc_iface_transfer_out_callback_t func_out, + void *arg, + usb_device_keeper_t *manager + ); + +void batch_dispose(usb_transfer_batch_t *instance); + +bool batch_is_complete(usb_transfer_batch_t *instance); + +void batch_control_write(usb_transfer_batch_t *instance); + +void batch_control_read(usb_transfer_batch_t *instance); + +void batch_interrupt_in(usb_transfer_batch_t *instance); + +void batch_interrupt_out(usb_transfer_batch_t *instance); + +void batch_bulk_in(usb_transfer_batch_t *instance); + +void batch_bulk_out(usb_transfer_batch_t *instance); + +qh_t * batch_qh(usb_transfer_batch_t *instance); +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/hc.c =================================================================== --- uspace/drv/uhci-hcd/hc.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/hc.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,520 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI Host controller driver routines + */ +#include +#include +#include +#include + +#include +#include +#include +#include + +#include "hc.h" + +static irq_cmd_t uhci_cmds[] = { + { + .cmd = CMD_PIO_READ_16, + .addr = NULL, /* patched for every instance */ + .dstarg = 1 + }, + { + .cmd = CMD_PIO_WRITE_16, + .addr = NULL, /* pathed for every instance */ + .value = 0x1f + }, + { + .cmd = CMD_ACCEPT + } +}; +/*----------------------------------------------------------------------------*/ +static int hc_init_transfer_lists(hc_t *instance); +static int hc_init_mem_structures(hc_t *instance); +static void hc_init_hw(hc_t *instance); + +static int hc_interrupt_emulator(void *arg); +static int hc_debug_checker(void *arg); + +static bool usb_is_allowed( + bool low_speed, usb_transfer_type_t transfer, size_t size); +/*----------------------------------------------------------------------------*/ +/** Initialize UHCI hcd driver structure + * + * @param[in] instance Memory place to initialize. + * @param[in] fun DDF function. + * @param[in] regs Address of I/O control registers. + * @param[in] size Size of I/O control registers. + * @return Error code. + * @note Should be called only once on any structure. + * + * Initializes memory structures, starts up hw, and launches debugger and + * interrupt fibrils. + */ +int hc_init(hc_t *instance, ddf_fun_t *fun, + void *regs, size_t reg_size, bool interrupts) +{ + assert(reg_size >= sizeof(regs_t)); + int ret; + +#define CHECK_RET_DEST_FUN_RETURN(ret, message...) \ + if (ret != EOK) { \ + usb_log_error(message); \ + if (instance->ddf_instance) \ + ddf_fun_destroy(instance->ddf_instance); \ + return ret; \ + } else (void) 0 + + instance->hw_interrupts = interrupts; + instance->hw_failures = 0; + + /* Setup UHCI function. */ + instance->ddf_instance = fun; + + /* allow access to hc control registers */ + regs_t *io; + ret = pio_enable(regs, reg_size, (void**)&io); + CHECK_RET_DEST_FUN_RETURN(ret, + "Failed(%d) to gain access to registers at %p: %s.\n", + ret, str_error(ret), io); + instance->registers = io; + usb_log_debug("Device registers at %p(%u) accessible.\n", + io, reg_size); + + ret = hc_init_mem_structures(instance); + CHECK_RET_DEST_FUN_RETURN(ret, + "Failed to initialize UHCI memory structures.\n"); + + hc_init_hw(instance); + if (!interrupts) { + instance->cleaner = + fibril_create(hc_interrupt_emulator, instance); + fibril_add_ready(instance->cleaner); + } else { + /* TODO: enable interrupts here */ + } + + instance->debug_checker = + fibril_create(hc_debug_checker, instance); +// fibril_add_ready(instance->debug_checker); + + return EOK; +#undef CHECK_RET_DEST_FUN_RETURN +} +/*----------------------------------------------------------------------------*/ +/** Initialize UHCI hc hw resources. + * + * @param[in] instance UHCI structure to use. + * For magic values see UHCI Design Guide + */ +void hc_init_hw(hc_t *instance) +{ + assert(instance); + regs_t *registers = instance->registers; + + /* Reset everything, who knows what touched it before us */ + pio_write_16(®isters->usbcmd, UHCI_CMD_GLOBAL_RESET); + async_usleep(10000); /* 10ms according to USB spec */ + pio_write_16(®isters->usbcmd, 0); + + /* Reset hc, all states and counters */ + pio_write_16(®isters->usbcmd, UHCI_CMD_HCRESET); + do { async_usleep(10); } + while ((pio_read_16(®isters->usbcmd) & UHCI_CMD_HCRESET) != 0); + + /* Set frame to exactly 1ms */ + pio_write_8(®isters->sofmod, 64); + + /* Set frame list pointer */ + const uint32_t pa = addr_to_phys(instance->frame_list); + pio_write_32(®isters->flbaseadd, pa); + + if (instance->hw_interrupts) { + /* Enable all interrupts, but resume interrupt */ + pio_write_16(&instance->registers->usbintr, + UHCI_INTR_CRC | UHCI_INTR_COMPLETE | UHCI_INTR_SHORT_PACKET); + } + + uint16_t status = pio_read_16(®isters->usbcmd); + if (status != 0) + usb_log_warning("Previous command value: %x.\n", status); + + /* Start the hc with large(64B) packet FSBR */ + pio_write_16(®isters->usbcmd, + UHCI_CMD_RUN_STOP | UHCI_CMD_MAX_PACKET | UHCI_CMD_CONFIGURE); +} +/*----------------------------------------------------------------------------*/ +/** Initialize UHCI hc memory structures. + * + * @param[in] instance UHCI structure to use. + * @return Error code + * @note Should be called only once on any structure. + * + * Structures: + * - interrupt code (I/O addressses are customized per instance) + * - transfer lists (queue heads need to be accessible by the hw) + * - frame list page (needs to be one UHCI hw accessible 4K page) + */ +int hc_init_mem_structures(hc_t *instance) +{ + assert(instance); +#define CHECK_RET_DEST_CMDS_RETURN(ret, message...) \ + if (ret != EOK) { \ + usb_log_error(message); \ + if (instance->interrupt_code.cmds != NULL) \ + free(instance->interrupt_code.cmds); \ + return ret; \ + } else (void) 0 + + /* Init interrupt code */ + instance->interrupt_code.cmds = malloc(sizeof(uhci_cmds)); + int ret = (instance->interrupt_code.cmds == NULL) ? ENOMEM : EOK; + CHECK_RET_DEST_CMDS_RETURN(ret, + "Failed to allocate interrupt cmds space.\n"); + + { + irq_cmd_t *interrupt_commands = instance->interrupt_code.cmds; + memcpy(interrupt_commands, uhci_cmds, sizeof(uhci_cmds)); + interrupt_commands[0].addr = + (void*)&instance->registers->usbsts; + interrupt_commands[1].addr = + (void*)&instance->registers->usbsts; + instance->interrupt_code.cmdcount = + sizeof(uhci_cmds) / sizeof(irq_cmd_t); + } + + /* Init transfer lists */ + ret = hc_init_transfer_lists(instance); + CHECK_RET_DEST_CMDS_RETURN(ret, "Failed to init transfer lists.\n"); + usb_log_debug("Initialized transfer lists.\n"); + + /* Init USB frame list page*/ + instance->frame_list = get_page(); + ret = instance ? EOK : ENOMEM; + CHECK_RET_DEST_CMDS_RETURN(ret, "Failed to get frame list page.\n"); + usb_log_debug("Initialized frame list at %p.\n", instance->frame_list); + + /* Set all frames to point to the first queue head */ + const uint32_t queue = + instance->transfers_interrupt.queue_head_pa + | LINK_POINTER_QUEUE_HEAD_FLAG; + + unsigned i = 0; + for(; i < UHCI_FRAME_LIST_COUNT; ++i) { + instance->frame_list[i] = queue; + } + + /* Init device keeper*/ + usb_device_keeper_init(&instance->manager); + usb_log_debug("Initialized device manager.\n"); + + return EOK; +#undef CHECK_RET_DEST_CMDS_RETURN +} +/*----------------------------------------------------------------------------*/ +/** Initialize UHCI hc transfer lists. + * + * @param[in] instance UHCI structure to use. + * @return Error code + * @note Should be called only once on any structure. + * + * Initializes transfer lists and sets them in one chain to support proper + * USB scheduling. Sets pointer table for quick access. + */ +int hc_init_transfer_lists(hc_t *instance) +{ + assert(instance); +#define CHECK_RET_CLEAR_RETURN(ret, message...) \ + if (ret != EOK) { \ + usb_log_error(message); \ + transfer_list_fini(&instance->transfers_bulk_full); \ + transfer_list_fini(&instance->transfers_control_full); \ + transfer_list_fini(&instance->transfers_control_slow); \ + transfer_list_fini(&instance->transfers_interrupt); \ + return ret; \ + } else (void) 0 + + /* initialize TODO: check errors */ + int ret; + ret = transfer_list_init(&instance->transfers_bulk_full, "BULK_FULL"); + CHECK_RET_CLEAR_RETURN(ret, "Failed to init BULK list."); + + ret = transfer_list_init( + &instance->transfers_control_full, "CONTROL_FULL"); + CHECK_RET_CLEAR_RETURN(ret, "Failed to init CONTROL FULL list."); + + ret = transfer_list_init( + &instance->transfers_control_slow, "CONTROL_SLOW"); + CHECK_RET_CLEAR_RETURN(ret, "Failed to init CONTROL SLOW list."); + + ret = transfer_list_init(&instance->transfers_interrupt, "INTERRUPT"); + CHECK_RET_CLEAR_RETURN(ret, "Failed to init INTERRUPT list."); + + transfer_list_set_next(&instance->transfers_control_full, + &instance->transfers_bulk_full); + transfer_list_set_next(&instance->transfers_control_slow, + &instance->transfers_control_full); + transfer_list_set_next(&instance->transfers_interrupt, + &instance->transfers_control_slow); + + /*FSBR*/ +#ifdef FSBR + transfer_list_set_next(&instance->transfers_bulk_full, + &instance->transfers_control_full); +#endif + + /* Assign pointers to be used during scheduling */ + instance->transfers[USB_SPEED_FULL][USB_TRANSFER_INTERRUPT] = + &instance->transfers_interrupt; + instance->transfers[USB_SPEED_LOW][USB_TRANSFER_INTERRUPT] = + &instance->transfers_interrupt; + instance->transfers[USB_SPEED_FULL][USB_TRANSFER_CONTROL] = + &instance->transfers_control_full; + instance->transfers[USB_SPEED_LOW][USB_TRANSFER_CONTROL] = + &instance->transfers_control_slow; + instance->transfers[USB_SPEED_FULL][USB_TRANSFER_BULK] = + &instance->transfers_bulk_full; + + return EOK; +#undef CHECK_RET_CLEAR_RETURN +} +/*----------------------------------------------------------------------------*/ +/** Schedule batch for execution. + * + * @param[in] instance UHCI structure to use. + * @param[in] batch Transfer batch to schedule. + * @return Error code + * + * Checks for bandwidth availability and appends the batch to the proper queue. + */ +int hc_schedule(hc_t *instance, usb_transfer_batch_t *batch) +{ + assert(instance); + assert(batch); + const int low_speed = (batch->speed == USB_SPEED_LOW); + if (!usb_is_allowed( + low_speed, batch->transfer_type, batch->max_packet_size)) { + usb_log_warning( + "Invalid USB transfer specified %s SPEED %d %zu.\n", + low_speed ? "LOW" : "FULL" , batch->transfer_type, + batch->max_packet_size); + return ENOTSUP; + } + /* TODO: check available bandwidth here */ + + transfer_list_t *list = + instance->transfers[batch->speed][batch->transfer_type]; + assert(list); + if (batch->transfer_type == USB_TRANSFER_CONTROL) { + usb_device_keeper_use_control( + &instance->manager, batch->target.address); + } + transfer_list_add_batch(list, batch); + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Take action based on the interrupt cause. + * + * @param[in] instance UHCI structure to use. + * @param[in] status Value of the status register at the time of interrupt. + * + * Interrupt might indicate: + * - transaction completed, either by triggering IOC, SPD, or an error + * - some kind of device error + * - resume from suspend state (not implemented) + */ +void hc_interrupt(hc_t *instance, uint16_t status) +{ + assert(instance); + /* TODO: Resume interrupts are not supported */ + /* Lower 2 bits are transaction error and transaction complete */ + if (status & 0x3) { + LIST_INITIALIZE(done); + transfer_list_remove_finished( + &instance->transfers_interrupt, &done); + transfer_list_remove_finished( + &instance->transfers_control_slow, &done); + transfer_list_remove_finished( + &instance->transfers_control_full, &done); + transfer_list_remove_finished( + &instance->transfers_bulk_full, &done); + + while (!list_empty(&done)) { + link_t *item = done.next; + list_remove(item); + usb_transfer_batch_t *batch = + list_get_instance(item, usb_transfer_batch_t, link); + if (batch->transfer_type == USB_TRANSFER_CONTROL) { + usb_device_keeper_release_control( + &instance->manager, batch->target.address); + } + batch->next_step(batch); + } + } + /* bits 4 and 5 indicate hc error */ + if (status & 0x18) { + usb_log_error("UHCI hardware failure!.\n"); + ++instance->hw_failures; + transfer_list_abort_all(&instance->transfers_interrupt); + transfer_list_abort_all(&instance->transfers_control_slow); + transfer_list_abort_all(&instance->transfers_control_full); + transfer_list_abort_all(&instance->transfers_bulk_full); + + if (instance->hw_failures < UHCI_ALLOWED_HW_FAIL) { + /* reinitialize hw, this triggers virtual disconnect*/ + hc_init_hw(instance); + } else { + usb_log_fatal("Too many UHCI hardware failures!.\n"); + hc_fini(instance); + } + } +} +/*----------------------------------------------------------------------------*/ +/** Polling function, emulates interrupts. + * + * @param[in] arg UHCI hc structure to use. + * @return EOK (should never return) + */ +int hc_interrupt_emulator(void* arg) +{ + usb_log_debug("Started interrupt emulator.\n"); + hc_t *instance = (hc_t*)arg; + assert(instance); + + while (1) { + /* read and ack interrupts */ + uint16_t status = pio_read_16(&instance->registers->usbsts); + pio_write_16(&instance->registers->usbsts, 0x1f); + if (status != 0) + usb_log_debug2("UHCI status: %x.\n", status); + hc_interrupt(instance, status); + async_usleep(UHCI_CLEANER_TIMEOUT); + } + return EOK; +} +/*---------------------------------------------------------------------------*/ +/** Debug function, checks consistency of memory structures. + * + * @param[in] arg UHCI structure to use. + * @return EOK (should never return) + */ +int hc_debug_checker(void *arg) +{ + hc_t *instance = (hc_t*)arg; + assert(instance); + +#define QH(queue) \ + instance->transfers_##queue.queue_head + + while (1) { + const uint16_t cmd = pio_read_16(&instance->registers->usbcmd); + const uint16_t sts = pio_read_16(&instance->registers->usbsts); + const uint16_t intr = + pio_read_16(&instance->registers->usbintr); + + if (((cmd & UHCI_CMD_RUN_STOP) != 1) || (sts != 0)) { + usb_log_debug2("Command: %X Status: %X Intr: %x\n", + cmd, sts, intr); + } + + uintptr_t frame_list = + pio_read_32(&instance->registers->flbaseadd) & ~0xfff; + if (frame_list != addr_to_phys(instance->frame_list)) { + usb_log_debug("Framelist address: %p vs. %p.\n", + frame_list, addr_to_phys(instance->frame_list)); + } + + int frnum = pio_read_16(&instance->registers->frnum) & 0x3ff; + + uintptr_t expected_pa = instance->frame_list[frnum] + & LINK_POINTER_ADDRESS_MASK; + uintptr_t real_pa = addr_to_phys(QH(interrupt)); + if (expected_pa != real_pa) { + usb_log_debug("Interrupt QH: %p(frame: %d) vs. %p.\n", + expected_pa, frnum, real_pa); + } + + expected_pa = QH(interrupt)->next & LINK_POINTER_ADDRESS_MASK; + real_pa = addr_to_phys(QH(control_slow)); + if (expected_pa != real_pa) { + usb_log_debug("Control Slow QH: %p vs. %p.\n", + expected_pa, real_pa); + } + + expected_pa = QH(control_slow)->next & LINK_POINTER_ADDRESS_MASK; + real_pa = addr_to_phys(QH(control_full)); + if (expected_pa != real_pa) { + usb_log_debug("Control Full QH: %p vs. %p.\n", + expected_pa, real_pa); + } + + expected_pa = QH(control_full)->next & LINK_POINTER_ADDRESS_MASK; + real_pa = addr_to_phys(QH(bulk_full)); + if (expected_pa != real_pa ) { + usb_log_debug("Bulk QH: %p vs. %p.\n", + expected_pa, real_pa); + } + async_usleep(UHCI_DEBUGER_TIMEOUT); + } + return EOK; +#undef QH +} +/*----------------------------------------------------------------------------*/ +/** Check transfers for USB validity + * + * @param[in] low_speed Transfer speed. + * @param[in] transfer Transer type + * @param[in] size Size of data packets + * @return True if transaction is allowed by USB specs, false otherwise + */ +bool usb_is_allowed( + bool low_speed, usb_transfer_type_t transfer, size_t size) +{ + /* see USB specification chapter 5.5-5.8 for magic numbers used here */ + switch(transfer) + { + case USB_TRANSFER_ISOCHRONOUS: + return (!low_speed && size < 1024); + case USB_TRANSFER_INTERRUPT: + return size <= (low_speed ? 8 : 64); + case USB_TRANSFER_CONTROL: /* device specifies its own max size */ + return (size <= (low_speed ? 8 : 64)); + case USB_TRANSFER_BULK: /* device specifies its own max size */ + return (!low_speed && size <= 64); + } + return false; +} +/** + * @} + */ Index: uspace/drv/uhci-hcd/hc.h =================================================================== --- uspace/drv/uhci-hcd/hc.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/hc.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,131 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI host controller driver structure + */ +#ifndef DRV_UHCI_UHCI_HC_H +#define DRV_UHCI_UHCI_HC_H + +#include +#include +#include +#include + +#include +#include + +#include "batch.h" +#include "transfer_list.h" + +typedef struct uhci_regs { + uint16_t usbcmd; +#define UHCI_CMD_MAX_PACKET (1 << 7) +#define UHCI_CMD_CONFIGURE (1 << 6) +#define UHCI_CMD_DEBUG (1 << 5) +#define UHCI_CMD_FORCE_GLOBAL_RESUME (1 << 4) +#define UHCI_CMD_FORCE_GLOBAL_SUSPEND (1 << 3) +#define UHCI_CMD_GLOBAL_RESET (1 << 2) +#define UHCI_CMD_HCRESET (1 << 1) +#define UHCI_CMD_RUN_STOP (1 << 0) + + uint16_t usbsts; +#define UHCI_STATUS_HALTED (1 << 5) +#define UHCI_STATUS_PROCESS_ERROR (1 << 4) +#define UHCI_STATUS_SYSTEM_ERROR (1 << 3) +#define UHCI_STATUS_RESUME (1 << 2) +#define UHCI_STATUS_ERROR_INTERRUPT (1 << 1) +#define UHCI_STATUS_INTERRUPT (1 << 0) + + uint16_t usbintr; +#define UHCI_INTR_SHORT_PACKET (1 << 3) +#define UHCI_INTR_COMPLETE (1 << 2) +#define UHCI_INTR_RESUME (1 << 1) +#define UHCI_INTR_CRC (1 << 0) + + uint16_t frnum; + uint32_t flbaseadd; + uint8_t sofmod; +} regs_t; + +#define UHCI_FRAME_LIST_COUNT 1024 +#define UHCI_CLEANER_TIMEOUT 10000 +#define UHCI_DEBUGER_TIMEOUT 5000000 +#define UHCI_ALLOWED_HW_FAIL 5 + +typedef struct hc { + usb_device_keeper_t manager; + + regs_t *registers; + + link_pointer_t *frame_list; + + transfer_list_t transfers_bulk_full; + transfer_list_t transfers_control_full; + transfer_list_t transfers_control_slow; + transfer_list_t transfers_interrupt; + + transfer_list_t *transfers[2][4]; + + irq_code_t interrupt_code; + + fid_t cleaner; + fid_t debug_checker; + bool hw_interrupts; + unsigned hw_failures; + + ddf_fun_t *ddf_instance; +} hc_t; + +int hc_init(hc_t *instance, ddf_fun_t *fun, + void *regs, size_t reg_size, bool interupts); + +int hc_schedule(hc_t *instance, usb_transfer_batch_t *batch); + +void hc_interrupt(hc_t *instance, uint16_t status); + +/** Safely dispose host controller internal structures + * + * @param[in] instance Host controller structure to use. + */ +static inline void hc_fini(hc_t *instance) { /* TODO: implement*/ }; + +/** Get and cast pointer to the driver data + * + * @param[in] fun DDF function pointer + * @return cast pointer to driver_data + */ +static inline hc_t * fun_to_hc(ddf_fun_t *fun) + { return (hc_t*)fun->driver_data; } +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/hw_struct/link_pointer.h =================================================================== --- uspace/drv/uhci-hcd/hw_struct/link_pointer.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/hw_struct/link_pointer.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,61 @@ +/* + * Copyright (c) 2010 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver + */ +#ifndef DRV_UHCI_LINK_POINTER_H +#define DRV_UHCI_LINK_POINTER_H + +/* UHCI link pointer, used by many data structures */ +typedef uint32_t link_pointer_t; + +#define LINK_POINTER_TERMINATE_FLAG (1 << 0) +#define LINK_POINTER_QUEUE_HEAD_FLAG (1 << 1) +#define LINK_POINTER_ZERO_BIT_FLAG (1 << 2) +#define LINK_POINTER_VERTICAL_FLAG (1 << 2) +#define LINK_POINTER_RESERVED_FLAG (1 << 3) + +#define LINK_POINTER_ADDRESS_MASK 0xfffffff0 /* upper 28 bits */ + +#define LINK_POINTER_QH(address) \ + ((address & LINK_POINTER_ADDRESS_MASK) | LINK_POINTER_QUEUE_HEAD_FLAG) + +#define LINK_POINTER_TD(address) \ + (address & LINK_POINTER_ADDRESS_MASK) + +#define LINK_POINTER_TERM \ + ((link_pointer_t)LINK_POINTER_TERMINATE_FLAG) + +#endif +/** + * @} + */ + Index: uspace/drv/uhci-hcd/hw_struct/queue_head.h =================================================================== --- uspace/drv/uhci-hcd/hw_struct/queue_head.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/hw_struct/queue_head.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,118 @@ +/* + * Copyright (c) 2010 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drv usbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver + */ +#ifndef DRV_UHCI_QH_H +#define DRV_UHCI_QH_H + +/* libc */ +#include + +#include "link_pointer.h" +#include "utils/malloc32.h" + +typedef struct queue_head { + volatile link_pointer_t next; + volatile link_pointer_t element; +} __attribute__((packed)) qh_t; +/*----------------------------------------------------------------------------*/ +/** Initialize queue head structure + * + * @param[in] instance qh_t structure to initialize. + * + * Sets both pointer to terminal NULL. + */ +static inline void qh_init(qh_t *instance) +{ + assert(instance); + + instance->element = 0 | LINK_POINTER_TERMINATE_FLAG; + instance->next = 0 | LINK_POINTER_TERMINATE_FLAG; +} +/*----------------------------------------------------------------------------*/ +/** Set queue head next pointer + * + * @param[in] instance qh_t structure to use. + * @param[in] pa Physical address of the next queue head. + * + * Adds proper flag. If the pointer is NULL or terminal, sets next to terminal + * NULL. + */ +static inline void qh_set_next_qh(qh_t *instance, uint32_t pa) +{ + /* Address is valid and not terminal */ + if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) { + instance->next = LINK_POINTER_QH(pa); + } else { + instance->next = LINK_POINTER_TERM; + } +} +/*----------------------------------------------------------------------------*/ +/** Set queue head element pointer + * + * @param[in] instance qh_t structure to initialize. + * @param[in] pa Physical address of the next queue head. + * + * Adds proper flag. If the pointer is NULL or terminal, sets element + * to terminal NULL. + */ +static inline void qh_set_element_qh(qh_t *instance, uint32_t pa) +{ + /* Address is valid and not terminal */ + if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) { + instance->element = LINK_POINTER_QH(pa); + } else { + instance->element = LINK_POINTER_TERM; + } +} +/*----------------------------------------------------------------------------*/ +/** Set queue head element pointer + * + * @param[in] instance qh_t structure to initialize. + * @param[in] pa Physical address of the TD structure. + * + * Adds proper flag. If the pointer is NULL or terminal, sets element + * to terminal NULL. + */ +static inline void qh_set_element_td(qh_t *instance, uint32_t pa) +{ + if (pa && ((pa & LINK_POINTER_TERMINATE_FLAG) == 0)) { + instance->element = LINK_POINTER_TD(pa); + } else { + instance->element = LINK_POINTER_TERM; + } +} + +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.c =================================================================== --- uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,173 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver + */ +#include +#include + +#include "transfer_descriptor.h" +#include "utils/malloc32.h" + +/** Initialize Transfer Descriptor + * + * @param[in] instance Memory place to initialize. + * @param[in] err_count Number of retries hc should attempt. + * @param[in] size Size of data source. + * @param[in] toggle Value of toggle bit. + * @param[in] iso True if TD represents Isochronous transfer. + * @param[in] low_speed Target device's speed. + * @param[in] target Address and endpoint receiving the transfer. + * @param[in] pid Packet identification (SETUP, IN or OUT). + * @param[in] buffer Source of data. + * @param[in] next Net TD in transaction. + * @return Error code. + * + * Uses a mix of supplied and default values. + * Implicit values: + * - all TDs have vertical flag set (makes transfers to endpoints atomic) + * - in the error field only active it is set + * - if the packet uses PID_IN and is not isochronous SPD is set + * + * Dumps 8 bytes of buffer if PID_SETUP is used. + */ +void td_init(td_t *instance, int err_count, size_t size, bool toggle, bool iso, + bool low_speed, usb_target_t target, usb_packet_id pid, void *buffer, + td_t *next) +{ + assert(instance); + assert(size < 1024); + assert((pid == USB_PID_SETUP) || (pid == USB_PID_IN) + || (pid == USB_PID_OUT)); + + const uint32_t next_pa = addr_to_phys(next); + assert((next_pa & LINK_POINTER_ADDRESS_MASK) == next_pa); + + instance->next = 0 + | LINK_POINTER_VERTICAL_FLAG + | (next_pa ? next_pa : LINK_POINTER_TERMINATE_FLAG); + + instance->status = 0 + | ((err_count & TD_STATUS_ERROR_COUNT_MASK) << TD_STATUS_ERROR_COUNT_POS) + | (low_speed ? TD_STATUS_LOW_SPEED_FLAG : 0) + | (iso ? TD_STATUS_ISOCHRONOUS_FLAG : 0) + | TD_STATUS_ERROR_ACTIVE; + + if (pid == USB_PID_IN && !iso) { + instance->status |= TD_STATUS_SPD_FLAG; + } + + instance->device = 0 + | (((size - 1) & TD_DEVICE_MAXLEN_MASK) << TD_DEVICE_MAXLEN_POS) + | (toggle ? TD_DEVICE_DATA_TOGGLE_ONE_FLAG : 0) + | ((target.address & TD_DEVICE_ADDRESS_MASK) << TD_DEVICE_ADDRESS_POS) + | ((target.endpoint & TD_DEVICE_ENDPOINT_MASK) << TD_DEVICE_ENDPOINT_POS) + | ((pid & TD_DEVICE_PID_MASK) << TD_DEVICE_PID_POS); + + instance->buffer_ptr = addr_to_phys(buffer); + + usb_log_debug2("Created TD(%p): %X:%X:%X:%X(%p).\n", + instance, instance->next, instance->status, instance->device, + instance->buffer_ptr, buffer); + td_print_status(instance); + if (pid == USB_PID_SETUP) { + usb_log_debug("SETUP BUFFER: %s\n", + usb_debug_str_buffer(buffer, 8, 8)); + } +} +/*----------------------------------------------------------------------------*/ +/** Convert TD status into standard error code + * + * @param[in] instance TD structure to use. + * @return Error code. + */ +int td_status(td_t *instance) +{ + assert(instance); + + /* this is hc internal error it should never be reported */ + if ((instance->status & TD_STATUS_ERROR_BIT_STUFF) != 0) + return EAGAIN; + + /* CRC or timeout error, like device not present or bad data, + * it won't be reported unless err count reached zero */ + if ((instance->status & TD_STATUS_ERROR_CRC) != 0) + return EBADCHECKSUM; + + /* hc does not end transaction on these, it should never be reported */ + if ((instance->status & TD_STATUS_ERROR_NAK) != 0) + return EAGAIN; + + /* buffer overrun or underrun */ + if ((instance->status & TD_STATUS_ERROR_BUFFER) != 0) + return ERANGE; + + /* device babble is something serious */ + if ((instance->status & TD_STATUS_ERROR_BABBLE) != 0) + return EIO; + + /* stall might represent err count reaching zero or stall response from + * the device, is err count reached zero, one of the above is reported*/ + if ((instance->status & TD_STATUS_ERROR_STALLED) != 0) + return ESTALL; + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Print values in status field (dw1) in a human readable way. + * + * @param[in] instance TD structure to use. + */ +void td_print_status(td_t *instance) +{ + assert(instance); + const uint32_t s = instance->status; + usb_log_debug2("TD(%p) status(%#x):%s %d,%s%s%s%s%s%s%s%s%s%s%s %d.\n", + instance, instance->status, + (s & TD_STATUS_SPD_FLAG) ? " SPD," : "", + (s >> TD_STATUS_ERROR_COUNT_POS) & TD_STATUS_ERROR_COUNT_MASK, + (s & TD_STATUS_LOW_SPEED_FLAG) ? " LOW SPEED," : "", + (s & TD_STATUS_ISOCHRONOUS_FLAG) ? " ISOCHRONOUS," : "", + (s & TD_STATUS_IOC_FLAG) ? " IOC," : "", + (s & TD_STATUS_ERROR_ACTIVE) ? " ACTIVE," : "", + (s & TD_STATUS_ERROR_STALLED) ? " STALLED," : "", + (s & TD_STATUS_ERROR_BUFFER) ? " BUFFER," : "", + (s & TD_STATUS_ERROR_BABBLE) ? " BABBLE," : "", + (s & TD_STATUS_ERROR_NAK) ? " NAK," : "", + (s & TD_STATUS_ERROR_CRC) ? " CRC/TIMEOUT," : "", + (s & TD_STATUS_ERROR_BIT_STUFF) ? " BIT_STUFF," : "", + (s & TD_STATUS_ERROR_RESERVED) ? " RESERVED," : "", + td_act_size(instance) + ); +} +/** + * @} + */ Index: uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.h =================================================================== --- uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/hw_struct/transfer_descriptor.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,161 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver + */ +#ifndef DRV_UHCI_TRANSFER_DESCRIPTOR_H +#define DRV_UHCI_TRANSFER_DESCRIPTOR_H + +#include +#include + +#include "link_pointer.h" + +/** UHCI Transfer Descriptor */ +typedef struct transfer_descriptor { + link_pointer_t next; + + volatile uint32_t status; +#define TD_STATUS_RESERVED_MASK 0xc000f800 +#define TD_STATUS_SPD_FLAG ( 1 << 29 ) +#define TD_STATUS_ERROR_COUNT_POS ( 27 ) +#define TD_STATUS_ERROR_COUNT_MASK ( 0x3 ) +#define TD_STATUS_LOW_SPEED_FLAG ( 1 << 26 ) +#define TD_STATUS_ISOCHRONOUS_FLAG ( 1 << 25 ) +#define TD_STATUS_IOC_FLAG ( 1 << 24 ) + +#define TD_STATUS_ERROR_ACTIVE ( 1 << 23 ) +#define TD_STATUS_ERROR_STALLED ( 1 << 22 ) +#define TD_STATUS_ERROR_BUFFER ( 1 << 21 ) +#define TD_STATUS_ERROR_BABBLE ( 1 << 20 ) +#define TD_STATUS_ERROR_NAK ( 1 << 19 ) +#define TD_STATUS_ERROR_CRC ( 1 << 18 ) +#define TD_STATUS_ERROR_BIT_STUFF ( 1 << 17 ) +#define TD_STATUS_ERROR_RESERVED ( 1 << 16 ) +#define TD_STATUS_ERROR_POS 16 +#define TD_STATUS_ERROR_MASK ( 0xff ) + +#define TD_STATUS_ACTLEN_POS 0 +#define TD_STATUS_ACTLEN_MASK 0x7ff + + volatile uint32_t device; +#define TD_DEVICE_MAXLEN_POS 21 +#define TD_DEVICE_MAXLEN_MASK ( 0x7ff ) +#define TD_DEVICE_RESERVED_FLAG ( 1 << 20 ) +#define TD_DEVICE_DATA_TOGGLE_ONE_FLAG ( 1 << 19 ) +#define TD_DEVICE_ENDPOINT_POS 15 +#define TD_DEVICE_ENDPOINT_MASK ( 0xf ) +#define TD_DEVICE_ADDRESS_POS 8 +#define TD_DEVICE_ADDRESS_MASK ( 0x7f ) +#define TD_DEVICE_PID_POS 0 +#define TD_DEVICE_PID_MASK ( 0xff ) + + volatile uint32_t buffer_ptr; + + /* there is 16 bytes of data available here, according to UHCI + * Design guide, according to linux kernel the hardware does not care, + * it just needs to be aligned, we don't use it anyway + */ +} __attribute__((packed)) td_t; + + +void td_init(td_t *instance, int error_count, size_t size, bool toggle, + bool iso, bool low_speed, usb_target_t target, usb_packet_id pid, + void *buffer, td_t *next); + +int td_status(td_t *instance); + +void td_print_status(td_t *instance); +/*----------------------------------------------------------------------------*/ +/** Helper function for parsing actual size out of TD. + * + * @param[in] instance TD structure to use. + * @return Parsed actual size. + */ +static inline size_t td_act_size(td_t *instance) +{ + assert(instance); + const uint32_t s = instance->status; + return ((s >> TD_STATUS_ACTLEN_POS) + 1) & TD_STATUS_ACTLEN_MASK; +} +/*----------------------------------------------------------------------------*/ +/** Check whether less than max data were received on SPD marked transfer. + * + * @param[in] instance TD structure to use. + * @return True if data packet is short (less than max bytes and SPD set), + * false otherwise. + */ +static inline bool td_is_short(td_t *instance) +{ + const size_t act_size = td_act_size(instance); + const size_t max_size = + ((instance->device >> TD_DEVICE_MAXLEN_POS) + 1) + & TD_DEVICE_MAXLEN_MASK; + return + (instance->status | TD_STATUS_SPD_FLAG) && act_size < max_size; +} +/*----------------------------------------------------------------------------*/ +/** Helper function for parsing value of toggle bit. + * + * @param[in] instance TD structure to use. + * @return Toggle bit value. + */ +static inline int td_toggle(td_t *instance) +{ + assert(instance); + return (instance->device & TD_DEVICE_DATA_TOGGLE_ONE_FLAG) ? 1 : 0; +} +/*----------------------------------------------------------------------------*/ +/** Helper function for parsing value of active bit + * + * @param[in] instance TD structure to use. + * @return Active bit value. + */ +static inline bool td_is_active(td_t *instance) +{ + assert(instance); + return (instance->status & TD_STATUS_ERROR_ACTIVE) != 0; +} +/*----------------------------------------------------------------------------*/ +/** Helper function for setting IOC bit. + * + * @param[in] instance TD structure to use. + */ +static inline void td_set_ioc(td_t *instance) +{ + assert(instance); + instance->status |= TD_STATUS_IOC_FLAG; +} +/*----------------------------------------------------------------------------*/ +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/iface.c =================================================================== --- uspace/drv/uhci-hcd/iface.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/iface.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,378 @@ +/* + * Copyright (c) 2011 Vojtech Horky, Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver hc interface implementation + */ +#include +#include + +#include + +#include "iface.h" +#include "hc.h" + +/** Reserve default address interface function + * + * @param[in] fun DDF function that was called. + * @param[in] speed Speed to associate with the new default address. + * @return Error code. + */ +static int reserve_default_address(ddf_fun_t *fun, usb_speed_t speed) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_log_debug("Default address request with speed %d.\n", speed); + usb_device_keeper_reserve_default_address(&hc->manager, speed); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Release default address interface function + * + * @param[in] fun DDF function that was called. + * @return Error code. + */ +static int release_default_address(ddf_fun_t *fun) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_log_debug("Default address release.\n"); + usb_device_keeper_release_default_address(&hc->manager); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Request address interface function + * + * @param[in] fun DDF function that was called. + * @param[in] speed Speed to associate with the new default address. + * @param[out] address Place to write a new address. + * @return Error code. + */ +static int request_address( + ddf_fun_t *fun, usb_speed_t speed, usb_address_t *address) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + assert(address); + + usb_log_debug("Address request with speed %d.\n", speed); + *address = device_keeper_get_free_address(&hc->manager, speed); + usb_log_debug("Address request with result: %d.\n", *address); + if (*address <= 0) + return *address; + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Bind address interface function + * + * @param[in] fun DDF function that was called. + * @param[in] address Address of the device + * @param[in] handle Devman handle of the device driver. + * @return Error code. + */ +static int bind_address( + ddf_fun_t *fun, usb_address_t address, devman_handle_t handle) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_log_debug("Address bind %d-%d.\n", address, handle); + usb_device_keeper_bind(&hc->manager, address, handle); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Release address interface function + * + * @param[in] fun DDF function that was called. + * @param[in] address USB address to be released. + * @return Error code. + */ +static int release_address(ddf_fun_t *fun, usb_address_t address) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_log_debug("Address release %d.\n", address); + usb_device_keeper_release(&hc->manager, address); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Interrupt out transaction interface function + * + * @param[in] fun DDF function that was called. + * @param[in] target USB device to write to. + * @param[in] max_packet_size maximum size of data packet the device accepts + * @param[in] data Source of data. + * @param[in] size Size of data source. + * @param[in] callback Function to call on transaction completion + * @param[in] arg Additional for callback function. + * @return Error code. + */ +static int interrupt_out( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, void *data, + size_t size, usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + + usb_log_debug("Interrupt OUT %d:%d %zu(%zu).\n", + target.address, target.endpoint, size, max_packet_size); + + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_INTERRUPT, max_packet_size, + speed, data, size, NULL, 0, NULL, callback, arg, &hc->manager); + if (!batch) + return ENOMEM; + batch_interrupt_out(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Interrupt in transaction interface function + * + * @param[in] fun DDF function that was called. + * @param[in] target USB device to write to. + * @param[in] max_packet_size maximum size of data packet the device accepts + * @param[out] data Data destination. + * @param[in] size Size of data source. + * @param[in] callback Function to call on transaction completion + * @param[in] arg Additional for callback function. + * @return Error code. + */ +static int interrupt_in( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, void *data, + size_t size, usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + usb_log_debug("Interrupt IN %d:%d %zu(%zu).\n", + target.address, target.endpoint, size, max_packet_size); + + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_INTERRUPT, max_packet_size, + speed, data, size, NULL, 0, callback, NULL, arg, &hc->manager); + if (!batch) + return ENOMEM; + batch_interrupt_in(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Bulk out transaction interface function + * + * @param[in] fun DDF function that was called. + * @param[in] target USB device to write to. + * @param[in] max_packet_size maximum size of data packet the device accepts + * @param[in] data Source of data. + * @param[in] size Size of data source. + * @param[in] callback Function to call on transaction completion + * @param[in] arg Additional for callback function. + * @return Error code. + */ +static int bulk_out( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, void *data, + size_t size, usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + + usb_log_debug("Bulk OUT %d:%d %zu(%zu).\n", + target.address, target.endpoint, size, max_packet_size); + + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_BULK, max_packet_size, speed, + data, size, NULL, 0, NULL, callback, arg, &hc->manager); + if (!batch) + return ENOMEM; + batch_bulk_out(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Bulk in transaction interface function + * + * @param[in] fun DDF function that was called. + * @param[in] target USB device to write to. + * @param[in] max_packet_size maximum size of data packet the device accepts + * @param[out] data Data destination. + * @param[in] size Size of data source. + * @param[in] callback Function to call on transaction completion + * @param[in] arg Additional for callback function. + * @return Error code. + */ +static int bulk_in( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, void *data, + size_t size, usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + usb_log_debug("Bulk IN %d:%d %zu(%zu).\n", + target.address, target.endpoint, size, max_packet_size); + + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_BULK, max_packet_size, speed, + data, size, NULL, 0, callback, NULL, arg, &hc->manager); + if (!batch) + return ENOMEM; + batch_bulk_in(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Control write transaction interface function + * + * @param[in] fun DDF function that was called. + * @param[in] target USB device to write to. + * @param[in] max_packet_size maximum size of data packet the device accepts. + * @param[in] setup_data Data to send with SETUP transfer. + * @param[in] setup_size Size of data to send with SETUP transfer (always 8B). + * @param[in] data Source of data. + * @param[in] size Size of data source. + * @param[in] callback Function to call on transaction completion. + * @param[in] arg Additional for callback function. + * @return Error code. + */ +static int control_write( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, + void *setup_data, size_t setup_size, void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + usb_log_debug("Control WRITE (%d) %d:%d %zu(%zu).\n", + speed, target.address, target.endpoint, size, max_packet_size); + + if (setup_size != 8) + return EINVAL; + + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_CONTROL, max_packet_size, speed, + data, size, setup_data, setup_size, NULL, callback, arg, + &hc->manager); + if (!batch) + return ENOMEM; + usb_device_keeper_reset_if_need(&hc->manager, target, setup_data); + batch_control_write(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +/** Control read transaction interface function + * + * @param[in] fun DDF function that was called. + * @param[in] target USB device to write to. + * @param[in] max_packet_size maximum size of data packet the device accepts. + * @param[in] setup_data Data to send with SETUP packet. + * @param[in] setup_size Size of data to send with SETUP packet (should be 8B). + * @param[out] data Source of data. + * @param[in] size Size of data source. + * @param[in] callback Function to call on transaction completion. + * @param[in] arg Additional for callback function. + * @return Error code. + */ +static int control_read( + ddf_fun_t *fun, usb_target_t target, size_t max_packet_size, + void *setup_data, size_t setup_size, void *data, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + assert(fun); + hc_t *hc = fun_to_hc(fun); + assert(hc); + usb_speed_t speed = + usb_device_keeper_get_speed(&hc->manager, target.address); + + usb_log_debug("Control READ(%d) %d:%d %zu(%zu).\n", + speed, target.address, target.endpoint, size, max_packet_size); + usb_transfer_batch_t *batch = + batch_get(fun, target, USB_TRANSFER_CONTROL, max_packet_size, speed, + data, size, setup_data, setup_size, callback, NULL, arg, + &hc->manager); + if (!batch) + return ENOMEM; + batch_control_read(batch); + const int ret = hc_schedule(hc, batch); + if (ret != EOK) { + batch_dispose(batch); + } + return ret; +} +/*----------------------------------------------------------------------------*/ +usbhc_iface_t hc_iface = { + .reserve_default_address = reserve_default_address, + .release_default_address = release_default_address, + .request_address = request_address, + .bind_address = bind_address, + .release_address = release_address, + + .interrupt_out = interrupt_out, + .interrupt_in = interrupt_in, + + .bulk_out = bulk_out, + .bulk_in = bulk_in, + + .control_write = control_write, + .control_read = control_read, +}; +/** + * @} + */ Index: uspace/drv/uhci-hcd/iface.h =================================================================== --- uspace/drv/uhci-hcd/iface.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/iface.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,45 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver iface + */ +#ifndef DRV_UHCI_IFACE_H +#define DRV_UHCI_IFACE_H + +#include + +extern usbhc_iface_t hc_iface; + +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/main.c =================================================================== --- uspace/drv/uhci-hcd/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,104 @@ +/* + * Copyright (c) 2011 Vojtech Horky, Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver initialization + */ +#include +#include +#include + +#include +#include + +#include "iface.h" +#include "uhci.h" + +#define NAME "uhci-hcd" + +static int uhci_add_device(ddf_dev_t *device); +/*----------------------------------------------------------------------------*/ +static driver_ops_t uhci_driver_ops = { + .add_device = uhci_add_device, +}; +/*----------------------------------------------------------------------------*/ +static driver_t uhci_driver = { + .name = NAME, + .driver_ops = &uhci_driver_ops +}; +/*----------------------------------------------------------------------------*/ +/** Initialize a new ddf driver instance for uhci hc and hub. + * + * @param[in] device DDF instance of the device to initialize. + * @return Error code. + */ +int uhci_add_device(ddf_dev_t *device) +{ + usb_log_debug("uhci_add_device() called\n"); + assert(device); + uhci_t *uhci = malloc(sizeof(uhci_t)); + if (uhci == NULL) { + usb_log_error("Failed to allocate UHCI driver.\n"); + return ENOMEM; + } + + int ret = uhci_init(uhci, device); + if (ret != EOK) { + usb_log_error("Failed to initialize UHCI driver: %s.\n", + str_error(ret)); + return ret; + } + device->driver_data = uhci; + + usb_log_info("Controlling new UHCI device `%s'.\n", device->name); + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Initialize global driver structures (NONE). + * + * @param[in] argc Nmber of arguments in argv vector (ignored). + * @param[in] argv Cmdline argument vector (ignored). + * @return Error code. + * + * Driver debug level is set here. + */ +int main(int argc, char *argv[]) +{ + printf(NAME ": HelenOS UHCI driver.\n"); + + sleep(3); /* TODO: remove in final version */ + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + + return ddf_driver_main(&uhci_driver); +} +/** + * @} + */ Index: uspace/drv/uhci-hcd/pci.c =================================================================== --- uspace/drv/uhci-hcd/pci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/pci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,165 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** + * @addtogroup drvusbuhcihc + * @{ + */ +/** + * @file + * PCI related functions needed by the UHCI driver. + */ +#include +#include +#include +#include + +#include +#include + +#include "pci.h" + +/** Get address of registers and IRQ for given device. + * + * @param[in] dev Device asking for the addresses. + * @param[out] io_reg_address Base address of the I/O range. + * @param[out] io_reg_size Size of the I/O range. + * @param[out] irq_no IRQ assigned to the device. + * @return Error code. + */ +int pci_get_my_registers(ddf_dev_t *dev, + uintptr_t *io_reg_address, size_t *io_reg_size, + int *irq_no) +{ + assert(dev != NULL); + + int parent_phone = devman_parent_device_connect(dev->handle, + IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + + int rc; + hw_resource_list_t hw_resources; + rc = hw_res_get_resource_list(parent_phone, &hw_resources); + if (rc != EOK) { + goto leave; + } + + uintptr_t io_address = 0; + size_t io_size = 0; + bool io_found = false; + + int irq = 0; + bool irq_found = false; + + size_t i; + for (i = 0; i < hw_resources.count; i++) { + hw_resource_t *res = &hw_resources.resources[i]; + switch (res->type) + { + case INTERRUPT: + irq = res->res.interrupt.irq; + irq_found = true; + usb_log_debug2("Found interrupt: %d.\n", irq); + break; + + case IO_RANGE: + io_address = res->res.io_range.address; + io_size = res->res.io_range.size; + usb_log_debug2("Found io: %llx %zu.\n", + res->res.io_range.address, res->res.io_range.size); + io_found = true; + + default: + break; + } + } + + if (!io_found || !irq_found) { + rc = ENOENT; + goto leave; + } + + *io_reg_address = io_address; + *io_reg_size = io_size; + *irq_no = irq; + + rc = EOK; +leave: + async_hangup(parent_phone); + + return rc; +} +/*----------------------------------------------------------------------------*/ +/** Call the PCI driver with a request to enable interrupts + * + * @param[in] device Device asking for interrupts + * @return Error code. + */ +int pci_enable_interrupts(ddf_dev_t *device) +{ + int parent_phone = devman_parent_device_connect(device->handle, + IPC_FLAG_BLOCKING); + bool enabled = hw_res_enable_interrupt(parent_phone); + async_hangup(parent_phone); + return enabled ? EOK : EIO; +} +/*----------------------------------------------------------------------------*/ +/** Call the PCI driver with a request to clear legacy support register + * + * @param[in] device Device asking to disable interrupts + * @return Error code. + */ +int pci_disable_legacy(ddf_dev_t *device) +{ + assert(device); + int parent_phone = + devman_parent_device_connect(device->handle, IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + + /* See UHCI design guide for these values, + * write all WC bits in USB legacy register */ + sysarg_t address = 0xc0; + sysarg_t value = 0x8f00; + + int rc = async_req_3_0(parent_phone, DEV_IFACE_ID(PCI_DEV_IFACE), + IPC_M_CONFIG_SPACE_WRITE_16, address, value); + async_hangup(parent_phone); + + return rc; +} +/*----------------------------------------------------------------------------*/ +/** + * @} + */ + +/** + * @} + */ Index: uspace/drv/uhci-hcd/pci.h =================================================================== --- uspace/drv/uhci-hcd/pci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/pci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,48 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver PCI helper functions + */ +#ifndef DRV_UHCI_PCI_H +#define DRV_UHCI_PCI_H + +#include + +int pci_get_my_registers(ddf_dev_t *, uintptr_t *, size_t *, int *); +int pci_enable_interrupts(ddf_dev_t *); +int pci_disable_legacy(ddf_dev_t *); + +#endif +/** + * @} + */ + Index: uspace/drv/uhci-hcd/root_hub.c =================================================================== --- uspace/drv/uhci-hcd/root_hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/root_hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,81 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhci + * @{ + */ +/** @file + * @brief UHCI driver + */ +#include +#include +#include +#include + +#include + +#include "root_hub.h" + +/** Root hub initialization + * @param[in] instance RH structure to initialize + * @param[in] fun DDF function representing UHCI root hub + * @param[in] reg_addr Address of root hub status and control registers. + * @param[in] reg_size Size of accessible address space. + * @return Error code. + */ +int rh_init(rh_t *instance, ddf_fun_t *fun, uintptr_t reg_addr, size_t reg_size) +{ + assert(fun); + + char *match_str = NULL; + int ret = asprintf(&match_str, "usb&uhci&root-hub"); + if (ret < 0) { + usb_log_error("Failed to create root hub match string.\n"); + return ENOMEM; + } + + ret = ddf_fun_add_match_id(fun, match_str, 100); + if (ret != EOK) { + usb_log_error("Failed(%d) to add root hub match id: %s\n", + ret, str_error(ret)); + return ret; + } + + hw_resource_list_t *resource_list = &instance->resource_list; + resource_list->count = 1; + resource_list->resources = &instance->io_regs; + assert(resource_list->resources); + instance->io_regs.type = IO_RANGE; + instance->io_regs.res.io_range.address = reg_addr; + instance->io_regs.res.io_range.size = reg_size; + instance->io_regs.res.io_range.endianness = LITTLE_ENDIAN; + + return EOK; +} +/** + * @} + */ Index: uspace/drv/uhci-hcd/root_hub.h =================================================================== --- uspace/drv/uhci-hcd/root_hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/root_hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,52 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbuhci + * @{ + */ +/** @file + * @brief UHCI driver + */ +#ifndef DRV_UHCI_UHCI_RH_H +#define DRV_UHCI_UHCI_RH_H + +#include +#include + +typedef struct rh { + hw_resource_list_t resource_list; + hw_resource_t io_regs; +} rh_t; + +int rh_init( + rh_t *instance, ddf_fun_t *fun, uintptr_t reg_addr, size_t reg_size); + +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/transfer_list.c =================================================================== --- uspace/drv/uhci-hcd/transfer_list.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/transfer_list.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,228 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver transfer list implementation + */ +#include +#include + +#include "transfer_list.h" + +static void transfer_list_remove_batch( + transfer_list_t *instance, usb_transfer_batch_t *batch); +/*----------------------------------------------------------------------------*/ +/** Initialize transfer list structures. + * + * @param[in] instance Memory place to use. + * @param[in] name Name of the new list. + * @return Error code + * + * Allocates memory for internal qh_t structure. + */ +int transfer_list_init(transfer_list_t *instance, const char *name) +{ + assert(instance); + instance->name = name; + instance->queue_head = malloc32(sizeof(qh_t)); + if (!instance->queue_head) { + usb_log_error("Failed to allocate queue head.\n"); + return ENOMEM; + } + instance->queue_head_pa = addr_to_phys(instance->queue_head); + usb_log_debug2("Transfer list %s setup with QH: %p(%p).\n", + name, instance->queue_head, instance->queue_head_pa); + + qh_init(instance->queue_head); + list_initialize(&instance->batch_list); + fibril_mutex_initialize(&instance->guard); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Set the next list in transfer list chain. + * + * @param[in] instance List to lead. + * @param[in] next List to append. + * @return Error code + * + * Does not check whether this replaces an existing list . + */ +void transfer_list_set_next(transfer_list_t *instance, transfer_list_t *next) +{ + assert(instance); + assert(next); + if (!instance->queue_head) + return; + /* Set both queue_head.next to point to the follower */ + qh_set_next_qh(instance->queue_head, next->queue_head_pa); +} +/*----------------------------------------------------------------------------*/ +/** Submit transfer batch to the list and queue. + * + * @param[in] instance List to use. + * @param[in] batch Transfer batch to submit. + * @return Error code + * + * The batch is added to the end of the list and queue. + */ +void transfer_list_add_batch( + transfer_list_t *instance, usb_transfer_batch_t *batch) +{ + assert(instance); + assert(batch); + usb_log_debug2("Queue %s: Adding batch(%p).\n", instance->name, batch); + + fibril_mutex_lock(&instance->guard); + + qh_t *last_qh = NULL; + /* Add to the hardware queue. */ + if (list_empty(&instance->batch_list)) { + /* There is nothing scheduled */ + last_qh = instance->queue_head; + } else { + /* There is something scheduled */ + usb_transfer_batch_t *last = list_get_instance( + instance->batch_list.prev, usb_transfer_batch_t, link); + last_qh = batch_qh(last); + } + const uint32_t pa = addr_to_phys(batch_qh(batch)); + assert((pa & LINK_POINTER_ADDRESS_MASK) == pa); + + /* keep link */ + batch_qh(batch)->next = last_qh->next; + qh_set_next_qh(last_qh, pa); + + asm volatile ("": : :"memory"); + + /* Add to the driver list */ + list_append(&batch->link, &instance->batch_list); + + usb_transfer_batch_t *first = list_get_instance( + instance->batch_list.next, usb_transfer_batch_t, link); + usb_log_debug("Batch(%p) added to queue %s, first is %p.\n", + batch, instance->name, first); + fibril_mutex_unlock(&instance->guard); +} +/*----------------------------------------------------------------------------*/ +/** Check list for finished batches. + * + * @param[in] instance List to use. + * @return Error code + * + * Creates a local list of finished batches and calls next_step on each and + * every one. This is safer because next_step may theoretically access + * this transfer list leading to the deadlock if its done inline. + */ +void transfer_list_remove_finished(transfer_list_t *instance, link_t *done) +{ + assert(instance); + assert(done); + + fibril_mutex_lock(&instance->guard); + link_t *current = instance->batch_list.next; + while (current != &instance->batch_list) { + link_t *next = current->next; + usb_transfer_batch_t *batch = + list_get_instance(current, usb_transfer_batch_t, link); + + if (batch_is_complete(batch)) { + /* Save for post-processing */ + transfer_list_remove_batch(instance, batch); + list_append(current, done); + } + current = next; + } + fibril_mutex_unlock(&instance->guard); + +} +/*----------------------------------------------------------------------------*/ +/** Walk the list and abort all batches. + * + * @param[in] instance List to use. + */ +void transfer_list_abort_all(transfer_list_t *instance) +{ + fibril_mutex_lock(&instance->guard); + while (!list_empty(&instance->batch_list)) { + link_t *current = instance->batch_list.next; + usb_transfer_batch_t *batch = + list_get_instance(current, usb_transfer_batch_t, link); + transfer_list_remove_batch(instance, batch); + usb_transfer_batch_finish(batch, EIO); + } + fibril_mutex_unlock(&instance->guard); +} +/*----------------------------------------------------------------------------*/ +/** Remove a transfer batch from the list and queue. + * + * @param[in] instance List to use. + * @param[in] batch Transfer batch to remove. + * @return Error code + * + * Does not lock the transfer list, caller is responsible for that. + */ +void transfer_list_remove_batch( + transfer_list_t *instance, usb_transfer_batch_t *batch) +{ + assert(instance); + assert(instance->queue_head); + assert(batch); + assert(batch_qh(batch)); + assert(fibril_mutex_is_locked(&instance->guard)); + + usb_log_debug2( + "Queue %s: removing batch(%p).\n", instance->name, batch); + + const char *qpos = NULL; + /* Remove from the hardware queue */ + if (instance->batch_list.next == &batch->link) { + /* I'm the first one here */ + assert((instance->queue_head->next & LINK_POINTER_ADDRESS_MASK) + == addr_to_phys(batch_qh(batch))); + instance->queue_head->next = batch_qh(batch)->next; + qpos = "FIRST"; + } else { + usb_transfer_batch_t *prev = + list_get_instance( + batch->link.prev, usb_transfer_batch_t, link); + assert((batch_qh(prev)->next & LINK_POINTER_ADDRESS_MASK) + == addr_to_phys(batch_qh(batch))); + batch_qh(prev)->next = batch_qh(batch)->next; + qpos = "NOT FIRST"; + } + asm volatile ("": : :"memory"); + /* Remove from the batch list */ + list_remove(&batch->link); + usb_log_debug("Batch(%p) removed (%s) from %s, next %x.\n", + batch, qpos, instance->name, batch_qh(batch)->next); +} +/** + * @} + */ Index: uspace/drv/uhci-hcd/transfer_list.h =================================================================== --- uspace/drv/uhci-hcd/transfer_list.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/transfer_list.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,75 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcihc + * @{ + */ +/** @file + * @brief UHCI driver transfer list structure + */ +#ifndef DRV_UHCI_TRANSFER_LIST_H +#define DRV_UHCI_TRANSFER_LIST_H + +#include + +#include "batch.h" +#include "hw_struct/queue_head.h" + +typedef struct transfer_list +{ + fibril_mutex_t guard; + qh_t *queue_head; + uint32_t queue_head_pa; + const char *name; + link_t batch_list; +} transfer_list_t; + +/** Dispose transfer list structures. + * + * @param[in] instance Memory place to use. + * + * Frees memory for internal qh_t structure. + */ +static inline void transfer_list_fini(transfer_list_t *instance) +{ + assert(instance); + free32(instance->queue_head); +} + +int transfer_list_init(transfer_list_t *instance, const char *name); + +void transfer_list_set_next(transfer_list_t *instance, transfer_list_t *next); + +void transfer_list_add_batch(transfer_list_t *instance, usb_transfer_batch_t *batch); + +void transfer_list_remove_finished(transfer_list_t *instance, link_t *done); + +void transfer_list_abort_all(transfer_list_t *instance); +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/transfers.c =================================================================== --- uspace/drv/uhci-hcd/transfers.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/transfers.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,160 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +#include +#include + +#include "uhci.h" + +static int enqueue_transfer_out(device_t *dev, + usb_target_t target, usb_transfer_type_t transfer_type, + void *buffer, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + printf(NAME ": transfer OUT [%d.%d (%s); %zu]\n", + target.address, target.endpoint, + usb_str_transfer_type(transfer_type), + size); + + return ENOTSUP; +} + +static int enqueue_transfer_setup(device_t *dev, + usb_target_t target, usb_transfer_type_t transfer_type, + void *buffer, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + printf(NAME ": transfer SETUP [%d.%d (%s); %zu]\n", + target.address, target.endpoint, + usb_str_transfer_type(transfer_type), + size); + + return ENOTSUP; +} + +static int enqueue_transfer_in(device_t *dev, + usb_target_t target, usb_transfer_type_t transfer_type, + void *buffer, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + printf(NAME ": transfer IN [%d.%d (%s); %zu]\n", + target.address, target.endpoint, + usb_str_transfer_type(transfer_type), + size); + + return ENOTSUP; +} + + +static int get_address(device_t *dev, devman_handle_t handle, + usb_address_t *address) +{ + return ENOTSUP; +} + +static int interrupt_out(device_t *dev, usb_target_t target, + void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + return enqueue_transfer_out(dev, target, USB_TRANSFER_INTERRUPT, + data, size, + callback, arg); +} + +static int interrupt_in(device_t *dev, usb_target_t target, + void *data, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + return enqueue_transfer_in(dev, target, USB_TRANSFER_INTERRUPT, + data, size, + callback, arg); +} + +static int control_write_setup(device_t *dev, usb_target_t target, + void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + return enqueue_transfer_setup(dev, target, USB_TRANSFER_CONTROL, + data, size, + callback, arg); +} + +static int control_write_data(device_t *dev, usb_target_t target, + void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + return enqueue_transfer_out(dev, target, USB_TRANSFER_CONTROL, + data, size, + callback, arg); +} + +static int control_write_status(device_t *dev, usb_target_t target, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + return enqueue_transfer_in(dev, target, USB_TRANSFER_CONTROL, + NULL, 0, + callback, arg); +} + +static int control_read_setup(device_t *dev, usb_target_t target, + void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + return enqueue_transfer_setup(dev, target, USB_TRANSFER_CONTROL, + data, size, + callback, arg); +} + +static int control_read_data(device_t *dev, usb_target_t target, + void *data, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + return enqueue_transfer_in(dev, target, USB_TRANSFER_CONTROL, + data, size, + callback, arg); +} + +static int control_read_status(device_t *dev, usb_target_t target, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + return enqueue_transfer_out(dev, target, USB_TRANSFER_CONTROL, + NULL, 0, + callback, arg); +} + + +usbhc_iface_t uhci_iface = { + .tell_address = get_address, + .interrupt_out = interrupt_out, + .interrupt_in = interrupt_in, + .control_write_setup = control_write_setup, + .control_write_data = control_write_data, + .control_write_status = control_write_status, + .control_read_setup = control_read_setup, + .control_read_data = control_read_data, + .control_read_status = control_read_status +}; Index: uspace/drv/uhci-hcd/uhci-hcd.ma =================================================================== --- uspace/drv/uhci-hcd/uhci-hcd.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/uhci-hcd.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,21 @@ +10 pci/ven=8086&dev=7020 +10 pci/ven=8086&dev=7112 + +10 pci/ven=8086&dev=27c8 +10 pci/ven=8086&dev=27c9 +10 pci/ven=8086&dev=27ca +10 pci/ven=8086&dev=27cb + + +10 pci/ven=8086&dev=2830 +10 pci/ven=8086&dev=2831 +10 pci/ven=8086&dev=2832 +10 pci/ven=8086&dev=2834 +10 pci/ven=8086&dev=2835 + +10 pci/ven=8086&dev=2934 +10 pci/ven=8086&dev=2935 +10 pci/ven=8086&dev=2936 +10 pci/ven=8086&dev=2937 +10 pci/ven=8086&dev=2938 +10 pci/ven=8086&dev=2939 Index: uspace/drv/uhci-hcd/uhci.c =================================================================== --- uspace/drv/uhci-hcd/uhci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/uhci.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,246 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbuhci + * @{ + */ +/** @file + * @brief UHCI driver + */ +#include +#include +#include +#include +#include +#include + +#include "uhci.h" +#include "iface.h" +#include "pci.h" + +/** IRQ handling callback, identifies device + * + * @param[in] dev DDF instance of the device to use. + * @param[in] iid (Unused). + * @param[in] call Pointer to the call that represents interrupt. + */ +static void irq_handler(ddf_dev_t *dev, ipc_callid_t iid, ipc_call_t *call) +{ + assert(dev); + hc_t *hc = &((uhci_t*)dev->driver_data)->hc; + uint16_t status = IPC_GET_ARG1(*call); + assert(hc); + hc_interrupt(hc, status); +} +/*----------------------------------------------------------------------------*/ +/** Get address of the device identified by handle. + * + * @param[in] dev DDF instance of the device to use. + * @param[in] iid (Unused). + * @param[in] call Pointer to the call that represents interrupt. + */ +static int usb_iface_get_address( + ddf_fun_t *fun, devman_handle_t handle, usb_address_t *address) +{ + assert(fun); + usb_device_keeper_t *manager = &((uhci_t*)fun->dev->driver_data)->hc.manager; + + usb_address_t addr = usb_device_keeper_find(manager, handle); + if (addr < 0) { + return addr; + } + + if (address != NULL) { + *address = addr; + } + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Gets handle of the respective hc (this or parent device). + * + * @param[in] root_hub_fun Root hub function seeking hc handle. + * @param[out] handle Place to write the handle. + * @return Error code. + */ +static int usb_iface_get_hc_handle( + ddf_fun_t *fun, devman_handle_t *handle) +{ + assert(handle); + ddf_fun_t *hc_fun = ((uhci_t*)fun->dev->driver_data)->hc_fun; + assert(hc_fun != NULL); + + *handle = hc_fun->handle; + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** This iface is generic for both RH and HC. */ +static usb_iface_t usb_iface = { + .get_hc_handle = usb_iface_get_hc_handle, + .get_address = usb_iface_get_address +}; +/*----------------------------------------------------------------------------*/ +static ddf_dev_ops_t hc_ops = { +// .interfaces[USB_DEV_IFACE] = &usb_iface, + .interfaces[USBHC_DEV_IFACE] = &hc_iface, /* see iface.h/c */ +}; +/*----------------------------------------------------------------------------*/ +/** Get root hub hw resources (I/O registers). + * + * @param[in] fun Root hub function. + * @return Pointer to the resource list used by the root hub. + */ +static hw_resource_list_t *get_resource_list(ddf_fun_t *fun) +{ + assert(fun); + return &((rh_t*)fun->driver_data)->resource_list; +} +/*----------------------------------------------------------------------------*/ +static hw_res_ops_t hw_res_iface = { + .get_resource_list = get_resource_list, + .enable_interrupt = NULL +}; +/*----------------------------------------------------------------------------*/ +static ddf_dev_ops_t rh_ops = { + .interfaces[USB_DEV_IFACE] = &usb_iface, + .interfaces[HW_RES_DEV_IFACE] = &hw_res_iface +}; +/*----------------------------------------------------------------------------*/ +/** Initialize hc and rh ddf structures and their respective drivers. + * + * @param[in] instance UHCI structure to use. + * @param[in] device DDF instance of the device to use. + * + * This function does all the preparatory work for hc and rh drivers: + * - gets device hw resources + * - disables UHCI legacy support + * - asks for interrupt + * - registers interrupt handler + */ +int uhci_init(uhci_t *instance, ddf_dev_t *device) +{ + assert(instance); + instance->hc_fun = NULL; + instance->rh_fun = NULL; +#define CHECK_RET_DEST_FUN_RETURN(ret, message...) \ +if (ret != EOK) { \ + usb_log_error(message); \ + if (instance->hc_fun) \ + ddf_fun_destroy(instance->hc_fun); \ + if (instance->rh_fun) \ + ddf_fun_destroy(instance->rh_fun); \ + return ret; \ +} + + uintptr_t io_reg_base = 0; + size_t io_reg_size = 0; + int irq = 0; + + int ret = + pci_get_my_registers(device, &io_reg_base, &io_reg_size, &irq); + CHECK_RET_DEST_FUN_RETURN(ret, + "Failed(%d) to get I/O addresses:.\n", ret, device->handle); + usb_log_debug("I/O regs at 0x%X (size %zu), IRQ %d.\n", + io_reg_base, io_reg_size, irq); + + ret = pci_disable_legacy(device); + CHECK_RET_DEST_FUN_RETURN(ret, + "Failed(%d) to disable legacy USB: %s.\n", ret, str_error(ret)); + + bool interrupts = false; +#ifdef CONFIG_USBHC_NO_INTERRUPTS + usb_log_warning("Interrupts disabled in OS config, " \ + "falling back to polling.\n"); +#else + ret = pci_enable_interrupts(device); + if (ret != EOK) { + usb_log_warning("Failed to enable interrupts: %s.\n", + str_error(ret)); + usb_log_info("HW interrupts not available, " \ + "falling back to polling.\n"); + } else { + usb_log_debug("Hw interrupts enabled.\n"); + interrupts = true; + } +#endif + + instance->hc_fun = ddf_fun_create(device, fun_exposed, "uhci-hc"); + ret = (instance->hc_fun == NULL) ? ENOMEM : EOK; + CHECK_RET_DEST_FUN_RETURN(ret, + "Failed(%d) to create HC function.\n", ret); + + ret = hc_init(&instance->hc, instance->hc_fun, + (void*)io_reg_base, io_reg_size, interrupts); + CHECK_RET_DEST_FUN_RETURN(ret, "Failed(%d) to init uhci-hcd.\n", ret); + instance->hc_fun->ops = &hc_ops; + instance->hc_fun->driver_data = &instance->hc; + ret = ddf_fun_bind(instance->hc_fun); + CHECK_RET_DEST_FUN_RETURN(ret, + "Failed(%d) to bind UHCI device function: %s.\n", + ret, str_error(ret)); +#undef CHECK_RET_HC_RETURN + +#define CHECK_RET_FINI_RETURN(ret, message...) \ +if (ret != EOK) { \ + usb_log_error(message); \ + if (instance->hc_fun) \ + ddf_fun_destroy(instance->hc_fun); \ + if (instance->rh_fun) \ + ddf_fun_destroy(instance->rh_fun); \ + hc_fini(&instance->hc); \ + return ret; \ +} + + /* It does no harm if we register this on polling */ + ret = register_interrupt_handler(device, irq, irq_handler, + &instance->hc.interrupt_code); + CHECK_RET_FINI_RETURN(ret, + "Failed(%d) to register interrupt handler.\n", ret); + + instance->rh_fun = ddf_fun_create(device, fun_inner, "uhci-rh"); + ret = (instance->rh_fun == NULL) ? ENOMEM : EOK; + CHECK_RET_FINI_RETURN(ret, + "Failed(%d) to create root hub function.\n", ret); + + ret = rh_init(&instance->rh, instance->rh_fun, + (uintptr_t)instance->hc.registers + 0x10, 4); + CHECK_RET_FINI_RETURN(ret, + "Failed(%d) to setup UHCI root hub.\n", ret); + + instance->rh_fun->ops = &rh_ops; + instance->rh_fun->driver_data = &instance->rh; + ret = ddf_fun_bind(instance->rh_fun); + CHECK_RET_FINI_RETURN(ret, + "Failed(%d) to register UHCI root hub.\n", ret); + + return EOK; +#undef CHECK_RET_FINI_RETURN +} +/** + * @} + */ Index: uspace/drv/uhci-hcd/uhci.h =================================================================== --- uspace/drv/uhci-hcd/uhci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/uhci.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,56 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbuhci + * @{ + */ +/** @file + * @brief UHCI driver main structure for both host controller and root-hub. + */ +#ifndef DRV_UHCI_UHCI_H +#define DRV_UHCI_UHCI_H +#include +#include + +#include "hc.h" +#include "root_hub.h" + +typedef struct uhci { + ddf_fun_t *hc_fun; + ddf_fun_t *rh_fun; + + hc_t hc; + rh_t rh; +} uhci_t; + +int uhci_init(uhci_t *instance, ddf_dev_t *device); + +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/utils/malloc32.h =================================================================== --- uspace/drv/uhci-hcd/utils/malloc32.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/utils/malloc32.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,111 @@ +/* + * Copyright (c) 2010 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup usb + * @{ + */ +/** @file + * @brief UHCI driver + */ +#ifndef DRV_UHCI_TRANSLATOR_H +#define DRV_UHCI_TRANSLATOR_H + +#include +#include +#include +#include + +#include "slab.h" + +#define UHCI_STRCUTURES_ALIGNMENT 16 +#define UHCI_REQUIRED_PAGE_SIZE 4096 + + +/** Get physical address translation + * + * @param[in] addr Virtual address to translate + * @return Physical address if exists, NULL otherwise. + */ +static inline uintptr_t addr_to_phys(void *addr) +{ + if (addr == NULL) + return 0; + + uintptr_t result; + const int ret = as_get_physical_mapping(addr, &result); + assert(ret == EOK); + + if (ret != EOK) + return 0; + return (result | ((uintptr_t)addr & 0xfff)); +} +/*----------------------------------------------------------------------------*/ +/** Physical mallocator simulator + * + * @param[in] size Size of the required memory space + * @return Address of the alligned and big enough memory place, NULL on failure. + */ +static inline void * malloc32(size_t size) { + if (size <= SLAB_ELEMENT_SIZE) + return slab_malloc_g(); + assert(false); + return memalign(UHCI_STRCUTURES_ALIGNMENT, size); +} +/*----------------------------------------------------------------------------*/ +/** Physical mallocator simulator + * + * @param[in] addr Address of the place allocated by malloc32 + */ +static inline void free32(void *addr) { + if (!addr) + return; + if (slab_in_range_g(addr)) + return slab_free_g(addr); + free(addr); +} +/*----------------------------------------------------------------------------*/ +/** Create 4KB page mapping + * + * @return Address of the mapped page, NULL on failure. + */ +static inline void * get_page(void) +{ + void *free_address = as_get_mappable_page(UHCI_REQUIRED_PAGE_SIZE); + assert(free_address); /* TODO: remove this assert */ + if (free_address == 0) + return NULL; + void *ret = as_area_create(free_address, UHCI_REQUIRED_PAGE_SIZE, + AS_AREA_READ | AS_AREA_WRITE); + if (ret != free_address) + return NULL; + return ret; +} + +#endif +/** + * @} + */ Index: uspace/drv/uhci-hcd/utils/slab.c =================================================================== --- uspace/drv/uhci-hcd/utils/slab.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/utils/slab.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,141 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup usb + * @{ + */ +/** @file + * @brief UHCI driver + */ +#include +#include +#include +#include + +#include "slab.h" + +#define SLAB_SIZE (PAGE_SIZE * 16) +#define SLAB_ELEMENT_COUNT (SLAB_SIZE / SLAB_ELEMENT_SIZE) + +typedef struct slab { + void *page; + bool slabs[SLAB_ELEMENT_COUNT]; + fibril_mutex_t guard; +} slab_t; + +static slab_t global_slab; + +static void * slab_malloc(slab_t *intance); +static bool slab_in_range(slab_t *intance, void *addr); +static void slab_free(slab_t *intance, void *addr); +/*----------------------------------------------------------------------------*/ +void * slab_malloc_g(void) +{ + return slab_malloc(&global_slab); +} +/*----------------------------------------------------------------------------*/ +void slab_free_g(void *addr) +{ + return slab_free(&global_slab, addr); +} +/*----------------------------------------------------------------------------*/ +bool slab_in_range_g(void *addr) +{ + return slab_in_range(&global_slab, addr); +} +/*----------------------------------------------------------------------------*/ +static void slab_init(slab_t *instance) +{ + static FIBRIL_MUTEX_INITIALIZE(init_mutex); + assert(instance); + fibril_mutex_lock(&init_mutex); + if (instance->page != NULL) { + /* already initialized */ + fibril_mutex_unlock(&init_mutex); + return; + } + fibril_mutex_initialize(&instance->guard); + size_t i = 0; + for (;i < SLAB_ELEMENT_COUNT; ++i) { + instance->slabs[i] = true; + } + instance->page = as_get_mappable_page(SLAB_SIZE); + if (instance->page != NULL) { + void* ret = + as_area_create(instance->page, SLAB_SIZE, AS_AREA_READ | AS_AREA_WRITE); + if (ret != instance->page) { + instance->page = NULL; + } + } + memset(instance->page, 0xa, SLAB_SIZE); + fibril_mutex_unlock(&init_mutex); + usb_log_debug2("SLAB initialized at %p.\n", instance->page); +} +/*----------------------------------------------------------------------------*/ +static void * slab_malloc(slab_t *instance) { + assert(instance); + if (instance->page == NULL) + slab_init(instance); + + fibril_mutex_lock(&instance->guard); + void *addr = NULL; + size_t i = 0; + for (; i < SLAB_ELEMENT_COUNT; ++i) { + if (instance->slabs[i]) { + instance->slabs[i] = false; + addr = (instance->page + (i * SLAB_ELEMENT_SIZE)); + break; + } + } + fibril_mutex_unlock(&instance->guard); + + return addr; +} +/*----------------------------------------------------------------------------*/ +static bool slab_in_range(slab_t *instance, void *addr) { + assert(instance); + bool in_range = (instance->page != NULL) && + (addr >= instance->page) && (addr < instance->page + SLAB_SIZE); + return in_range; +} +/*----------------------------------------------------------------------------*/ +static void slab_free(slab_t *instance, void *addr) +{ + assert(instance); + assert(slab_in_range(instance, addr)); + memset(addr, 0xa, SLAB_ELEMENT_SIZE); + + const size_t pos = (addr - instance->page) / SLAB_ELEMENT_SIZE; + + fibril_mutex_lock(&instance->guard); + assert(instance->slabs[pos] == false); + instance->slabs[pos] = true; + fibril_mutex_unlock(&instance->guard); +} +/** + * @} + */ Index: uspace/drv/uhci-hcd/utils/slab.h =================================================================== --- uspace/drv/uhci-hcd/utils/slab.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-hcd/utils/slab.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,50 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup usb + * @{ + */ +/** @file + * @brief UHCI driver + */ +#ifndef DRV_UHCI_SLAB_H +#define DRV_UHCI_SLAB_H + +#include + +#define SLAB_ELEMENT_SIZE 1024 + +void * slab_malloc_g(void); + +void slab_free_g(void *addr); + +bool slab_in_range_g(void *addr); + +#endif +/** + * @} + */ Index: uspace/drv/uhci-rhd/Makefile =================================================================== --- uspace/drv/uhci-rhd/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-rhd/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,39 @@ +# +# Copyright (c) 2010 Jan Vesely +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBS = $(LIBDRV_PREFIX)/libdrv.a $(LIBUSB_PREFIX)/libusb.a +EXTRA_CFLAGS += -I$(LIBDRV_PREFIX)/include -I$(LIBUSB_PREFIX)/include -I. +BINARY = uhci-rhd + +SOURCES = \ + main.c \ + port.c \ + root_hub.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/uhci-rhd/main.c =================================================================== --- uspace/drv/uhci-rhd/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-rhd/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,204 @@ +/* + * Copyright (c) 2011 Vojtech Horky, Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcirh + * @{ + */ +/** @file + * @brief UHCI root hub initialization routines + */ +#include +#include +#include +#include +#include +#include +#include +#include + +#include "root_hub.h" + +#define NAME "uhci-rhd" +static int hc_get_my_registers(ddf_dev_t *dev, + uintptr_t *io_reg_address, size_t *io_reg_size); +#if 0 +/*----------------------------------------------------------------------------*/ +static int usb_iface_get_hc_handle(ddf_fun_t *fun, devman_handle_t *handle) +{ + assert(fun); + assert(fun->driver_data); + assert(handle); + + *handle = ((uhci_root_hub_t*)fun->driver_data)->hc_handle; + + return EOK; +} +/*----------------------------------------------------------------------------*/ +static usb_iface_t uhci_rh_usb_iface = { + .get_hc_handle = usb_iface_get_hc_handle, + .get_address = usb_iface_get_address_hub_impl +}; +/*----------------------------------------------------------------------------*/ +static ddf_dev_ops_t uhci_rh_ops = { + .interfaces[USB_DEV_IFACE] = &uhci_rh_usb_iface, +}; +#endif +/*----------------------------------------------------------------------------*/ +/** Initialize a new ddf driver instance of UHCI root hub. + * + * @param[in] device DDF instance of the device to initialize. + * @return Error code. + */ +static int uhci_rh_add_device(ddf_dev_t *device) +{ + if (!device) + return ENOTSUP; + + usb_log_debug2("%s called device %d\n", __FUNCTION__, device->handle); + + //device->ops = &uhci_rh_ops; + uintptr_t io_regs = 0; + size_t io_size = 0; + + int ret = hc_get_my_registers(device, &io_regs, &io_size); + if (ret != EOK) { + usb_log_error("Failed to get registers from parent HC: %s.\n", + str_error(ret)); + } + usb_log_debug("I/O regs at %#X (size %zu).\n", io_regs, io_size); + + uhci_root_hub_t *rh = malloc(sizeof(uhci_root_hub_t)); + if (!rh) { + usb_log_error("Failed to allocate driver instance.\n"); + return ENOMEM; + } + + ret = uhci_root_hub_init(rh, (void*)io_regs, io_size, device); + if (ret != EOK) { + usb_log_error("Failed to initialize driver instance: %s.\n", + str_error(ret)); + free(rh); + return ret; + } + + device->driver_data = rh; + usb_log_info("Controlling root hub `%s' (%llu).\n", + device->name, device->handle); + return EOK; +} +/*----------------------------------------------------------------------------*/ +static driver_ops_t uhci_rh_driver_ops = { + .add_device = uhci_rh_add_device, +}; +/*----------------------------------------------------------------------------*/ +static driver_t uhci_rh_driver = { + .name = NAME, + .driver_ops = &uhci_rh_driver_ops +}; +/*----------------------------------------------------------------------------*/ +/** Initialize global driver structures (NONE). + * + * @param[in] argc Nmber of arguments in argv vector (ignored). + * @param[in] argv Cmdline argument vector (ignored). + * @return Error code. + * + * Driver debug level is set here. + */ +int main(int argc, char *argv[]) +{ + printf(NAME ": HelenOS UHCI root hub driver.\n"); + + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + + return ddf_driver_main(&uhci_rh_driver); +} +/*----------------------------------------------------------------------------*/ +/** Get address of I/O registers. + * + * @param[in] dev Device asking for the addresses. + * @param[out] io_reg_address Base address of the memory range. + * @param[out] io_reg_size Size of the memory range. + * @return Error code. + */ +int hc_get_my_registers( + ddf_dev_t *dev, uintptr_t *io_reg_address, size_t *io_reg_size) +{ + assert(dev != NULL); + + int parent_phone = devman_parent_device_connect(dev->handle, + IPC_FLAG_BLOCKING); + if (parent_phone < 0) { + return parent_phone; + } + + int rc; + + hw_resource_list_t hw_resources; + rc = hw_res_get_resource_list(parent_phone, &hw_resources); + if (rc != EOK) { + goto leave; + } + + uintptr_t io_address = 0; + size_t io_size = 0; + bool io_found = false; + + size_t i; + for (i = 0; i < hw_resources.count; i++) { + hw_resource_t *res = &hw_resources.resources[i]; + switch (res->type) + { + case IO_RANGE: + io_address = (uintptr_t) res->res.io_range.address; + io_size = res->res.io_range.size; + io_found = true; + + default: + break; + } + } + + if (!io_found) { + rc = ENOENT; + goto leave; + } + + if (io_reg_address != NULL) { + *io_reg_address = io_address; + } + if (io_reg_size != NULL) { + *io_reg_size = io_size; + } + rc = EOK; + +leave: + async_hangup(parent_phone); + return rc; +} +/** + * @} + */ Index: uspace/drv/uhci-rhd/port.c =================================================================== --- uspace/drv/uhci-rhd/port.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-rhd/port.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,348 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcirh + * @{ + */ +/** @file + * @brief UHCI root hub port routines + */ +#include /* pio_read and pio_write */ +#include +#include +#include + +#include /* usb_address_t */ +#include +#include + +#include "port.h" + +static int uhci_port_new_device(uhci_port_t *port, usb_speed_t speed); +static int uhci_port_remove_device(uhci_port_t *port); +static int uhci_port_set_enabled(uhci_port_t *port, bool enabled); +static int uhci_port_check(void *port); +static int uhci_port_reset_enable(int portno, void *arg); +static void uhci_port_print_status( + uhci_port_t *port, const port_status_t value); + +/** Register reading helper function. + * + * @param[in] port Structure to use. + * @return Error code. (Always EOK) + */ +static inline port_status_t uhci_port_read_status(uhci_port_t *port) +{ + assert(port); + return pio_read_16(port->address); +} +/*----------------------------------------------------------------------------*/ +/** Register writing helper function. + * + * @param[in] port Structure to use. + * @param[in] value New register value. + * @return Error code. (Always EOK) + */ +static inline void uhci_port_write_status( + uhci_port_t *port, port_status_t value) +{ + assert(port); + pio_write_16(port->address, value); +} + +/*----------------------------------------------------------------------------*/ +/** Initialize UHCI root hub port instance. + * + * @param[in] port Memory structure to use. + * @param[in] addr Address of I/O register. + * @param[in] number Port number. + * @param[in] usec Polling interval. + * @param[in] rh Pointer to ddf instance fo the root hub driver. + * @return Error code. + * + * Creates and starts the polling fibril. + */ +int uhci_port_init(uhci_port_t *port, + port_status_t *address, unsigned number, unsigned usec, ddf_dev_t *rh) +{ + assert(port); + asprintf(&port->id_string, "Port (%p - %d)", port, number); + if (port->id_string == NULL) { + return ENOMEM; + } + + port->address = address; + port->number = number; + port->wait_period_usec = usec; + port->attached_device = 0; + port->rh = rh; + + int rc = usb_hc_connection_initialize_from_device( + &port->hc_connection, rh); + if (rc != EOK) { + usb_log_error("Failed to initialize connection to HC."); + return rc; + } + + port->checker = fibril_create(uhci_port_check, port); + if (port->checker == 0) { + usb_log_error("%s: failed to create polling fibril.", + port->id_string); + return ENOMEM; + } + + fibril_add_ready(port->checker); + usb_log_debug("%s: Started polling fibril(%x).\n", + port->id_string, port->checker); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Cleanup UHCI root hub port instance. + * + * @param[in] port Memory structure to use. + * + * Stops the polling fibril. + */ +void uhci_port_fini(uhci_port_t *port) +{ + assert(port); + free(port->id_string); + /* TODO: Kill fibril here */ + return; +} +/*----------------------------------------------------------------------------*/ +/** Periodically checks port status and reports new devices. + * + * @param[in] port Port structure to use. + * @return Error code. + */ +int uhci_port_check(void *port) +{ + uhci_port_t *instance = port; + assert(instance); + + while (1) { + async_usleep(instance->wait_period_usec); + + /* Read register value */ + port_status_t port_status = uhci_port_read_status(instance); + + /* Print the value if it's interesting */ + if (port_status & ~STATUS_ALWAYS_ONE) + uhci_port_print_status(instance, port_status); + + if ((port_status & STATUS_CONNECTED_CHANGED) == 0) + continue; + + usb_log_debug("%s: Connected change detected: %x.\n", + instance->id_string, port_status); + + int rc = + usb_hc_connection_open(&instance->hc_connection); + if (rc != EOK) { + usb_log_error("%s: Failed to connect to HC.", + instance->id_string); + continue; + } + + /* Remove any old device */ + if (instance->attached_device) { + usb_log_debug2("%s: Removing device.\n", + instance->id_string); + uhci_port_remove_device(instance); + } + + if ((port_status & STATUS_CONNECTED) != 0) { + /* New device */ + const usb_speed_t speed = + ((port_status & STATUS_LOW_SPEED) != 0) ? + USB_SPEED_LOW : USB_SPEED_FULL; + uhci_port_new_device(instance, speed); + } else { + /* Write one to WC bits, to ack changes */ + uhci_port_write_status(instance, port_status); + usb_log_debug("%s: status change ACK.\n", + instance->id_string); + } + + rc = usb_hc_connection_close(&instance->hc_connection); + if (rc != EOK) { + usb_log_error("%s: Failed to disconnect.", + instance->id_string); + } + } + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Callback for enabling port during adding a new device. + * + * @param portno Port number (unused). + * @param arg Pointer to uhci_port_t of port with the new device. + * @return Error code. + * + * Resets and enables the ub port. + */ +int uhci_port_reset_enable(int portno, void *arg) +{ + uhci_port_t *port = (uhci_port_t *) arg; + + usb_log_debug2("%s: new_device_enable_port.\n", port->id_string); + + /* + * The host then waits for at least 100 ms to allow completion of + * an insertion process and for power at the device to become stable. + */ + async_usleep(100000); + + /* + * Resets from root ports should be nominally 50ms + */ + { + usb_log_debug("%s: Reset Signal start.\n", port->id_string); + port_status_t port_status = uhci_port_read_status(port); + port_status |= STATUS_IN_RESET; + uhci_port_write_status(port, port_status); + async_usleep(50000); + port_status = uhci_port_read_status(port); + port_status &= ~STATUS_IN_RESET; + uhci_port_write_status(port, port_status); + usb_log_debug("%s: Reset Signal stop.\n", port->id_string); + } + + /* the reset recovery time 10ms */ + async_usleep(10000); + + /* Enable the port. */ + uhci_port_set_enabled(port, true); + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Initialize and report connected device. + * + * @param[in] port Port structure to use. + * @param[in] speed Detected speed. + * @return Error code. + * + * Uses libUSB function to do the actual work. + */ +int uhci_port_new_device(uhci_port_t *port, usb_speed_t speed) +{ + assert(port); + assert(usb_hc_connection_is_opened(&port->hc_connection)); + + usb_log_debug("%s: Detected new device.\n", port->id_string); + + usb_address_t dev_addr; + int rc = usb_hc_new_device_wrapper(port->rh, &port->hc_connection, + speed, uhci_port_reset_enable, port->number, port, + &dev_addr, &port->attached_device, NULL, NULL, NULL); + + if (rc != EOK) { + usb_log_error("%s: Failed(%d) to add device: %s.\n", + port->id_string, rc, str_error(rc)); + uhci_port_set_enabled(port, false); + return rc; + } + + usb_log_info("New device at port %u, address %d (handle %llu).\n", + port->number, dev_addr, port->attached_device); + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Remove device. + * + * @param[in] port Memory structure to use. + * @return Error code. + * + * Does not work, DDF does not support device removal. + * Does not even free used USB address (it would be dangerous if tis driver + * is still running). + */ +int uhci_port_remove_device(uhci_port_t *port) +{ + usb_log_error("%s: Don't know how to remove device %d.\n", + port->id_string, (unsigned int)port->attached_device); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Enable or disable root hub port. + * + * @param[in] port Port structure to use. + * @param[in] enabled Port status to set. + * @return Error code. (Always EOK) + */ +int uhci_port_set_enabled(uhci_port_t *port, bool enabled) +{ + assert(port); + + /* Read register value */ + port_status_t port_status = uhci_port_read_status(port); + + /* Set enabled bit */ + if (enabled) { + port_status |= STATUS_ENABLED; + } else { + port_status &= ~STATUS_ENABLED; + } + + /* Write new value. */ + uhci_port_write_status(port, port_status); + + usb_log_debug("%s: %sabled port.\n", + port->id_string, enabled ? "En" : "Dis"); + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Print the port status value in a human friendly way + * + * @param[in] port Port structure to use. + * @param[in] value Port register value to print. + * @return Error code. (Always EOK) + */ +void uhci_port_print_status(uhci_port_t *port, const port_status_t value) +{ + assert(port); + usb_log_debug2("%s Port status(%#x):%s%s%s%s%s%s%s%s%s%s%s.\n", + port->id_string, value, + (value & STATUS_SUSPEND) ? " SUSPENDED," : "", + (value & STATUS_RESUME) ? " IN RESUME," : "", + (value & STATUS_IN_RESET) ? " IN RESET," : "", + (value & STATUS_LINE_D_MINUS) ? " VD-," : "", + (value & STATUS_LINE_D_PLUS) ? " VD+," : "", + (value & STATUS_LOW_SPEED) ? " LOWSPEED," : "", + (value & STATUS_ENABLED_CHANGED) ? " ENABLED-CHANGE," : "", + (value & STATUS_ENABLED) ? " ENABLED," : "", + (value & STATUS_CONNECTED_CHANGED) ? " CONNECTED-CHANGE," : "", + (value & STATUS_CONNECTED) ? " CONNECTED," : "", + (value & STATUS_ALWAYS_ONE) ? " ALWAYS ONE" : " ERROR: NO ALWAYS ONE" + ); +} +/** + * @} + */ Index: uspace/drv/uhci-rhd/port.h =================================================================== --- uspace/drv/uhci-rhd/port.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-rhd/port.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,77 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcirh + * @{ + */ +/** @file + * @brief UHCI root hub port routines + */ +#ifndef DRV_UHCI_PORT_H +#define DRV_UHCI_PORT_H + +#include +#include +#include +#include /* usb_hc_connection_t */ + +typedef uint16_t port_status_t; +#define STATUS_CONNECTED (1 << 0) +#define STATUS_CONNECTED_CHANGED (1 << 1) +#define STATUS_ENABLED (1 << 2) +#define STATUS_ENABLED_CHANGED (1 << 3) +#define STATUS_LINE_D_PLUS (1 << 4) +#define STATUS_LINE_D_MINUS (1 << 5) +#define STATUS_RESUME (1 << 6) +#define STATUS_ALWAYS_ONE (1 << 7) + +#define STATUS_LOW_SPEED (1 << 8) +#define STATUS_IN_RESET (1 << 9) +#define STATUS_SUSPEND (1 << 12) + +typedef struct uhci_port +{ + char *id_string; + port_status_t *address; + unsigned number; + unsigned wait_period_usec; + usb_hc_connection_t hc_connection; + ddf_dev_t *rh; + devman_handle_t attached_device; + fid_t checker; +} uhci_port_t; + +int uhci_port_init( + uhci_port_t *port, port_status_t *address, unsigned number, + unsigned usec, ddf_dev_t *rh); + +void uhci_port_fini(uhci_port_t *port); + +#endif +/** + * @} + */ Index: uspace/drv/uhci-rhd/root_hub.c =================================================================== --- uspace/drv/uhci-rhd/root_hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-rhd/root_hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,100 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcirh + * @{ + */ +/** @file + * @brief UHCI root hub driver + */ +#include +#include +#include + +#include "root_hub.h" + +/** Initialize UHCI root hub instance. + * + * @param[in] instance Driver memory structure to use. + * @param[in] addr Address of I/O registers. + * @param[in] size Size of available I/O space. + * @param[in] rh Pointer to ddf instance of the root hub driver. + * @return Error code. + */ +int uhci_root_hub_init( + uhci_root_hub_t *instance, void *addr, size_t size, ddf_dev_t *rh) +{ + assert(instance); + assert(rh); + int ret; + + /* Allow access to root hub port registers */ + assert(sizeof(port_status_t) * UHCI_ROOT_HUB_PORT_COUNT <= size); + port_status_t *regs; + ret = pio_enable(addr, size, (void**)®s); + if (ret < 0) { + usb_log_error( + "Failed(%d) to gain access to port registers at %p\n", + ret, regs); + return ret; + } + + /* Initialize root hub ports */ + unsigned i = 0; + for (; i < UHCI_ROOT_HUB_PORT_COUNT; ++i) { + /* NOTE: mind pointer arithmetics here */ + ret = uhci_port_init( + &instance->ports[i], regs + i, i, ROOT_HUB_WAIT_USEC, rh); + if (ret != EOK) { + unsigned j = 0; + for (;j < i; ++j) + uhci_port_fini(&instance->ports[j]); + return ret; + } + } + + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** Cleanup UHCI root hub instance. + * + * @param[in] instance Root hub structure to use. + * @return Error code. + */ +int uhci_root_hub_fini(uhci_root_hub_t* instance) +{ + assert(instance); + unsigned i = 0; + for (; i < UHCI_ROOT_HUB_PORT_COUNT; ++i) { + uhci_port_fini(&instance->ports[i]); + } + return EOK; +} +/*----------------------------------------------------------------------------*/ +/** + * @} + */ Index: uspace/drv/uhci-rhd/root_hub.h =================================================================== --- uspace/drv/uhci-rhd/root_hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-rhd/root_hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,56 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbuhcirh + * @{ + */ +/** @file + * @brief UHCI driver + */ +#ifndef DRV_UHCI_ROOT_HUB_H +#define DRV_UHCI_ROOT_HUB_H + +#include + +#include "port.h" + +#define UHCI_ROOT_HUB_PORT_COUNT 2 +#define ROOT_HUB_WAIT_USEC 5000000 /* 5 seconds */ + +typedef struct root_hub { + uhci_port_t ports[UHCI_ROOT_HUB_PORT_COUNT]; + devman_handle_t hc_handle; +} uhci_root_hub_t; + +int uhci_root_hub_init( + uhci_root_hub_t *instance, void *addr, size_t size, ddf_dev_t *rh); + +int uhci_root_hub_fini(uhci_root_hub_t *instance); +#endif +/** + * @} + */ Index: uspace/drv/uhci-rhd/uhci-rhd.ma =================================================================== --- uspace/drv/uhci-rhd/uhci-rhd.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/uhci-rhd/uhci-rhd.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,1 @@ +10 usb&uhci&root-hub Index: uspace/drv/usbflbk/Makefile =================================================================== --- uspace/drv/usbflbk/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbflbk/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,37 @@ +# +# Copyright (c) 2011 Vojtech Horky +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBS = $(LIBDRV_PREFIX)/libdrv.a $(LIBUSB_PREFIX)/libusb.a +EXTRA_CFLAGS += -I$(LIBDRV_PREFIX)/include -I$(LIBUSB_PREFIX)/include +BINARY = usbflbk + +SOURCES = \ + main.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/usbflbk/main.c =================================================================== --- uspace/drv/usbflbk/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbflbk/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,95 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbfallback + * @{ + */ +/** + * @file + * Main routines of USB fallback driver. + */ +#include +#include +#include +#include + +#define NAME "usbflbk" + +/** Callback when new device is attached and recognized by DDF. + * + * @param dev Representation of a generic DDF device. + * @return Error code. + */ +static int usbfallback_add_device(usb_device_t *dev) +{ + int rc; + const char *fun_name = "ctl"; + + ddf_fun_t *ctl_fun = ddf_fun_create(dev->ddf_dev, fun_exposed, + fun_name); + if (ctl_fun == NULL) { + usb_log_error("Failed to create control function.\n"); + return ENOMEM; + } + rc = ddf_fun_bind(ctl_fun); + if (rc != EOK) { + usb_log_error("Failed to bind control function: %s.\n", + str_error(rc)); + return rc; + } + + usb_log_info("Pretending to control %s `%s'" \ + " (node `%s', handle %llu).\n", + dev->interface_no < 0 ? "device" : "interface", + dev->ddf_dev->name, fun_name, dev->ddf_dev->handle); + + return EOK; +} + +/** USB fallback driver ops. */ +static usb_driver_ops_t usbfallback_driver_ops = { + .add_device = usbfallback_add_device, +}; + +/** USB fallback driver. */ +static usb_driver_t usbfallback_driver = { + .name = NAME, + .ops = &usbfallback_driver_ops, + .endpoints = NULL +}; + +int main(int argc, char *argv[]) +{ + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + + return usb_driver_main(&usbfallback_driver); +} + +/** + * @} + */ Index: uspace/drv/usbflbk/usbflbk.ma =================================================================== --- uspace/drv/usbflbk/usbflbk.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbflbk/usbflbk.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,2 @@ +10 usb&fallback +10 usb&interface&fallback Index: uspace/drv/usbhub/Makefile =================================================================== --- uspace/drv/usbhub/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbhub/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,40 @@ +# +# Copyright (c) 2010 Vojtech Horky +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBS = $(LIBDRV_PREFIX)/libdrv.a $(LIBUSB_PREFIX)/libusb.a +EXTRA_CFLAGS += -I$(LIBDRV_PREFIX)/include -I$(LIBUSB_PREFIX)/include +BINARY = usbhub + +SOURCES = \ + main.c \ + utils.c \ + usbhub.c \ + usblist.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/usbhub/main.c =================================================================== --- uspace/drv/usbhub/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbhub/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,86 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhub + * @{ + */ + +#include +#include +#include +#include + +#include +#include + +#include "usbhub.h" +#include "usbhub_private.h" + +/** Hub status-change endpoint description. + * + * For more information see section 11.15.1 of USB 1.1 specification. + */ +static usb_endpoint_description_t hub_status_change_endpoint_description = { + .transfer_type = USB_TRANSFER_INTERRUPT, + .direction = USB_DIRECTION_IN, + .interface_class = USB_CLASS_HUB, + .interface_subclass = 0, + .interface_protocol = 0, + .flags = 0 +}; + + +static usb_driver_ops_t usb_hub_driver_ops = { + .add_device = usb_hub_add_device +}; + +static usb_endpoint_description_t *usb_hub_endpoints[] = { + &hub_status_change_endpoint_description, + NULL +}; + +static usb_driver_t usb_hub_driver = { + .name = NAME, + .ops = &usb_hub_driver_ops, + .endpoints = usb_hub_endpoints +}; + + +int main(int argc, char *argv[]) +{ + printf(NAME ": HelenOS USB hub driver.\n"); + + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + + return usb_driver_main(&usb_hub_driver); +} + +/** + * @} + */ + Index: uspace/drv/usbhub/port_status.h =================================================================== --- uspace/drv/usbhub/port_status.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbhub/port_status.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,360 @@ +/* + * Copyright (c) 2010 Matus Dekanek + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbhub + * @{ + */ + +#ifndef HUB_PORT_STATUS_H +#define HUB_PORT_STATUS_H + +#include +#include +#include +#include "usbhub_private.h" + +/** + * structure holding port status and changes flags. + * should not be accessed directly, use supplied getter/setter methods. + * + * For more information refer to table 11-15 in + * "Universal Serial Bus Specification Revision 1.1" + * + */ +typedef uint32_t usb_port_status_t; + +/** + * set values in request to be it a port status request + * @param request + * @param port + */ +static inline void usb_hub_set_port_status_request( +usb_device_request_setup_packet_t * request, uint16_t port +){ + request->index = port; + request->request_type = USB_HUB_REQ_TYPE_GET_PORT_STATUS; + request->request = USB_HUB_REQUEST_GET_STATUS; + request->value = 0; + request->length = 4; +} + + +/** + * create request for usb hub port status + * @param port + * @return + */ +static inline usb_device_request_setup_packet_t * +usb_hub_create_port_status_request(uint16_t port){ + usb_device_request_setup_packet_t * result = + usb_new(usb_device_request_setup_packet_t); + usb_hub_set_port_status_request(result,port); + return result; +} + + +/** + * set the device request to be a port feature enable request + * @param request + * @param port + * @param feature_selector + */ +static inline void usb_hub_set_enable_port_feature_request( +usb_device_request_setup_packet_t * request, uint16_t port, + uint16_t feature_selector +){ + request->index = port; + request->request_type = USB_HUB_REQ_TYPE_SET_PORT_FEATURE; + request->request = USB_HUB_REQUEST_SET_FEATURE; + request->value = feature_selector; + request->length = 0; +} + + +/** + * set the device request to be a port enable request + * @param request + * @param port + */ +static inline void usb_hub_set_enable_port_request( +usb_device_request_setup_packet_t * request, uint16_t port +){ + request->index = port; + request->request_type = USB_HUB_REQ_TYPE_SET_PORT_FEATURE; + request->request = USB_HUB_REQUEST_SET_FEATURE; + request->value = USB_HUB_FEATURE_C_PORT_ENABLE; + request->length = 0; +} + +/** + * enable specified port + * @param port + * @return + */ +static inline usb_device_request_setup_packet_t * +usb_hub_create_enable_port_request(uint16_t port){ + usb_device_request_setup_packet_t * result = + usb_new(usb_device_request_setup_packet_t); + usb_hub_set_enable_port_request(result,port); + return result; +} + +/** + * set the device request to be a port disable request + * @param request + * @param port + */ +static inline void usb_hub_set_disable_port_request( +usb_device_request_setup_packet_t * request, uint16_t port +){ + request->index = port; + request->request_type = USB_HUB_REQ_TYPE_SET_PORT_FEATURE; + request->request = USB_HUB_REQUEST_SET_FEATURE; + request->value = USB_HUB_FEATURE_C_PORT_SUSPEND; + request->length = 0; +} + +/** + * disable specified port + * @param port + * @return + */ +static inline usb_device_request_setup_packet_t * +usb_hub_create_disable_port_request(uint16_t port){ + usb_device_request_setup_packet_t * result = + usb_new(usb_device_request_setup_packet_t); + usb_hub_set_disable_port_request(result,port); + return result; +} + +/** + * set the device request to be a port disable request + * @param request + * @param port + */ +static inline void usb_hub_set_reset_port_request( +usb_device_request_setup_packet_t * request, uint16_t port +){ + request->index = port; + request->request_type = USB_HUB_REQ_TYPE_SET_PORT_FEATURE; + request->request = USB_HUB_REQUEST_SET_FEATURE; + request->value = USB_HUB_FEATURE_PORT_RESET; + request->length = 0; +} + +/** + * disable specified port + * @param port + * @return + */ +static inline usb_device_request_setup_packet_t * +usb_hub_create_reset_port_request(uint16_t port){ + usb_device_request_setup_packet_t * result = + usb_new(usb_device_request_setup_packet_t); + usb_hub_set_reset_port_request(result,port); + return result; +} + +/** + * set the device request to be a port disable request + * @param request + * @param port + */ +static inline void usb_hub_set_power_port_request( +usb_device_request_setup_packet_t * request, uint16_t port +){ + request->index = port; + request->request_type = USB_HUB_REQ_TYPE_SET_PORT_FEATURE; + request->request = USB_HUB_REQUEST_SET_FEATURE; + request->value = USB_HUB_FEATURE_PORT_POWER; + request->length = 0; +} + +/** + * set the device request to be a port disable request + * @param request + * @param port + */ +static inline void usb_hub_unset_power_port_request( +usb_device_request_setup_packet_t * request, uint16_t port +){ + request->index = port; + request->request_type = USB_HUB_REQ_TYPE_SET_PORT_FEATURE; + request->request = USB_HUB_REQUEST_CLEAR_FEATURE; + request->value = USB_HUB_FEATURE_PORT_POWER; + request->length = 0; +} + + +/** get i`th bit of port status */ +static inline bool usb_port_get_bit(usb_port_status_t * status, int idx) +{ + return (((*status)>>(idx))%2); +} + +/** set i`th bit of port status */ +static inline void usb_port_set_bit( + usb_port_status_t * status, int idx, bool value) +{ + (*status) = value? + ((*status)|(1<<(idx))): + ((*status)&(~(1<<(idx)))); +} + +//device connnected on port +static inline bool usb_port_dev_connected(usb_port_status_t * status){ + return usb_port_get_bit(status,0); +} + +static inline void usb_port_set_dev_connected(usb_port_status_t * status,bool connected){ + usb_port_set_bit(status,0,connected); +} + +//port enabled +static inline bool usb_port_enabled(usb_port_status_t * status){ + return usb_port_get_bit(status,1); +} + +static inline void usb_port_set_enabled(usb_port_status_t * status,bool enabled){ + usb_port_set_bit(status,1,enabled); +} + +//port suspended +static inline bool usb_port_suspended(usb_port_status_t * status){ + return usb_port_get_bit(status,2); +} + +static inline void usb_port_set_suspended(usb_port_status_t * status,bool suspended){ + usb_port_set_bit(status,2,suspended); +} + +//over currect +static inline bool usb_port_over_current(usb_port_status_t * status){ + return usb_port_get_bit(status,3); +} + +static inline void usb_port_set_over_current(usb_port_status_t * status,bool value){ + usb_port_set_bit(status,3,value); +} + +//port reset +static inline bool usb_port_reset(usb_port_status_t * status){ + return usb_port_get_bit(status,4); +} + +static inline void usb_port_set_reset(usb_port_status_t * status,bool value){ + usb_port_set_bit(status,4,value); +} + +//powered +static inline bool usb_port_powered(usb_port_status_t * status){ + return usb_port_get_bit(status,8); +} + +static inline void usb_port_set_powered(usb_port_status_t * status,bool powered){ + usb_port_set_bit(status,8,powered); +} + +//low speed device attached +static inline bool usb_port_low_speed(usb_port_status_t * status){ + return usb_port_get_bit(status,9); +} + +static inline void usb_port_set_low_speed(usb_port_status_t * status,bool low_speed){ + usb_port_set_bit(status,9,low_speed); +} + +//low speed device attached +static inline bool usb_port_high_speed(usb_port_status_t * status){ + return usb_port_get_bit(status,10); +} + +static inline void usb_port_set_high_speed(usb_port_status_t * status,bool high_speed){ + usb_port_set_bit(status,10,high_speed); +} + +static inline usb_speed_t usb_port_speed(usb_port_status_t * status){ + if(usb_port_low_speed(status)) + return USB_SPEED_LOW; + if(usb_port_high_speed(status)) + return USB_SPEED_HIGH; + return USB_SPEED_FULL; +} + + +//connect change +static inline bool usb_port_connect_change(usb_port_status_t * status){ + return usb_port_get_bit(status,16); +} + +static inline void usb_port_set_connect_change(usb_port_status_t * status,bool change){ + usb_port_set_bit(status,16,change); +} + +//port enable change +static inline bool usb_port_enabled_change(usb_port_status_t * status){ + return usb_port_get_bit(status,17); +} + +static inline void usb_port_set_enabled_change(usb_port_status_t * status,bool change){ + usb_port_set_bit(status,17,change); +} + +//suspend change +static inline bool usb_port_suspend_change(usb_port_status_t * status){ + return usb_port_get_bit(status,18); +} + +static inline void usb_port_set_suspend_change(usb_port_status_t * status,bool change){ + usb_port_set_bit(status,18,change); +} + +//over current change +static inline bool usb_port_overcurrent_change(usb_port_status_t * status){ + return usb_port_get_bit(status,19); +} + +static inline void usb_port_set_overcurrent_change(usb_port_status_t * status,bool change){ + usb_port_set_bit(status,19,change); +} + +//reset change +static inline bool usb_port_reset_completed(usb_port_status_t * status){ + return usb_port_get_bit(status,20); +} + +static inline void usb_port_set_reset_completed(usb_port_status_t * status,bool completed){ + usb_port_set_bit(status,20,completed); +} + + + +#endif /* HUB_PORT_STATUS_H */ + +/** + * @} + */ Index: uspace/drv/usbhub/usbhub.c =================================================================== --- uspace/drv/usbhub/usbhub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbhub/usbhub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,696 @@ +/* + * Copyright (c) 2010 Matus Dekanek + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbhub + * @{ + */ +/** @file + * @brief usb hub main functionality + */ + +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include + +#include "usbhub.h" +#include "usbhub_private.h" +#include "port_status.h" +#include "usb/usb.h" +#include "usb/pipes.h" +#include "usb/classes/classes.h" + + +static void usb_hub_init_add_device(usb_hub_info_t * hub, uint16_t port, + usb_speed_t speed); + +static int usb_hub_trigger_connecting_non_removable_devices( + usb_hub_info_t * hub, usb_hub_descriptor_t * descriptor); + +/** + * control loop running in hub`s fibril + * + * Hub`s fibril periodically asks for changes on hub and if needded calls + * change handling routine. + * @warning currently hub driver asks for changes once a second + * @param hub_info_param hub representation pointer + * @return zero + */ +int usb_hub_control_loop(void * hub_info_param){ + usb_hub_info_t * hub_info = (usb_hub_info_t*)hub_info_param; + int errorCode = EOK; + + while(errorCode == EOK){ + async_usleep(1000 * 1000 * 10 );/// \TODO proper number once + errorCode = usb_hub_check_hub_changes(hub_info); + } + usb_log_error("something in ctrl loop went wrong, errno %d\n",errorCode); + + return 0; +} + + +//********************************************* +// +// hub driver code, initialization +// +//********************************************* + +/** + * create usb_hub_info_t structure + * + * Does only basic copying of known information into new structure. + * @param usb_dev usb device structure + * @return basic usb_hub_info_t structure + */ +static usb_hub_info_t * usb_hub_info_create(usb_device_t * usb_dev) { + usb_hub_info_t * result = usb_new(usb_hub_info_t); + if(!result) return NULL; + result->usb_device = usb_dev; + result->status_change_pipe = usb_dev->pipes[0].pipe; + result->control_pipe = &usb_dev->ctrl_pipe; + result->is_default_address_used = false; + return result; +} + +/** + * Load hub-specific information into hub_info structure and process if needed + * + * Particularly read port count and initialize structure holding port + * information. If there are non-removable devices, start initializing them. + * This function is hub-specific and should be run only after the hub is + * configured using usb_hub_set_configuration function. + * @param hub_info hub representation + * @return error code + */ +static int usb_hub_process_hub_specific_info(usb_hub_info_t * hub_info){ + // get hub descriptor + usb_log_debug("creating serialized descriptor\n"); + void * serialized_descriptor = malloc(USB_HUB_MAX_DESCRIPTOR_SIZE); + usb_hub_descriptor_t * descriptor; + + /* this was one fix of some bug, should not be needed anymore + * these lines allow to reset hub once more, it can be used as + * brute-force initialization for non-removable devices + int opResult = usb_request_set_configuration(&result->endpoints.control, 1); + if(opResult!=EOK){ + usb_log_error("could not set default configuration, errno %d",opResult); + return opResult; + } + */ + size_t received_size; + int opResult = usb_request_get_descriptor(&hub_info->usb_device->ctrl_pipe, + USB_REQUEST_TYPE_CLASS, USB_REQUEST_RECIPIENT_DEVICE, + USB_DESCTYPE_HUB, + 0, 0, serialized_descriptor, + USB_HUB_MAX_DESCRIPTOR_SIZE, &received_size); + + if (opResult != EOK) { + usb_log_error("failed when receiving hub descriptor, badcode = %d\n", + opResult); + free(serialized_descriptor); + return opResult; + } + usb_log_debug2("deserializing descriptor\n"); + descriptor = usb_deserialize_hub_desriptor(serialized_descriptor); + if(descriptor==NULL){ + usb_log_warning("could not deserialize descriptor \n"); + return opResult; + } + usb_log_debug("setting port count to %d\n",descriptor->ports_count); + hub_info->port_count = descriptor->ports_count; + hub_info->attached_devs = (usb_hc_attached_device_t*) + malloc((hub_info->port_count+1) * sizeof(usb_hc_attached_device_t)); + int i; + for(i=0;iport_count+1;++i){ + hub_info->attached_devs[i].handle=0; + hub_info->attached_devs[i].address=0; + } + //handle non-removable devices + usb_hub_trigger_connecting_non_removable_devices(hub_info, descriptor); + usb_log_debug2("freeing data\n"); + free(serialized_descriptor); + free(descriptor->devices_removable); + free(descriptor); + return EOK; +} +/** + * Set configuration of hub + * + * Check whether there is at least one configuration and sets the first one. + * This function should be run prior to running any hub-specific action. + * @param hub_info hub representation + * @return error code + */ +static int usb_hub_set_configuration(usb_hub_info_t * hub_info){ + //device descriptor + usb_standard_device_descriptor_t *std_descriptor + = &hub_info->usb_device->descriptors.device; + usb_log_debug("hub has %d configurations\n", + std_descriptor->configuration_count); + if(std_descriptor->configuration_count<1){ + usb_log_error("there are no configurations available\n"); + return EINVAL; + } + + usb_standard_configuration_descriptor_t *config_descriptor + = (usb_standard_configuration_descriptor_t *) + hub_info->usb_device->descriptors.configuration; + + /* Set configuration. */ + int opResult = usb_request_set_configuration( + &hub_info->usb_device->ctrl_pipe, + config_descriptor->configuration_number); + + if (opResult != EOK) { + usb_log_error("Failed to set hub configuration: %s.\n", + str_error(opResult)); + return opResult; + } + usb_log_debug("\tused configuration %d\n", + config_descriptor->configuration_number); + + return EOK; +} + +/** + * Initialize hub device driver fibril + * + * Creates hub representation and fibril that periodically checks hub`s status. + * Hub representation is passed to the fibril. + * @param usb_dev generic usb device information + * @return error code + */ +int usb_hub_add_device(usb_device_t * usb_dev){ + if(!usb_dev) return EINVAL; + usb_hub_info_t * hub_info = usb_hub_info_create(usb_dev); + //create hc connection + usb_log_debug("Initializing USB wire abstraction.\n"); + int opResult = usb_hc_connection_initialize_from_device( + &hub_info->connection, + hub_info->usb_device->ddf_dev); + if(opResult != EOK){ + usb_log_error("could not initialize connection to device, errno %d\n", + opResult); + free(hub_info); + return opResult; + } + + usb_pipe_start_session(hub_info->control_pipe); + //set hub configuration + opResult = usb_hub_set_configuration(hub_info); + if(opResult!=EOK){ + usb_log_error("could not set hub configuration, errno %d\n",opResult); + free(hub_info); + return opResult; + } + //get port count and create attached_devs + opResult = usb_hub_process_hub_specific_info(hub_info); + if(opResult!=EOK){ + usb_log_error("could not set hub configuration, errno %d\n",opResult); + free(hub_info); + return opResult; + } + usb_pipe_end_session(hub_info->control_pipe); + + + /// \TODO what is this? + usb_log_debug("Creating `hub' function.\n"); + ddf_fun_t *hub_fun = ddf_fun_create(hub_info->usb_device->ddf_dev, + fun_exposed, "hub"); + assert(hub_fun != NULL); + hub_fun->ops = NULL; + + int rc = ddf_fun_bind(hub_fun); + assert(rc == EOK); + rc = ddf_fun_add_to_class(hub_fun, "hub"); + assert(rc == EOK); + + //create fibril for the hub control loop + fid_t fid = fibril_create(usb_hub_control_loop, hub_info); + if (fid == 0) { + usb_log_error("failed to start monitoring fibril for new hub.\n"); + return ENOMEM; + } + fibril_add_ready(fid); + usb_log_debug("Hub fibril created.\n"); + + usb_log_info("Controlling hub `%s' (%d ports).\n", + hub_info->usb_device->ddf_dev->name, hub_info->port_count); + return EOK; +} + + +//********************************************* +// +// hub driver code, main loop and port handling +// +//********************************************* + +/** + * triggers actions to connect non0removable devices + * + * This will trigger operations leading to activated non-removable device. + * Control pipe of the hub must be open fo communication. + * @param hub hub representation + * @param descriptor usb hub descriptor + * @return error code + */ +static int usb_hub_trigger_connecting_non_removable_devices(usb_hub_info_t * hub, + usb_hub_descriptor_t * descriptor) +{ + usb_log_info("attaching non-removable devices(if any)\n"); + usb_device_request_setup_packet_t request; + int opResult; + size_t rcvd_size; + usb_port_status_t status; + uint8_t * non_removable_dev_bitmap = descriptor->devices_removable; + int port; + for(port=1;port<=descriptor->ports_count;++port){ + bool is_non_removable = + ((non_removable_dev_bitmap[port/8]) >> (port%8)) %2; + if(is_non_removable){ + usb_log_debug("non-removable device on port %d\n",port); + usb_hub_set_port_status_request(&request, port); + opResult = usb_pipe_control_read( + hub->control_pipe, + &request, sizeof(usb_device_request_setup_packet_t), + &status, 4, &rcvd_size + ); + if (opResult != EOK) { + usb_log_error("could not get port status of port %d errno:%d\n", + port, opResult); + return opResult; + } + //set the status change bit, so it will be noticed in driver loop + if(usb_port_dev_connected(&status)){ + usb_hub_set_enable_port_feature_request(&request, port, + USB_HUB_FEATURE_C_PORT_CONNECTION); + opResult = usb_pipe_control_read( + hub->control_pipe, + &request, sizeof(usb_device_request_setup_packet_t), + &status, 4, &rcvd_size + ); + if (opResult != EOK) { + usb_log_warning( + "could not set port change on port %d errno:%d\n", + port, opResult); + } + } + } + } + return EOK; +} + + +/** + * release default address used by given hub + * + * Also unsets hub->is_default_address_used. Convenience wrapper function. + * @note hub->connection MUST be open for communication + * @param hub hub representation + * @return error code + */ +static int usb_hub_release_default_address(usb_hub_info_t * hub){ + int opResult = usb_hc_release_default_address(&hub->connection); + if(opResult!=EOK){ + usb_log_error("could not release default address, errno %d\n",opResult); + return opResult; + } + hub->is_default_address_used = false; + return EOK; +} + +/** + * Reset the port with new device and reserve the default address. + * @param hub hub representation + * @param port port number, starting from 1 + * @param speed transfer speed of attached device, one of low, full or high + */ +static void usb_hub_init_add_device(usb_hub_info_t * hub, uint16_t port, + usb_speed_t speed) { + //if this hub already uses default address, it cannot request it once more + if(hub->is_default_address_used) return; + usb_log_debug("some connection changed\n"); + assert(hub->control_pipe->hc_phone); + int opResult = usb_hub_clear_port_feature(hub->control_pipe, + port, USB_HUB_FEATURE_C_PORT_CONNECTION); + if(opResult != EOK){ + usb_log_warning("could not clear port-change-connection flag\n"); + } + usb_device_request_setup_packet_t request; + + //get default address + opResult = usb_hc_reserve_default_address(&hub->connection, speed); + + if (opResult != EOK) { + usb_log_warning("cannot assign default address, it is probably used %d\n", + opResult); + return; + } + hub->is_default_address_used = true; + //reset port + usb_hub_set_reset_port_request(&request, port); + opResult = usb_pipe_control_write( + hub->control_pipe, + &request,sizeof(usb_device_request_setup_packet_t), + NULL, 0 + ); + if (opResult != EOK) { + usb_log_error("something went wrong when reseting a port %d\n",opResult); + usb_hub_release_default_address(hub); + } + return; +} + +/** + * Finalize adding new device after port reset + * + * Set device`s address and start it`s driver. + * @param hub hub representation + * @param port port number, starting from 1 + * @param speed transfer speed of attached device, one of low, full or high + */ +static void usb_hub_finalize_add_device( usb_hub_info_t * hub, + uint16_t port, usb_speed_t speed) { + + int opResult; + usb_log_debug("finalizing add device\n"); + opResult = usb_hub_clear_port_feature(hub->control_pipe, + port, USB_HUB_FEATURE_C_PORT_RESET); + + if (opResult != EOK) { + usb_log_error("failed to clear port reset feature\n"); + usb_hub_release_default_address(hub); + return; + } + //create connection to device + usb_pipe_t new_device_pipe; + usb_device_connection_t new_device_connection; + usb_device_connection_initialize_on_default_address( + &new_device_connection, + &hub->connection + ); + usb_pipe_initialize_default_control( + &new_device_pipe, + &new_device_connection); + usb_pipe_probe_default_control(&new_device_pipe); + + /* Request address from host controller. */ + usb_address_t new_device_address = usb_hc_request_address( + &hub->connection, + speed + ); + if (new_device_address < 0) { + usb_log_error("failed to get free USB address\n"); + opResult = new_device_address; + usb_hub_release_default_address(hub); + return; + } + usb_log_debug("setting new address %d\n",new_device_address); + //opResult = usb_drv_req_set_address(hc, USB_ADDRESS_DEFAULT, + // new_device_address); + usb_pipe_start_session(&new_device_pipe); + opResult = usb_request_set_address(&new_device_pipe,new_device_address); + usb_pipe_end_session(&new_device_pipe); + if (opResult != EOK) { + usb_log_error("could not set address for new device %d\n",opResult); + usb_hub_release_default_address(hub); + return; + } + + //opResult = usb_hub_release_default_address(hc); + opResult = usb_hub_release_default_address(hub); + if(opResult!=EOK){ + return; + } + + devman_handle_t child_handle; + //?? + opResult = usb_device_register_child_in_devman(new_device_address, + hub->connection.hc_handle, hub->usb_device->ddf_dev, &child_handle, + NULL, NULL, NULL); + + if (opResult != EOK) { + usb_log_error("could not start driver for new device %d\n",opResult); + return; + } + hub->attached_devs[port].handle = child_handle; + hub->attached_devs[port].address = new_device_address; + + //opResult = usb_drv_bind_address(hc, new_device_address, child_handle); + opResult = usb_hc_register_device( + &hub->connection, + &hub->attached_devs[port]); + if (opResult != EOK) { + usb_log_error("could not assign address of device in hcd %d\n",opResult); + return; + } + usb_log_info("Detected new device on `%s' (port %d), " \ + "address %d (handle %llu).\n", + hub->usb_device->ddf_dev->name, (int) port, + new_device_address, child_handle); +} + +/** + * routine called when a device on port has been removed + * + * If the device on port had default address, it releases default address. + * Otherwise does not do anything, because DDF does not allow to remove device + * from it`s device tree. + * @param hub hub representation + * @param port port number, starting from 1 + */ +static void usb_hub_removed_device( + usb_hub_info_t * hub,uint16_t port) { + + int opResult = usb_hub_clear_port_feature(hub->control_pipe, + port, USB_HUB_FEATURE_C_PORT_CONNECTION); + if(opResult != EOK){ + usb_log_warning("could not clear port-change-connection flag\n"); + } + /** \TODO remove device from device manager - not yet implemented in + * devide manager + */ + + //close address + if(hub->attached_devs[port].address!=0){ + /*uncomment this code to use it when DDF allows device removal + opResult = usb_hc_unregister_device( + &hub->connection, hub->attached_devs[port].address); + if(opResult != EOK) { + dprintf(USB_LOG_LEVEL_WARNING, "could not release address of " \ + "removed device: %d", opResult); + } + hub->attached_devs[port].address = 0; + hub->attached_devs[port].handle = 0; + */ + }else{ + usb_log_warning("this is strange, disconnected device had no address\n"); + //device was disconnected before it`s port was reset - return default address + usb_hub_release_default_address(hub); + } +} + + +/** + * Process over current condition on port. + * + * Turn off the power on the port. + * + * @param hub hub representation + * @param port port number, starting from 1 + */ +static void usb_hub_over_current( usb_hub_info_t * hub, + uint16_t port){ + int opResult; + opResult = usb_hub_clear_port_feature(hub->control_pipe, + port, USB_HUB_FEATURE_PORT_POWER); + if(opResult!=EOK){ + usb_log_error("cannot power off port %d; %d\n", + port, opResult); + } +} + +/** + * Process interrupts on given hub port + * + * Accepts connection, over current and port reset change. + * @param hub hub representation + * @param port port number, starting from 1 + */ +static void usb_hub_process_interrupt(usb_hub_info_t * hub, + uint16_t port) { + usb_log_debug("interrupt at port %d\n", port); + //determine type of change + usb_pipe_t *pipe = hub->control_pipe; + + int opResult; + + usb_port_status_t status; + size_t rcvd_size; + usb_device_request_setup_packet_t request; + //int opResult; + usb_hub_set_port_status_request(&request, port); + //endpoint 0 + + opResult = usb_pipe_control_read( + pipe, + &request, sizeof(usb_device_request_setup_packet_t), + &status, 4, &rcvd_size + ); + if (opResult != EOK) { + usb_log_error("could not get port status\n"); + return; + } + if (rcvd_size != sizeof (usb_port_status_t)) { + usb_log_error("received status has incorrect size\n"); + return; + } + //something connected/disconnected + if (usb_port_connect_change(&status)) { + if (usb_port_dev_connected(&status)) { + usb_log_debug("some connection changed\n"); + usb_hub_init_add_device(hub, port, usb_port_speed(&status)); + } else { + usb_hub_removed_device(hub, port); + } + } + //over current + if (usb_port_overcurrent_change(&status)) { + //check if it was not auto-resolved + if(usb_port_over_current(&status)){ + usb_hub_over_current(hub,port); + }else{ + usb_log_debug("over current condition was auto-resolved on port %d\n", + port); + } + } + //port reset + if (usb_port_reset_completed(&status)) { + usb_log_debug("port reset complete\n"); + if (usb_port_enabled(&status)) { + usb_hub_finalize_add_device(hub, port, usb_port_speed(&status)); + } else { + usb_log_warning("port reset, but port still not enabled\n"); + } + } + + usb_port_set_connect_change(&status, false); + usb_port_set_reset(&status, false); + usb_port_set_reset_completed(&status, false); + usb_port_set_dev_connected(&status, false); + if (status>>16) { + usb_log_info("there was some unsupported change on port %d: %X\n", + port,status); + + } +} + +/** + * check changes on hub + * + * Handles changes on each port with a status change. + * @param hub_info hub representation + * @return error code + */ +int usb_hub_check_hub_changes(usb_hub_info_t * hub_info){ + int opResult; + opResult = usb_pipe_start_session( + hub_info->status_change_pipe); + if(opResult != EOK){ + usb_log_error("could not initialize communication for hub; %d\n", + opResult); + return opResult; + } + + size_t port_count = hub_info->port_count; + + /// FIXME: count properly + size_t byte_length = ((port_count+1) / 8) + 1; + void *change_bitmap = malloc(byte_length); + size_t actual_size; + + /* + * Send the request. + */ + opResult = usb_pipe_read( + hub_info->status_change_pipe, + change_bitmap, byte_length, &actual_size + ); + + if (opResult != EOK) { + free(change_bitmap); + usb_log_warning("something went wrong while getting status of hub\n"); + usb_pipe_end_session(hub_info->status_change_pipe); + return opResult; + } + unsigned int port; + opResult = usb_pipe_start_session(hub_info->control_pipe); + if(opResult!=EOK){ + usb_log_error("could not start control pipe session %d\n", opResult); + usb_pipe_end_session(hub_info->status_change_pipe); + return opResult; + } + opResult = usb_hc_connection_open(&hub_info->connection); + if(opResult!=EOK){ + usb_log_error("could not start host controller session %d\n", + opResult); + usb_pipe_end_session(hub_info->control_pipe); + usb_pipe_end_session(hub_info->status_change_pipe); + return opResult; + } + + ///todo, opresult check, pre obe konekce + for (port = 1; port < port_count+1; ++port) { + bool interrupt = + (((uint8_t*) change_bitmap)[port / 8] >> (port % 8)) % 2; + if (interrupt) { + usb_hub_process_interrupt( + hub_info, port); + } + } + usb_hc_connection_close(&hub_info->connection); + usb_pipe_end_session(hub_info->control_pipe); + usb_pipe_end_session(hub_info->status_change_pipe); + free(change_bitmap); + return EOK; +} + + + +/** + * @} + */ Index: uspace/drv/usbhub/usbhub.h =================================================================== --- uspace/drv/usbhub/usbhub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbhub/usbhub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,108 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhub + * @{ + */ +/** @file + * @brief Hub driver. + */ +#ifndef DRV_USBHUB_USBHUB_H +#define DRV_USBHUB_USBHUB_H + +#include +#include +#include + +#define NAME "usbhub" + +#include + +#include +#include + + +/** Information about attached hub. */ +typedef struct { + /** Number of ports. */ + int port_count; + + /** attached device handles, for each port one */ + usb_hc_attached_device_t * attached_devs; + + /** connection to hcd */ + usb_hc_connection_t connection; + + /** default address is used indicator + * + * If default address is requested by this device, it cannot + * be requested by the same hub again, otherwise a deadlock will occur. + */ + bool is_default_address_used; + + /** convenience pointer to status change pipe + * + * Status change pipe is initialized in usb_device structure. This is + * pointer into this structure, so that it does not have to be + * searched again and again for the 'right pipe'. + */ + usb_pipe_t * status_change_pipe; + + /** convenience pointer to control pipe + * + * Control pipe is initialized in usb_device structure. This is + * pointer into this structure, so that it does not have to be + * searched again and again for the 'right pipe'. + */ + usb_pipe_t * control_pipe; + + /** generic usb device data*/ + usb_device_t * usb_device; +} usb_hub_info_t; + +/** + * function running the hub-controlling loop. + * @param hub_info_param hub info pointer + */ +int usb_hub_control_loop(void * hub_info_param); + +/** + * Check changes on specified hub + * @param hub_info_param pointer to usb_hub_info_t structure + * @return error code if there is problem when initializing communication with + * hub, EOK otherwise + */ +int usb_hub_check_hub_changes(usb_hub_info_t * hub_info_param); + + +int usb_hub_add_device(usb_device_t * usb_dev); + +#endif +/** + * @} + */ Index: uspace/drv/usbhub/usbhub.ma =================================================================== --- uspace/drv/usbhub/usbhub.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbhub/usbhub.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,2 @@ +10 usb&hub +10 usb&class=hub Index: uspace/drv/usbhub/usbhub_private.h =================================================================== --- uspace/drv/usbhub/usbhub_private.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbhub/usbhub_private.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,136 @@ +/* + * Copyright (c) 2010 Matus Dekanek + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhub + * @{ + */ +/** @file + * @brief Hub driver private definitions + */ + +#ifndef USBHUB_PRIVATE_H +#define USBHUB_PRIVATE_H + +#include "usbhub.h" +#include "usblist.h" + +#include +#include +#include +#include + +#include +#include +#include +#include + +//************ +// +// convenience define for malloc +// +//************ +#define usb_new(type) (type*)malloc(sizeof(type)) + + +/** + * Create hub structure instance + * + * Set the address and port count information most importantly. + * + * @param device + * @param hc host controller phone + * @return + */ +usb_hub_info_t * usb_create_hub_info(ddf_dev_t * device); + +/** + * Set the device request to be a get hub descriptor request. + * @warning the size is allways set to USB_HUB_MAX_DESCRIPTOR_SIZE + * @param request + * @param addr + */ +static inline void usb_hub_set_descriptor_request( +usb_device_request_setup_packet_t * request +){ + request->index = 0; + request->request_type = USB_HUB_REQ_TYPE_GET_DESCRIPTOR; + request->request = USB_HUB_REQUEST_GET_DESCRIPTOR; + request->value_high = USB_DESCTYPE_HUB; + request->value_low = 0; + request->length = USB_HUB_MAX_DESCRIPTOR_SIZE; +} + +/** + * Clear feature on hub port. + * + * @param hc Host controller telephone + * @param address Hub address + * @param port_index Port + * @param feature Feature selector + * @return Operation result + */ +static inline int usb_hub_clear_port_feature(usb_pipe_t *pipe, + int port_index, + usb_hub_class_feature_t feature) { + + usb_device_request_setup_packet_t clear_request = { + .request_type = USB_HUB_REQ_TYPE_CLEAR_PORT_FEATURE, + .request = USB_DEVREQ_CLEAR_FEATURE, + .length = 0, + .index = port_index + }; + clear_request.value = feature; + return usb_pipe_control_write(pipe, &clear_request, + sizeof(clear_request), NULL, 0); +} + +/** + * create uint8_t array with serialized descriptor + * + * @param descriptor + * @return newly created serializd descriptor pointer + */ +void * usb_serialize_hub_descriptor(usb_hub_descriptor_t * descriptor); + +/** + * create deserialized desriptor structure out of serialized descriptor + * + * The serialized descriptor must be proper usb hub descriptor, + * otherwise an eerror might occur. + * + * @param sdescriptor serialized descriptor + * @return newly created deserialized descriptor pointer + */ +usb_hub_descriptor_t * usb_deserialize_hub_desriptor(void * sdescriptor); + + +#endif /* USBHUB_PRIVATE_H */ + +/** + * @} + */ Index: uspace/drv/usbhub/usblist.c =================================================================== --- uspace/drv/usbhub/usblist.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbhub/usblist.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,80 @@ +/* + * Copyright (c) 2010 Matus Dekanek + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ +/** @addtogroup drvusbhub + * @{ + */ +/** @file + * @brief usblist implementation + */ +#include + +#include "usbhub_private.h" + + +usb_general_list_t * usb_lst_create(void) { + usb_general_list_t* result = usb_new(usb_general_list_t); + usb_lst_init(result); + return result; +} + +void usb_lst_init(usb_general_list_t * lst) { + lst->prev = lst; + lst->next = lst; + lst->data = NULL; +} + +void usb_lst_prepend(usb_general_list_t* item, void* data) { + usb_general_list_t* appended = usb_new(usb_general_list_t); + appended->data = data; + appended->next = item; + appended->prev = item->prev; + item->prev->next = appended; + item->prev = appended; +} + +void usb_lst_append(usb_general_list_t* item, void* data) { + usb_general_list_t* appended = usb_new(usb_general_list_t); + appended->data = data; + appended->next = item->next; + appended->prev = item; + item->next->prev = appended; + item->next = appended; +} + +void usb_lst_remove(usb_general_list_t* item) { + item->next->prev = item->prev; + item->prev->next = item->next; +} + + + +/** + * @} + */ + + Index: uspace/drv/usbhub/usblist.h =================================================================== --- uspace/drv/usbhub/usblist.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbhub/usblist.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,82 @@ +/* + * Copyright (c) 2010 Matus Dekanek + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhub + * @{ + */ +/** @file + * @brief HC driver and hub driver. + * + * My private list implementation; I did not like the original helenos list. + * This one does not depend on the structure of stored data and has + * much simpler and more straight-forward semantics. + */ +#ifndef USBLIST_H +#define USBLIST_H + +/** + * general list structure + */ +typedef struct usb_general_list{ + void * data; + struct usb_general_list * prev, * next; +} usb_general_list_t; + +/** create head of usb general list */ +usb_general_list_t * usb_lst_create(void); + +/** initialize head of usb general list */ +void usb_lst_init(usb_general_list_t * lst); + + +/** is the list empty? */ +static inline bool usb_lst_empty(usb_general_list_t * lst){ + return lst?(lst->next==lst):true; +} + +/** append data behind item */ +void usb_lst_append(usb_general_list_t * lst, void * data); + +/** prepend data beore item */ +void usb_lst_prepend(usb_general_list_t * lst, void * data); + +/** remove list item from list */ +void usb_lst_remove(usb_general_list_t * item); + +/** get data o specified type from list item */ +#define usb_lst_get_data(item, type) (type *) (item->data) + +/** get usb_hub_info_t data from list item */ +static inline usb_hub_info_t * usb_hub_lst_get_data(usb_general_list_t * item) { + return usb_lst_get_data(item,usb_hub_info_t); +} + +#endif /* USBLIST_H */ +/** + * @} + */ Index: uspace/drv/usbhub/utils.c =================================================================== --- uspace/drv/usbhub/utils.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbhub/utils.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,117 @@ +/* + * Copyright (c) 2010 Matus Dekanek + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhub + * @{ + */ +/** @file + * @brief various utilities + */ +#include +#include +#include + +#include +#include +#include + +#include "usbhub.h" +#include "usbhub_private.h" +#include "port_status.h" + + +size_t USB_HUB_MAX_DESCRIPTOR_SIZE = 71; + +//********************************************* +// +// various utils +// +//********************************************* + +//hub descriptor utils + +void * usb_serialize_hub_descriptor(usb_hub_descriptor_t * descriptor) { + //base size + size_t size = 7; + //variable size according to port count + size_t var_size = descriptor->ports_count / 8 + ((descriptor->ports_count % 8 > 0) ? 1 : 0); + size += 2 * var_size; + uint8_t * result = (uint8_t*) malloc(size); + //size + result[0] = size; + //descriptor type + result[1] = USB_DESCTYPE_HUB; + result[2] = descriptor->ports_count; + /// @fixme handling of endianness?? + result[3] = descriptor->hub_characteristics / 256; + result[4] = descriptor->hub_characteristics % 256; + result[5] = descriptor->pwr_on_2_good_time; + result[6] = descriptor->current_requirement; + + size_t i; + for (i = 0; i < var_size; ++i) { + result[7 + i] = descriptor->devices_removable[i]; + } + for (i = 0; i < var_size; ++i) { + result[7 + var_size + i] = 255; + } + return result; +} + +usb_hub_descriptor_t * usb_deserialize_hub_desriptor(void * serialized_descriptor) { + uint8_t * sdescriptor = (uint8_t*) serialized_descriptor; + + if (sdescriptor[1] != USB_DESCTYPE_HUB) { + usb_log_warning("trying to deserialize wrong descriptor %x\n",sdescriptor[1]); + return NULL; + } + + usb_hub_descriptor_t * result = usb_new(usb_hub_descriptor_t); + + + result->ports_count = sdescriptor[2]; + /// @fixme handling of endianness?? + result->hub_characteristics = sdescriptor[4] + 256 * sdescriptor[3]; + result->pwr_on_2_good_time = sdescriptor[5]; + result->current_requirement = sdescriptor[6]; + size_t var_size = result->ports_count / 8 + ((result->ports_count % 8 > 0) + ? 1 : 0); + result->devices_removable = (uint8_t*) malloc(var_size); + + size_t i; + for (i = 0; i < var_size; ++i) { + result->devices_removable[i] = sdescriptor[7 + i]; + } + return result; +} + + + +/** + * @} + */ Index: uspace/drv/usbkbd/Makefile =================================================================== --- uspace/drv/usbkbd/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,53 @@ +# +# Copyright (c) 2010-2011 Vojtech Horky +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBS = $(LIBDRV_PREFIX)/libdrv.a $(LIBUSB_PREFIX)/libusb.a +EXTRA_CFLAGS += -I$(LIBDRV_PREFIX)/include -I$(LIBUSB_PREFIX)/include -I. +BINARY = usbkbd + +STOLEN_LAYOUT_SOURCES = \ + layout/us_qwerty.c \ + layout/us_dvorak.c \ + layout/cz.c + +SOURCES = \ + main.c \ + conv.c \ + kbddev.c \ + kbdrepeat.c \ + $(STOLEN_LAYOUT_SOURCES) + +EXTRA_CLEAN = $(STOLEN_LAYOUT_SOURCES) + +SRV_KBD = $(USPACE_PREFIX)/srv/hid/kbd + +include $(USPACE_PREFIX)/Makefile.common + +layout/%.c: $(SRV_KBD)/layout/%.c + ln -sfn ../$< $@ Index: uspace/drv/usbkbd/conv.c =================================================================== --- uspace/drv/usbkbd/conv.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/conv.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,193 @@ +/* + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** @file + * USB scancode parser. + */ + +#include +#include +#include +#include +#include "conv.h" + +/** + * Mapping between USB HID key codes (from HID Usage Tables) and corresponding + * HelenOS key codes. + */ +static int scanmap_simple[255] = { + +// [0x29] = KC_BACKTICK, + +// [0x02] = KC_1, +// [0x03] = KC_2, + [0x04] = KC_A, + [0x05] = KC_B, + [0x06] = KC_C, + [0x07] = KC_D, + [0x08] = KC_E, + [0x09] = KC_F, + [0x0a] = KC_G, + [0x0b] = KC_H, + [0x0c] = KC_I, + [0x0d] = KC_J, + [0x0e] = KC_K, + [0x0f] = KC_L, + [0x10] = KC_M, + [0x11] = KC_N, + [0x12] = KC_O, + [0x13] = KC_P, + [0x14] = KC_Q, + [0x15] = KC_R, + [0x16] = KC_S, + [0x17] = KC_T, + [0x18] = KC_U, + [0x19] = KC_V, + [0x1a] = KC_W, + [0x1b] = KC_X, + [0x1c] = KC_Y, + [0x1d] = KC_Z, + + [0x1e] = KC_1, + [0x1f] = KC_2, + [0x20] = KC_3, + [0x21] = KC_4, + [0x22] = KC_5, + [0x23] = KC_6, + [0x24] = KC_7, + [0x25] = KC_8, + [0x26] = KC_9, + [0x27] = KC_0, + + [0x28] = KC_ENTER, + [0x29] = KC_ESCAPE, + [0x2a] = KC_BACKSPACE, + [0x2b] = KC_TAB, + [0x2c] = KC_SPACE, + + [0x2d] = KC_MINUS, // same as DASH? (- or _) + [0x2e] = KC_EQUALS, + [0x2f] = KC_LBRACKET, + [0x30] = KC_RBRACKET, + [0x31] = KC_BACKSLASH, + //[0x32] = KC_, // TODO: HASH??? maybe some as 0x31 - backslash + [0x33] = KC_SEMICOLON, + [0x34] = KC_QUOTE, // same as APOSTROPHE? (') + [0x35] = KC_BACKTICK, // same as GRAVE ACCENT?? (`) + [0x36] = KC_COMMA, + [0x37] = KC_PERIOD, + [0x38] = KC_SLASH, + + [0x39] = KC_CAPS_LOCK, + + [0x3a] = KC_F1, + [0x3b] = KC_F2, + [0x3c] = KC_F3, + [0x3d] = KC_F4, + [0x3e] = KC_F5, + [0x3f] = KC_F6, + [0x40] = KC_F7, + [0x41] = KC_F8, + [0x42] = KC_F9, + [0x43] = KC_F10, + [0x44] = KC_F11, + [0x45] = KC_F12, + + [0x46] = KC_PRTSCR, + [0x47] = KC_SCROLL_LOCK, + [0x48] = KC_PAUSE, + [0x49] = KC_INSERT, + [0x4a] = KC_HOME, + [0x4b] = KC_PAGE_UP, + [0x4c] = KC_DELETE, + [0x4d] = KC_END, + [0x4e] = KC_PAGE_DOWN, + [0x4f] = KC_RIGHT, + [0x50] = KC_LEFT, + [0x51] = KC_DOWN, + [0x52] = KC_UP, + + //[0x64] = // some funny key + + [0xe0] = KC_LCTRL, + [0xe1] = KC_LSHIFT, + [0xe2] = KC_LALT, + //[0xe3] = KC_L // TODO: left GUI + [0xe4] = KC_RCTRL, + [0xe5] = KC_RSHIFT, + [0xe6] = KC_RALT, + //[0xe7] = KC_R // TODO: right GUI + + [0x53] = KC_NUM_LOCK, + [0x54] = KC_NSLASH, + [0x55] = KC_NTIMES, + [0x56] = KC_NMINUS, + [0x57] = KC_NPLUS, + [0x58] = KC_NENTER, + [0x59] = KC_N1, + [0x5a] = KC_N2, + [0x5b] = KC_N3, + [0x5c] = KC_N4, + [0x5d] = KC_N5, + [0x5e] = KC_N6, + [0x5f] = KC_N7, + [0x60] = KC_N8, + [0x61] = KC_N9, + [0x62] = KC_N0, + [0x63] = KC_NPERIOD + +}; + +/** + * Translate USB HID key codes (from HID Usage Tables) to generic key codes + * recognized by HelenOS. + * + * @param scancode USB HID key code (from HID Usage Tables). + * + * @retval HelenOS key code corresponding to the given USB HID key code. + */ +unsigned int usbhid_parse_scancode(int scancode) +{ + unsigned int key; + int *map = scanmap_simple; + size_t map_length = sizeof(scanmap_simple) / sizeof(int); + + if ((scancode < 0) || ((size_t) scancode >= map_length)) + return -1; + + key = map[scancode]; + + return key; +} + +/** + * @} + */ Index: uspace/drv/usbkbd/conv.h =================================================================== --- uspace/drv/usbkbd/conv.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/conv.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,45 @@ +/* + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** @file + * USB scancode parser. + */ + +#ifndef USB_KBD_CONV_H_ +#define USB_KBD_CONV_H_ + +unsigned int usbhid_parse_scancode(int scancode); + +#endif /* USB_KBD_CONV_H_ */ + +/** + * @} + */ Index: uspace/drv/usbkbd/kbd.h =================================================================== --- uspace/drv/usbkbd/kbd.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/kbd.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,5 @@ +/* + * Dummy file because of shared layout sources. + * + * Do not delete. + */ Index: uspace/drv/usbkbd/kbddev.c =================================================================== --- uspace/drv/usbkbd/kbddev.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/kbddev.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,936 @@ +/* + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** + * @file + * USB HID keyboard device structure and API. + */ + +#include +#include +#include + +#include +#include +#include +#include +#include + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include + +#include "kbddev.h" + +#include "layout.h" +#include "conv.h" +#include "kbdrepeat.h" + +/*----------------------------------------------------------------------------*/ +/** Default modifiers when the keyboard is initialized. */ +static const unsigned DEFAULT_ACTIVE_MODS = KM_NUM_LOCK; + +///** Boot protocol report size (key part). */ +//static const size_t BOOTP_REPORT_SIZE = 6; + +///** Boot protocol total report size. */ +//static const size_t BOOTP_BUFFER_SIZE = 8; + +///** Boot protocol output report size. */ +//static const size_t BOOTP_BUFFER_OUT_SIZE = 1; + +///** Boot protocol error key code. */ +//static const uint8_t BOOTP_ERROR_ROLLOVER = 1; +static const uint8_t ERROR_ROLLOVER = 1; + +/** Default idle rate for keyboards. */ +static const uint8_t IDLE_RATE = 0; + +/** Delay before a pressed key starts auto-repeating. */ +static const unsigned int DEFAULT_DELAY_BEFORE_FIRST_REPEAT = 500 * 1000; + +/** Delay between two repeats of a pressed key when auto-repeating. */ +static const unsigned int DEFAULT_REPEAT_DELAY = 50 * 1000; + +/*----------------------------------------------------------------------------*/ + +/** Keyboard polling endpoint description for boot protocol class. */ +static usb_endpoint_description_t boot_poll_endpoint_description = { + .transfer_type = USB_TRANSFER_INTERRUPT, + .direction = USB_DIRECTION_IN, + .interface_class = USB_CLASS_HID, + .interface_subclass = USB_HID_SUBCLASS_BOOT, + .interface_protocol = USB_HID_PROTOCOL_KEYBOARD, + .flags = 0 +}; + +/* Array of endpoints expected on the device, NULL terminated. */ +usb_endpoint_description_t + *usb_kbd_endpoints[USB_KBD_POLL_EP_COUNT + 1] = { + &boot_poll_endpoint_description, + NULL +}; + +/*----------------------------------------------------------------------------*/ + +enum { + BOOT_REPORT_DESCRIPTOR_SIZE = 63 +}; + +static const uint8_t BOOT_REPORT_DESCRIPTOR[BOOT_REPORT_DESCRIPTOR_SIZE] = { + 0x05, 0x01, // Usage Page (Generic Desktop), + 0x09, 0x06, // Usage (Keyboard), + 0xA1, 0x01, // Collection (Application), + 0x75, 0x01, // Report Size (1), + 0x95, 0x08, // Report Count (8), + 0x05, 0x07, // Usage Page (Key Codes); + 0x19, 0xE0, // Usage Minimum (224), + 0x29, 0xE7, // Usage Maximum (231), + 0x15, 0x00, // Logical Minimum (0), + 0x25, 0x01, // Logical Maximum (1), + 0x81, 0x02, // Input (Data, Variable, Absolute), ; Modifier byte + 0x95, 0x01, // Report Count (1), + 0x75, 0x08, // Report Size (8), + 0x81, 0x01, // Input (Constant), ; Reserved byte + 0x95, 0x05, // Report Count (5), + 0x75, 0x01, // Report Size (1), + 0x05, 0x08, // Usage Page (Page# for LEDs), + 0x19, 0x01, // Usage Minimum (1), + 0x29, 0x05, // Usage Maxmimum (5), + 0x91, 0x02, // Output (Data, Variable, Absolute), ; LED report + 0x95, 0x01, // Report Count (1), + 0x75, 0x03, // Report Size (3), + 0x91, 0x01, // Output (Constant), ; LED report padding + 0x95, 0x06, // Report Count (6), + 0x75, 0x08, // Report Size (8), + 0x15, 0x00, // Logical Minimum (0), + 0x25, 0xff, // Logical Maximum (255), + 0x05, 0x07, // Usage Page (Key Codes), + 0x19, 0x00, // Usage Minimum (0), + 0x29, 0xff, // Usage Maximum (255), + 0x81, 0x00, // Input (Data, Array), ; Key arrays (6 bytes) + 0xC0 // End Collection + +}; + +/*----------------------------------------------------------------------------*/ + +typedef enum usb_kbd_flags { + USB_KBD_STATUS_UNINITIALIZED = 0, + USB_KBD_STATUS_INITIALIZED = 1, + USB_KBD_STATUS_TO_DESTROY = -1 +} usb_kbd_flags; + +/*----------------------------------------------------------------------------*/ +/* Keyboard layouts */ +/*----------------------------------------------------------------------------*/ + +#define NUM_LAYOUTS 3 + +/** Keyboard layout map. */ +static layout_op_t *layout[NUM_LAYOUTS] = { + &us_qwerty_op, + &us_dvorak_op, + &cz_op +}; + +static int active_layout = 0; + +/*----------------------------------------------------------------------------*/ +/* Modifier constants */ +/*----------------------------------------------------------------------------*/ +/** Mapping of USB modifier key codes to generic modifier key codes. */ +static const keycode_t usbhid_modifiers_keycodes[USB_HID_MOD_COUNT] = { + KC_LCTRL, /* USB_HID_MOD_LCTRL */ + KC_LSHIFT, /* USB_HID_MOD_LSHIFT */ + KC_LALT, /* USB_HID_MOD_LALT */ + 0, /* USB_HID_MOD_LGUI */ + KC_RCTRL, /* USB_HID_MOD_RCTRL */ + KC_RSHIFT, /* USB_HID_MOD_RSHIFT */ + KC_RALT, /* USB_HID_MOD_RALT */ + 0, /* USB_HID_MOD_RGUI */ +}; + +typedef enum usbhid_lock_code { + USB_KBD_LOCK_NUM = 0x53, + USB_KBD_LOCK_CAPS = 0x39, + USB_KBD_LOCK_SCROLL = 0x47, + USB_KBD_LOCK_COUNT = 3 +} usbhid_lock_code; + +static const usbhid_lock_code usbhid_lock_codes[USB_KBD_LOCK_COUNT] = { + USB_KBD_LOCK_NUM, + USB_KBD_LOCK_CAPS, + USB_KBD_LOCK_SCROLL +}; + +/*----------------------------------------------------------------------------*/ +/* IPC method handler */ +/*----------------------------------------------------------------------------*/ + +static void default_connection_handler(ddf_fun_t *, ipc_callid_t, ipc_call_t *); +ddf_dev_ops_t keyboard_ops = { + .default_handler = default_connection_handler +}; + +/** + * Default handler for IPC methods not handled by DDF. + * + * Currently recognizes only one method (IPC_M_CONNECT_TO_ME), in which case it + * assumes the caller is the console and thus it stores IPC phone to it for + * later use by the driver to notify about key events. + * + * @param fun Device function handling the call. + * @param icallid Call id. + * @param icall Call data. + */ +void default_connection_handler(ddf_fun_t *fun, + ipc_callid_t icallid, ipc_call_t *icall) +{ + sysarg_t method = IPC_GET_IMETHOD(*icall); + + usb_kbd_t *kbd_dev = (usb_kbd_t *)fun->driver_data; + assert(kbd_dev != NULL); + + if (method == IPC_M_CONNECT_TO_ME) { + int callback = IPC_GET_ARG5(*icall); + + if (kbd_dev->console_phone != -1) { + async_answer_0(icallid, ELIMIT); + return; + } + + kbd_dev->console_phone = callback; + async_answer_0(icallid, EOK); + return; + } + + async_answer_0(icallid, EINVAL); +} + +/*----------------------------------------------------------------------------*/ +/* Key processing functions */ +/*----------------------------------------------------------------------------*/ +/** + * Handles turning of LED lights on and off. + * + * In case of USB keyboards, the LEDs are handled in the driver, not in the + * device. When there should be a change (lock key was pressed), the driver + * uses a Set_Report request sent to the device to set the state of the LEDs. + * + * This functions sets the LED lights according to current settings of modifiers + * kept in the keyboard device structure. + * + * @param kbd_dev Keyboard device structure. + */ +static void usb_kbd_set_led(usb_kbd_t *kbd_dev) +{ + unsigned i = 0; + + /* Reset the LED data. */ + memset(kbd_dev->led_data, 0, kbd_dev->led_output_size * sizeof(int32_t)); + + if ((kbd_dev->mods & KM_NUM_LOCK) && (i < kbd_dev->led_output_size)) { + kbd_dev->led_data[i++] = USB_HID_LED_NUM_LOCK; + } + + if ((kbd_dev->mods & KM_CAPS_LOCK) && (i < kbd_dev->led_output_size)) { + kbd_dev->led_data[i++] = USB_HID_LED_CAPS_LOCK; + } + + if ((kbd_dev->mods & KM_SCROLL_LOCK) + && (i < kbd_dev->led_output_size)) { + kbd_dev->led_data[i++] = USB_HID_LED_SCROLL_LOCK; + } + + // TODO: COMPOSE and KANA + + usb_log_debug("Creating output report.\n"); + + int rc = usb_hid_report_output_translate(kbd_dev->parser, + kbd_dev->led_path, USB_HID_PATH_COMPARE_END, kbd_dev->output_buffer, + kbd_dev->output_size, kbd_dev->led_data, kbd_dev->led_output_size); + + if (rc != EOK) { + usb_log_warning("Error translating LED output to output report" + ".\n"); + return; + } + + usb_log_debug("Output report buffer: %s\n", + usb_debug_str_buffer(kbd_dev->output_buffer, kbd_dev->output_size, + 0)); + + usbhid_req_set_report(&kbd_dev->usb_dev->ctrl_pipe, + kbd_dev->usb_dev->interface_no, USB_HID_REPORT_TYPE_OUTPUT, + kbd_dev->output_buffer, kbd_dev->output_size); +} + +/*----------------------------------------------------------------------------*/ +/** + * Processes key events. + * + * @note This function was copied from AT keyboard driver and modified to suit + * USB keyboard. + * + * @note Lock keys are not sent to the console, as they are completely handled + * in the driver. It may, however, be required later that the driver + * sends also these keys to application (otherwise it cannot use those + * keys at all). + * + * @param kbd_dev Keyboard device structure. + * @param type Type of the event (press / release). Recognized values: + * KEY_PRESS, KEY_RELEASE + * @param key Key code of the key according to HID Usage Tables. + */ +void usb_kbd_push_ev(usb_kbd_t *kbd_dev, int type, unsigned int key) +{ + console_event_t ev; + unsigned mod_mask; + + /* + * These parts are copy-pasted from the AT keyboard driver. + * + * They definitely require some refactoring, but will keep it for later + * when the console and keyboard system is changed in HelenOS. + */ + switch (key) { + case KC_LCTRL: mod_mask = KM_LCTRL; break; + case KC_RCTRL: mod_mask = KM_RCTRL; break; + case KC_LSHIFT: mod_mask = KM_LSHIFT; break; + case KC_RSHIFT: mod_mask = KM_RSHIFT; break; + case KC_LALT: mod_mask = KM_LALT; break; + case KC_RALT: mod_mask = KM_RALT; break; + default: mod_mask = 0; break; + } + + if (mod_mask != 0) { + if (type == KEY_PRESS) + kbd_dev->mods = kbd_dev->mods | mod_mask; + else + kbd_dev->mods = kbd_dev->mods & ~mod_mask; + } + + switch (key) { + case KC_CAPS_LOCK: mod_mask = KM_CAPS_LOCK; break; + case KC_NUM_LOCK: mod_mask = KM_NUM_LOCK; break; + case KC_SCROLL_LOCK: mod_mask = KM_SCROLL_LOCK; break; + default: mod_mask = 0; break; + } + + if (mod_mask != 0) { + if (type == KEY_PRESS) { + /* + * Only change lock state on transition from released + * to pressed. This prevents autorepeat from messing + * up the lock state. + */ + unsigned int locks_old = kbd_dev->lock_keys; + + kbd_dev->mods = + kbd_dev->mods ^ (mod_mask & ~kbd_dev->lock_keys); + kbd_dev->lock_keys = kbd_dev->lock_keys | mod_mask; + + /* Update keyboard lock indicator lights. */ + if (kbd_dev->lock_keys != locks_old) { + usb_kbd_set_led(kbd_dev); + } + } else { + kbd_dev->lock_keys = kbd_dev->lock_keys & ~mod_mask; + } + } + + if (key == KC_CAPS_LOCK || key == KC_NUM_LOCK || key == KC_SCROLL_LOCK) { + // do not send anything to the console, this is our business + return; + } + + if (type == KEY_PRESS && (kbd_dev->mods & KM_LCTRL) && key == KC_F1) { + active_layout = 0; + layout[active_layout]->reset(); + return; + } + + if (type == KEY_PRESS && (kbd_dev->mods & KM_LCTRL) && key == KC_F2) { + active_layout = 1; + layout[active_layout]->reset(); + return; + } + + if (type == KEY_PRESS && (kbd_dev->mods & KM_LCTRL) && key == KC_F3) { + active_layout = 2; + layout[active_layout]->reset(); + return; + } + + ev.type = type; + ev.key = key; + ev.mods = kbd_dev->mods; + + ev.c = layout[active_layout]->parse_ev(&ev); + + usb_log_debug2("Sending key %d to the console\n", ev.key); + if (kbd_dev->console_phone < 0) { + usb_log_warning( + "Connection to console not ready, key discarded.\n"); + return; + } + + async_msg_4(kbd_dev->console_phone, KBD_EVENT, ev.type, ev.key, + ev.mods, ev.c); +} + +/*----------------------------------------------------------------------------*/ + +static inline int usb_kbd_is_lock(unsigned int key_code) +{ + return (key_code == KC_NUM_LOCK + || key_code == KC_SCROLL_LOCK + || key_code == KC_CAPS_LOCK); +} + +/*----------------------------------------------------------------------------*/ +/** + * Checks if some keys were pressed or released and generates key events. + * + * An event is created only when key is pressed or released. Besides handling + * the events (usb_kbd_push_ev()), the auto-repeat fibril is notified about + * key presses and releases (see usb_kbd_repeat_start() and + * usb_kbd_repeat_stop()). + * + * @param kbd_dev Keyboard device structure. + * @param key_codes Parsed keyboard report - codes of currently pressed keys + * according to HID Usage Tables. + * @param count Number of key codes in report (size of the report). + * + * @sa usb_kbd_push_ev(), usb_kbd_repeat_start(), usb_kbd_repeat_stop() + */ +static void usb_kbd_check_key_changes(usb_kbd_t *kbd_dev, + const uint8_t *key_codes, size_t count) +{ + unsigned int key; + unsigned int i, j; + + /* + * First of all, check if the kbd have reported phantom state. + * + * As there is no way to distinguish keys from modifiers, we do not have + * a way to check that 'all keys report Error Rollover'. We thus check + * if there is at least one such error and in such case we ignore the + * whole input report. + */ + i = 0; + while (i < count && key_codes[i] != ERROR_ROLLOVER) { + ++i; + } + if (i != count) { + usb_log_debug("Phantom state occured.\n"); + // phantom state, do nothing + return; + } + + /* TODO: quite dummy right now, think of better implementation */ + assert(count == kbd_dev->key_count); + + /* + * 1) Key releases + */ + for (j = 0; j < count; ++j) { + // try to find the old key in the new key list + i = 0; + while (i < kbd_dev->key_count + && key_codes[i] != kbd_dev->keys[j]) { + ++i; + } + + if (i == count) { + // not found, i.e. the key was released + key = usbhid_parse_scancode(kbd_dev->keys[j]); + if (!usb_kbd_is_lock(key)) { + usb_kbd_repeat_stop(kbd_dev, key); + } + usb_kbd_push_ev(kbd_dev, KEY_RELEASE, key); + usb_log_debug2("Key released: %d\n", key); + } else { + // found, nothing happens + } + } + + /* + * 1) Key presses + */ + for (i = 0; i < kbd_dev->key_count; ++i) { + // try to find the new key in the old key list + j = 0; + while (j < count && kbd_dev->keys[j] != key_codes[i]) { + ++j; + } + + if (j == count) { + // not found, i.e. new key pressed + key = usbhid_parse_scancode(key_codes[i]); + usb_log_debug2("Key pressed: %d (keycode: %d)\n", key, + key_codes[i]); + usb_kbd_push_ev(kbd_dev, KEY_PRESS, key); + if (!usb_kbd_is_lock(key)) { + usb_kbd_repeat_start(kbd_dev, key); + } + } else { + // found, nothing happens + } + } + + memcpy(kbd_dev->keys, key_codes, count); + + usb_log_debug("New stored keycodes: %s\n", + usb_debug_str_buffer(kbd_dev->keys, kbd_dev->key_count, 0)); +} + +/*----------------------------------------------------------------------------*/ +/* Callbacks for parser */ +/*----------------------------------------------------------------------------*/ +/** + * Callback function for the HID report parser. + * + * This function is called by the HID report parser with the parsed report. + * The parsed report is used to check if any events occured (key was pressed or + * released, modifier was pressed or released). + * + * @param key_codes Parsed keyboard report - codes of currently pressed keys + * according to HID Usage Tables. + * @param count Number of key codes in report (size of the report). + * @param modifiers Bitmap of modifiers (Ctrl, Alt, Shift, GUI). + * @param arg User-specified argument. Expects pointer to the keyboard device + * structure representing the keyboard. + * + * @sa usb_kbd_check_key_changes(), usb_kbd_check_modifier_changes() + */ +static void usb_kbd_process_keycodes(const uint8_t *key_codes, size_t count, + uint8_t modifiers, void *arg) +{ + if (arg == NULL) { + usb_log_warning("Missing argument in callback " + "usbhid_process_keycodes().\n"); + return; + } + + usb_kbd_t *kbd_dev = (usb_kbd_t *)arg; + assert(kbd_dev != NULL); + + usb_log_debug("Got keys from parser: %s\n", + usb_debug_str_buffer(key_codes, count, 0)); + + if (count != kbd_dev->key_count) { + usb_log_warning("Number of received keycodes (%d) differs from" + " expected number (%d).\n", count, kbd_dev->key_count); + return; + } + + ///usb_kbd_check_modifier_changes(kbd_dev, key_codes, count); + usb_kbd_check_key_changes(kbd_dev, key_codes, count); +} + +/*----------------------------------------------------------------------------*/ +/* General kbd functions */ +/*----------------------------------------------------------------------------*/ +/** + * Processes data received from the device in form of report. + * + * This function uses the HID report parser to translate the data received from + * the device into generic USB HID key codes and into generic modifiers bitmap. + * The parser then calls the given callback (usb_kbd_process_keycodes()). + * + * @note Currently, only the boot protocol is supported. + * + * @param kbd_dev Keyboard device structure (must be initialized). + * @param buffer Data from the keyboard (i.e. the report). + * @param actual_size Size of the data from keyboard (report size) in bytes. + * + * @sa usb_kbd_process_keycodes(), usb_hid_boot_keyboard_input_report(), + * usb_hid_parse_report(). + */ +static void usb_kbd_process_data(usb_kbd_t *kbd_dev, + uint8_t *buffer, size_t actual_size) +{ + assert(kbd_dev->initialized == USB_KBD_STATUS_INITIALIZED); + assert(kbd_dev->parser != NULL); + + usb_hid_report_in_callbacks_t *callbacks = + (usb_hid_report_in_callbacks_t *)malloc( + sizeof(usb_hid_report_in_callbacks_t)); + + callbacks->keyboard = usb_kbd_process_keycodes; + + usb_log_debug("Calling usb_hid_parse_report() with " + "buffer %s\n", usb_debug_str_buffer(buffer, actual_size, 0)); + +// int rc = usb_hid_boot_keyboard_input_report(buffer, actual_size, +// callbacks, kbd_dev); + usb_hid_report_path_t *path = usb_hid_report_path(); + usb_hid_report_path_append_item(path, USB_HIDUT_PAGE_KEYBOARD, 0); + + int rc = usb_hid_parse_report(kbd_dev->parser, buffer, + actual_size, path, USB_HID_PATH_COMPARE_STRICT, callbacks, kbd_dev); + + usb_hid_report_path_free (path); + + if (rc != EOK) { + usb_log_warning("Error in usb_hid_boot_keyboard_input_report():" + "%s\n", str_error(rc)); + } +} + +/*----------------------------------------------------------------------------*/ +/* HID/KBD structure manipulation */ +/*----------------------------------------------------------------------------*/ + +static void usb_kbd_mark_unusable(usb_kbd_t *kbd_dev) +{ + kbd_dev->initialized = USB_KBD_STATUS_TO_DESTROY; +} + + +/*----------------------------------------------------------------------------*/ +/* API functions */ +/*----------------------------------------------------------------------------*/ +/** + * Creates a new USB/HID keyboard structure. + * + * The structure returned by this function is not initialized. Use + * usb_kbd_init() to initialize it prior to polling. + * + * @return New uninitialized structure for representing a USB/HID keyboard or + * NULL if not successful (memory error). + */ +usb_kbd_t *usb_kbd_new(void) +{ + usb_kbd_t *kbd_dev = + (usb_kbd_t *)malloc(sizeof(usb_kbd_t)); + + if (kbd_dev == NULL) { + usb_log_fatal("No memory!\n"); + return NULL; + } + + memset(kbd_dev, 0, sizeof(usb_kbd_t)); + + kbd_dev->parser = (usb_hid_report_parser_t *)(malloc(sizeof( + usb_hid_report_parser_t))); + if (kbd_dev->parser == NULL) { + usb_log_fatal("No memory!\n"); + free(kbd_dev); + return NULL; + } + + kbd_dev->console_phone = -1; + kbd_dev->initialized = USB_KBD_STATUS_UNINITIALIZED; + + return kbd_dev; +} + +/*----------------------------------------------------------------------------*/ +/** + * Initialization of the USB/HID keyboard structure. + * + * This functions initializes required structures from the device's descriptors. + * + * During initialization, the keyboard is switched into boot protocol, the idle + * rate is set to 0 (infinity), resulting in the keyboard only reporting event + * when a key is pressed or released. Finally, the LED lights are turned on + * according to the default setup of lock keys. + * + * @note By default, the keyboards is initialized with Num Lock turned on and + * other locks turned off. + * + * @param kbd_dev Keyboard device structure to be initialized. + * @param dev DDF device structure of the keyboard. + * + * @retval EOK if successful. + * @retval EINVAL if some parameter is not given. + * @return Other value inherited from function usbhid_dev_init(). + */ +int usb_kbd_init(usb_kbd_t *kbd_dev, usb_device_t *dev) +{ + int rc; + + usb_log_debug("Initializing HID/KBD structure...\n"); + + if (kbd_dev == NULL) { + usb_log_error("Failed to init keyboard structure: no structure" + " given.\n"); + return EINVAL; + } + + if (dev == NULL) { + usb_log_error("Failed to init keyboard structure: no USB device" + " given.\n"); + return EINVAL; + } + + if (kbd_dev->initialized == USB_KBD_STATUS_INITIALIZED) { + usb_log_warning("Keyboard structure already initialized.\n"); + return EINVAL; + } + + /* TODO: does not work! */ + if (!dev->pipes[USB_KBD_POLL_EP_NO].present) { + usb_log_warning("Required endpoint not found - probably not " + "a supported device.\n"); + return ENOTSUP; + } + + /* The USB device should already be initialized, save it in structure */ + kbd_dev->usb_dev = dev; + + /* Initialize the report parser. */ + rc = usb_hid_parser_init(kbd_dev->parser); + if (rc != EOK) { + usb_log_error("Failed to initialize report parser.\n"); + return rc; + } + + /* Get the report descriptor and parse it. */ + rc = usb_hid_process_report_descriptor(kbd_dev->usb_dev, + kbd_dev->parser); + if (rc != EOK) { + usb_log_warning("Could not process report descriptor, " + "falling back to boot protocol.\n"); + rc = usb_hid_parse_report_descriptor(kbd_dev->parser, + BOOT_REPORT_DESCRIPTOR, BOOT_REPORT_DESCRIPTOR_SIZE); + if (rc != EOK) { + usb_log_error("Failed to parse boot report descriptor:" + " %s.\n", str_error(rc)); + return rc; + } + + rc = usbhid_req_set_protocol(&kbd_dev->usb_dev->ctrl_pipe, + kbd_dev->usb_dev->interface_no, USB_HID_PROTOCOL_BOOT); + + if (rc != EOK) { + usb_log_warning("Failed to set boot protocol to the " + "device: %s\n", str_error(rc)); + return rc; + } + } + + /* + * TODO: make more general + */ + usb_hid_report_path_t *path = usb_hid_report_path(); + usb_hid_report_path_append_item(path, USB_HIDUT_PAGE_KEYBOARD, 0); + kbd_dev->key_count = usb_hid_report_input_length( + kbd_dev->parser, path, USB_HID_PATH_COMPARE_STRICT); + usb_hid_report_path_free (path); + + usb_log_debug("Size of the input report: %zu\n", kbd_dev->key_count); + + kbd_dev->keys = (uint8_t *)calloc(kbd_dev->key_count, sizeof(uint8_t)); + + if (kbd_dev->keys == NULL) { + usb_log_fatal("No memory!\n"); + return ENOMEM; + } + + /* + * Output report + */ + kbd_dev->output_size = 0; + kbd_dev->output_buffer = usb_hid_report_output(kbd_dev->parser, + &kbd_dev->output_size); + if (kbd_dev->output_buffer == NULL) { + usb_log_warning("Error creating output report buffer.\n"); + free(kbd_dev->keys); + return ENOMEM; /* TODO: other error code */ + } + + usb_log_debug("Output buffer size: %zu\n", kbd_dev->output_size); + + kbd_dev->led_path = usb_hid_report_path(); + usb_hid_report_path_append_item( + kbd_dev->led_path, USB_HIDUT_PAGE_LED, 0); + + kbd_dev->led_output_size = usb_hid_report_output_size(kbd_dev->parser, + kbd_dev->led_path, USB_HID_PATH_COMPARE_END); + + usb_log_debug("Output report size (in items): %zu\n", + kbd_dev->led_output_size); + + kbd_dev->led_data = (int32_t *)calloc( + kbd_dev->led_output_size, sizeof(int32_t)); + + if (kbd_dev->led_data == NULL) { + usb_log_warning("Error creating buffer for LED output report." + "\n"); + free(kbd_dev->keys); + usb_hid_report_output_free(kbd_dev->output_buffer); + return ENOMEM; + } + + /* + * Modifiers and locks + */ + kbd_dev->modifiers = 0; + kbd_dev->mods = DEFAULT_ACTIVE_MODS; + kbd_dev->lock_keys = 0; + + /* + * Autorepeat + */ + kbd_dev->repeat.key_new = 0; + kbd_dev->repeat.key_repeated = 0; + kbd_dev->repeat.delay_before = DEFAULT_DELAY_BEFORE_FIRST_REPEAT; + kbd_dev->repeat.delay_between = DEFAULT_REPEAT_DELAY; + + kbd_dev->repeat_mtx = (fibril_mutex_t *)( + malloc(sizeof(fibril_mutex_t))); + if (kbd_dev->repeat_mtx == NULL) { + usb_log_fatal("No memory!\n"); + free(kbd_dev->keys); + return ENOMEM; + } + + fibril_mutex_initialize(kbd_dev->repeat_mtx); + + /* + * Set LEDs according to initial setup. + * Set Idle rate + */ + usb_kbd_set_led(kbd_dev); + + usbhid_req_set_idle(&kbd_dev->usb_dev->ctrl_pipe, + kbd_dev->usb_dev->interface_no, IDLE_RATE); + + kbd_dev->initialized = USB_KBD_STATUS_INITIALIZED; + usb_log_debug("HID/KBD device structure initialized.\n"); + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +bool usb_kbd_polling_callback(usb_device_t *dev, uint8_t *buffer, + size_t buffer_size, void *arg) +{ + if (dev == NULL || buffer == NULL || arg == NULL) { + // do not continue polling (???) + return false; + } + + usb_kbd_t *kbd_dev = (usb_kbd_t *)arg; + + // TODO: add return value from this function + usb_kbd_process_data(kbd_dev, buffer, buffer_size); + + return true; +} + +/*----------------------------------------------------------------------------*/ + +void usb_kbd_polling_ended_callback(usb_device_t *dev, bool reason, + void *arg) +{ + if (dev == NULL || arg == NULL) { + return; + } + + usb_kbd_t *kbd = (usb_kbd_t *)arg; + + usb_kbd_mark_unusable(kbd); +} + +/*----------------------------------------------------------------------------*/ + +int usb_kbd_is_initialized(const usb_kbd_t *kbd_dev) +{ + return (kbd_dev->initialized == USB_KBD_STATUS_INITIALIZED); +} + +/*----------------------------------------------------------------------------*/ + +int usb_kbd_is_ready_to_destroy(const usb_kbd_t *kbd_dev) +{ + return (kbd_dev->initialized == USB_KBD_STATUS_TO_DESTROY); +} + +/*----------------------------------------------------------------------------*/ +/** + * Properly destroys the USB/HID keyboard structure. + * + * @param kbd_dev Pointer to the structure to be destroyed. + */ +void usb_kbd_free(usb_kbd_t **kbd_dev) +{ + if (kbd_dev == NULL || *kbd_dev == NULL) { + return; + } + + // hangup phone to the console + async_hangup((*kbd_dev)->console_phone); + +// if ((*kbd_dev)->hid_dev != NULL) { +// usbhid_dev_free(&(*kbd_dev)->hid_dev); +// assert((*kbd_dev)->hid_dev == NULL); +// } + + if ((*kbd_dev)->repeat_mtx != NULL) { + /* TODO: replace by some check and wait */ + assert(!fibril_mutex_is_locked((*kbd_dev)->repeat_mtx)); + free((*kbd_dev)->repeat_mtx); + } + + // destroy the parser + if ((*kbd_dev)->parser != NULL) { + usb_hid_free_report_parser((*kbd_dev)->parser); + } + + // free the output buffer + usb_hid_report_output_free((*kbd_dev)->output_buffer); + + /* TODO: what about the USB device structure?? */ + + free(*kbd_dev); + *kbd_dev = NULL; +} + +/** + * @} + */ Index: uspace/drv/usbkbd/kbddev.h =================================================================== --- uspace/drv/usbkbd/kbddev.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/kbddev.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,154 @@ +/* + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** @file + * USB HID keyboard device structure and API. + */ + +#ifndef USB_KBDDEV_H_ +#define USB_KBDDEV_H_ + +#include + +#include + +#include +#include +#include +#include +#include + +#include "kbdrepeat.h" + +/*----------------------------------------------------------------------------*/ +/** + * USB/HID keyboard device type. + * + * Holds a reference to generic USB/HID device structure and keyboard-specific + * data, such as currently pressed keys, modifiers and lock keys. + * + * Also holds a IPC phone to the console (since there is now no other way to + * communicate with it). + * + * @note Storing active lock keys in this structure results in their setting + * being device-specific. + */ +typedef struct usb_kbd_t { + /** Structure holding generic USB device information. */ + //usbhid_dev_t *hid_dev; + usb_device_t *usb_dev; + + /** Currently pressed keys (not translated to key codes). */ + uint8_t *keys; + /** Count of stored keys (i.e. number of keys in the report). */ + size_t key_count; + /** Currently pressed modifiers (bitmap). */ + uint8_t modifiers; + + /** Currently active modifiers including locks. Sent to the console. */ + unsigned mods; + + /** Currently active lock keys. */ + unsigned lock_keys; + + /** IPC phone to the console device (for sending key events). */ + int console_phone; + + /** Information for auto-repeat of keys. */ + usb_kbd_repeat_t repeat; + + /** Mutex for accessing the information about auto-repeat. */ + fibril_mutex_t *repeat_mtx; + + /** Report descriptor. */ + uint8_t *report_desc; + + /** Report descriptor size. */ + size_t report_desc_size; + + uint8_t *output_buffer; + + size_t output_size; + + size_t led_output_size; + + usb_hid_report_path_t *led_path; + + int32_t *led_data; + + /** HID Report parser. */ + usb_hid_report_parser_t *parser; + + /** State of the structure (for checking before use). + * + * 0 - not initialized + * 1 - initialized + * -1 - ready for destroying + */ + int initialized; +} usb_kbd_t; + +/*----------------------------------------------------------------------------*/ + +enum { + USB_KBD_POLL_EP_NO = 0, + USB_KBD_POLL_EP_COUNT = 1 +}; + +usb_endpoint_description_t *usb_kbd_endpoints[USB_KBD_POLL_EP_COUNT + 1]; + +ddf_dev_ops_t keyboard_ops; + +/*----------------------------------------------------------------------------*/ + +usb_kbd_t *usb_kbd_new(void); + +int usb_kbd_init(usb_kbd_t *kbd_dev, usb_device_t *dev); + +bool usb_kbd_polling_callback(usb_device_t *dev, uint8_t *buffer, + size_t buffer_size, void *arg); + +void usb_kbd_polling_ended_callback(usb_device_t *dev, bool reason, + void *arg); + +int usb_kbd_is_initialized(const usb_kbd_t *kbd_dev); + +int usb_kbd_is_ready_to_destroy(const usb_kbd_t *kbd_dev); + +void usb_kbd_free(usb_kbd_t **kbd_dev); + +void usb_kbd_push_ev(usb_kbd_t *kbd_dev, int type, unsigned int key); + +#endif /* USB_KBDDEV_H_ */ + +/** + * @} + */ Index: uspace/drv/usbkbd/kbdrepeat.c =================================================================== --- uspace/drv/usbkbd/kbdrepeat.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/kbdrepeat.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,185 @@ +/* + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** + * @file + * USB HID keyboard autorepeat facilities + */ + +#include +#include +#include +#include + +#include + +#include "kbdrepeat.h" +#include "kbddev.h" + + +/** Delay between auto-repeat state checks when no key is being repeated. */ +static unsigned int CHECK_DELAY = 10000; + +/*----------------------------------------------------------------------------*/ +/** + * Main loop handling the auto-repeat of keys. + * + * This functions periodically checks if there is some key to be auto-repeated. + * + * If a new key is to be repeated, it uses the delay before first repeat stored + * in the keyboard structure to wait until the key has to start repeating. + * + * If the same key is still pressed, it uses the delay between repeats stored + * in the keyboard structure to wait until the key should be repeated. + * + * If the currently repeated key is not pressed any more ( + * usb_kbd_repeat_stop() was called), it stops repeating it and starts + * checking again. + * + * @note For accessing the keyboard device auto-repeat information a fibril + * mutex (repeat_mtx) from the @a kbd structure is used. + * + * @param kbd Keyboard device structure. + */ +static void usb_kbd_repeat_loop(usb_kbd_t *kbd) +{ + unsigned int delay = 0; + + usb_log_debug("Starting autorepeat loop.\n"); + + while (true) { + // check if the kbd structure is usable + if (!usb_kbd_is_initialized(kbd)) { + if (usb_kbd_is_ready_to_destroy(kbd)) { + usb_kbd_free(&kbd); + assert(kbd == NULL); + } + return; + } + + fibril_mutex_lock(kbd->repeat_mtx); + + if (kbd->repeat.key_new > 0) { + if (kbd->repeat.key_new == kbd->repeat.key_repeated) { + usb_log_debug2("Repeating key: %u.\n", + kbd->repeat.key_repeated); + usb_kbd_push_ev(kbd, KEY_PRESS, + kbd->repeat.key_repeated); + delay = kbd->repeat.delay_between; + } else { + usb_log_debug("New key to repeat: %u.\n", + kbd->repeat.key_new); + kbd->repeat.key_repeated = kbd->repeat.key_new; + delay = kbd->repeat.delay_before; + } + } else { + if (kbd->repeat.key_repeated > 0) { + usb_log_debug("Stopping to repeat key: %u.\n", + kbd->repeat.key_repeated); + kbd->repeat.key_repeated = 0; + } + delay = CHECK_DELAY; + } + fibril_mutex_unlock(kbd->repeat_mtx); + + async_usleep(delay); + } +} + +/*----------------------------------------------------------------------------*/ +/** + * Main routine to be executed by a fibril for handling auto-repeat. + * + * Starts the loop for checking changes in auto-repeat. + * + * @param arg User-specified argument. Expects pointer to the keyboard device + * structure representing the keyboard. + * + * @retval EOK if the routine has finished. + * @retval EINVAL if no argument is supplied. + */ +int usb_kbd_repeat_fibril(void *arg) +{ + usb_log_debug("Autorepeat fibril spawned.\n"); + + if (arg == NULL) { + usb_log_error("No device!\n"); + return EINVAL; + } + + usb_kbd_t *kbd = (usb_kbd_t *)arg; + + usb_kbd_repeat_loop(kbd); + + return EOK; +} + +/*----------------------------------------------------------------------------*/ +/** + * Start repeating particular key. + * + * @note Only one key is repeated at any time, so calling this function + * effectively cancels auto-repeat of the current repeated key (if any) + * and 'schedules' another key for auto-repeat. + * + * @param kbd Keyboard device structure. + * @param key Key to start repeating. + */ +void usb_kbd_repeat_start(usb_kbd_t *kbd, unsigned int key) +{ + fibril_mutex_lock(kbd->repeat_mtx); + kbd->repeat.key_new = key; + fibril_mutex_unlock(kbd->repeat_mtx); +} + +/*----------------------------------------------------------------------------*/ +/** + * Stop repeating particular key. + * + * @note Only one key is repeated at any time, but this function may be called + * even with key that is not currently repeated (in that case nothing + * happens). + * + * @param kbd Keyboard device structure. + * @param key Key to stop repeating. + */ +void usb_kbd_repeat_stop(usb_kbd_t *kbd, unsigned int key) +{ + fibril_mutex_lock(kbd->repeat_mtx); + if (key == kbd->repeat.key_new) { + kbd->repeat.key_new = 0; + } + fibril_mutex_unlock(kbd->repeat_mtx); +} + +/** + * @} + */ Index: uspace/drv/usbkbd/kbdrepeat.h =================================================================== --- uspace/drv/usbkbd/kbdrepeat.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/kbdrepeat.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,68 @@ +/* + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** @file + * USB HID keyboard autorepeat facilities + */ + +#ifndef USB_KBDREPEAT_H_ +#define USB_KBDREPEAT_H_ + +struct usb_kbd_t; + +/*----------------------------------------------------------------------------*/ +/** + * Structure for keeping information needed for auto-repeat of keys. + */ +typedef struct { + /** Last pressed key. */ + unsigned int key_new; + /** Key to be repeated. */ + unsigned int key_repeated; + /** Delay before first repeat in microseconds. */ + unsigned int delay_before; + /** Delay between repeats in microseconds. */ + unsigned int delay_between; +} usb_kbd_repeat_t; + +/*----------------------------------------------------------------------------*/ + +int usb_kbd_repeat_fibril(void *arg); + +void usb_kbd_repeat_start(struct usb_kbd_t *kbd, unsigned int key); + +void usb_kbd_repeat_stop(struct usb_kbd_t *kbd, unsigned int key); + +#endif /* USB_KBDREPEAT_H_ */ + +/** + * @} + */ Index: uspace/drv/usbkbd/layout.h =================================================================== --- uspace/drv/usbkbd/layout.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/layout.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,57 @@ +/* + * Copyright (c) 2009 Jiri Svoboda + * Copyright (c) 2011 Lubos Slovak + * (copied from /uspace/srv/hid/kbd/include/layout.h) + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** @file + * Keyboard layout. + */ + +#ifndef USB_KBD_LAYOUT_H_ +#define USB_KBD_LAYOUT_H_ + +#include +#include + +typedef struct { + void (*reset)(void); + wchar_t (*parse_ev)(console_event_t *); +} layout_op_t; + +extern layout_op_t us_qwerty_op; +extern layout_op_t us_dvorak_op; +extern layout_op_t cz_op; + +#endif + +/** + * @} + */ Index: uspace/drv/usbkbd/main.c =================================================================== --- uspace/drv/usbkbd/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,264 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * Copyright (c) 2011 Lubos Slovak + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbhid + * @{ + */ +/** + * @file + * Main routines of USB HID driver. + */ + +#include +#include +#include +#include + +#include + +#include "kbddev.h" +#include "kbdrepeat.h" + +/*----------------------------------------------------------------------------*/ + +#define NAME "usbkbd" + +/** + * Function for adding a new device of type USB/HID/keyboard. + * + * This functions initializes required structures from the device's descriptors + * and starts new fibril for polling the keyboard for events and another one for + * handling auto-repeat of keys. + * + * During initialization, the keyboard is switched into boot protocol, the idle + * rate is set to 0 (infinity), resulting in the keyboard only reporting event + * when a key is pressed or released. Finally, the LED lights are turned on + * according to the default setup of lock keys. + * + * @note By default, the keyboards is initialized with Num Lock turned on and + * other locks turned off. + * @note Currently supports only boot-protocol keyboards. + * + * @param dev Device to add. + * + * @retval EOK if successful. + * @retval ENOMEM if there + * @return Other error code inherited from one of functions usb_kbd_init(), + * ddf_fun_bind() and ddf_fun_add_to_class(). + * + * @sa usb_kbd_fibril(), usb_kbd_repeat_fibril() + */ +static int usbhid_try_add_device(usb_device_t *dev) +{ + /* Create the function exposed under /dev/devices. */ + ddf_fun_t *kbd_fun = ddf_fun_create(dev->ddf_dev, fun_exposed, + "keyboard"); + if (kbd_fun == NULL) { + usb_log_error("Could not create DDF function node.\n"); + return ENOMEM; + } + + /* + * Initialize device (get and process descriptors, get address, etc.) + */ + usb_log_debug("Initializing USB/HID KBD device...\n"); + + usb_kbd_t *kbd_dev = usb_kbd_new(); + if (kbd_dev == NULL) { + usb_log_error("Error while creating USB/HID KBD device " + "structure.\n"); + ddf_fun_destroy(kbd_fun); + return ENOMEM; // TODO: some other code?? + } + + int rc = usb_kbd_init(kbd_dev, dev); + + if (rc != EOK) { + usb_log_error("Failed to initialize USB/HID KBD device.\n"); + ddf_fun_destroy(kbd_fun); + usb_kbd_free(&kbd_dev); + return rc; + } + + usb_log_debug("USB/HID KBD device structure initialized.\n"); + + /* + * Store the initialized keyboard device and keyboard ops + * to the DDF function. + */ + kbd_fun->driver_data = kbd_dev; + kbd_fun->ops = &keyboard_ops; + + rc = ddf_fun_bind(kbd_fun); + if (rc != EOK) { + usb_log_error("Could not bind DDF function: %s.\n", + str_error(rc)); + // TODO: Can / should I destroy the DDF function? + ddf_fun_destroy(kbd_fun); + usb_kbd_free(&kbd_dev); + return rc; + } + + rc = ddf_fun_add_to_class(kbd_fun, "keyboard"); + if (rc != EOK) { + usb_log_error( + "Could not add DDF function to class 'keyboard': %s.\n", + str_error(rc)); + // TODO: Can / should I destroy the DDF function? + ddf_fun_destroy(kbd_fun); + usb_kbd_free(&kbd_dev); + return rc; + } + + /* + * Create new fibril for handling this keyboard + */ + //fid_t fid = fibril_create(usb_kbd_fibril, kbd_dev); + + /* Start automated polling function. + * This will create a separate fibril that will query the device + * for the data continuously + */ + rc = usb_device_auto_poll(dev, + /* Index of the polling pipe. */ + USB_KBD_POLL_EP_NO, + /* Callback when data arrives. */ + usb_kbd_polling_callback, + /* How much data to request. */ + dev->pipes[USB_KBD_POLL_EP_NO].pipe->max_packet_size, + /* Callback when the polling ends. */ + usb_kbd_polling_ended_callback, + /* Custom argument. */ + kbd_dev); + + + if (rc != EOK) { + usb_log_error("Failed to start polling fibril for `%s'.\n", + dev->ddf_dev->name); + return rc; + } + //fibril_add_ready(fid); + + /* + * Create new fibril for auto-repeat + */ + fid_t fid = fibril_create(usb_kbd_repeat_fibril, kbd_dev); + if (fid == 0) { + usb_log_error("Failed to start fibril for KBD auto-repeat"); + return ENOMEM; + } + fibril_add_ready(fid); + + (void)keyboard_ops; + + /* + * Hurrah, device is initialized. + */ + return EOK; +} + +/*----------------------------------------------------------------------------*/ +/** + * Callback for passing a new device to the driver. + * + * @note Currently, only boot-protocol keyboards are supported by this driver. + * + * @param dev Structure representing the new device. + * + * @retval EOK if successful. + * @retval EREFUSED if the device is not supported. + */ +static int usbhid_add_device(usb_device_t *dev) +{ + usb_log_debug("usbhid_add_device()\n"); + + if (dev->interface_no < 0) { + usb_log_warning("Device is not a supported keyboard.\n"); + usb_log_error("Failed to add HID device: endpoint not found." + "\n"); + return ENOTSUP; + } + + int rc = usbhid_try_add_device(dev); + + if (rc != EOK) { + usb_log_warning("Device is not a supported keyboard.\n"); + usb_log_error("Failed to add HID device: %s.\n", + str_error(rc)); + return rc; + } + + usb_log_info("Keyboard `%s' ready to use.\n", dev->ddf_dev->name); + + return EOK; +} + +/*----------------------------------------------------------------------------*/ + +/* Currently, the framework supports only device adding. Once the framework + * supports unplug, more callbacks will be added. */ +static usb_driver_ops_t usbhid_driver_ops = { + .add_device = usbhid_add_device, +}; + + +/* The driver itself. */ +static usb_driver_t usbhid_driver = { + .name = NAME, + .ops = &usbhid_driver_ops, + .endpoints = usb_kbd_endpoints +}; + +/*----------------------------------------------------------------------------*/ + +//static driver_ops_t kbd_driver_ops = { +// .add_device = usbhid_add_device, +//}; + +///*----------------------------------------------------------------------------*/ + +//static driver_t kbd_driver = { +// .name = NAME, +// .driver_ops = &kbd_driver_ops +//}; + +/*----------------------------------------------------------------------------*/ + +int main(int argc, char *argv[]) +{ + printf(NAME ": HelenOS USB HID driver.\n"); + + usb_log_enable(USB_LOG_LEVEL_DEBUG, NAME); + + return usb_driver_main(&usbhid_driver); +} + +/** + * @} + */ Index: uspace/drv/usbkbd/usbkbd.ma =================================================================== --- uspace/drv/usbkbd/usbkbd.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbkbd/usbkbd.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,2 @@ +100 usb&interface&class=HID&subclass=0x01&protocol=0x01 +10 usb&interface&class=HID Index: uspace/drv/usbmid/Makefile =================================================================== --- uspace/drv/usbmid/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmid/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,40 @@ +# +# Copyright (c) 2011 Vojtech Horky +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBS = $(LIBDRV_PREFIX)/libdrv.a $(LIBUSB_PREFIX)/libusb.a +EXTRA_CFLAGS += -I$(LIBDRV_PREFIX)/include -I$(LIBUSB_PREFIX)/include +BINARY = usbmid + +SOURCES = \ + dump.c \ + explore.c \ + main.c \ + usbmid.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/usbmid/dump.c =================================================================== --- uspace/drv/usbmid/dump.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmid/dump.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,120 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmid + * @{ + */ +/** + * @file + * Dumping and debugging functions. + */ +#include +#include +#include +#include +#include +#include +#include "usbmid.h" + +/** Dump found descriptor. + * + * @param data Descriptor data. + * @param depth Nesting depth. + */ +static void dump_tree_descriptor(uint8_t *data, size_t depth) +{ + if (data == NULL) { + return; + } + int type = (int) *(data + 1); + if (type == USB_DESCTYPE_INTERFACE) { + usb_standard_interface_descriptor_t *descriptor + = (usb_standard_interface_descriptor_t *) data; + usb_log_info("Found interface: %s (0x%02x/0x%02x/0x%02x).\n", + usb_str_class(descriptor->interface_class), + (int) descriptor->interface_class, + (int) descriptor->interface_subclass, + (int) descriptor->interface_protocol); + } +} + +/** Dump tree of descriptors. + * + * @param parser Descriptor parser. + * @param data Descriptor parser data. + * @param root Pointer to current root. + * @param depth Nesting depth. + */ +static void dump_tree_internal(usb_dp_parser_t *parser, usb_dp_parser_data_t *data, + uint8_t *root, size_t depth) +{ + if (root == NULL) { + return; + } + dump_tree_descriptor(root, depth); + uint8_t *child = usb_dp_get_nested_descriptor(parser, data, root); + do { + dump_tree_internal(parser, data, child, depth + 1); + child = usb_dp_get_sibling_descriptor(parser, data, root, child); + } while (child != NULL); +} + +/** Dump descriptor tree. + * + * @param parser Descriptor parser. + * @param data Descriptor parser data. + */ +static void dump_tree(usb_dp_parser_t *parser, usb_dp_parser_data_t *data) +{ + uint8_t *ptr = data->data; + dump_tree_internal(parser, data, ptr, 0); +} + +/** Dump given descriptors. + * + * @param descriptors Descriptors buffer (typically full config descriptor). + * @param length Size of @p descriptors buffer in bytes. + */ +void usbmid_dump_descriptors(uint8_t *descriptors, size_t length) +{ + usb_dp_parser_data_t data = { + .data = descriptors, + .size = length, + .arg = NULL + }; + + usb_dp_parser_t parser = { + .nesting = usb_dp_standard_descriptor_nesting + }; + + dump_tree(&parser, &data); +} + +/** + * @} + */ Index: uspace/drv/usbmid/explore.c =================================================================== --- uspace/drv/usbmid/explore.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmid/explore.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,204 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmid + * @{ + */ +/** + * @file + * Exploration of available interfaces in the USB device. + */ +#include +#include +#include +#include +#include +#include +#include +#include "usbmid.h" + +/** Operations of the device itself. */ +static ddf_dev_ops_t mid_device_ops = { + .interfaces[USB_DEV_IFACE] = &usb_iface_hub_impl +}; + +/** Find starting indexes of all interface descriptors in a configuration. + * + * @param config_descriptor Full configuration descriptor. + * @param config_descriptor_size Size of @p config_descriptor in bytes. + * @param interface_positions Array where to store indexes of interfaces. + * @param interface_count Size of @p interface_positions array. + * @return Number of found interfaces. + * @retval (size_t)-1 Error occured. + */ +static size_t find_interface_descriptors(uint8_t *config_descriptor, + size_t config_descriptor_size, + size_t *interface_positions, size_t interface_count) +{ + if (interface_count == 0) { + return (size_t) -1; + } + + usb_dp_parser_data_t data = { + .data = config_descriptor, + .size = config_descriptor_size, + .arg = NULL + }; + + usb_dp_parser_t parser = { + .nesting = usb_dp_standard_descriptor_nesting + }; + + uint8_t *interface = usb_dp_get_nested_descriptor(&parser, &data, + data.data); + if (interface == NULL) { + return (size_t) -1; + } + if (interface[1] != USB_DESCTYPE_INTERFACE) { + return (size_t) -1; + } + + size_t found_interfaces = 0; + interface_positions[found_interfaces] = interface - config_descriptor; + found_interfaces++; + + while (interface != NULL) { + interface = usb_dp_get_sibling_descriptor(&parser, &data, + data.data, interface); + if ((interface != NULL) + && (found_interfaces < interface_count) + && (interface[1] == USB_DESCTYPE_INTERFACE)) { + interface_positions[found_interfaces] + = interface - config_descriptor; + found_interfaces++; + } + } + + return found_interfaces; +} + +/** Explore MID device. + * + * We expect that @p dev is initialized and session on control pipe is + * started. + * + * @param dev Device to be explored. + * @return Whether to accept this device from devman. + */ +bool usbmid_explore_device(usb_device_t *dev) +{ + int rc; + + int dev_class = dev->descriptors.device.device_class; + if (dev_class != USB_CLASS_USE_INTERFACE) { + usb_log_warning( + "Device class: %d (%s), but expected class 0.\n", + dev_class, usb_str_class(dev_class)); + usb_log_error("Not multi interface device, refusing.\n"); + return false; + } + + /* Short cuts to save on typing ;-). */ + uint8_t *config_descriptor_raw = dev->descriptors.configuration; + size_t config_descriptor_size = dev->descriptors.configuration_size; + usb_standard_configuration_descriptor_t *config_descriptor = + (usb_standard_configuration_descriptor_t *) config_descriptor_raw; + + size_t *interface_descriptors + = malloc(sizeof(size_t) * config_descriptor->interface_count); + if (interface_descriptors == NULL) { + usb_log_error("Out of memory (wanted %zuB).\n", + sizeof(size_t) * config_descriptor->interface_count); + free(config_descriptor_raw); + return false; + } + size_t interface_descriptors_count + = find_interface_descriptors( + config_descriptor_raw, config_descriptor_size, + interface_descriptors, config_descriptor->interface_count); + + if (interface_descriptors_count == (size_t) -1) { + usb_log_error("Problem parsing configuration descriptor.\n"); + free(interface_descriptors); + return false; + } + + /* Select the first configuration */ + rc = usb_request_set_configuration(&dev->ctrl_pipe, + config_descriptor->configuration_number); + if (rc != EOK) { + usb_log_error("Failed to set device configuration: %s.\n", + str_error(rc)); + free(interface_descriptors); + return false; + } + + + /* Create control function */ + ddf_fun_t *ctl_fun = ddf_fun_create(dev->ddf_dev, fun_exposed, "ctl"); + if (ctl_fun == NULL) { + usb_log_error("Failed to create control function.\n"); + free(interface_descriptors); + return false; + } + + ctl_fun->ops = &mid_device_ops; + + rc = ddf_fun_bind(ctl_fun); + if (rc != EOK) { + usb_log_error("Failed to bind control function: %s.\n", + str_error(rc)); + free(interface_descriptors); + return false; + } + + /* Spawn interface children */ + size_t i; + for (i = 0; i < interface_descriptors_count; i++) { + usb_standard_interface_descriptor_t *interface + = (usb_standard_interface_descriptor_t *) + (config_descriptor_raw + interface_descriptors[i]); + usb_log_debug2("Interface descriptor at index %zu (type %d).\n", + interface_descriptors[i], (int) interface->descriptor_type); + usb_log_info("Creating child for interface %d (%s).\n", + (int) interface->interface_number, + usb_str_class(interface->interface_class)); + rc = usbmid_spawn_interface_child(dev, &dev->descriptors.device, + interface); + if (rc != EOK) { + usb_log_error("Failed to create interface child: %s.\n", + str_error(rc)); + } + } + + return true; +} + +/** + * @} + */ Index: uspace/drv/usbmid/main.c =================================================================== --- uspace/drv/usbmid/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmid/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,102 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmid + * @{ + */ +/** + * @file + * Main routines of USB multi interface device driver. + */ +#include +#include +#include +#include +#include +#include +#include + +#include "usbmid.h" + +/** Callback when new MID device is attached to the host. + * + * @param gen_dev Generic DDF device representing the new device. + * @return Error code. + */ +static int usbmid_add_device(usb_device_t *dev) +{ + usb_log_info("Taking care of new MID `%s'.\n", dev->ddf_dev->name); + + int rc; + + rc = usb_pipe_start_session(&dev->ctrl_pipe); + if (rc != EOK) { + usb_log_error("Failed to start session on control pipe: %s.\n", + str_error(rc)); + return rc; + } + + bool accept = usbmid_explore_device(dev); + + rc = usb_pipe_end_session(&dev->ctrl_pipe); + if (rc != EOK) { + usb_log_warning("Failed to end session on control pipe: %s.\n", + str_error(rc)); + } + + if (!accept) { + return ENOTSUP; + } + + return EOK; +} + +/** USB MID driver ops. */ +static usb_driver_ops_t mid_driver_ops = { + .add_device = usbmid_add_device, +}; + +/** USB MID driver. */ +static usb_driver_t mid_driver = { + .name = NAME, + .ops = &mid_driver_ops, + .endpoints = NULL +}; + +int main(int argc, char *argv[]) +{ + printf(NAME ": USB multi interface device driver.\n"); + + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + + return usb_driver_main(&mid_driver); +} + +/** + * @} + */ Index: uspace/drv/usbmid/usbmid.c =================================================================== --- uspace/drv/usbmid/usbmid.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmid/usbmid.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,183 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmid + * @{ + */ +/** + * @file + * Helper functions. + */ +#include +#include +#include +#include +#include +#include +#include +#include +#include "usbmid.h" + +/** Callback for DDF USB interface. */ +static int usb_iface_get_address_impl(ddf_fun_t *fun, devman_handle_t handle, + usb_address_t *address) +{ + return usb_iface_get_address_hub_impl(fun, handle, address); +} + +/** Callback for DDF USB interface. */ +static int usb_iface_get_interface_impl(ddf_fun_t *fun, devman_handle_t handle, + int *iface_no) +{ + assert(fun); + + usbmid_interface_t *iface = fun->driver_data; + assert(iface); + + if (iface_no != NULL) { + *iface_no = iface->interface_no; + } + + return EOK; +} + +/** DDF interface of the child - interface function. */ +static usb_iface_t child_usb_iface = { + .get_hc_handle = usb_iface_get_hc_handle_hub_child_impl, + .get_address = usb_iface_get_address_impl, + .get_interface = usb_iface_get_interface_impl +}; + +/** Operations for children - interface functions. */ +static ddf_dev_ops_t child_device_ops = { + .interfaces[USB_DEV_IFACE] = &child_usb_iface +}; + +/** Create new interface for USB MID device. + * + * @param fun Backing generic DDF device function (representing interface). + * @param iface_no Interface number. + * @return New interface. + * @retval NULL Error occured. + */ +usbmid_interface_t *usbmid_interface_create(ddf_fun_t *fun, int iface_no) +{ + usbmid_interface_t *iface = malloc(sizeof(usbmid_interface_t)); + if (iface == NULL) { + usb_log_error("Out of memory (wanted %zuB).\n", + sizeof(usbmid_interface_t)); + return NULL; + } + + iface->fun = fun; + iface->interface_no = iface_no; + + return iface; +} + + +/** Spawn new child device from one interface. + * + * @param parent Parent MID device. + * @param device_descriptor Device descriptor. + * @param interface_descriptor Interface descriptor. + * @return Error code. + */ +int usbmid_spawn_interface_child(usb_device_t *parent, + const usb_standard_device_descriptor_t *device_descriptor, + const usb_standard_interface_descriptor_t *interface_descriptor) +{ + ddf_fun_t *child = NULL; + char *child_name = NULL; + usbmid_interface_t *child_as_interface = NULL; + int rc; + + /* + * Name is class name followed by interface number. + * The interface number shall provide uniqueness while the + * class name something humanly understandable. + */ + rc = asprintf(&child_name, "%s%d", + usb_str_class(interface_descriptor->interface_class), + (int) interface_descriptor->interface_number); + if (rc < 0) { + goto error_leave; + } + + /* Create the device. */ + child = ddf_fun_create(parent->ddf_dev, fun_inner, child_name); + if (child == NULL) { + rc = ENOMEM; + goto error_leave; + } + + + + child_as_interface = usbmid_interface_create(child, + (int) interface_descriptor->interface_number); + if (child_as_interface == NULL) { + rc = ENOMEM; + goto error_leave; + } + + child->driver_data = child_as_interface; + child->ops = &child_device_ops; + + rc = usb_device_create_match_ids_from_interface(device_descriptor, + interface_descriptor, + &child->match_ids); + if (rc != EOK) { + goto error_leave; + } + + rc = ddf_fun_bind(child); + if (rc != EOK) { + goto error_leave; + } + + return EOK; + +error_leave: + if (child != NULL) { + child->name = NULL; + /* This takes care of match_id deallocation as well. */ + ddf_fun_destroy(child); + } + if (child_name != NULL) { + free(child_name); + } + if (child_as_interface != NULL) { + free(child_as_interface); + } + + return rc; +} + +/** + * @} + */ Index: uspace/drv/usbmid/usbmid.h =================================================================== --- uspace/drv/usbmid/usbmid.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmid/usbmid.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,66 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmid + * @{ + */ +/** @file + * Common definitions. + */ + +#ifndef USBMID_H_ +#define USBMID_H_ + +#include +#include +#include +#include +#include + +#define NAME "usbmid" + +/** Container for single interface in a MID device. */ +typedef struct { + /** Function container. */ + ddf_fun_t *fun; + + /** Interface number. */ + int interface_no; +} usbmid_interface_t; + +usbmid_interface_t *usbmid_interface_create(ddf_fun_t *, int); +bool usbmid_explore_device(usb_device_t *); +int usbmid_spawn_interface_child(usb_device_t *, + const usb_standard_device_descriptor_t *, + const usb_standard_interface_descriptor_t *); +void usbmid_dump_descriptors(uint8_t *, size_t); + +#endif +/** + * @} + */ Index: uspace/drv/usbmid/usbmid.ma =================================================================== --- uspace/drv/usbmid/usbmid.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmid/usbmid.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,1 @@ +100 usb&mid Index: uspace/drv/usbmouse/Makefile =================================================================== --- uspace/drv/usbmouse/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmouse/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,40 @@ +# +# Copyright (c) 2011 Vojtech Horky +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBS = $(LIBDRV_PREFIX)/libdrv.a $(LIBUSB_PREFIX)/libusb.a +EXTRA_CFLAGS += -I$(LIBDRV_PREFIX)/include -I$(LIBUSB_PREFIX)/include -I. + +BINARY = usbmouse + +SOURCES = \ + init.c \ + main.c \ + mouse.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/usbmouse/init.c =================================================================== --- uspace/drv/usbmouse/init.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmouse/init.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,160 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmouse + * @{ + */ +/** + * @file + * Initialization routines for USB mouse driver. + */ +#include "mouse.h" +#include +#include +#include +#include +#include + +/** Mouse polling endpoint description for boot protocol subclass. */ +usb_endpoint_description_t poll_endpoint_description = { + .transfer_type = USB_TRANSFER_INTERRUPT, + .direction = USB_DIRECTION_IN, + .interface_class = USB_CLASS_HID, + .interface_subclass = USB_HID_SUBCLASS_BOOT, + .interface_protocol = USB_HID_PROTOCOL_MOUSE, + .flags = 0 +}; + +static void default_connection_handler(ddf_fun_t *, ipc_callid_t, ipc_call_t *); +/** Device ops for USB mouse. */ +static ddf_dev_ops_t mouse_ops = { + .default_handler = default_connection_handler +}; + +/** Default handler for IPC methods not handled by DDF. + * + * @param fun Device function handling the call. + * @param icallid Call id. + * @param icall Call data. + */ +void default_connection_handler(ddf_fun_t *fun, + ipc_callid_t icallid, ipc_call_t *icall) +{ + sysarg_t method = IPC_GET_IMETHOD(*icall); + + usb_mouse_t *mouse = (usb_mouse_t *) fun->driver_data; + assert(mouse != NULL); + + if (method == IPC_M_CONNECT_TO_ME) { + int callback = IPC_GET_ARG5(*icall); + + if (mouse->console_phone != -1) { + async_answer_0(icallid, ELIMIT); + return; + } + + mouse->console_phone = callback; + async_answer_0(icallid, EOK); + return; + } + + async_answer_0(icallid, EINVAL); +} + +/** Create USB mouse device. + * + * The mouse device is stored into dev->driver_data. + * + * @param dev Generic device. + * @return Error code. + */ +int usb_mouse_create(usb_device_t *dev) +{ + usb_mouse_t *mouse = malloc(sizeof(usb_mouse_t)); + if (mouse == NULL) { + return ENOMEM; + } + mouse->dev = dev; + mouse->console_phone = -1; + + int rc; + + /* Create DDF function. */ + mouse->mouse_fun = ddf_fun_create(dev->ddf_dev, fun_exposed, "mouse"); + if (mouse->mouse_fun == NULL) { + rc = ENOMEM; + goto leave; + } + + mouse->mouse_fun->ops = &mouse_ops; + + rc = ddf_fun_bind(mouse->mouse_fun); + if (rc != EOK) { + goto leave; + } + + /* Add the function to mouse class. */ + rc = ddf_fun_add_to_class(mouse->mouse_fun, "mouse"); + if (rc != EOK) { + goto leave; + } + + /* Open the control pipe. */ + rc = usb_pipe_start_session(&dev->ctrl_pipe); + if (rc != EOK) { + goto leave; + } + + /* Set the boot protocol. */ + rc = usb_control_request_set(&dev->ctrl_pipe, + USB_REQUEST_TYPE_CLASS, USB_REQUEST_RECIPIENT_INTERFACE, + USB_HIDREQ_SET_PROTOCOL, USB_HID_PROTOCOL_BOOT, dev->interface_no, + NULL, 0); + if (rc != EOK) { + goto leave; + } + + /* Close the control pipe (ignore errors). */ + usb_pipe_end_session(&dev->ctrl_pipe); + + + /* Everything allright. */ + dev->driver_data = mouse; + mouse->mouse_fun->driver_data = mouse; + + return EOK; + +leave: + free(mouse); + + return rc; +} + +/** + * @} + */ Index: uspace/drv/usbmouse/main.c =================================================================== --- uspace/drv/usbmouse/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmouse/main.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,99 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmouse + * @{ + */ +/** + * @file + * Main routines of USB boot protocol mouse driver. + */ +#include "mouse.h" +#include +#include +#include + +/** Callback when new mouse device is attached and recognised by DDF. + * + * @param dev Representation of a generic DDF device. + * @return Error code. + */ +static int usbmouse_add_device(usb_device_t *dev) +{ + int rc = usb_mouse_create(dev); + if (rc != EOK) { + usb_log_error("Failed to initialize device driver: %s.\n", + str_error(rc)); + return rc; + } + + usb_log_debug("Polling pipe at endpoint %d.\n", dev->pipes[0].pipe->endpoint_no); + + rc = usb_device_auto_poll(dev, 0, + usb_mouse_polling_callback, dev->pipes[0].pipe->max_packet_size, + usb_mouse_polling_ended_callback, dev->driver_data); + + if (rc != EOK) { + usb_log_error("Failed to start polling fibril: %s.\n", + str_error(rc)); + return rc; + } + + usb_log_info("controlling new mouse (handle %llu).\n", + dev->ddf_dev->handle); + + return EOK; +} + +/** USB mouse driver ops. */ +static usb_driver_ops_t mouse_driver_ops = { + .add_device = usbmouse_add_device, +}; + +static usb_endpoint_description_t *endpoints[] = { + &poll_endpoint_description, + NULL +}; + +/** USB mouse driver. */ +static usb_driver_t mouse_driver = { + .name = NAME, + .ops = &mouse_driver_ops, + .endpoints = endpoints +}; + +int main(int argc, char *argv[]) +{ + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + + return usb_driver_main(&mouse_driver); +} + +/** + * @} + */ Index: uspace/drv/usbmouse/mouse.c =================================================================== --- uspace/drv/usbmouse/mouse.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmouse/mouse.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,123 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmouse + * @{ + */ +/** + * @file + * Actual handling of USB mouse protocol. + */ +#include "mouse.h" +#include +#include +#include +#include + +/** Mouse polling callback. + * + * @param dev Device that is being polled. + * @param buffer Data buffer. + * @param buffer_size Buffer size in bytes. + * @param arg Custom argument - points to usb_mouse_t. + * @return Always true. + */ +bool usb_mouse_polling_callback(usb_device_t *dev, + uint8_t *buffer, size_t buffer_size, void *arg) +{ + usb_mouse_t *mouse = (usb_mouse_t *) arg; + + usb_log_debug2("got buffer: %s.\n", + usb_debug_str_buffer(buffer, buffer_size, 0)); + + uint8_t butt = buffer[0]; + char str_buttons[4] = { + butt & 1 ? '#' : '.', + butt & 2 ? '#' : '.', + butt & 4 ? '#' : '.', + 0 + }; + + int shift_x = ((int) buffer[1]) - 127; + int shift_y = ((int) buffer[2]) - 127; + int wheel = ((int) buffer[3]) - 127; + + if (buffer[1] == 0) { + shift_x = 0; + } + if (buffer[2] == 0) { + shift_y = 0; + } + if (buffer[3] == 0) { + wheel = 0; + } + + if (mouse->console_phone >= 0) { + if ((shift_x != 0) || (shift_y != 0)) { + /* FIXME: guessed for QEMU */ + async_req_2_0(mouse->console_phone, + MEVENT_MOVE, + - shift_x / 10, - shift_y / 10); + } + if (butt) { + /* FIXME: proper button clicking. */ + async_req_2_0(mouse->console_phone, + MEVENT_BUTTON, 1, 1); + async_req_2_0(mouse->console_phone, + MEVENT_BUTTON, 1, 0); + } + } + + usb_log_debug("buttons=%s dX=%+3d dY=%+3d wheel=%+3d\n", + str_buttons, shift_x, shift_y, wheel); + + /* Guess. */ + async_usleep(1000); + + return true; +} + +/** Callback when polling is terminated. + * + * @param dev Device where the polling terminated. + * @param recurring_errors Whether the polling was terminated due to + * recurring errors. + * @param arg Custom argument - points to usb_mouse_t. + */ +void usb_mouse_polling_ended_callback(usb_device_t *dev, + bool recurring_errors, void *arg) +{ + usb_mouse_t *mouse = (usb_mouse_t *) arg; + + async_hangup(mouse->console_phone); + mouse->console_phone = -1; +} + +/** + * @} + */ Index: uspace/drv/usbmouse/mouse.h =================================================================== --- uspace/drv/usbmouse/mouse.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmouse/mouse.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,69 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbmouse + * @{ + */ +/** + * @file + * Common definitions for USB mouse driver. + */ +#ifndef USBMOUSE_MOUSE_H_ +#define USBMOUSE_MOUSE_H_ + +#include +#include +#include + +#define NAME "usbmouse" + +/** Container for USB mouse device. */ +typedef struct { + /** Generic device container. */ + usb_device_t *dev; + /** Function representing the device. */ + ddf_fun_t *mouse_fun; + /** Polling interval in microseconds. */ + suseconds_t poll_interval_us; + /** IPC phone to console (consumer). */ + int console_phone; +} usb_mouse_t; + +#define POLL_PIPE(dev) ((dev)->pipes[0].pipe) + +extern usb_endpoint_description_t poll_endpoint_description; + +int usb_mouse_create(usb_device_t *); + +bool usb_mouse_polling_callback(usb_device_t *, uint8_t *, size_t, void *); +void usb_mouse_polling_ended_callback(usb_device_t *, bool, void *); + +#endif +/** + * @} + */ Index: uspace/drv/usbmouse/usbmouse.ma =================================================================== --- uspace/drv/usbmouse/usbmouse.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/usbmouse/usbmouse.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,1 @@ +100 usb&interface&class=HID&subclass=0x01&protocol=0x02 Index: uspace/drv/vhc/Makefile =================================================================== --- uspace/drv/vhc/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/Makefile (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,51 @@ +# +# Copyright (c) 2010 Vojtech Horky +# All rights reserved. +# +# Redistribution and use in source and binary forms, with or without +# modification, are permitted provided that the following conditions +# are met: +# +# - Redistributions of source code must retain the above copyright +# notice, this list of conditions and the following disclaimer. +# - Redistributions in binary form must reproduce the above copyright +# notice, this list of conditions and the following disclaimer in the +# documentation and/or other materials provided with the distribution. +# - The name of the author may not be used to endorse or promote products +# derived from this software without specific prior written permission. +# +# THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR +# IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +# OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +# IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, +# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT +# NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF +# THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +# + +USPACE_PREFIX = ../.. +LIBS = \ + $(LIBUSB_PREFIX)/libusb.a \ + $(LIBUSBVIRT_PREFIX)/libusbvirt.a \ + $(LIBDRV_PREFIX)/libdrv.a +EXTRA_CFLAGS += \ + -I$(LIBUSBVIRT_PREFIX)/include \ + -I$(LIBUSB_PREFIX)/include \ + -I$(LIBDRV_PREFIX)/include +BINARY = vhc + +SOURCES = \ + hub/hub.c \ + hub/virthub.c \ + hub/virthubops.c \ + conndev.c \ + connhost.c \ + devices.c \ + hc.c \ + hcd.c \ + hub.c + +include $(USPACE_PREFIX)/Makefile.common Index: uspace/drv/vhc/conn.h =================================================================== --- uspace/drv/vhc/conn.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/conn.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,60 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Connection handling of incoming calls. + */ +#ifndef VHCD_CONN_H_ +#define VHCD_CONN_H_ + +#include +#include +#include +#include "vhcd.h" +#include "devices.h" + +void connection_handler_host(sysarg_t); + +extern usbhc_iface_t vhc_iface; +extern usb_iface_t vhc_usb_iface; +extern usb_iface_t rh_usb_iface; + +void address_init(void); + + +void default_connection_handler(ddf_fun_t *, ipc_callid_t, ipc_call_t *); +void on_client_close(ddf_fun_t *); + + +#endif +/** + * @} + */ Index: uspace/drv/vhc/conndev.c =================================================================== --- uspace/drv/vhc/conndev.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/conndev.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,131 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Connection handling of calls from virtual device (implementation). + */ + +#include +#include +#include + +#include "conn.h" +#include "hc.h" +#include "hub.h" + +#define DEVICE_NAME_MAXLENGTH 32 + +static int get_device_name(int phone, char *buffer, size_t len) +{ + ipc_call_t answer_data; + sysarg_t answer_rc; + aid_t req; + int rc; + + req = async_send_0(phone, + IPC_M_USBVIRT_GET_NAME, + &answer_data); + + rc = async_data_read_start(phone, buffer, len); + if (rc != EOK) { + async_wait_for(req, NULL); + return EINVAL; + } + + async_wait_for(req, &answer_rc); + rc = (int)answer_rc; + + if (IPC_GET_ARG1(answer_data) < len) { + len = IPC_GET_ARG1(answer_data); + } else { + len--; + } + buffer[len] = 0; + + return rc; +} + +/** Default handler for IPC methods not handled by DDF. + * + * @param fun Device handling the call. + * @param icallid Call id. + * @param icall Call data. + */ +void default_connection_handler(ddf_fun_t *fun, + ipc_callid_t icallid, ipc_call_t *icall) +{ + sysarg_t method = IPC_GET_IMETHOD(*icall); + + if (method == IPC_M_CONNECT_TO_ME) { + int callback = IPC_GET_ARG5(*icall); + virtdev_connection_t *dev + = virtdev_add_device(callback, (sysarg_t)fibril_get_id()); + if (!dev) { + async_answer_0(icallid, EEXISTS); + async_hangup(callback); + return; + } + async_answer_0(icallid, EOK); + + char devname[DEVICE_NAME_MAXLENGTH + 1]; + int rc = get_device_name(callback, devname, DEVICE_NAME_MAXLENGTH); + + usb_log_info("New virtual device `%s' (id = %x).\n", + rc == EOK ? devname : "", dev->id); + + return; + } + + async_answer_0(icallid, EINVAL); +} + +/** Callback for DDF when client disconnects. + * + * @param fun Device function the client was connected to. + */ +void on_client_close(ddf_fun_t *fun) +{ + /* + * Maybe a virtual device is being unplugged. + */ + virtdev_connection_t *dev = virtdev_find((sysarg_t)fibril_get_id()); + if (dev == NULL) { + return; + } + + usb_log_info("Virtual device disconnected (id = %x).\n", dev->id); + virtdev_destroy_device(dev); +} + + +/** + * @} + */ Index: uspace/drv/vhc/connhost.c =================================================================== --- uspace/drv/vhc/connhost.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/connhost.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,420 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Connection handling of calls from host (implementation). + */ +#include +#include +#include +#include +#include + +#include "vhcd.h" +#include "conn.h" +#include "hc.h" + + +typedef struct { + usb_direction_t direction; + usbhc_iface_transfer_out_callback_t out_callback; + usbhc_iface_transfer_in_callback_t in_callback; + ddf_fun_t *fun; + size_t reported_size; + void *arg; +} transfer_info_t; + +typedef struct { + usb_direction_t direction; + usb_target_t target; + usbhc_iface_transfer_out_callback_t out_callback; + usbhc_iface_transfer_in_callback_t in_callback; + ddf_fun_t *fun; + void *arg; + void *data_buffer; + size_t data_buffer_size; +} control_transfer_info_t; + +static void universal_callback(void *buffer, size_t size, + int outcome, void *arg) +{ + transfer_info_t *transfer = (transfer_info_t *) arg; + + if (transfer->reported_size != (size_t) -1) { + size = transfer->reported_size; + } + + switch (transfer->direction) { + case USB_DIRECTION_IN: + transfer->in_callback(transfer->fun, + outcome, size, + transfer->arg); + break; + case USB_DIRECTION_OUT: + transfer->out_callback(transfer->fun, + outcome, + transfer->arg); + break; + default: + assert(false && "unreachable"); + break; + } + + free(transfer); +} + +static transfer_info_t *create_transfer_info(ddf_fun_t *fun, + usb_direction_t direction, void *arg) +{ + transfer_info_t *transfer = malloc(sizeof(transfer_info_t)); + + transfer->direction = direction; + transfer->in_callback = NULL; + transfer->out_callback = NULL; + transfer->arg = arg; + transfer->fun = fun; + transfer->reported_size = (size_t) -1; + + return transfer; +} + +static void control_abort_prematurely(control_transfer_info_t *transfer, + size_t size, int outcome) +{ + switch (transfer->direction) { + case USB_DIRECTION_IN: + transfer->in_callback(transfer->fun, + outcome, size, + transfer->arg); + break; + case USB_DIRECTION_OUT: + transfer->out_callback(transfer->fun, + outcome, + transfer->arg); + break; + default: + assert(false && "unreachable"); + break; + } +} + +static void control_callback_two(void *buffer, size_t size, + int outcome, void *arg) +{ + control_transfer_info_t *ctrl_transfer = (control_transfer_info_t *) arg; + + if (outcome != EOK) { + control_abort_prematurely(ctrl_transfer, outcome, size); + free(ctrl_transfer); + return; + } + + transfer_info_t *transfer = create_transfer_info(ctrl_transfer->fun, + ctrl_transfer->direction, ctrl_transfer->arg); + transfer->out_callback = ctrl_transfer->out_callback; + transfer->in_callback = ctrl_transfer->in_callback; + transfer->reported_size = size; + + switch (ctrl_transfer->direction) { + case USB_DIRECTION_IN: + hc_add_transaction_to_device(false, ctrl_transfer->target, + USB_TRANSFER_CONTROL, + NULL, 0, + universal_callback, transfer); + break; + case USB_DIRECTION_OUT: + hc_add_transaction_from_device(ctrl_transfer->target, + USB_TRANSFER_CONTROL, + NULL, 0, + universal_callback, transfer); + break; + default: + assert(false && "unreachable"); + break; + } + + free(ctrl_transfer); +} + +static void control_callback_one(void *buffer, size_t size, + int outcome, void *arg) +{ + control_transfer_info_t *transfer = (control_transfer_info_t *) arg; + + if (outcome != EOK) { + control_abort_prematurely(transfer, outcome, size); + free(transfer); + return; + } + + switch (transfer->direction) { + case USB_DIRECTION_IN: + hc_add_transaction_from_device(transfer->target, + USB_TRANSFER_CONTROL, + transfer->data_buffer, transfer->data_buffer_size, + control_callback_two, transfer); + break; + case USB_DIRECTION_OUT: + hc_add_transaction_to_device(false, transfer->target, + USB_TRANSFER_CONTROL, + transfer->data_buffer, transfer->data_buffer_size, + control_callback_two, transfer); + break; + default: + assert(false && "unreachable"); + break; + } +} + +static control_transfer_info_t *create_control_transfer_info(ddf_fun_t *fun, + usb_direction_t direction, usb_target_t target, + void *data_buffer, size_t data_buffer_size, + void *arg) +{ + control_transfer_info_t *transfer + = malloc(sizeof(control_transfer_info_t)); + + transfer->direction = direction; + transfer->target = target; + transfer->in_callback = NULL; + transfer->out_callback = NULL; + transfer->arg = arg; + transfer->fun = fun; + transfer->data_buffer = data_buffer; + transfer->data_buffer_size = data_buffer_size; + + return transfer; +} + +static int enqueue_transfer_out(ddf_fun_t *fun, + usb_target_t target, usb_transfer_type_t transfer_type, + void *buffer, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + usb_log_debug2("Transfer OUT [%d.%d (%s); %zu].\n", + target.address, target.endpoint, + usb_str_transfer_type(transfer_type), + size); + + transfer_info_t *transfer + = create_transfer_info(fun, USB_DIRECTION_OUT, arg); + transfer->out_callback = callback; + + hc_add_transaction_to_device(false, target, transfer_type, buffer, size, + universal_callback, transfer); + + return EOK; +} + +static int enqueue_transfer_in(ddf_fun_t *fun, + usb_target_t target, usb_transfer_type_t transfer_type, + void *buffer, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + usb_log_debug2("Transfer IN [%d.%d (%s); %zu].\n", + target.address, target.endpoint, + usb_str_transfer_type(transfer_type), + size); + + transfer_info_t *transfer + = create_transfer_info(fun, USB_DIRECTION_IN, arg); + transfer->in_callback = callback; + + hc_add_transaction_from_device(target, transfer_type, buffer, size, + universal_callback, transfer); + + return EOK; +} + + +static int interrupt_out(ddf_fun_t *fun, usb_target_t target, + size_t max_packet_size, + void *data, size_t size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + return enqueue_transfer_out(fun, target, USB_TRANSFER_INTERRUPT, + data, size, + callback, arg); +} + +static int interrupt_in(ddf_fun_t *fun, usb_target_t target, + size_t max_packet_size, + void *data, size_t size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + return enqueue_transfer_in(fun, target, USB_TRANSFER_INTERRUPT, + data, size, + callback, arg); +} + +static int control_write(ddf_fun_t *fun, usb_target_t target, + size_t max_packet_size, + void *setup_packet, size_t setup_packet_size, + void *data, size_t data_size, + usbhc_iface_transfer_out_callback_t callback, void *arg) +{ + control_transfer_info_t *transfer + = create_control_transfer_info(fun, USB_DIRECTION_OUT, target, + data, data_size, arg); + transfer->out_callback = callback; + + hc_add_transaction_to_device(true, target, USB_TRANSFER_CONTROL, + setup_packet, setup_packet_size, + control_callback_one, transfer); + + return EOK; +} + +static int control_read(ddf_fun_t *fun, usb_target_t target, + size_t max_packet_size, + void *setup_packet, size_t setup_packet_size, + void *data, size_t data_size, + usbhc_iface_transfer_in_callback_t callback, void *arg) +{ + control_transfer_info_t *transfer + = create_control_transfer_info(fun, USB_DIRECTION_IN, target, + data, data_size, arg); + transfer->in_callback = callback; + + hc_add_transaction_to_device(true, target, USB_TRANSFER_CONTROL, + setup_packet, setup_packet_size, + control_callback_one, transfer); + + return EOK; +} + +static usb_address_keeping_t addresses; + +static int tell_address(ddf_fun_t *fun, devman_handle_t handle, + usb_address_t *address) +{ + usb_log_debug("tell_address(fun \"%s\", handle %zu)\n", + fun->name, (size_t) fun->handle); + usb_address_t addr = usb_address_keeping_find(&addresses, handle); + if (addr < 0) { + return addr; + } + + *address = addr; + return EOK; +} + +static int reserve_default_address(ddf_fun_t *fun, usb_speed_t ignored) +{ + usb_address_keeping_reserve_default(&addresses); + return EOK; +} + +static int release_default_address(ddf_fun_t *fun) +{ + usb_address_keeping_release_default(&addresses); + return EOK; +} + +static int request_address(ddf_fun_t *fun, usb_speed_t ignored, + usb_address_t *address) +{ + usb_address_t addr = usb_address_keeping_request(&addresses); + if (addr < 0) { + return (int)addr; + } + + *address = addr; + return EOK; +} + +static int release_address(ddf_fun_t *fun, usb_address_t address) +{ + return usb_address_keeping_release(&addresses, address); +} + +static int bind_address(ddf_fun_t *fun, usb_address_t address, + devman_handle_t handle) +{ + usb_address_keeping_devman_bind(&addresses, address, handle); + return EOK; +} + +static int usb_iface_get_hc_handle_rh_impl(ddf_fun_t *root_hub_fun, + devman_handle_t *handle) +{ + ddf_fun_t *hc_fun = root_hub_fun->driver_data; + assert(hc_fun != NULL); + + *handle = hc_fun->handle; + + usb_log_debug("usb_iface_get_hc_handle_rh_impl returns %zu\n", *handle); + + return EOK; +} + +static int tell_address_rh(ddf_fun_t *root_hub_fun, devman_handle_t handle, + usb_address_t *address) +{ + ddf_fun_t *hc_fun = root_hub_fun->driver_data; + assert(hc_fun != NULL); + + return tell_address(hc_fun, root_hub_fun->handle, address); +} + +void address_init(void) +{ + usb_address_keeping_init(&addresses, 50); +} + +usbhc_iface_t vhc_iface = { + .reserve_default_address = reserve_default_address, + .release_default_address = release_default_address, + .request_address = request_address, + .bind_address = bind_address, + .release_address = release_address, + + .interrupt_out = interrupt_out, + .interrupt_in = interrupt_in, + + .control_write = control_write, + .control_read = control_read +}; + +usb_iface_t vhc_usb_iface = { + .get_hc_handle = usb_iface_get_hc_handle_hc_impl, + .get_address = tell_address +}; + +usb_iface_t rh_usb_iface = { + .get_hc_handle = usb_iface_get_hc_handle_rh_impl, + .get_address = tell_address_rh +}; + + +/** + * @} + */ Index: uspace/drv/vhc/devices.c =================================================================== --- uspace/drv/vhc/devices.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/devices.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,235 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Virtual device management (implementation). + */ + +#include +#include +#include +#include +#include +#include +#include + +#include + +#include "devices.h" +#include "hub.h" +#include "hub/virthub.h" +#include "vhcd.h" + +#define list_foreach(pos, head) \ + for (pos = (head)->next; pos != (head); \ + pos = pos->next) + +static LIST_INITIALIZE(devices); + +/** Create virtual device. + * + * @param phone Callback phone. + * @param id Device id. + * @return New device. + * @retval NULL Out of memory. + */ +virtdev_connection_t *virtdev_add_device(int phone, sysarg_t id) +{ + virtdev_connection_t *dev = (virtdev_connection_t *) + malloc(sizeof(virtdev_connection_t)); + if (dev == NULL) { + return NULL; + } + + dev->phone = phone; + dev->id = id; + list_append(&dev->link, &devices); + + virthub_connect_device(&virtual_hub_device, dev); + + return dev; +} + +/** Find virtual device by id. + * + * @param id Device id. + * @return Device with given id. + * @retval NULL No such device. + */ +virtdev_connection_t *virtdev_find(sysarg_t id) +{ + link_t *pos; + list_foreach(pos, &devices) { + virtdev_connection_t *dev + = list_get_instance(pos, virtdev_connection_t, link); + if (dev->id == id) { + return dev; + } + } + + return NULL; +} + +/** Destroy virtual device. + */ +void virtdev_destroy_device(virtdev_connection_t *dev) +{ + virthub_disconnect_device(&virtual_hub_device, dev); + list_remove(&dev->link); + free(dev); +} + +/** Send data to all connected devices. + * + * @param transaction Transaction to be sent over the bus. + */ +int virtdev_send_to_all(transaction_t *transaction) +{ + /* For easier debugging. */ + switch (transaction->type) { + case USBVIRT_TRANSACTION_SETUP: + case USBVIRT_TRANSACTION_OUT: + transaction->actual_len = transaction->len; + break; + case USBVIRT_TRANSACTION_IN: + transaction->actual_len = 0; + break; + default: + assert(false && "unreachable branch in switch()"); + } + int outcome = EBADCHECKSUM; + + link_t *pos; + list_foreach(pos, &devices) { + virtdev_connection_t *dev + = list_get_instance(pos, virtdev_connection_t, link); + + if (!virthub_is_device_enabled(&virtual_hub_device, dev)) { + continue; + } + + ipc_call_t answer_data; + sysarg_t answer_rc; + aid_t req; + int rc = EOK; + int method = IPC_M_USBVIRT_TRANSACTION_SETUP; + + switch (transaction->type) { + case USBVIRT_TRANSACTION_SETUP: + method = IPC_M_USBVIRT_TRANSACTION_SETUP; + break; + case USBVIRT_TRANSACTION_IN: + method = IPC_M_USBVIRT_TRANSACTION_IN; + break; + case USBVIRT_TRANSACTION_OUT: + method = IPC_M_USBVIRT_TRANSACTION_OUT; + break; + } + + req = async_send_3(dev->phone, + method, + transaction->target.address, + transaction->target.endpoint, + transaction->len, + &answer_data); + + if (transaction->len > 0) { + if (transaction->type == USBVIRT_TRANSACTION_IN) { + rc = async_data_read_start(dev->phone, + transaction->buffer, transaction->len); + } else { + rc = async_data_write_start(dev->phone, + transaction->buffer, transaction->len); + } + } + + if (rc != EOK) { + async_wait_for(req, NULL); + } else { + async_wait_for(req, &answer_rc); + transaction->actual_len = IPC_GET_ARG1(answer_data); + rc = (int)answer_rc; + } + + /* + * If at least one device was able to accept this + * transaction and process it, we can announce success. + */ + if (rc == EOK) { + outcome = EOK; + } + } + + /* + * Send the data to the virtual hub as well + * (if the address matches). + */ + if (virtual_hub_device.address == transaction->target.address) { + size_t tmp; + usb_log_debug2("Sending `%s' transaction to hub.\n", + usbvirt_str_transaction_type(transaction->type)); + switch (transaction->type) { + case USBVIRT_TRANSACTION_SETUP: + virtual_hub_device.transaction_setup( + &virtual_hub_device, + transaction->target.endpoint, + transaction->buffer, transaction->len); + break; + + case USBVIRT_TRANSACTION_IN: + virtual_hub_device.transaction_in( + &virtual_hub_device, + transaction->target.endpoint, + transaction->buffer, transaction->len, + &tmp); + transaction->actual_len = tmp; + break; + + case USBVIRT_TRANSACTION_OUT: + virtual_hub_device.transaction_out( + &virtual_hub_device, + transaction->target.endpoint, + transaction->buffer, transaction->len); + break; + } + outcome = EOK; + } + + /* + * TODO: maybe screw some transactions to get more + * real-life image. + */ + return outcome; +} + +/** + * @} + */ Index: uspace/drv/vhc/devices.h =================================================================== --- uspace/drv/vhc/devices.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/devices.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,61 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Virtual device management. + */ +#ifndef VHCD_DEVICES_H_ +#define VHCD_DEVICES_H_ + +#include +#include + +#include "hc.h" + +/** Connected virtual device. */ +typedef struct { + /** Phone used when sending data to device. */ + int phone; + /** Unique identification. */ + sysarg_t id; + /** Linked-list handle. */ + link_t link; +} virtdev_connection_t; + +virtdev_connection_t *virtdev_add_device(int, sysarg_t); +virtdev_connection_t *virtdev_find(sysarg_t); +void virtdev_destroy_device(virtdev_connection_t *); +int virtdev_send_to_all(transaction_t *); + +#endif +/** + * @} + */ Index: uspace/drv/vhc/hc.c =================================================================== --- uspace/drv/vhc/hc.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/hc.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,209 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Virtual HC (implementation). + */ + +#include +#include +#include +#include +#include +#include +#include + +#include + +#include "vhcd.h" +#include "hc.h" +#include "devices.h" +#include "hub.h" + +#define USLEEP_BASE (0 * 5 * 1000) + +#define USLEEP_VAR 50 + +#define SHORTENING_VAR 15 + +#define PROB_OUTCOME_BABBLE 5 +#define PROB_OUTCOME_CRCERROR 7 + +#define PROB_TEST(var, new_value, prob, number) \ + do { \ + if (((number) % (prob)) == 0) { \ + var = (new_value); \ + } \ + } while (0) + +static link_t transaction_list; + +#define TRANSACTION_FORMAT "T[%d.%d %s/%s (%d)]" +#define TRANSACTION_PRINTF(t) \ + (t).target.address, (t).target.endpoint, \ + usb_str_transfer_type((t).transfer_type), \ + usbvirt_str_transaction_type((t).type), \ + (int)(t).len + +#define transaction_get_instance(lnk) \ + list_get_instance(lnk, transaction_t, link) + +#define HUB_STATUS_MAX_LEN (HUB_PORT_COUNT + 64) + +static inline unsigned int pseudo_random(unsigned int *seed) +{ + *seed = ((*seed) * 873511) % 22348977 + 7; + return ((*seed) >> 8); +} + +/** Call transaction callback. + * Calling this callback informs the backend that transaction was processed. + */ +static void process_transaction_with_outcome(transaction_t * transaction, + int outcome) +{ + usb_log_debug2("Transaction " TRANSACTION_FORMAT " done: %s.\n", + TRANSACTION_PRINTF(*transaction), + str_error(outcome)); + + transaction->callback(transaction->buffer, transaction->actual_len, + outcome, transaction->callback_arg); +} + +/** Host controller manager main function. + */ +static int hc_manager_fibril(void *arg) +{ + list_initialize(&transaction_list); + + static unsigned int seed = 4573; + + usb_log_info("Transaction processor ready.\n"); + + while (true) { + async_usleep(USLEEP_BASE + (pseudo_random(&seed) % USLEEP_VAR)); + + if (list_empty(&transaction_list)) { + continue; + } + + char ports[HUB_STATUS_MAX_LEN + 1]; + virthub_get_status(&virtual_hub_device, ports, HUB_STATUS_MAX_LEN); + + link_t *first_transaction_link = transaction_list.next; + transaction_t *transaction + = transaction_get_instance(first_transaction_link); + list_remove(first_transaction_link); + + usb_log_debug("Processing " TRANSACTION_FORMAT " [%s].\n", + TRANSACTION_PRINTF(*transaction), ports); + + int outcome; + outcome = virtdev_send_to_all(transaction); + + process_transaction_with_outcome(transaction, outcome); + + free(transaction); + } + + assert(false && "unreachable"); + return EOK; +} + +void hc_manager(void) +{ + fid_t fid = fibril_create(hc_manager_fibril, NULL); + if (fid == 0) { + usb_log_fatal("Failed to start HC manager fibril.\n"); + return; + } + fibril_add_ready(fid); +} + +/** Create new transaction + */ +static transaction_t *transaction_create(usbvirt_transaction_type_t type, + usb_target_t target, usb_transfer_type_t transfer_type, + void * buffer, size_t len, + hc_transaction_done_callback_t callback, void * arg) +{ + transaction_t * transaction = malloc(sizeof(transaction_t)); + + list_initialize(&transaction->link); + transaction->type = type; + transaction->transfer_type = transfer_type; + transaction->target = target; + transaction->buffer = buffer; + transaction->len = len; + transaction->actual_len = len; + transaction->callback = callback; + transaction->callback_arg = arg; + + return transaction; +} + +static void hc_add_transaction(transaction_t *transaction) +{ + usb_log_debug("Adding transaction " TRANSACTION_FORMAT ".\n", + TRANSACTION_PRINTF(*transaction)); + list_append(&transaction->link, &transaction_list); +} + +/** Add transaction directioned towards the device. + */ +void hc_add_transaction_to_device(bool setup, usb_target_t target, + usb_transfer_type_t transfer_type, + void * buffer, size_t len, + hc_transaction_done_callback_t callback, void * arg) +{ + transaction_t *transaction = transaction_create( + setup ? USBVIRT_TRANSACTION_SETUP : USBVIRT_TRANSACTION_OUT, + target, transfer_type, + buffer, len, callback, arg); + hc_add_transaction(transaction); +} + +/** Add transaction directioned from the device. + */ +void hc_add_transaction_from_device(usb_target_t target, + usb_transfer_type_t transfer_type, + void * buffer, size_t len, + hc_transaction_done_callback_t callback, void * arg) +{ + transaction_t *transaction = transaction_create(USBVIRT_TRANSACTION_IN, + target, transfer_type, + buffer, len, callback, arg); + hc_add_transaction(transaction); +} + +/** + * @} + */ Index: uspace/drv/vhc/hc.h =================================================================== --- uspace/drv/vhc/hc.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/hc.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,91 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Virtual HC. + */ +#ifndef VHCD_HC_H_ +#define VHCD_HC_H_ + +#include +#include + +/** Callback after transaction is sent to USB. + * + * @param buffer Transaction data buffer. + * @param size Transaction data size. + * @param outcome Transaction outcome. + * @param arg Custom argument. + */ +typedef void (*hc_transaction_done_callback_t)(void *buffer, size_t size, + int outcome, void *arg); + +/** Pending transaction details. */ +typedef struct { + /** Linked-list link. */ + link_t link; + /** Transaction type. */ + usbvirt_transaction_type_t type; + /** Transfer type. */ + usb_transfer_type_t transfer_type; + /** Device address. */ + usb_target_t target; + /** Direction of the transaction. */ + usb_direction_t direction; + /** Transaction data buffer. */ + void * buffer; + /** Transaction data length. */ + size_t len; + /** Data length actually transfered. */ + size_t actual_len; + /** Callback after transaction is done. */ + hc_transaction_done_callback_t callback; + /** Argument to the callback. */ + void * callback_arg; +} transaction_t; + +void hc_manager(void); + +void hc_add_transaction_to_device(bool setup, + usb_target_t target, usb_transfer_type_t transfer_type, + void * buffer, size_t len, + hc_transaction_done_callback_t callback, void * arg); + +void hc_add_transaction_from_device( + usb_target_t target, usb_transfer_type_t transfer_type, + void * buffer, size_t len, + hc_transaction_done_callback_t callback, void * arg); + + +#endif +/** + * @} + */ Index: uspace/drv/vhc/hcd.c =================================================================== --- uspace/drv/vhc/hcd.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/hcd.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,147 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Virtual host controller driver. + */ + +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include +#include "vhcd.h" +#include "hc.h" +#include "devices.h" +#include "hub.h" +#include "conn.h" + +static ddf_dev_ops_t vhc_ops = { + .interfaces[USBHC_DEV_IFACE] = &vhc_iface, + .interfaces[USB_DEV_IFACE] = &vhc_usb_iface, + .close = on_client_close, + .default_handler = default_connection_handler +}; + +static int vhc_add_device(ddf_dev_t *dev) +{ + static int vhc_count = 0; + int rc; + + /* + * Currently, we know how to simulate only single HC. + */ + if (vhc_count > 0) { + return ELIMIT; + } + + /* + * Create exposed function representing the host controller + * itself. + */ + ddf_fun_t *hc = ddf_fun_create(dev, fun_exposed, "hc"); + if (hc == NULL) { + usb_log_fatal("Failed to create device function.\n"); + return ENOMEM; + } + + hc->ops = &vhc_ops; + + rc = ddf_fun_bind(hc); + if (rc != EOK) { + usb_log_fatal("Failed to bind HC function: %s.\n", + str_error(rc)); + return rc; + } + + ddf_fun_add_to_class(hc, "usbhc"); + + /* + * Initialize our hub and announce its presence. + */ + virtual_hub_device_init(hc); + + usb_log_info("Virtual USB host controller ready (dev %zu, hc %zu).\n", + (size_t) dev->handle, (size_t) hc->handle); + + return EOK; +} + +static driver_ops_t vhc_driver_ops = { + .add_device = vhc_add_device, +}; + +static driver_t vhc_driver = { + .name = NAME, + .driver_ops = &vhc_driver_ops +}; + + +int main(int argc, char * argv[]) +{ + /* + * Temporary workaround. Wait a little bit to be the last driver + * in devman output. + */ + //sleep(5); + + usb_log_enable(USB_LOG_LEVEL_DEFAULT, NAME); + + printf(NAME ": virtual USB host controller driver.\n"); + + /* + * Initialize address management. + */ + address_init(); + + /* + * Run the transfer scheduler. + */ + hc_manager(); + + /* + * We are also a driver within devman framework. + */ + return ddf_driver_main(&vhc_driver); +} + + +/** + * @} + */ Index: uspace/drv/vhc/hub.c =================================================================== --- uspace/drv/vhc/hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,131 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Virtual USB hub. + */ +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "hub.h" +#include "hub/virthub.h" +#include "vhcd.h" +#include "conn.h" + +usbvirt_device_t virtual_hub_device; +static ddf_dev_ops_t rh_ops = { + .interfaces[USB_DEV_IFACE] = &rh_usb_iface, +}; + +static int hub_register_in_devman_fibril(void *arg); + +void virtual_hub_device_init(ddf_fun_t *hc_dev) +{ + virthub_init(&virtual_hub_device); + + /* + * We need to register the root hub. + * This must be done in separate fibril because the device + * we are connecting to are ourselves and we cannot connect + * before leaving the add_device() function. + */ + fid_t root_hub_registration + = fibril_create(hub_register_in_devman_fibril, hc_dev); + if (root_hub_registration == 0) { + usb_log_fatal("Failed to create hub registration fibril.\n"); + return; + } + + fibril_add_ready(root_hub_registration); +} + +static int pretend_port_rest(int unused, void *unused2) +{ + return EOK; +} + +/** Register root hub in devman. + * + * @param arg Host controller device (type device_t *). + * @return Error code. + */ +int hub_register_in_devman_fibril(void *arg) +{ + ddf_fun_t *hc_dev = (ddf_fun_t *) arg; + + /* + * Wait until parent device is properly initialized. + */ + int phone; + do { + phone = devman_device_connect(hc_dev->handle, 0); + } while (phone < 0); + async_hangup(phone); + + int rc; + + usb_hc_connection_t hc_conn; + rc = usb_hc_connection_initialize(&hc_conn, hc_dev->handle); + assert(rc == EOK); + + rc = usb_hc_connection_open(&hc_conn); + assert(rc == EOK); + + ddf_fun_t *hub_dev; + rc = usb_hc_new_device_wrapper(hc_dev->dev, &hc_conn, + USB_SPEED_FULL, + pretend_port_rest, 0, NULL, + NULL, NULL, &rh_ops, hc_dev, &hub_dev); + if (rc != EOK) { + usb_log_fatal("Failed to create root hub: %s.\n", + str_error(rc)); + } + + usb_hc_connection_close(&hc_conn); + + usb_log_info("Created root hub function (handle %zu).\n", + (size_t) hub_dev->handle); + + return 0; +} + + +/** + * @} + */ Index: uspace/drv/vhc/hub.h =================================================================== --- uspace/drv/vhc/hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,52 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Virtual USB hub. + */ +#ifndef VHCD_HUB_H_ +#define VHCD_HUB_H_ + +#include +#include + +#include "devices.h" +#include "hub/hub.h" +#include "hub/virthub.h" + +extern usbvirt_device_t virtual_hub_device; + +void virtual_hub_device_init(ddf_fun_t *); + +#endif +/** + * @} + */ Index: uspace/drv/vhc/hub/hub.c =================================================================== --- uspace/drv/vhc/hub/hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/hub/hub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,511 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Representation of an USB hub (implementation). + */ +#include +#include +#include +#include +#include +#include +#include +#include + +#include "hub.h" + + +/** Produce a byte from bit values. + */ +#define MAKE_BYTE(b0, b1, b2, b3, b4, b5, b6, b7) \ + (( \ + ((b0) << 0) \ + | ((b1) << 1) \ + | ((b2) << 2) \ + | ((b3) << 3) \ + | ((b4) << 4) \ + | ((b5) << 5) \ + | ((b6) << 6) \ + | ((b7) << 7) \ + )) + +/* Static functions. */ +static hub_port_t *get_hub_port(hub_t *, size_t); +static void set_port_status_change(hub_port_t *, hub_status_change_t); +static void clear_port_status_change(hub_port_t *, uint16_t); +static int set_port_state_delayed_fibril(void *); +static void set_port_state_delayed(hub_t *, size_t, suseconds_t, + hub_port_state_t, hub_port_state_t); + +/** Convert hub port state to a char. */ +char hub_port_state_to_char(hub_port_state_t state) { + switch (state) { + case HUB_PORT_STATE_NOT_CONFIGURED: + return '-'; + case HUB_PORT_STATE_POWERED_OFF: + return 'O'; + case HUB_PORT_STATE_DISCONNECTED: + return 'X'; + case HUB_PORT_STATE_DISABLED: + return 'D'; + case HUB_PORT_STATE_RESETTING: + return 'R'; + case HUB_PORT_STATE_ENABLED: + return 'E'; + case HUB_PORT_STATE_SUSPENDED: + return 'S'; + case HUB_PORT_STATE_RESUMING: + return 'F'; + default: + return '?'; + } +} + +/** Initialize single hub port. + * + * @param port Port to be initialized. + * @param index Port index (one based). + */ +static void hub_init_port(hub_port_t *port, size_t index) +{ + port->connected_device = NULL; + port->index = index; + port->state = HUB_PORT_STATE_NOT_CONFIGURED; + port->status_change = 0; +} + +/** Initialize the hub. + * + * @param hub Hub to be initialized. + */ +void hub_init(hub_t *hub) +{ + size_t i; + for (i = 0; i < HUB_PORT_COUNT; i++) { + hub_init_port(&hub->ports[i], i + 1); + } + hub->custom_data = NULL; + fibril_mutex_initialize(&hub->guard); +} + +/** Connect a device to the hub. + * + * @param hub Hub to connect device to. + * @param device Device to be connected. + * @return Index of port the device was connected to. + * @retval -1 No free port available. + */ +size_t hub_connect_device(hub_t *hub, void *device) +{ + size_t i; + for (i = 0; i < HUB_PORT_COUNT; i++) { + hub_port_t *port = &hub->ports[i]; + + if (port->connected_device != NULL) { + continue; + } + + port->connected_device = device; + + /* + * TODO: + * If the hub was configured, we can normally + * announce the plug-in. + * Otherwise, we will wait until hub is configured + * and announce changes in single burst. + */ + //if (port->state == HUB_PORT_STATE_DISCONNECTED) { + port->state = HUB_PORT_STATE_DISABLED; + set_port_status_change(port, HUB_STATUS_C_PORT_CONNECTION); + //} + + return i; + } + + return (size_t) -1; +} + +/** Disconnects a device from a hub. + * + * @param hub Hub the device was connected to. + * @param device Device to be disconnected. + * @return Error code. + */ +int hub_disconnect_device(hub_t *hub, void *device) +{ + size_t index = hub_find_device(hub, device); + if (index == (size_t) -1) { + return ENOENT; + } + + hub_port_t *port = &hub->ports[index]; + + port->connected_device = NULL; + port->state = HUB_PORT_STATE_DISCONNECTED; + set_port_status_change(port, HUB_STATUS_C_PORT_CONNECTION); + + return EOK; +} + +/** Find port device is connected to. + * + * @param hub Hub in question. + * @param device Device in question. + * @return Port index (zero based). + * @retval -1 Device is not connected. + */ +size_t hub_find_device(hub_t *hub, void *device) +{ + size_t i; + for (i = 0; i < HUB_PORT_COUNT; i++) { + hub_port_t *port = &hub->ports[i]; + + if (port->connected_device == device) { + return i; + } + } + + return -1; +} + +/** Acquire exclusive access to the hub. + * + * @param hub Hub in question. + */ +void hub_acquire(hub_t *hub) +{ + fibril_mutex_lock(&hub->guard); +} + +/** Give up exclusive access to the hub. + * + * @param hub Hub in question. + */ +void hub_release(hub_t *hub) +{ + fibril_mutex_unlock(&hub->guard); +} + +/** Change port state. + * + * @param hub Hub the port belongs to. + * @param port_index Port index (zero based). + * @param state New port state. + */ +void hub_set_port_state(hub_t *hub, size_t port_index, hub_port_state_t state) +{ + hub_port_t *port = get_hub_port(hub, port_index); + if (port == NULL) { + return; + } + + switch (state) { + case HUB_PORT_STATE_POWERED_OFF: + clear_port_status_change(port, HUB_STATUS_C_PORT_CONNECTION); + clear_port_status_change(port, HUB_STATUS_C_PORT_ENABLE); + clear_port_status_change(port, HUB_STATUS_C_PORT_RESET); + break; + case HUB_PORT_STATE_RESUMING: + set_port_state_delayed(hub, port_index, + 10, state, HUB_PORT_STATE_ENABLED); + break; + case HUB_PORT_STATE_RESETTING: + set_port_state_delayed(hub, port_index, + 10, state, HUB_PORT_STATE_ENABLED); + break; + case HUB_PORT_STATE_ENABLED: + if (port->state == HUB_PORT_STATE_RESETTING) { + set_port_status_change(port, HUB_STATUS_C_PORT_RESET); + } + break; + default: + break; + } + + port->state = state; +} + +/** Change state of all ports. + * + * @param hub Hub in question. + * @param state New state for all ports. + */ +void hub_set_port_state_all(hub_t *hub, hub_port_state_t state) +{ + size_t i; + for (i = 0; i < HUB_PORT_COUNT; i++) { + hub_set_port_state(hub, i, state); + } +} + +/** Get port state. + * + * @param hub Hub the port belongs to. + * @param port_index Port index (zero based). + * @return Port state. + */ +hub_port_state_t hub_get_port_state(hub_t *hub, size_t port_index) +{ + hub_port_t *port = get_hub_port(hub, port_index); + if (port == NULL) { + return HUB_PORT_STATE_UNKNOWN; + } + + return port->state; +} + +/** Clear port status change bit. + * + * @param hub Hub the port belongs to. + * @param port_index Port index (zero based). + * @param change Change to be cleared. + */ +void hub_clear_port_status_change(hub_t *hub, size_t port_index, + hub_status_change_t change) +{ + hub_port_t *port = get_hub_port(hub, port_index); + if (port == NULL) { + return; + } + + clear_port_status_change(port, change); +} + +/** Get port status change bits. + * + * @param hub Hub the port belongs to. + * @param port_index Port index (zero based). + * @return Port status change bitmap in standard format. + */ +uint16_t hub_get_port_status_change(hub_t *hub, size_t port_index) +{ + hub_port_t *port = get_hub_port(hub, port_index); + if (port == NULL) { + return 0; + } + + return port->status_change; +} + +/** Get port status bits. + * + * @param hub Hub the port belongs to. + * @param port_index Port index (zero based). + * @return Port status bitmap in standard format. + */ +uint32_t hub_get_port_status(hub_t *hub, size_t port_index) +{ + hub_port_t *port = get_hub_port(hub, port_index); + if (port == NULL) { + return 0; + } + + uint32_t status; + status = MAKE_BYTE( + /* Current connect status. */ + port->connected_device == NULL ? 0 : 1, + /* Port enabled/disabled. */ + port->state == HUB_PORT_STATE_ENABLED ? 1 : 0, + /* Suspend. */ + (port->state == HUB_PORT_STATE_SUSPENDED) + || (port->state == HUB_PORT_STATE_RESUMING) ? 1 : 0, + /* Over-current. */ + 0, + /* Reset. */ + port->state == HUB_PORT_STATE_RESETTING ? 1 : 0, + /* Reserved. */ + 0, 0, 0) + + | (MAKE_BYTE( + /* Port power. */ + port->state == HUB_PORT_STATE_POWERED_OFF ? 0 : 1, + /* Full-speed device. */ + 0, + /* Reserved. */ + 0, 0, 0, 0, 0, 0 + )) << 8; + + status |= (port->status_change << 16); + + return status; +} + +/** Create hub status change bitmap. + * + * @warning This function assumes that the whole bitmap fits into 8 bits. + * + * @param hub Hub in question. + * @return Hub status change bitmap. + */ +uint8_t hub_get_status_change_bitmap(hub_t *hub) +{ + uint8_t change_map = 0; + + size_t i; + for (i = 0; i < HUB_PORT_COUNT; i++) { + hub_port_t *port = &hub->ports[i]; + + if (port->status_change != 0) { + change_map |= (1 << port->index); + } + } + + return change_map; +} + + +/* + * + * STATIC (HELPER) FUNCTIONS + * + */ + +/** Find a port in a hub. + * + * @param hub Hub in question. + * @param port Port index (zero based). + * @return Port structure. + * @retval NULL Invalid port index. + */ +static hub_port_t *get_hub_port(hub_t *hub, size_t port) +{ + if (port >= HUB_PORT_COUNT) { + return NULL; + } + + return &hub->ports[port]; +} + +/** Adds a port status change to a port. + * + * @param port The port with status change. + * @param change Change to be added to the status. + */ +static void set_port_status_change(hub_port_t *port, + hub_status_change_t change) +{ + assert(port != NULL); + port->status_change |= change; +} + +/** Clears a port status change on a port. + * + * @param port The port with status change. + * @param change Change to be removed from the status. + */ +static void clear_port_status_change(hub_port_t *port, + uint16_t change) +{ + assert(port != NULL); + port->status_change &= (~change); +} + +/** Structure for automatic (delayed) port state change. */ +struct delay_port_state_change { + /** Delay in microseconds. */ + suseconds_t delay; + /** Old state of the port. */ + hub_port_state_t old_state; + /** New state of the port. */ + hub_port_state_t new_state; + /** Port index (zero based). */ + size_t port; + /** Hub. */ + hub_t *hub; +}; + +/** Fibril responsible for delayed port state change. + * + * @param arg Pointer to delay_port_state_change. + * @return Always EOK. + */ +static int set_port_state_delayed_fibril(void *arg) +{ + struct delay_port_state_change *change + = (struct delay_port_state_change *) arg; + + async_usleep(change->delay); + + hub_acquire(change->hub); + + hub_port_t *port = get_hub_port(change->hub, change->port); + assert(port != NULL); + + if (port->state == change->old_state) { + hub_set_port_state(change->hub, change->port, + change->new_state); + } + + hub_release(change->hub); + + free(change); + + return EOK; +} + +/** Change port state with a delay. + * + * @warning If the port state changes during the waiting phase, the state + * is not changed. + * + * @param hub Hub in question. + * @param port_index Port index (zero based). + * @param delay_time_ms Delay time in miliseconds. + * @param old_state Old (current) state of the port. + * @param new_state New state of the port. + */ +static void set_port_state_delayed(hub_t *hub, size_t port_index, + suseconds_t delay_time_ms, + hub_port_state_t old_state, hub_port_state_t new_state) +{ + struct delay_port_state_change *change + = malloc(sizeof(struct delay_port_state_change)); + + change->hub = hub; + change->port = port_index; + change->delay = delay_time_ms * 1000; + change->old_state = old_state; + change->new_state = new_state; + fid_t fibril = fibril_create(set_port_state_delayed_fibril, change); + if (fibril == 0) { + printf("Failed to create fibril\n"); + free(change); + return; + } + fibril_add_ready(fibril); +} + + + +/** + * @} + */ Index: uspace/drv/vhc/hub/hub.h =================================================================== --- uspace/drv/vhc/hub/hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/hub/hub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,114 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Representation of an USB hub. + */ +#ifndef VHC_HUB_HUB_H_ +#define VHC_HUB_HUB_H_ + +#include + +#ifndef HUB_PORT_COUNT +#define HUB_PORT_COUNT 2 +#endif +#define BITS2BYTES(bits) (bits ? ((((bits)-1)>>3)+1) : 0) + +/** Hub port internal state. + * Some states (e.g. port over current) are not covered as they are not + * simulated at all. + */ +typedef enum { + HUB_PORT_STATE_UNKNOWN, + HUB_PORT_STATE_NOT_CONFIGURED, + HUB_PORT_STATE_POWERED_OFF, + HUB_PORT_STATE_DISCONNECTED, + HUB_PORT_STATE_DISABLED, + HUB_PORT_STATE_RESETTING, + HUB_PORT_STATE_ENABLED, + HUB_PORT_STATE_SUSPENDED, + HUB_PORT_STATE_RESUMING, + /* HUB_PORT_STATE_, */ +} hub_port_state_t; + +char hub_port_state_to_char(hub_port_state_t); + +/** Hub status change mask bits. */ +typedef enum { + HUB_STATUS_C_PORT_CONNECTION = (1 << 0), + HUB_STATUS_C_PORT_ENABLE = (1 << 1), + HUB_STATUS_C_PORT_SUSPEND = (1 << 2), + HUB_STATUS_C_PORT_OVER_CURRENT = (1 << 3), + HUB_STATUS_C_PORT_RESET = (1 << 4), + /* HUB_STATUS_C_ = (1 << ), */ +} hub_status_change_t; + +/** Hub port information. */ +typedef struct { + /** Custom pointer to connected device. */ + void *connected_device; + /** Port index (one based). */ + size_t index; + /** Port state. */ + hub_port_state_t state; + /** Status change bitmap. */ + uint16_t status_change; +} hub_port_t; + +/** Hub device type. */ +typedef struct { + /** Hub ports. */ + hub_port_t ports[HUB_PORT_COUNT]; + /** Custom hub data. */ + void *custom_data; + /** Access guard to the whole hub. */ + fibril_mutex_t guard; +} hub_t; + +void hub_init(hub_t *); +size_t hub_connect_device(hub_t *, void *); +int hub_disconnect_device(hub_t *, void *); +size_t hub_find_device(hub_t *, void *); +void hub_acquire(hub_t *); +void hub_release(hub_t *); +void hub_set_port_state(hub_t *, size_t, hub_port_state_t); +void hub_set_port_state_all(hub_t *, hub_port_state_t); +hub_port_state_t hub_get_port_state(hub_t *, size_t); +void hub_clear_port_status_change(hub_t *, size_t, hub_status_change_t); +uint16_t hub_get_port_status_change(hub_t *, size_t); +uint32_t hub_get_port_status(hub_t *, size_t); +uint8_t hub_get_status_change_bitmap(hub_t *); + + +#endif +/** + * @} + */ Index: uspace/drv/vhc/hub/virthub.c =================================================================== --- uspace/drv/vhc/hub/virthub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/hub/virthub.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,271 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief + */ +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#include "virthub.h" +#include "hub.h" + + +/** Standard device descriptor. */ +usb_standard_device_descriptor_t std_device_descriptor = { + .length = sizeof(usb_standard_device_descriptor_t), + .descriptor_type = USB_DESCTYPE_DEVICE, + .usb_spec_version = 0x110, + .device_class = USB_CLASS_HUB, + .device_subclass = 0, + .device_protocol = 0, + .max_packet_size = 64, + .configuration_count = 1 +}; + +/** Standard interface descriptor. */ +usb_standard_interface_descriptor_t std_interface_descriptor = { + .length = sizeof(usb_standard_interface_descriptor_t), + .descriptor_type = USB_DESCTYPE_INTERFACE, + .interface_number = 0, + .alternate_setting = 0, + .endpoint_count = 1, + .interface_class = USB_CLASS_HUB, + .interface_subclass = 0, + .interface_protocol = 0, + .str_interface = 0 +}; + +/** Hub descriptor. */ +hub_descriptor_t hub_descriptor = { + .length = sizeof(hub_descriptor_t), + .type = USB_DESCTYPE_HUB, + .port_count = HUB_PORT_COUNT, + .characteristics = 0, + .power_on_warm_up = 50, /* Huh? */ + .max_current = 100, /* Huh again. */ + .removable_device = { 0 }, + .port_power = { 0xFF } +}; + +/** Endpoint descriptor. */ +usb_standard_endpoint_descriptor_t endpoint_descriptor = { + .length = sizeof(usb_standard_endpoint_descriptor_t), + .descriptor_type = USB_DESCTYPE_ENDPOINT, + .endpoint_address = HUB_STATUS_CHANGE_PIPE | 128, + .attributes = USB_TRANSFER_INTERRUPT, + .max_packet_size = 8, + .poll_interval = 0xFF +}; + +/** Standard configuration descriptor. */ +usb_standard_configuration_descriptor_t std_configuration_descriptor = { + .length = sizeof(usb_standard_configuration_descriptor_t), + .descriptor_type = USB_DESCTYPE_CONFIGURATION, + .total_length = + sizeof(usb_standard_configuration_descriptor_t) + + sizeof(std_interface_descriptor) + + sizeof(hub_descriptor) + + sizeof(endpoint_descriptor) + , + .interface_count = 1, + .configuration_number = HUB_CONFIGURATION_ID, + .str_configuration = 0, + .attributes = 128, /* denotes bus-powered device */ + .max_power = 50 +}; + +/** All hub configuration descriptors. */ +static usbvirt_device_configuration_extras_t extra_descriptors[] = { + { + .data = (uint8_t *) &std_interface_descriptor, + .length = sizeof(std_interface_descriptor) + }, + { + .data = (uint8_t *) &hub_descriptor, + .length = sizeof(hub_descriptor) + }, + { + .data = (uint8_t *) &endpoint_descriptor, + .length = sizeof(endpoint_descriptor) + } +}; + +/** Hub configuration. */ +usbvirt_device_configuration_t configuration = { + .descriptor = &std_configuration_descriptor, + .extra = extra_descriptors, + .extra_count = sizeof(extra_descriptors)/sizeof(extra_descriptors[0]) +}; + +/** Hub standard descriptors. */ +usbvirt_descriptors_t descriptors = { + .device = &std_device_descriptor, + .configuration = &configuration, + .configuration_count = 1, +}; + +/** Initializes virtual hub device. + * + * @param dev Virtual USB device backend. + * @return Error code. + */ +int virthub_init(usbvirt_device_t *dev) +{ + if (dev == NULL) { + return EBADMEM; + } + dev->ops = &hub_ops; + dev->descriptors = &descriptors; + dev->lib_debug_level = 0; + dev->lib_debug_enabled_tags = USBVIRT_DEBUGTAG_ALL; + + hub_t *hub = malloc(sizeof(hub_t)); + if (hub == NULL) { + return ENOMEM; + } + + hub_init(hub); + dev->device_data = hub; + + int rc; +#ifdef STANDALONE_HUB + dev->name = "hub"; + rc = usbvirt_connect(dev); +#else + rc = usbvirt_connect_local(dev); +#endif + + return rc; +} + +/** Connect a device to a virtual hub. + * + * @param dev Virtual device representing the hub. + * @param conn Device to be connected. + * @return Port device was connected to. + */ +int virthub_connect_device(usbvirt_device_t *dev, virtdev_connection_t *conn) +{ + assert(dev != NULL); + assert(conn != NULL); + + hub_t *hub = (hub_t *) dev->device_data; + + hub_acquire(hub); + size_t port = hub_connect_device(hub, conn); + hub_release(hub); + + return port; +} + +/** Disconnect a device from a virtual hub. + * + * @param dev Virtual device representing the hub. + * @param conn Device to be disconnected. + * @return Error code. + */ +int virthub_disconnect_device(usbvirt_device_t *dev, virtdev_connection_t *conn) +{ + assert(dev != NULL); + assert(conn != NULL); + + hub_t *hub = (hub_t *) dev->device_data; + + hub_acquire(hub); + hub_disconnect_device(hub, conn); + hub_release(hub); + + return ENOTSUP; +} + +/** Whether trafic is propagated to given device. + * + * @param dev Virtual device representing the hub. + * @param conn Connected device. + * @return Whether port is signalling to the device. + */ +bool virthub_is_device_enabled(usbvirt_device_t *dev, virtdev_connection_t *conn) +{ + assert(dev != NULL); + assert(conn != NULL); + + hub_t *hub = (hub_t *) dev->device_data; + + hub_acquire(hub); + + hub_port_state_t state = HUB_PORT_STATE_UNKNOWN; + size_t port = hub_find_device(hub, conn); + if (port != (size_t) -1) { + state = hub_get_port_state(hub, port); + } + hub_release(hub); + + return state == HUB_PORT_STATE_ENABLED; +} + +/** Format status of a virtual hub. + * + * @param dev Virtual device representing the hub. + * @param[out] status Hub status information. + * @param[in] len Size of the @p status buffer. + */ +void virthub_get_status(usbvirt_device_t *dev, char *status, size_t len) +{ + assert(dev != NULL); + if (len == 0) { + return; + } + + hub_t *hub = (hub_t *) dev->device_data; + + char port_status[HUB_PORT_COUNT + 1]; + + size_t i; + for (i = 0; i < HUB_PORT_COUNT; i++) { + port_status[i] = hub_port_state_to_char( + hub_get_port_state(hub, i)); + } + port_status[HUB_PORT_COUNT] = 0; + + snprintf(status, len, "vhub:%s", port_status); +} + +/** + * @} + */ Index: uspace/drv/vhc/hub/virthub.h =================================================================== --- uspace/drv/vhc/hub/virthub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/hub/virthub.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,90 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief USB hub as a virtual USB device. + */ +#ifndef VHC_HUB_VIRTHUB_H_ +#define VHC_HUB_VIRTHUB_H_ + +#include +#include "hub.h" + +#ifdef STANDALONE_HUB +#define virtdev_connection_t int +#else +#include "../devices.h" +#endif + +/** Endpoint number for status change pipe. */ +#define HUB_STATUS_CHANGE_PIPE 1 +/** Configuration value for hub configuration. */ +#define HUB_CONFIGURATION_ID 1 + + +/** Hub descriptor. + */ +typedef struct { + /** Size of this descriptor in bytes. */ + uint8_t length; + /** Descriptor type (USB_DESCTYPE_HUB). */ + uint8_t type; + /** Number of downstream ports. */ + uint8_t port_count; + /** Hub characteristics. */ + uint16_t characteristics; + /** Time from power-on to stabilized current. + * Expressed in 2ms unit. + */ + uint8_t power_on_warm_up; + /** Maximum current (in mA). */ + uint8_t max_current; + /** Whether device at given port is removable. */ + uint8_t removable_device[BITS2BYTES(HUB_PORT_COUNT+1)]; + /** Port power control. + * This is USB1.0 compatibility field, all bits must be 1. + */ + uint8_t port_power[BITS2BYTES(HUB_PORT_COUNT+1)]; +} __attribute__ ((packed)) hub_descriptor_t; + +extern usbvirt_device_ops_t hub_ops; +extern hub_descriptor_t hub_descriptor; + +int virthub_init(usbvirt_device_t *); +int virthub_connect_device(usbvirt_device_t *, virtdev_connection_t *); +int virthub_disconnect_device(usbvirt_device_t *, virtdev_connection_t *); +bool virthub_is_device_enabled(usbvirt_device_t *, virtdev_connection_t *); +void virthub_get_status(usbvirt_device_t *, char *, size_t); + +#endif +/** + * @} + */ Index: uspace/drv/vhc/hub/virthubops.c =================================================================== --- uspace/drv/vhc/hub/virthubops.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/hub/virthubops.c (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,433 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Virtual USB hub operations. + */ +#include +#include +#include "virthub.h" +#include "hub.h" + +/** Callback when device changes states. */ +static void on_state_change(struct usbvirt_device *dev, + usbvirt_device_state_t old_state, usbvirt_device_state_t new_state) +{ + hub_t *hub = (hub_t *)dev->device_data; + + hub_acquire(hub); + + switch (new_state) { + case USBVIRT_STATE_CONFIGURED: + hub_set_port_state_all(hub, HUB_PORT_STATE_POWERED_OFF); + break; + case USBVIRT_STATE_ADDRESS: + hub_set_port_state_all(hub, HUB_PORT_STATE_NOT_CONFIGURED); + break; + default: + break; + } + + hub_release(hub); +} + +/** Callback for data request. */ +static int req_on_data(struct usbvirt_device *dev, + usb_endpoint_t endpoint, + void *buffer, size_t size, size_t *actual_size) +{ + if (endpoint != HUB_STATUS_CHANGE_PIPE) { + return EINVAL; + } + + hub_t *hub = (hub_t *)dev->device_data; + + hub_acquire(hub); + + uint8_t change_map = hub_get_status_change_bitmap(hub); + + uint8_t *b = (uint8_t *) buffer; + if (size > 0) { + *b = change_map; + *actual_size = 1; + } + + hub_release(hub); + + return EOK; +} + +/** Handle ClearHubFeature request. + * + * @param dev Virtual device representing the hub. + * @param request The SETUP packet of the control request. + * @param data Extra data (when DATA stage present). + * @return Error code. + */ +static int req_clear_hub_feature(usbvirt_device_t *dev, + usb_device_request_setup_packet_t *request, + uint8_t *data) +{ + return ENOTSUP; +} + +/** Handle ClearPortFeature request. + * + * @param dev Virtual device representing the hub. + * @param request The SETUP packet of the control request. + * @param data Extra data (when DATA stage present). + * @return Error code. + */ +static int req_clear_port_feature(usbvirt_device_t *dev, + usb_device_request_setup_packet_t *request, + uint8_t *data) +{ + int rc; + size_t port = request->index - 1; + usb_hub_class_feature_t feature = request->value; + hub_t *hub = (hub_t *) dev->device_data; + + hub_acquire(hub); + + hub_port_state_t port_state = hub_get_port_state(hub, port); + + switch (feature) { + case USB_HUB_FEATURE_PORT_ENABLE: + if ((port_state != HUB_PORT_STATE_NOT_CONFIGURED) + && (port_state != HUB_PORT_STATE_POWERED_OFF)) { + hub_set_port_state(hub, port, HUB_PORT_STATE_DISABLED); + } + rc = EOK; + break; + + case USB_HUB_FEATURE_PORT_SUSPEND: + if (port_state != HUB_PORT_STATE_SUSPENDED) { + rc = EOK; + break; + } + hub_set_port_state(hub, port, HUB_PORT_STATE_RESUMING); + rc = EOK; + break; + + case USB_HUB_FEATURE_PORT_POWER: + if (port_state != HUB_PORT_STATE_NOT_CONFIGURED) { + hub_set_port_state(hub, port, HUB_PORT_STATE_POWERED_OFF); + } + rc = EOK; + break; + + case USB_HUB_FEATURE_C_PORT_CONNECTION: + hub_clear_port_status_change(hub, port, HUB_STATUS_C_PORT_CONNECTION); + rc = EOK; + break; + + case USB_HUB_FEATURE_C_PORT_ENABLE: + hub_clear_port_status_change(hub, port, HUB_STATUS_C_PORT_ENABLE); + rc = EOK; + break; + + case USB_HUB_FEATURE_C_PORT_SUSPEND: + hub_clear_port_status_change(hub, port, HUB_STATUS_C_PORT_SUSPEND); + rc = EOK; + break; + + case USB_HUB_FEATURE_C_PORT_OVER_CURRENT: + hub_clear_port_status_change(hub, port, HUB_STATUS_C_PORT_OVER_CURRENT); + rc = EOK; + break; + + case USB_HUB_FEATURE_C_PORT_RESET: + hub_clear_port_status_change(hub, port, HUB_STATUS_C_PORT_RESET); + rc = EOK; + break; + + default: + rc = ENOTSUP; + break; + } + + hub_release(hub); + + return rc; +} + +/** Handle GetBusState request. + * + * @param dev Virtual device representing the hub. + * @param request The SETUP packet of the control request. + * @param data Extra data (when DATA stage present). + * @return Error code. + */ +static int req_get_bus_state(usbvirt_device_t *dev, + usb_device_request_setup_packet_t *request, + uint8_t *data) +{ + return ENOTSUP; +} + +/** Handle GetDescriptor request. + * + * @param dev Virtual device representing the hub. + * @param request The SETUP packet of the control request. + * @param data Extra data (when DATA stage present). + * @return Error code. + */ +static int req_get_descriptor(usbvirt_device_t *dev, + usb_device_request_setup_packet_t *request, + uint8_t *data) +{ + if (request->value_high == USB_DESCTYPE_HUB) { + int rc = dev->control_transfer_reply(dev, 0, + &hub_descriptor, hub_descriptor.length); + + return rc; + } + /* Let the framework handle all the rest. */ + return EFORWARD; +} + +/** Handle GetHubStatus request. + * + * @param dev Virtual device representing the hub. + * @param request The SETUP packet of the control request. + * @param data Extra data (when DATA stage present). + * @return Error code. + */ +static int req_get_hub_status(usbvirt_device_t *dev, + usb_device_request_setup_packet_t *request, + uint8_t *data) +{ + uint32_t hub_status = 0; + + return dev->control_transfer_reply(dev, 0, + &hub_status, sizeof(hub_status)); +} + +/** Handle GetPortStatus request. + * + * @param dev Virtual device representing the hub. + * @param request The SETUP packet of the control request. + * @param data Extra data (when DATA stage present). + * @return Error code. + */ +static int req_get_port_status(usbvirt_device_t *dev, + usb_device_request_setup_packet_t *request, + uint8_t *data) +{ + hub_t *hub = (hub_t *) dev->device_data; + + hub_acquire(hub); + + uint32_t status = hub_get_port_status(hub, request->index - 1); + + hub_release(hub); + + return dev->control_transfer_reply(dev, 0, &status, 4); +} + +/** Handle SetHubFeature request. + * + * @param dev Virtual device representing the hub. + * @param request The SETUP packet of the control request. + * @param data Extra data (when DATA stage present). + * @return Error code. + */ +static int req_set_hub_feature(usbvirt_device_t *dev, + usb_device_request_setup_packet_t *request, + uint8_t *data) +{ + return ENOTSUP; +} + +/** Handle SetPortFeature request. + * + * @param dev Virtual device representing the hub. + * @param request The SETUP packet of the control request. + * @param data Extra data (when DATA stage present). + * @return Error code. + */ +static int req_set_port_feature(usbvirt_device_t *dev, + usb_device_request_setup_packet_t *request, + uint8_t *data) +{ + int rc; + size_t port = request->index - 1; + usb_hub_class_feature_t feature = request->value; + hub_t *hub = (hub_t *) dev->device_data; + + hub_acquire(hub); + + hub_port_state_t port_state = hub_get_port_state(hub, port); + + switch (feature) { + case USB_HUB_FEATURE_PORT_RESET: + if (port_state != HUB_PORT_STATE_POWERED_OFF) { + hub_set_port_state(hub, port, HUB_PORT_STATE_RESETTING); + } + rc = EOK; + break; + + case USB_HUB_FEATURE_PORT_SUSPEND: + if (port_state == HUB_PORT_STATE_ENABLED) { + hub_set_port_state(hub, port, HUB_PORT_STATE_SUSPENDED); + } + rc = EOK; + break; + + case USB_HUB_FEATURE_PORT_POWER: + if (port_state == HUB_PORT_STATE_POWERED_OFF) { + hub_set_port_state(hub, port, HUB_PORT_STATE_DISCONNECTED); + } + rc = EOK; + break; + + default: + break; + } + + hub_release(hub); + + return rc; +} + + +/** IN class request. */ +#define CLASS_REQ_IN(recipient) \ + USBVIRT_MAKE_CONTROL_REQUEST_TYPE(USB_DIRECTION_IN, \ + USBVIRT_REQUEST_TYPE_CLASS, recipient) +/** OUT class request. */ +#define CLASS_REQ_OUT(recipient) \ + USBVIRT_MAKE_CONTROL_REQUEST_TYPE(USB_DIRECTION_OUT, \ + USBVIRT_REQUEST_TYPE_CLASS, recipient) + +/** Recipient: other. */ +#define REC_OTHER USBVIRT_REQUEST_RECIPIENT_OTHER +/** Recipient: device. */ +#define REC_DEVICE USBVIRT_REQUEST_RECIPIENT_DEVICE +/** Direction: in. */ +#define DIR_IN USB_DIRECTION_IN +/** Direction: out. */ +#define DIR_OUT USB_DIRECTION_OUT + +/** Create a class request. + * + * @param direction Request direction. + * @param recipient Request recipient. + * @param req Request code. + */ +#define CLASS_REQ(direction, recipient, req) \ + .request_type = USBVIRT_MAKE_CONTROL_REQUEST_TYPE(direction, \ + USBVIRT_REQUEST_TYPE_CLASS, recipient), \ + .request = req + +/** Create a standard request. + * + * @param direction Request direction. + * @param recipient Request recipient. + * @param req Request code. + */ +#define STD_REQ(direction, recipient, req) \ + .request_type = USBVIRT_MAKE_CONTROL_REQUEST_TYPE(direction, \ + USBVIRT_REQUEST_TYPE_STANDARD, recipient), \ + .request = req + +/** Hub operations on control endpoint zero. */ +static usbvirt_control_transfer_handler_t endpoint_zero_handlers[] = { + { + STD_REQ(DIR_IN, REC_DEVICE, USB_DEVREQ_GET_DESCRIPTOR), + .name = "GetDescriptor", + .callback = req_get_descriptor + }, + { + CLASS_REQ(DIR_IN, REC_DEVICE, USB_DEVREQ_GET_DESCRIPTOR), + .name = "GetDescriptor", + .callback = req_get_descriptor + }, + { + CLASS_REQ(DIR_IN, REC_OTHER, USB_HUB_REQUEST_GET_STATUS), + .name = "GetPortStatus", + .callback = req_get_port_status + }, + { + CLASS_REQ(DIR_OUT, REC_DEVICE, USB_HUB_REQUEST_CLEAR_FEATURE), + .name = "ClearHubFeature", + .callback = req_clear_hub_feature + }, + { + CLASS_REQ(DIR_OUT, REC_OTHER, USB_HUB_REQUEST_CLEAR_FEATURE), + .name = "ClearPortFeature", + .callback = req_clear_port_feature + }, + { + CLASS_REQ(DIR_IN, REC_OTHER, USB_HUB_REQUEST_GET_STATE), + .name = "GetBusState", + .callback = req_get_bus_state + }, + { + CLASS_REQ(DIR_IN, REC_DEVICE, USB_HUB_REQUEST_GET_DESCRIPTOR), + .name = "GetHubDescriptor", + .callback = req_get_descriptor + }, + { + CLASS_REQ(DIR_IN, REC_DEVICE, USB_HUB_REQUEST_GET_STATUS), + .name = "GetHubStatus", + .callback = req_get_hub_status + }, + { + CLASS_REQ(DIR_IN, REC_OTHER, USB_HUB_REQUEST_GET_STATUS), + .name = "GetPortStatus", + .callback = req_get_port_status + }, + { + CLASS_REQ(DIR_OUT, REC_DEVICE, USB_HUB_REQUEST_SET_FEATURE), + .name = "SetHubFeature", + .callback = req_set_hub_feature + }, + { + CLASS_REQ(DIR_OUT, REC_OTHER, USB_HUB_REQUEST_SET_FEATURE), + .name = "SetPortFeature", + .callback = req_set_port_feature + }, + USBVIRT_CONTROL_TRANSFER_HANDLER_LAST +}; + + +/** Hub operations. */ +usbvirt_device_ops_t hub_ops = { + .control_transfer_handlers = endpoint_zero_handlers, + .on_data = NULL, + .on_data_request = req_on_data, + .on_state_change = on_state_change, +}; + +/** + * @} + */ Index: uspace/drv/vhc/vhc.ma =================================================================== --- uspace/drv/vhc/vhc.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/vhc.ma (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,2 @@ +10 usb&hc=vhc + Index: uspace/drv/vhc/vhcd.h =================================================================== --- uspace/drv/vhc/vhcd.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) +++ uspace/drv/vhc/vhcd.h (revision 969585f91e912d72b71cfd6d44243c9504d8d795) @@ -0,0 +1,54 @@ +/* + * Copyright (c) 2010 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup drvusbvhc + * @{ + */ +/** @file + * @brief Virtual USB host controller common definitions. + */ +#ifndef VHCD_VHCD_H_ +#define VHCD_VHCD_H_ + +#include + +#define NAME "vhc" +#define NAME_DEV "hcd-virt-dev" +#define NAMESPACE "usb" + +#define DEVMAP_PATH_HC NAMESPACE "/" NAME +#define DEVMAP_PATH_DEV NAMESPACE "/" NAME_DEV + +//#define dprintf(level, format, ...) +// usb_dprintf(NAME, (level), format "\n", ##__VA_ARGS__) +//void dprintf_inval_call(int, ipc_call_t, sysarg_t); + +#endif +/** + * @} + */