/* * Copyright (c) 2010 Matus Dekanek * All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * - Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * - Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * - The name of the author may not be used to endorse or promote products * derived from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. */ /** @addtogroup drvusbhub * @{ */ /** @file * @brief usb hub main functionality */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "usbhub.h" #include "utils.h" #include "port_status.h" #define HUB_FNC_NAME "hub" static int usb_set_first_configuration(usb_device_t *usb_device); static usb_hub_info_t * usb_hub_info_create(usb_device_t *usb_dev); static int usb_hub_process_hub_specific_info(usb_hub_info_t *hub_info); static int usb_process_hub_over_current(usb_hub_info_t *hub_info, usb_hub_status_t status); static int usb_process_hub_local_power_change(usb_hub_info_t *hub_info, usb_hub_status_t status); static void usb_hub_process_global_interrupt(usb_hub_info_t *hub_info); static void usb_hub_polling_terminated_callback(usb_device_t *device, bool was_error, void *data); //********************************************* // // hub driver code, initialization // //********************************************* /** * Initialize hub device driver fibril * * Creates hub representation and fibril that periodically checks hub`s status. * Hub representation is passed to the fibril. * @param usb_dev generic usb device information * @return error code */ int usb_hub_add_device(usb_device_t *usb_dev) { assert(usb_dev); /* Create driver soft-state structure */ usb_hub_info_t *hub_info = usb_hub_info_create(usb_dev); if (hub_info == NULL) { usb_log_error("Failed to create hun driver structure.\n"); return ENOMEM; } /* Create hc connection */ usb_log_debug("Initializing USB wire abstraction.\n"); int opResult = usb_hc_connection_initialize_from_device( &hub_info->connection, hub_info->usb_device->ddf_dev); if (opResult != EOK) { usb_log_error("Could not initialize connection to device: %s\n", str_error(opResult)); free(hub_info); return opResult; } /* Set hub's first configuration. (There should be only one) */ opResult = usb_set_first_configuration(usb_dev); if (opResult != EOK) { usb_log_error("Could not set hub configuration: %s\n", str_error(opResult)); free(hub_info); return opResult; } //get port count and create attached_devs opResult = usb_hub_process_hub_specific_info(hub_info); if (opResult != EOK) { usb_log_error("Could process hub specific info, %s\n", str_error(opResult)); free(hub_info); return opResult; } usb_log_debug("Creating DDF function '" HUB_FNC_NAME "'.\n"); ddf_fun_t *hub_fun = ddf_fun_create(hub_info->usb_device->ddf_dev, fun_exposed, HUB_FNC_NAME); if (hub_fun == NULL) { usb_log_error("Failed to create hub function.\n"); free(hub_info); return ENOMEM; } opResult = ddf_fun_bind(hub_fun); if (opResult != EOK) { usb_log_error("Failed to bind hub function: %s.\n", str_error(opResult)); free(hub_info); ddf_fun_destroy(hub_fun); return opResult; } opResult = usb_device_auto_poll(hub_info->usb_device, 0, hub_port_changes_callback, ((hub_info->port_count + 1) / 8) + 1, usb_hub_polling_terminated_callback, hub_info); if (opResult != EOK) { ddf_fun_destroy(hub_fun); free(hub_info); usb_log_error("Failed to create polling fibril: %s.\n", str_error(opResult)); return opResult; } usb_log_info("Controlling hub '%s' (%zu ports).\n", hub_info->usb_device->ddf_dev->name, hub_info->port_count); return EOK; } /** Callback for polling hub for changes. * * @param dev Device where the change occured. * @param change_bitmap Bitmap of changed ports. * @param change_bitmap_size Size of the bitmap in bytes. * @param arg Custom argument, points to @c usb_hub_info_t. * @return Whether to continue polling. */ bool hub_port_changes_callback(usb_device_t *dev, uint8_t *change_bitmap, size_t change_bitmap_size, void *arg) { usb_log_debug("hub_port_changes_callback\n"); usb_hub_info_t *hub = arg; /* FIXME: check that we received enough bytes. */ if (change_bitmap_size == 0) { goto leave; } /* Lowest bit indicates global change */ const bool change = change_bitmap[0] & 1; if (change) { usb_hub_process_global_interrupt(hub); } /* N + 1 bit indicates change on port N */ size_t port = 1; for (; port < hub->port_count + 1; port++) { const bool change = (change_bitmap[port / 8] >> (port % 8)) & 1; if (change) { usb_hub_process_port_interrupt(hub, port); } } leave: /* FIXME: proper interval. */ // TODO Interval should be handled by USB HC scheduler not here async_usleep(1000 * 250); return true; } //********************************************* // // support functions // //********************************************* /** * create usb_hub_info_t structure * * Does only basic copying of known information into new structure. * @param usb_dev usb device structure * @return basic usb_hub_info_t structure */ static usb_hub_info_t * usb_hub_info_create(usb_device_t *usb_dev) { assert(usb_dev); usb_hub_info_t *result = malloc(sizeof(usb_hub_info_t)); if (!result) return NULL; result->usb_device = usb_dev; result->control_pipe = &usb_dev->ctrl_pipe; result->is_default_address_used = false; result->ports = NULL; result->port_count = -1; fibril_mutex_initialize(&result->port_mutex); fibril_mutex_initialize(&result->pending_ops_mutex); fibril_condvar_initialize(&result->pending_ops_cv); result->pending_ops_count = 0; return result; } /** * Load hub-specific information into hub_info structure and process if needed * * Particularly read port count and initialize structure holding port * information. If there are non-removable devices, start initializing them. * This function is hub-specific and should be run only after the hub is * configured using usb_set_first_configuration function. * @param hub_info hub representation * @return error code */ int usb_hub_process_hub_specific_info(usb_hub_info_t *hub_info) { assert(hub_info); // get hub descriptor usb_log_debug("Retrieving descriptor\n"); uint8_t serialized_descriptor[USB_HUB_MAX_DESCRIPTOR_SIZE]; int opResult; size_t received_size; opResult = usb_request_get_descriptor(hub_info->control_pipe, USB_REQUEST_TYPE_CLASS, USB_REQUEST_RECIPIENT_DEVICE, USB_DESCTYPE_HUB, 0, 0, serialized_descriptor, USB_HUB_MAX_DESCRIPTOR_SIZE, &received_size); if (opResult != EOK) { usb_log_error("Failed to receive hub descriptor: %s.\n", str_error(opResult)); return opResult; } usb_log_debug2("Parsing descriptor\n"); usb_hub_descriptor_t descriptor; opResult = usb_deserialize_hub_desriptor( serialized_descriptor, received_size, &descriptor); if (opResult != EOK) { usb_log_error("Could not parse descriptor: %s\n", str_error(opResult)); return opResult; } usb_log_debug("Setting port count to %d.\n", descriptor.ports_count); hub_info->port_count = descriptor.ports_count; // TODO Why +1 ? hub_info->ports = malloc(sizeof(usb_hub_port_t) * (hub_info->port_count + 1)); if (!hub_info->ports) { return ENOMEM; } size_t port; for (port = 0; port < hub_info->port_count + 1; ++port) { usb_hub_port_init(&hub_info->ports[port]); } const bool is_power_switched = !(descriptor.hub_characteristics & HUB_CHAR_NO_POWER_SWITCH_FLAG); if (is_power_switched) { usb_log_debug("Hub power switched\n"); const bool per_port_power = descriptor.hub_characteristics & HUB_CHAR_POWER_PER_PORT_FLAG; for (port = 1; port <= hub_info->port_count; ++port) { usb_log_debug("Powering port %zu.\n", port); opResult = usb_hub_set_port_feature( hub_info->control_pipe, port, USB_HUB_FEATURE_PORT_POWER); if (opResult != EOK) { usb_log_error("Cannot power on port %zu: %s.\n", port, str_error(opResult)); } else { if (!per_port_power) { usb_log_debug( "Ganged power switching mode, " "one port is enough.\n"); break; } } } } else { usb_log_debug("Power not switched, ports always powered\n"); } return EOK; } /** * Set configuration of and USB device * * 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 usb_device usb device representation * @return error code */ static int usb_set_first_configuration(usb_device_t *usb_device) { assert(usb_device); /* Get number of possible configurations from device descriptor */ const size_t configuration_count = usb_device->descriptors.device.configuration_count; usb_log_debug("Hub has %d configurations.\n", configuration_count); if (configuration_count < 1) { usb_log_error("There are no configurations available\n"); return EINVAL; } // TODO: Make sure that there is enough data and the cast is correct usb_standard_configuration_descriptor_t *config_descriptor = (usb_standard_configuration_descriptor_t *) usb_device->descriptors.configuration; /* Set configuration. Use the configuration that was in * usb_device->descriptors.configuration */ const int opResult = usb_request_set_configuration( &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; } //********************************************* // // change handling functions // //********************************************* /** * process hub over current change * * This means either to power off the hub or power it on. * @param hub_info hub instance * @param status hub status bitmask * @return error code */ static int usb_process_hub_over_current(usb_hub_info_t *hub_info, usb_hub_status_t status) { int opResult; if (usb_hub_is_status(status, USB_HUB_FEATURE_HUB_OVER_CURRENT)) { //poweroff all ports unsigned int port; for (port = 1; port <= hub_info->port_count; ++port) { opResult = usb_hub_clear_port_feature( hub_info->control_pipe, port, USB_HUB_FEATURE_PORT_POWER); if (opResult != EOK) { usb_log_warning( "Cannot power off port %d; %s\n", port, str_error(opResult)); } } } else { //power all ports unsigned int port; for (port = 1; port <= hub_info->port_count; ++port) { opResult = usb_hub_set_port_feature( hub_info->control_pipe, port, USB_HUB_FEATURE_PORT_POWER); if (opResult != EOK) { usb_log_warning( "Cannot power off port %d; %s\n", port, str_error(opResult)); } } } return opResult; } /** * process hub local power change * * This change is ignored. * @param hub_info hub instance * @param status hub status bitmask * @return error code */ static int usb_process_hub_local_power_change(usb_hub_info_t *hub_info, usb_hub_status_t status) { int opResult = EOK; opResult = usb_hub_clear_feature(hub_info->control_pipe, USB_HUB_FEATURE_C_HUB_LOCAL_POWER); if (opResult != EOK) { usb_log_error("Cannnot clear hub power change flag: " "%s\n", str_error(opResult)); } return opResult; } /** * process hub interrupts * * The change can be either in the over-current condition or * local-power change. * @param hub_info hub instance */ static void usb_hub_process_global_interrupt(usb_hub_info_t *hub_info) { usb_log_debug("Global interrupt on a hub\n"); usb_pipe_t *pipe = hub_info->control_pipe; int opResult; usb_port_status_t status; size_t rcvd_size; usb_device_request_setup_packet_t request; //int opResult; usb_hub_set_hub_status_request(&request); //endpoint 0 opResult = usb_pipe_control_read( pipe, &request, sizeof (usb_device_request_setup_packet_t), &status, 4, &rcvd_size ); if (opResult != EOK) { usb_log_error("Could not get hub status: %s\n", str_error(opResult)); return; } if (rcvd_size != sizeof (usb_port_status_t)) { usb_log_error("Received status has incorrect size\n"); return; } //port reset if ( usb_hub_is_status(status, 16 + USB_HUB_FEATURE_C_HUB_OVER_CURRENT)) { usb_process_hub_over_current(hub_info, status); } if ( usb_hub_is_status(status, 16 + USB_HUB_FEATURE_C_HUB_LOCAL_POWER)) { usb_process_hub_local_power_change(hub_info, status); } } /** * callback called from hub polling fibril when the fibril terminates * * Should perform a cleanup - deletes hub_info. * @param device usb device afected * @param was_error indicates that the fibril is stoped due to an error * @param data pointer to usb_hub_info_t structure */ static void usb_hub_polling_terminated_callback(usb_device_t *device, bool was_error, void *data) { usb_hub_info_t * hub = data; assert(hub); fibril_mutex_lock(&hub->pending_ops_mutex); /* The device is dead. However there might be some pending operations * that we need to wait for. * One of them is device adding in progress. * The respective fibril is probably waiting for status change * in port reset (port enable) callback. * Such change would never come (otherwise we would not be here). * Thus, we would flush all pending port resets. */ if (hub->pending_ops_count > 0) { fibril_mutex_lock(&hub->port_mutex); size_t port; for (port = 0; port < hub->port_count; port++) { usb_hub_port_t *the_port = hub->ports + port; fibril_mutex_lock(&the_port->reset_mutex); the_port->reset_completed = true; the_port->reset_okay = false; fibril_condvar_broadcast(&the_port->reset_cv); fibril_mutex_unlock(&the_port->reset_mutex); } fibril_mutex_unlock(&hub->port_mutex); } /* And now wait for them. */ while (hub->pending_ops_count > 0) { fibril_condvar_wait(&hub->pending_ops_cv, &hub->pending_ops_mutex); } fibril_mutex_unlock(&hub->pending_ops_mutex); usb_device_destroy(hub->usb_device); free(hub->ports); free(hub); } /** * @} */