Changeset 25696fea in mainline for uspace/drv/bus/usb/usbhub/usbhub.c

Timestamp:

2011-10-15T20:05:00Z (13 years ago)

Author:

Frantisek Princ <frantisek.princ@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

22ceff3a

Parents:

1ccc32f (diff), 721d4b6e (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge with mainline

File:

• uspace/drv/bus/usb/usbhub/usbhub.c (modified) (20 diffs)

uspace/drv/bus/usb/usbhub/usbhub.c

@@ -68 +68 @@
 
 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 void usb_hub_over_current(const usb_hub_info_t *hub_info,
+static usb_hub_dev_t * usb_hub_dev_create(usb_device_t *usb_dev);
+static int usb_hub_process_hub_specific_info(usb_hub_dev_t *hub_dev);
+static void usb_hub_over_current(const usb_hub_dev_t *hub_dev,
     usb_hub_status_t status);
-static void usb_hub_global_interrupt(const usb_hub_info_t *hub_info);
+static void usb_hub_global_interrupt(const usb_hub_dev_t *hub_dev);
 static void usb_hub_polling_terminated_callback(usb_device_t *device,
     bool was_error, void *data);
-
 /**
  * Initialize hub device driver fibril
@@ -84 +83 @@
  * @return error code
  */
-int usb_hub_add_device(usb_device_t *usb_dev)
+int usb_hub_device_gone(usb_device_t *usb_dev)
+{
+        assert(usb_dev);
+        usb_hub_dev_t *hub = usb_dev->driver_data;
+        assert(hub);
+        unsigned tries = 10;
+        while (hub->running) {
+                async_usleep(100000);
+                if (!tries--) {
+                        usb_log_error("Can't remove hub, still running.\n");
+                        return EINPROGRESS;
+                }
+        }
+
+        assert(!hub->running);
+
+        for (size_t port = 0; port < hub->port_count; ++port) {
+                if (hub->ports[port].attached_device.fun) {
+                        const int ret =
+                            usb_hub_port_fini(&hub->ports[port], hub);
+                        if (ret != EOK)
+                                return ret;
+                }
+        }
+        free(hub->ports);
+
+        const int ret = ddf_fun_unbind(hub->hub_fun);
+        if (ret != EOK) {
+                usb_log_error("Failed to unbind '%s' function: %s.\n",
+                   HUB_FNC_NAME, str_error(ret));
+                return ret;
+        }
+        ddf_fun_destroy(hub->hub_fun);
+
+        usb_log_info("USB hub driver, stopped and cleaned.\n");
+        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_device_add(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_hub_dev_t *hub_dev = usb_hub_dev_create(usb_dev);
+        if (hub_dev == NULL) {
                 usb_log_error("Failed to create hun driver structure.\n");
                 return ENOMEM;
@@ -97 +142 @@
         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);
+            &hub_dev->connection, hub_dev->usb_device->ddf_dev);
         if (opResult != EOK) {
                 usb_log_error("Could not initialize connection to device: %s\n",
                     str_error(opResult));
-                free(hub_info);
+                free(hub_dev);
                 return opResult;
         }
@@ -110 +155 @@
                 usb_log_error("Could not set hub configuration: %s\n",
                     str_error(opResult));
-                free(hub_info);
+                free(hub_dev);
                 return opResult;
         }
 
-        //get port count and create attached_devs
-        opResult = usb_hub_process_hub_specific_info(hub_info);
+        /* Get port count and create attached_devices. */
+        opResult = usb_hub_process_hub_specific_info(hub_dev);
         if (opResult != EOK) {
                 usb_log_error("Could process hub specific info, %s\n",
                     str_error(opResult));
-                free(hub_info);
+                free(hub_dev);
                 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,
+        hub_dev->hub_fun = ddf_fun_create(hub_dev->usb_device->ddf_dev,
             fun_exposed, HUB_FNC_NAME);
-        if (hub_fun == NULL) {
+        if (hub_dev->hub_fun == NULL) {
                 usb_log_error("Failed to create hub function.\n");
-                free(hub_info);
+                free(hub_dev);
                 return ENOMEM;
         }
 
-        opResult = ddf_fun_bind(hub_fun);
+        opResult = ddf_fun_bind(hub_dev->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);
+                free(hub_dev);
+                ddf_fun_destroy(hub_dev->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);
+        opResult = usb_device_auto_poll(hub_dev->usb_device, 0,
+            hub_port_changes_callback, ((hub_dev->port_count + 1 + 8) / 8),
+            usb_hub_polling_terminated_callback, hub_dev);
+        if (opResult != EOK) {
+                /* Function is already bound */
+                ddf_fun_unbind(hub_dev->hub_fun);
+                ddf_fun_destroy(hub_dev->hub_fun);
+                free(hub_dev);
                 usb_log_error("Failed to create polling fibril: %s.\n",
                     str_error(opResult));
                 return opResult;
         }
+        hub_dev->running = true;
         usb_log_info("Controlling hub '%s' (%zu ports).\n",
-            hub_info->usb_device->ddf_dev->name, hub_info->port_count);
+            hub_dev->usb_device->ddf_dev->name, hub_dev->port_count);
 
         return EOK;
@@ -162 +210 @@
  * @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.
+ * @param arg Custom argument, points to @c usb_hub_dev_t.
  * @return Whether to continue polling.
  */
@@ -169 +217 @@
 {
         usb_log_debug("hub_port_changes_callback\n");
-        usb_hub_info_t *hub = arg;
+        usb_hub_dev_t *hub = arg;
         assert(hub);
 
@@ -184 +232 @@
 
         /* 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;
+        for (size_t port = 0; port < hub->port_count + 1; port++) {
+                const size_t bit = port + 1;
+                const bool change = (change_bitmap[bit / 8] >> (bit % 8)) & 1;
                 if (change) {
                         usb_hub_port_process_interrupt(&hub->ports[port], hub);
@@ -195 +243 @@
 /*----------------------------------------------------------------------------*/
 /**
- * create usb_hub_info_t structure
+ * create usb_hub_dev_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)
+ * @return basic usb_hub_dev_t structure
+ */
+static usb_hub_dev_t * usb_hub_dev_create(usb_device_t *usb_dev)
 {
         assert(usb_dev);
-        usb_hub_info_t *info = malloc(sizeof(usb_hub_info_t));
-        if (!info)
+        usb_hub_dev_t *hub_dev =
+            usb_device_data_alloc(usb_dev, sizeof(usb_hub_dev_t));
+        if (!hub_dev)
             return NULL;
 
-        info->usb_device = usb_dev;
-
-        info->ports = NULL;
-        info->port_count = -1;
-        fibril_mutex_initialize(&info->pending_ops_mutex);
-        fibril_condvar_initialize(&info->pending_ops_cv);
-        info->pending_ops_count = 0;
-
-        return info;
-}
-/*----------------------------------------------------------------------------*/
-/**
- * Load hub-specific information into hub_info structure and process if needed
+        hub_dev->usb_device = usb_dev;
+        hub_dev->ports = NULL;
+        hub_dev->port_count = 0;
+        hub_dev->pending_ops_count = 0;
+        hub_dev->running = false;
+        fibril_mutex_initialize(&hub_dev->pending_ops_mutex);
+        fibril_condvar_initialize(&hub_dev->pending_ops_cv);
+
+        return hub_dev;
+}
+/*----------------------------------------------------------------------------*/
+/**
+ * Load hub-specific information into hub_dev structure and process if needed
  *
  * Read port count and initialize structures holding per port information.
@@ -226 +275 @@
  * 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
+ * @param hub_dev hub representation
  * @return error code
  */
-static int usb_hub_process_hub_specific_info(usb_hub_info_t *hub_info)
-{
-        assert(hub_info);
+static int usb_hub_process_hub_specific_info(usb_hub_dev_t *hub_dev)
+{
+        assert(hub_dev);
 
         /* Get hub descriptor. */
         usb_log_debug("Retrieving descriptor\n");
-        usb_pipe_t *control_pipe = &hub_info->usb_device->ctrl_pipe;
+        usb_pipe_t *control_pipe = &hub_dev->usb_device->ctrl_pipe;
 
         usb_hub_descriptor_header_t descriptor;
@@ -250 +299 @@
 
         usb_log_debug("Setting port count to %d.\n", descriptor.port_count);
-        hub_info->port_count = descriptor.port_count;
-
-        // TODO: +1 hack is no longer necessary
-        hub_info->ports =
-            malloc(sizeof(usb_hub_port_t) * (hub_info->port_count + 1));
-        if (!hub_info->ports) {
+        hub_dev->port_count = descriptor.port_count;
+
+        hub_dev->ports = calloc(hub_dev->port_count, sizeof(usb_hub_port_t));
+        if (!hub_dev->ports) {
                 return ENOMEM;
         }
 
-        size_t port;
-        for (port = 0; port < hub_info->port_count + 1; ++port) {
-                usb_hub_port_init(&hub_info->ports[port], port, control_pipe);
+        for (size_t port = 0; port < hub_dev->port_count; ++port) {
+                usb_hub_port_init(
+                    &hub_dev->ports[port], port + 1, control_pipe);
         }
 
@@ -271 +318 @@
                     & HUB_CHAR_POWER_PER_PORT_FLAG;
 
-                for (port = 1; port <= hub_info->port_count; ++port) {
+                for (size_t port = 0; port < hub_dev->port_count; ++port) {
                         usb_log_debug("Powering port %zu.\n", port);
                         opResult = usb_hub_port_set_feature(
-                            &hub_info->ports[port], USB_HUB_FEATURE_PORT_POWER);
+                            &hub_dev->ports[port], USB_HUB_FEATURE_PORT_POWER);
                         if (opResult != EOK) {
                                 usb_log_error("Cannot power on port %zu: %s.\n",
@@ -314 +361 @@
         }
 
-        // TODO: Make sure that there is enough data and the cast is correct
+        if (usb_device->descriptors.configuration_size
+            < sizeof(usb_standard_configuration_descriptor_t)) {
+            usb_log_error("Configuration descriptor is not big enough"
+                " to fit standard configuration descriptor.\n");
+            return EOVERFLOW;
+        }
+
+        // TODO: Make sure that the cast is correct
         usb_standard_configuration_descriptor_t *config_descriptor
             = (usb_standard_configuration_descriptor_t *)
@@ -337 +391 @@
  *
  * This means either to power off the hub or power it on.
- * @param hub_info hub instance
+ * @param hub_dev hub instance
  * @param status hub status bitmask
  * @return error code
  */
-static void usb_hub_over_current(const usb_hub_info_t *hub_info,
+static void usb_hub_over_current(const usb_hub_dev_t *hub_dev,
     usb_hub_status_t status)
 {
@@ -351 +405 @@
                 /* Over-current condition is gone, it is safe to turn the
                  * ports on. */
-                size_t port;
-                for (port = 1; port <= hub_info->port_count; ++port) {
+                for (size_t port = 0; port < hub_dev->port_count; ++port) {
                         const int opResult = usb_hub_port_set_feature(
-                            &hub_info->ports[port], USB_HUB_FEATURE_PORT_POWER);
+                            &hub_dev->ports[port], USB_HUB_FEATURE_PORT_POWER);
+                        // TODO: consider power policy here
                         if (opResult != EOK) {
                                 usb_log_warning(
@@ -364 +418 @@
         }
         const int opResult = usb_request_clear_feature(
-            &hub_info->usb_device->ctrl_pipe, USB_REQUEST_TYPE_CLASS,
+            &hub_dev->usb_device->ctrl_pipe, USB_REQUEST_TYPE_CLASS,
             USB_REQUEST_RECIPIENT_DEVICE,
             USB_HUB_FEATURE_C_HUB_LOCAL_POWER, 0);
@@ -378 +432 @@
  *
  * The change can be either in the over-current condition or local-power change.
- * @param hub_info hub instance
- */
-static void usb_hub_global_interrupt(const usb_hub_info_t *hub_info)
-{
-        assert(hub_info);
-        assert(hub_info->usb_device);
+ * @param hub_dev hub instance
+ */
+static void usb_hub_global_interrupt(const usb_hub_dev_t *hub_dev)
+{
+        assert(hub_dev);
+        assert(hub_dev->usb_device);
         usb_log_debug("Global interrupt on a hub\n");
-        usb_pipe_t *control_pipe = &hub_info->usb_device->ctrl_pipe;
+        usb_pipe_t *control_pipe = &hub_dev->usb_device->ctrl_pipe;
 
         usb_hub_status_t status;
@@ -406 +460 @@
         /* Handle status changes */
         if (status & USB_HUB_STATUS_C_OVER_CURRENT) {
-                usb_hub_over_current(hub_info, status);
+                usb_hub_over_current(hub_dev, status);
         }
 
@@ -438 +492 @@
  * callback called from hub polling fibril when the fibril terminates
  *
- * Should perform a cleanup - deletes hub_info.
+ * Does not perform cleanup, just marks the hub as not running.
  * @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
+ * @param data pointer to usb_hub_dev_t structure
  */
 static void usb_hub_polling_terminated_callback(usb_device_t *device,
     bool was_error, void *data)
 {
-        usb_hub_info_t *hub = data;
+        usb_hub_dev_t *hub = data;
         assert(hub);
 
@@ -460 +514 @@
          */
         if (hub->pending_ops_count > 0) {
-                size_t port;
-                for (port = 0; port < hub->port_count; port++) {
+                for (size_t port = 0; port < hub->port_count; ++port) {
                         usb_hub_port_reset_fail(&hub->ports[port]);
                 }
@@ -471 +524 @@
         }
         fibril_mutex_unlock(&hub->pending_ops_mutex);
-
-        usb_device_destroy(hub->usb_device);
-
-        free(hub->ports);
-        free(hub);
+        hub->running = false;
 }
 /**