Index: uspace/lib/usb/Makefile =================================================================== --- uspace/lib/usb/Makefile (revision 1cbb4b7df3b478e0dda92c959b87f5b3358695ec) +++ uspace/lib/usb/Makefile (revision 9f104af4a2990fdb7a7bc9e9f3511be7c29ef91b) @@ -34,4 +34,5 @@ SOURCES = \ src/addrkeep.c \ + src/altiface.c \ src/class.c \ src/ddfiface.c \ Index: uspace/lib/usb/include/usb/devdrv.h =================================================================== --- uspace/lib/usb/include/usb/devdrv.h (revision 1cbb4b7df3b478e0dda92c959b87f5b3358695ec) +++ uspace/lib/usb/include/usb/devdrv.h (revision 9f104af4a2990fdb7a7bc9e9f3511be7c29ef91b) @@ -174,6 +174,9 @@ usb_endpoint_mapping_t **, size_t *); int usb_device_destroy_pipes(ddf_dev_t *, usb_endpoint_mapping_t *, size_t); +int usb_device_create(ddf_dev_t *, usb_endpoint_description_t **, usb_device_t **, const char **); size_t usb_interface_count_alternates(uint8_t *, size_t, uint8_t); +int usb_alternate_interfaces_create(uint8_t *, size_t, int, + usb_alternate_interfaces_t **); #endif Index: uspace/lib/usb/include/usb/request.h =================================================================== --- uspace/lib/usb/include/usb/request.h (revision 1cbb4b7df3b478e0dda92c959b87f5b3358695ec) +++ uspace/lib/usb/include/usb/request.h (revision 9f104af4a2990fdb7a7bc9e9f3511be7c29ef91b) @@ -50,4 +50,10 @@ /** USB endpoint status - endpoint is halted (stalled). */ #define USB_ENDPOINT_STATUS_HALTED ((uint16_t)(1 << 0)) + +/** USB feature selector - endpoint halt (stall). */ +#define USB_FEATURE_SELECTOR_ENDPOINT_HALT (0) + +/** USB feature selector - device remote wake-up. */ +#define USB_FEATURE_SELECTOR_REMOTE_WAKEUP (1) /** Standard device request. */ @@ -135,4 +141,6 @@ char **); +int usb_request_clear_endpoint_halt(usb_pipe_t *, uint16_t); + #endif /** Index: uspace/lib/usb/src/altiface.c =================================================================== --- uspace/lib/usb/src/altiface.c (revision 9f104af4a2990fdb7a7bc9e9f3511be7c29ef91b) +++ uspace/lib/usb/src/altiface.c (revision 9f104af4a2990fdb7a7bc9e9f3511be7c29ef91b) @@ -0,0 +1,181 @@ +/* + * Copyright (c) 2011 Vojtech Horky + * All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions + * are met: + * + * - Redistributions of source code must retain the above copyright + * notice, this list of conditions and the following disclaimer. + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * - The name of the author may not be used to endorse or promote products + * derived from this software without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES + * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. + * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, + * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT + * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF + * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +/** @addtogroup libusb + * @{ + */ +/** @file + * Handling alternate interface settings. + */ +#include +#include +#include +#include +#include +#include +#include + +/** Count number of alternate settings of a interface. + * + * @param config_descr Full configuration descriptor. + * @param config_descr_size Size of @p config_descr in bytes. + * @param interface_no Interface number. + * @return Number of alternate interfaces for @p interface_no interface. + */ +size_t usb_interface_count_alternates(uint8_t *config_descr, + size_t config_descr_size, uint8_t interface_no) +{ + assert(config_descr != NULL); + assert(config_descr_size > 0); + + usb_dp_parser_t dp_parser = { + .nesting = usb_dp_standard_descriptor_nesting + }; + usb_dp_parser_data_t dp_data = { + .data = config_descr, + .size = config_descr_size, + .arg = NULL + }; + + size_t alternate_count = 0; + + uint8_t *iface_ptr = usb_dp_get_nested_descriptor(&dp_parser, + &dp_data, config_descr); + while (iface_ptr != NULL) { + usb_standard_interface_descriptor_t *iface + = (usb_standard_interface_descriptor_t *) iface_ptr; + if (iface->descriptor_type == USB_DESCTYPE_INTERFACE) { + if (iface->interface_number == interface_no) { + alternate_count++; + } + } + iface_ptr = usb_dp_get_sibling_descriptor(&dp_parser, &dp_data, + config_descr, iface_ptr); + } + + return alternate_count; +} + +/** Create alternate interface representation structure. + * + * @param[in] config_descr Configuration descriptor. + * @param[in] config_descr_size Size of configuration descriptor. + * @param[in] interface_number Interface number. + * @param[out] alternates_ptr Where to store pointer to allocated structure. + * @return Error code. + */ +int usb_alternate_interfaces_create(uint8_t *config_descr, + size_t config_descr_size, int interface_number, + usb_alternate_interfaces_t **alternates_ptr) +{ + assert(alternates_ptr != NULL); + assert(config_descr != NULL); + assert(config_descr_size > 0); + + if (interface_number < 0) { + alternates_ptr = NULL; + return EOK; + } + + usb_alternate_interfaces_t *alternates + = malloc(sizeof(usb_alternate_interfaces_t)); + + if (alternates == NULL) { + return ENOMEM; + } + + alternates->alternative_count + = usb_interface_count_alternates(config_descr, config_descr_size, + interface_number); + + if (alternates->alternative_count == 0) { + free(alternates); + return ENOENT; + } + + alternates->alternatives = malloc(alternates->alternative_count + * sizeof(usb_alternate_interface_descriptors_t)); + if (alternates->alternatives == NULL) { + free(alternates); + return ENOMEM; + } + + alternates->current = 0; + + usb_dp_parser_t dp_parser = { + .nesting = usb_dp_standard_descriptor_nesting + }; + usb_dp_parser_data_t dp_data = { + .data = config_descr, + .size = config_descr_size, + .arg = NULL + }; + + usb_alternate_interface_descriptors_t *cur_alt_iface + = &alternates->alternatives[0]; + + uint8_t *iface_ptr = usb_dp_get_nested_descriptor(&dp_parser, + &dp_data, dp_data.data); + while (iface_ptr != NULL) { + usb_standard_interface_descriptor_t *iface + = (usb_standard_interface_descriptor_t *) iface_ptr; + if ((iface->descriptor_type != USB_DESCTYPE_INTERFACE) + || (iface->interface_number != interface_number)) { + iface_ptr = usb_dp_get_sibling_descriptor(&dp_parser, + &dp_data, + dp_data.data, iface_ptr); + continue; + } + + cur_alt_iface->interface = iface; + cur_alt_iface->nested_descriptors = iface_ptr + sizeof(*iface); + + /* Find next interface to count size of nested descriptors. */ + iface_ptr = usb_dp_get_sibling_descriptor(&dp_parser, &dp_data, + dp_data.data, iface_ptr); + if (iface_ptr == NULL) { + uint8_t *next = dp_data.data + dp_data.size; + cur_alt_iface->nested_descriptors_size + = next - cur_alt_iface->nested_descriptors; + } else { + cur_alt_iface->nested_descriptors_size + = iface_ptr - cur_alt_iface->nested_descriptors; + } + + cur_alt_iface++; + } + + *alternates_ptr = alternates; + + return EOK; +} + + +/** + * @} + */ Index: uspace/lib/usb/src/devdrv.c =================================================================== --- uspace/lib/usb/src/devdrv.c (revision 1cbb4b7df3b478e0dda92c959b87f5b3358695ec) +++ uspace/lib/usb/src/devdrv.c (revision 9f104af4a2990fdb7a7bc9e9f3511be7c29ef91b) @@ -100,4 +100,10 @@ usb_device_t *dev, int alternate_setting) { + if (endpoints == NULL) { + dev->pipes = NULL; + dev->pipes_count = 0; + return EOK; + } + usb_endpoint_mapping_t *pipes; size_t pipes_count; @@ -109,7 +115,4 @@ if (rc != EOK) { - usb_log_error( - "Failed to create endpoint pipes for `%s': %s.\n", - dev->ddf_dev->name, str_error(rc)); return rc; } @@ -117,207 +120,4 @@ dev->pipes = pipes; dev->pipes_count = pipes_count; - - return EOK; -} - -/** Initialize all endpoint pipes. - * - * @param drv The driver. - * @param dev The device to be initialized. - * @return Error code. - */ -static int initialize_pipes(usb_device_t *dev) -{ - int rc; - - rc = usb_device_connection_initialize_from_device(&dev->wire, - dev->ddf_dev); - if (rc != EOK) { - usb_log_error( - "Failed initializing connection on device `%s'. %s.\n", - dev->ddf_dev->name, str_error(rc)); - return rc; - } - - rc = usb_pipe_initialize_default_control(&dev->ctrl_pipe, - &dev->wire); - if (rc != EOK) { - usb_log_error("Failed to initialize default control pipe " \ - "on device `%s': %s.\n", - dev->ddf_dev->name, str_error(rc)); - return rc; - } - - rc = usb_pipe_probe_default_control(&dev->ctrl_pipe); - if (rc != EOK) { - usb_log_error( - "Probing default control pipe on device `%s' failed: %s.\n", - dev->ddf_dev->name, str_error(rc)); - return rc; - } - - /* Get our interface. */ - dev->interface_no = usb_device_get_assigned_interface(dev->ddf_dev); - - /* - * We will do some querying of the device, it is worth to prepare - * the long transfer. - */ - rc = usb_pipe_start_long_transfer(&dev->ctrl_pipe); - if (rc != EOK) { - usb_log_error("Failed to start transfer: %s.\n", - str_error(rc)); - return rc; - } - - /* Retrieve the descriptors. */ - rc = usb_device_retrieve_descriptors(&dev->ctrl_pipe, - &dev->descriptors); - if (rc != EOK) { - usb_log_error("Failed to retrieve standard device " \ - "descriptors of %s: %s.\n", - dev->ddf_dev->name, str_error(rc)); - return rc; - } - - - if (driver->endpoints != NULL) { - rc = initialize_other_pipes(driver->endpoints, dev, 0); - } - - usb_pipe_end_long_transfer(&dev->ctrl_pipe); - - /* Rollback actions. */ - if (rc != EOK) { - if (dev->descriptors.configuration != NULL) { - free(dev->descriptors.configuration); - } - } - - return rc; -} - -/** Count number of alternate settings of a interface. - * - * @param config_descr Full configuration descriptor. - * @param config_descr_size Size of @p config_descr in bytes. - * @param interface_no Interface number. - * @return Number of alternate interfaces for @p interface_no interface. - */ -size_t usb_interface_count_alternates(uint8_t *config_descr, - size_t config_descr_size, uint8_t interface_no) -{ - assert(config_descr != NULL); - assert(config_descr_size > 0); - - usb_dp_parser_t dp_parser = { - .nesting = usb_dp_standard_descriptor_nesting - }; - usb_dp_parser_data_t dp_data = { - .data = config_descr, - .size = config_descr_size, - .arg = NULL - }; - - size_t alternate_count = 0; - - uint8_t *iface_ptr = usb_dp_get_nested_descriptor(&dp_parser, - &dp_data, config_descr); - while (iface_ptr != NULL) { - usb_standard_interface_descriptor_t *iface - = (usb_standard_interface_descriptor_t *) iface_ptr; - if (iface->descriptor_type == USB_DESCTYPE_INTERFACE) { - if (iface->interface_number == interface_no) { - alternate_count++; - } - } - iface_ptr = usb_dp_get_sibling_descriptor(&dp_parser, &dp_data, - config_descr, iface_ptr); - } - - return alternate_count; -} - -/** Initialize structures related to alternate interfaces. - * - * @param dev Device where alternate settings shall be initialized. - * @return Error code. - */ -static int initialize_alternate_interfaces(usb_device_t *dev) -{ - if (dev->interface_no < 0) { - dev->alternate_interfaces = NULL; - return EOK; - } - - usb_alternate_interfaces_t *alternates - = malloc(sizeof(usb_alternate_interfaces_t)); - - if (alternates == NULL) { - return ENOMEM; - } - - alternates->alternative_count - = usb_interface_count_alternates(dev->descriptors.configuration, - dev->descriptors.configuration_size, dev->interface_no); - - if (alternates->alternative_count == 0) { - free(alternates); - return ENOENT; - } - - alternates->alternatives = malloc(alternates->alternative_count - * sizeof(usb_alternate_interface_descriptors_t)); - if (alternates->alternatives == NULL) { - free(alternates); - return ENOMEM; - } - - alternates->current = 0; - - usb_dp_parser_t dp_parser = { - .nesting = usb_dp_standard_descriptor_nesting - }; - usb_dp_parser_data_t dp_data = { - .data = dev->descriptors.configuration, - .size = dev->descriptors.configuration_size, - .arg = NULL - }; - - usb_alternate_interface_descriptors_t *cur_alt_iface - = &alternates->alternatives[0]; - - uint8_t *iface_ptr = usb_dp_get_nested_descriptor(&dp_parser, - &dp_data, dp_data.data); - while (iface_ptr != NULL) { - usb_standard_interface_descriptor_t *iface - = (usb_standard_interface_descriptor_t *) iface_ptr; - if ((iface->descriptor_type != USB_DESCTYPE_INTERFACE) - || (iface->interface_number != dev->interface_no)) { - iface_ptr = usb_dp_get_sibling_descriptor(&dp_parser, - &dp_data, - dp_data.data, iface_ptr); - continue; - } - - cur_alt_iface->interface = iface; - cur_alt_iface->nested_descriptors = iface_ptr + sizeof(*iface); - - /* Find next interface to count size of nested descriptors. */ - iface_ptr = usb_dp_get_sibling_descriptor(&dp_parser, &dp_data, - dp_data.data, iface_ptr); - if (iface_ptr == NULL) { - uint8_t *next = dp_data.data + dp_data.size; - cur_alt_iface->nested_descriptors_size - = next - cur_alt_iface->nested_descriptors; - } else { - cur_alt_iface->nested_descriptors_size - = iface_ptr - cur_alt_iface->nested_descriptors; - } - - cur_alt_iface++; - } - - dev->alternate_interfaces = alternates; return EOK; @@ -339,27 +139,12 @@ int rc; - usb_device_t *dev = malloc(sizeof(usb_device_t)); - if (dev == NULL) { - usb_log_error("Out of memory when adding device `%s'.\n", - gen_dev->name); - return ENOMEM; - } - - - dev->ddf_dev = gen_dev; - dev->ddf_dev->driver_data = dev; - dev->driver_data = NULL; - dev->descriptors.configuration = NULL; - - dev->pipes_count = 0; - dev->pipes = NULL; - - rc = initialize_pipes(dev); - if (rc != EOK) { - free(dev); - return rc; - } - - (void) initialize_alternate_interfaces(dev); + usb_device_t *dev = NULL; + const char *err_msg = NULL; + rc = usb_device_create(gen_dev, driver->endpoints, &dev, &err_msg); + if (rc != EOK) { + usb_log_error("USB device `%s' creation failed (%s): %s.\n", + gen_dev->name, err_msg, str_error(rc)); + return rc; + } return driver->ops->add_device(dev); @@ -395,4 +180,11 @@ * with usb_pipe_initialize_from_configuration(). * + * @warning This is a wrapper function that does several operations that + * can fail and that cannot be rollbacked easily. That means that a failure + * during the SET_INTERFACE request would result in having a device with + * no pipes at all (except the default control one). That is because the old + * pipes needs to be unregistered at HC first and the new ones could not + * be created. + * * @param dev USB device. * @param alternate_setting Alternate setting to choose. @@ -409,6 +201,4 @@ int rc; - /* TODO: more transactional behavior. */ - /* Destroy existing pipes. */ rc = destroy_current_pipes(dev); @@ -432,5 +222,5 @@ /** Retrieve basic descriptors from the device. * - * @param[in] ctrl_pipe Control pipe with opened session. + * @param[in] ctrl_pipe Control endpoint pipe. * @param[out] descriptors Where to store the descriptors. * @return Error code. @@ -440,14 +230,19 @@ { assert(descriptors != NULL); - assert(usb_pipe_is_session_started(ctrl_pipe)); descriptors->configuration = NULL; int rc; + + /* It is worth to start a long transfer. */ + rc = usb_pipe_start_long_transfer(ctrl_pipe); + if (rc != EOK) { + return rc; + } /* Get the device descriptor. */ rc = usb_request_get_device_descriptor(ctrl_pipe, &descriptors->device); if (rc != EOK) { - return rc; + goto leave; } @@ -456,9 +251,9 @@ ctrl_pipe, 0, (void **) &descriptors->configuration, &descriptors->configuration_size); - if (rc != EOK) { - return rc; - } - - return EOK; + +leave: + usb_pipe_end_long_transfer(ctrl_pipe); + + return rc; } @@ -641,4 +436,104 @@ } +/** Initialize control pipe in a device. + * + * @param dev USB device in question. + * @param errmsg Where to store error context. + * @return + */ +static int init_wire_and_ctrl_pipe(usb_device_t *dev, const char **errmsg) +{ + int rc; + + rc = usb_device_connection_initialize_from_device(&dev->wire, + dev->ddf_dev); + if (rc != EOK) { + *errmsg = "device connection initialization"; + return rc; + } + + rc = usb_pipe_initialize_default_control(&dev->ctrl_pipe, + &dev->wire); + if (rc != EOK) { + *errmsg = "default control pipe initialization"; + return rc; + } + + return EOK; +} + + +/** Create new instance of USB device. + * + * @param[in] ddf_dev Generic DDF device backing the USB one. + * @param[in] endpoints NULL terminated array of endpoints (NULL for none). + * @param[out] dev_ptr Where to store pointer to the new device. + * @param[out] errstr_ptr Where to store description of context + * (in case error occurs). + * @return Error code. + */ +int usb_device_create(ddf_dev_t *ddf_dev, + usb_endpoint_description_t **endpoints, + usb_device_t **dev_ptr, const char **errstr_ptr) +{ + assert(dev_ptr != NULL); + assert(ddf_dev != NULL); + + int rc; + + usb_device_t *dev = malloc(sizeof(usb_device_t)); + if (dev == NULL) { + *errstr_ptr = "structure allocation"; + return ENOMEM; + } + + // FIXME: proper deallocation in case of errors + + dev->ddf_dev = ddf_dev; + dev->driver_data = NULL; + dev->descriptors.configuration = NULL; + dev->alternate_interfaces = NULL; + + dev->pipes_count = 0; + dev->pipes = NULL; + + /* Initialize backing wire and control pipe. */ + rc = init_wire_and_ctrl_pipe(dev, errstr_ptr); + if (rc != EOK) { + return rc; + } + + /* Get our interface. */ + dev->interface_no = usb_device_get_assigned_interface(dev->ddf_dev); + + /* Retrieve standard descriptors. */ + rc = usb_device_retrieve_descriptors(&dev->ctrl_pipe, + &dev->descriptors); + if (rc != EOK) { + *errstr_ptr = "descriptor retrieval"; + return rc; + } + + /* Create alternate interfaces. */ + rc = usb_alternate_interfaces_create(dev->descriptors.configuration, + dev->descriptors.configuration_size, dev->interface_no, + &dev->alternate_interfaces); + if (rc != EOK) { + /* We will try to silently ignore this. */ + dev->alternate_interfaces = NULL; + } + + rc = initialize_other_pipes(endpoints, dev, 0); + if (rc != EOK) { + *errstr_ptr = "pipes initialization"; + return rc; + } + + *errstr_ptr = NULL; + *dev_ptr = dev; + + return EOK; +} + /** * @} Index: uspace/lib/usb/src/request.c =================================================================== --- uspace/lib/usb/src/request.c (revision 1cbb4b7df3b478e0dda92c959b87f5b3358695ec) +++ uspace/lib/usb/src/request.c (revision 9f104af4a2990fdb7a7bc9e9f3511be7c29ef91b) @@ -871,4 +871,18 @@ } +/** Clear halt bit of an endpoint pipe (after pipe stall). + * + * @param pipe Control pipe. + * @param ep_index Endpoint index (in native endianness). + * @return Error code. + */ +int usb_request_clear_endpoint_halt(usb_pipe_t *pipe, uint16_t ep_index) +{ + return usb_request_clear_feature(pipe, + USB_REQUEST_TYPE_STANDARD, USB_REQUEST_RECIPIENT_ENDPOINT, + uint16_host2usb(USB_FEATURE_SELECTOR_ENDPOINT_HALT), + uint16_host2usb(ep_index)); +} + /** * @}