Index: uspace/lib/usb/Makefile =================================================================== --- uspace/lib/usb/Makefile (revision 5e2be26723e8c36a320afa8d3a1bd358b33157d7) +++ uspace/lib/usb/Makefile (revision f0891ceffb99cfd7adae2b8dfc5798bcc7f0b54f) @@ -54,5 +54,6 @@ src/host/device_keeper.c \ src/host/batch.c \ - src/host/bandwidth.c + src/host/bandwidth.c \ + src/host/usb_endpoint_manager.c include $(USPACE_PREFIX)/Makefile.common Index: uspace/lib/usb/include/usb/host/usb_endpoint_manager.h =================================================================== --- uspace/lib/usb/include/usb/host/usb_endpoint_manager.h (revision f0891ceffb99cfd7adae2b8dfc5798bcc7f0b54f) +++ uspace/lib/usb/include/usb/host/usb_endpoint_manager.h (revision f0891ceffb99cfd7adae2b8dfc5798bcc7f0b54f) @@ -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 libusb + * @{ + */ +/** @file + * Device keeper structure and functions. + * + * Typical USB host controller needs to keep track of various settings for + * each device that is connected to it. + * State of toggle bit, device speed etc. etc. + * This structure shall simplify the management. + */ +#ifndef LIBUSB_HOST_USB_ENDPOINT_MANAGER_H +#define LIBUSB_HOST_YSB_ENDPOINT_MANAGER_H + +#include +#include +#include + +#define BANDWIDTH_TOTAL_USB11 12000000 +#define BANDWIDTH_AVAILABLE_USB11 ((BANDWIDTH_TOTAL_USB11 / 10) * 9) + +typedef struct usb_endpoint_manager { + hash_table_t ep_table; + fibril_mutex_t guard; + fibril_condvar_t change; + size_t free_bw; +} usb_endpoint_manager_t; + +size_t bandwidth_count_usb11(usb_speed_t speed, usb_transfer_type_t type, + size_t size, size_t max_packet_size); + +int usb_endpoint_manager_init(usb_endpoint_manager_t *instance, + size_t available_bandwidth); + +void usb_endpoint_manager_destroy(usb_endpoint_manager_t *instance); + +int usb_endpoint_manager_register_ep(usb_endpoint_manager_t *instance, + usb_address_t address, usb_endpoint_t ep, usb_direction_t direction, + void *data, void (*data_remove_callback)(void* data, void* arg), void *arg, + size_t bw); + +int usb_endpoint_manager_register_ep_wait(usb_endpoint_manager_t *instance, + usb_address_t address, usb_endpoint_t ep, usb_direction_t direction, + void *data, void (*data_remove_callback)(void* data, void* arg), void *arg, + size_t bw); + +int usb_endpoint_manager_unregister_ep(usb_endpoint_manager_t *instance, + usb_address_t address, usb_endpoint_t ep, usb_direction_t direction); + +void * usb_endpoint_manager_get_ep_data(usb_endpoint_manager_t *instance, + usb_address_t address, usb_endpoint_t ep, usb_direction_t direction, + size_t *bw); + +#endif +/** + * @} + */ + Index: uspace/lib/usb/src/host/usb_endpoint_manager.c =================================================================== --- uspace/lib/usb/src/host/usb_endpoint_manager.c (revision f0891ceffb99cfd7adae2b8dfc5798bcc7f0b54f) +++ uspace/lib/usb/src/host/usb_endpoint_manager.c (revision f0891ceffb99cfd7adae2b8dfc5798bcc7f0b54f) @@ -0,0 +1,240 @@ +/* + * Copyright (c) 2011 Jan Vesely + * All rights eps. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#include +#include +#include +#include + +#define BUCKET_COUNT 7 + +typedef struct { + usb_address_t address; + usb_endpoint_t endpoint; + usb_direction_t direction; +} __attribute__((aligned (sizeof(unsigned long)))) id_t; +#define MAX_KEYS (sizeof(id_t) / sizeof(unsigned long)) +typedef struct { + union { + id_t id; + unsigned long key[MAX_KEYS]; + }; + link_t link; + size_t bw; + void *data; + void (*data_remove_callback)(void* data, void* arg); + void *arg; +} ep_t; +/*----------------------------------------------------------------------------*/ +static hash_index_t ep_hash(unsigned long key[]) +{ + hash_index_t hash = 0; + unsigned i = 0; + for (;i < MAX_KEYS; ++i) { + hash ^= key[i]; + } + hash %= BUCKET_COUNT; + return hash; +} +/*----------------------------------------------------------------------------*/ +static int ep_compare( + unsigned long key[], hash_count_t keys, link_t *item) +{ + assert(item); + ep_t *ep = + hash_table_get_instance(item, ep_t, link); + hash_count_t i = 0; + for (; i < keys; ++i) { + if (key[i] != ep->key[i]) + return false; + } + return true; +} +/*----------------------------------------------------------------------------*/ +static void ep_remove(link_t *item) +{ + assert(item); + ep_t *ep = + hash_table_get_instance(item, ep_t, link); + ep->data_remove_callback(ep->data, ep->arg); + free(ep); +} +/*----------------------------------------------------------------------------*/ +hash_table_operations_t op = { + .hash = ep_hash, + .compare = ep_compare, + .remove_callback = ep_remove, +}; +/*----------------------------------------------------------------------------*/ +size_t bandwidth_count_usb11(usb_speed_t speed, usb_transfer_type_t type, + size_t size, size_t max_packet_size) +{ + const unsigned packet_count = + (size + max_packet_size - 1) / max_packet_size; + /* TODO: It may be that ISO and INT transfers use only one data packet + * per transaction, but I did not find text in UB spec that confirms + * this */ + /* NOTE: All data packets will be considered to be max_packet_size */ + switch (speed) + { + case USB_SPEED_LOW: + assert(type == USB_TRANSFER_INTERRUPT); + /* Protocol overhead 13B + * (3 SYNC bytes, 3 PID bytes, 2 Endpoint + CRC bytes, 2 + * CRC bytes, and a 3-byte interpacket delay) + * see USB spec page 45-46. */ + /* Speed penalty 8: low speed is 8-times slower*/ + return packet_count * (13 + max_packet_size) * 8; + case USB_SPEED_FULL: + /* Interrupt transfer overhead see above + * or page 45 of USB spec */ + if (type == USB_TRANSFER_INTERRUPT) + return packet_count * (13 + max_packet_size); + + assert(type == USB_TRANSFER_ISOCHRONOUS); + /* Protocol overhead 9B + * (2 SYNC bytes, 2 PID bytes, 2 Endpoint + CRC bytes, 2 CRC + * bytes, and a 1-byte interpacket delay) + * see USB spec page 42 */ + return packet_count * (9 + max_packet_size); + default: + return 0; + } +} +/*----------------------------------------------------------------------------*/ +int usb_endpoint_manager_init(usb_endpoint_manager_t *instance, + size_t available_bandwidth) +{ + assert(instance); + fibril_mutex_initialize(&instance->guard); + fibril_condvar_initialize(&instance->change); + instance->free_bw = available_bandwidth; + bool ht = + hash_table_create(&instance->ep_table, BUCKET_COUNT, MAX_KEYS, &op); + return ht ? EOK : ENOMEM; +} +/*----------------------------------------------------------------------------*/ +void usb_endpoint_manager_destroy(usb_endpoint_manager_t *instance) +{ + hash_table_destroy(&instance->ep_table); +} +/*----------------------------------------------------------------------------*/ +int usb_endpoint_manager_register_ep(usb_endpoint_manager_t *instance, + usb_address_t address, usb_endpoint_t endpoint, usb_direction_t direction, + void *data, void (*data_remove_callback)(void* data, void* arg), void *arg, + size_t bw) +{ + assert(instance); + + id_t id = { + .address = address, + .endpoint = endpoint, + .direction = direction, + }; + fibril_mutex_lock(&instance->guard); + + + link_t *item = + hash_table_find(&instance->ep_table, (unsigned long*)&id); + if (item != NULL) { + fibril_mutex_unlock(&instance->guard); + return EEXISTS; + } + + if (bw > instance->free_bw) { + fibril_mutex_unlock(&instance->guard); + return ENOSPC; + } + + ep_t *ep = malloc(sizeof(ep_t)); + if (ep == NULL) { + fibril_mutex_unlock(&instance->guard); + return ENOMEM; + } + + ep->id = id; + ep->bw = bw; + link_initialize(&ep->link); + + hash_table_insert(&instance->ep_table, (unsigned long*)&id, &ep->link); + instance->free_bw -= bw; + fibril_mutex_unlock(&instance->guard); + fibril_condvar_broadcast(&instance->change); + return EOK; +} +/*----------------------------------------------------------------------------*/ +int usb_endpoint_manager_unregister_ep(usb_endpoint_manager_t *instance, + usb_address_t address, usb_endpoint_t endpoint, usb_direction_t direction) +{ + assert(instance); + id_t id = { + .address = address, + .endpoint = endpoint, + .direction = direction, + }; + fibril_mutex_lock(&instance->guard); + link_t *item = + hash_table_find(&instance->ep_table, (unsigned long*)&id); + if (item == NULL) { + fibril_mutex_unlock(&instance->guard); + return EINVAL; + } + + ep_t *ep = hash_table_get_instance(item, ep_t, link); + instance->free_bw += ep->bw; + hash_table_remove(&instance->ep_table, (unsigned long*)&id, MAX_KEYS); + + fibril_mutex_unlock(&instance->guard); + fibril_condvar_broadcast(&instance->change); + return EOK; +} +/*----------------------------------------------------------------------------*/ +void * usb_endpoint_manager_get_ep_data(usb_endpoint_manager_t *instance, + usb_address_t address, usb_endpoint_t endpoint, usb_direction_t direction, + size_t *bw) +{ + assert(instance); + id_t id = { + .address = address, + .endpoint = endpoint, + .direction = direction, + }; + fibril_mutex_lock(&instance->guard); + link_t *item = + hash_table_find(&instance->ep_table, (unsigned long*)&id); + if (item == NULL) { + fibril_mutex_unlock(&instance->guard); + return NULL; + } + ep_t *ep = hash_table_get_instance(item, ep_t, link); + if (bw) + *bw = ep->bw; + + fibril_mutex_unlock(&instance->guard); + return ep->data; +}