Changeset 434ef65 in mainline

Timestamp:

2011-03-21T16:54:36Z (13 years ago)

Author:

Vojtech Horky <vojtechhorky@…>

Branches:

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

Children:

41ef5b9, ce794342

Parents:

5287502 (diff), 625f1ba (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:

Small improvements of libusb

Below is a summary of changes

• added usb_str_speed() function for nicer outputs
• USB framework remembers configuration descriptor
• some refactoring (hub driver, messages of transfer batch API)

Location:

uspace

Files:

• drv/usbhub/main.c (modified) (3 diffs)
• drv/usbhub/usbhub.c (modified) (5 diffs)
• drv/usbhub/usbhub.h (modified) (1 diff)
• lib/usb/include/usb/devdrv.h (modified) (2 diffs)
• lib/usb/include/usb/usb.h (modified) (2 diffs)
• lib/usb/src/devdrv.c (modified) (5 diffs)
• lib/usb/src/host/batch.c (modified) (2 diffs)
• lib/usb/src/usb.c (modified) (2 diffs)

uspace/drv/usbhub/main.c

@@ -42 +42 @@
 #include "usbhub_private.h"
 
-
-usb_endpoint_description_t hub_status_change_endpoint_description = {
+/** 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,
@@ -57 +60 @@
 };
 
+static usb_endpoint_description_t *usb_hub_endpoints[] = {
+        &hub_status_change_endpoint_description,
+        NULL
+};
+
 static usb_driver_t usb_hub_driver = {
-        .name = "usbhub",
-        .ops = &usb_hub_driver_ops
+        .name = NAME,
+        .ops = &usb_hub_driver_ops,
+        .endpoints = usb_hub_endpoints
 };
 
@@ -65 +74 @@
 int main(int argc, char *argv[])
 {
+        printf(NAME ": HelenOS USB hub driver.\n");
+
         usb_log_enable(USB_LOG_LEVEL_DEBUG, NAME);
-        usb_log_info("starting hub driver\n");
-
         
-        usb_hub_driver.endpoints = (usb_endpoint_description_t**)
-                        malloc(2 * sizeof(usb_endpoint_description_t*));
-        usb_hub_driver.endpoints[0] = &hub_status_change_endpoint_description;
-        usb_hub_driver.endpoints[1] = NULL;
-
         return usb_driver_main(&usb_hub_driver);
 }

uspace/drv/usbhub/usbhub.c

@@ -157 +157 @@
 static int usb_hub_set_configuration(usb_hub_info_t * hub_info){
         //device descriptor
-        usb_standard_device_descriptor_t std_descriptor;
-        int opResult = usb_request_get_device_descriptor(
-                &hub_info->usb_device->ctrl_pipe,
-            &std_descriptor);
-        if(opResult!=EOK){
-                usb_log_error("could not get device descriptor, %d\n",opResult);
-                return opResult;
-        }
+        usb_standard_device_descriptor_t *std_descriptor
+            = &hub_info->usb_device->descriptors.device;
         usb_log_info("hub has %d configurations\n",
-                        std_descriptor.configuration_count);
-        if(std_descriptor.configuration_count<1){
+            std_descriptor->configuration_count);
+        if(std_descriptor->configuration_count<1){
                 usb_log_error("THERE ARE NO CONFIGURATIONS AVAILABLE\n");
                 //shouldn`t I return?
-        }
-
-        /* Retrieve full configuration descriptor. */
-        uint8_t *descriptors = NULL;
-        size_t descriptors_size = 0;
-        opResult = usb_request_get_full_configuration_descriptor_alloc(
-            &hub_info->usb_device->ctrl_pipe, 0,
-            (void **) &descriptors, &descriptors_size);
-        if (opResult != EOK) {
-                usb_log_error("Could not get configuration descriptor: %s.\n",
-                    str_error(opResult));
-                return opResult;
-        }
+                //definitely
+                return EINVAL;
+        }
+
         usb_standard_configuration_descriptor_t *config_descriptor
-            = (usb_standard_configuration_descriptor_t *) descriptors;
+            = (usb_standard_configuration_descriptor_t *)
+            hub_info->usb_device->descriptors.configuration;
 
         /* Set configuration. */
-        opResult = usb_request_set_configuration(&hub_info->usb_device->ctrl_pipe,
+        int opResult = usb_request_set_configuration(
+            &hub_info->usb_device->ctrl_pipe,
             config_descriptor->configuration_number);
 
@@ -197 +184 @@
         usb_log_debug("\tused configuration %d\n",
                         config_descriptor->configuration_number);
-        free(descriptors);
+
         return EOK;
 }
@@ -243 +230 @@
 
         /// \TODO what is this?
-        usb_log_debug("adding to ddf");
+        usb_log_debug("Creating `hub' function.\n");
         ddf_fun_t *hub_fun = ddf_fun_create(hub_info->usb_device->ddf_dev,
                         fun_exposed, "hub");
@@ -257 +244 @@
         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");
+                usb_log_error("failed to start monitoring fibril for new hub.\n");
                 return ENOMEM;
         }
         fibril_add_ready(fid);
-        usb_log_debug("hub fibril created");
-        usb_log_debug("has %d ports ",hub_info->port_count);
+        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;
 }
@@ -533 +522 @@
         //port reset
         if (usb_port_reset_completed(&status)) {
-                usb_log_info("port reset complete");
+                usb_log_info("port reset complete\n");
                 if (usb_port_enabled(&status)) {
                         usb_hub_finalize_add_device(hub, port, usb_port_speed(&status));

uspace/drv/usbhub/usbhub.h

@@ -46 +46 @@
 #include <usb/pipes.h>
 #include <usb/devdrv.h>
-
-
-/** Hub status-change endpoint description
- *
- * For more see usb hub specification in 11.15.1 of
- */
-extern usb_endpoint_description_t hub_status_change_endpoint_description;
-
-
-
-/* Hub endpoints. */
-/*typedef struct {
-        usb_pipe_t control;
-        usb_pipe_t status_change;
-} usb_hub_endpoints_t;
-*/
 
 

uspace/lib/usb/include/usb/devdrv.h

@@ -38 +38 @@
 #include <usb/pipes.h>
 
+/** Descriptors for USB device. */
+typedef struct {
+        /** Standard device descriptor. */
+        usb_standard_device_descriptor_t device;
+        /** Full configuration descriptor of current configuration. */
+        uint8_t *configuration;
+        size_t configuration_size;
+} usb_device_descriptors_t;
+
 /** USB device structure. */
 typedef struct {
@@ -52 +61 @@
          */
         int interface_no;
+
+        /** Some useful descriptors. */
+        usb_device_descriptors_t descriptors;
+
         /** Generic DDF device backing this one. */
         ddf_dev_t *ddf_dev;

uspace/lib/usb/include/usb/usb.h

@@ -61 +61 @@
 
 const char * usb_str_transfer_type(usb_transfer_type_t t);
+const char * usb_str_transfer_type_short(usb_transfer_type_t t);
 
 /** USB data transfer direction. */
@@ -78 +79 @@
         USB_SPEED_HIGH
 } usb_speed_t;
+
+const char *usb_str_speed(usb_speed_t);
+
 
 /** USB request type target. */

uspace/lib/usb/src/devdrv.c

@@ -137 +137 @@
         }
 
-        void *config_descriptor;
-        size_t config_descriptor_size;
-        rc = usb_request_get_full_configuration_descriptor_alloc(
-            &dev->ctrl_pipe, 0, &config_descriptor, &config_descriptor_size);
-        if (rc != EOK) {
-                usb_log_error("Failed retrieving configuration of `%s': %s.\n",
-                    dev->ddf_dev->name, str_error(rc));
-                goto rollback;
-        }
-
-        rc = usb_pipe_initialize_from_configuration(dev->pipes,
-           pipe_count, config_descriptor, config_descriptor_size, &dev->wire);
+        rc = usb_pipe_initialize_from_configuration(dev->pipes, pipe_count,
+            dev->descriptors.configuration, dev->descriptors.configuration_size,
+            &dev->wire);
         if (rc != EOK) {
                 usb_log_error("Failed initializing USB endpoints: %s.\n",
@@ -237 +228 @@
 
         /*
-         * Initialization of other pipes requires open session on
-         * default control pipe.
+         * For further actions, we need open session on default control pipe.
          */
         rc = usb_pipe_start_session(&dev->ctrl_pipe);
@@ -247 +237 @@
         }
 
+        /* Get the device descriptor. */
+        rc = usb_request_get_device_descriptor(&dev->ctrl_pipe,
+            &dev->descriptors.device);
+        if (rc != EOK) {
+                usb_log_error("Failed to retrieve device descriptor: %s.\n",
+                    str_error(rc));
+                return rc;
+        }
+
+        /* Get the full configuration descriptor. */
+        rc = usb_request_get_full_configuration_descriptor_alloc(
+            &dev->ctrl_pipe, 0, (void **) &dev->descriptors.configuration,
+            &dev->descriptors.configuration_size);
+        if (rc != EOK) {
+                usb_log_error("Failed retrieving configuration descriptor: %s.\n",
+                    dev->ddf_dev->name, str_error(rc));
+                return rc;
+        }
+
         if (driver->endpoints != NULL) {
                 rc = initialize_other_pipes(driver, dev);
@@ -253 +262 @@
         /* No checking here. */
         usb_pipe_end_session(&dev->ctrl_pipe);
+
+        /* Rollback actions. */
+        if (rc != EOK) {
+                if (dev->descriptors.configuration != NULL) {
+                        free(dev->descriptors.configuration);
+                }
+        }
 
         return rc;
@@ -283 +299 @@
         dev->ddf_dev->driver_data = dev;
         dev->driver_data = NULL;
+        dev->descriptors.configuration = NULL;
 
         rc = initialize_pipes(dev);

uspace/lib/usb/src/host/batch.c

@@ -107 +107 @@
             instance->buffer_size);
 
-        int err = instance->error;
-        usb_log_debug("Batch(%p) callback IN(type:%d): %s(%d), %zu.\n",
-            instance, instance->transfer_type, str_error(err), err,
-            instance->transfered_size);
+        usb_log_debug("Batch %p done (T%d.%d, %s %s in, %zuB): %s (%d).\n",
+            instance,
+            instance->target.address, instance->target.endpoint,
+            usb_str_speed(instance->speed),
+            usb_str_transfer_type_short(instance->transfer_type),
+            instance->transfered_size,
+            str_error(instance->error), instance->error);
 
-        instance->callback_in(
-            instance->fun, err, instance->transfered_size, instance->arg);
+        instance->callback_in(instance->fun, instance->error,
+            instance->transfered_size, instance->arg);
 }
 /*----------------------------------------------------------------------------*/
@@ -125 +128 @@
         assert(instance->callback_out);
 
-        int err = instance->error;
-        usb_log_debug("Batch(%p) callback OUT(type:%d): %s(%d).\n",
-            instance, instance->transfer_type, str_error(err), err);
+        usb_log_debug("Batch %p done (T%d.%d, %s %s out): %s (%d).\n",
+            instance,
+            instance->target.address, instance->target.endpoint,
+            usb_str_speed(instance->speed),
+            usb_str_transfer_type_short(instance->transfer_type),
+            str_error(instance->error), instance->error);
+
         instance->callback_out(instance->fun,
-            err, instance->arg);
+            instance->error, instance->arg);
 }
 /**

uspace/lib/usb/src/usb.c

@@ -36 +36 @@
 #include <errno.h>
 
+#define ARR_SIZE(arr) (sizeof(arr)/sizeof(arr[0]))
+
+static const char *str_speed[] = {
+        "low",
+        "full",
+        "high"
+};
+
+static const char *str_transfer_type[] = {
+        "control",
+        "isochronous",
+        "bulk",
+        "interrupt"
+};
+
+static const char *str_transfer_type_short[] = {
+        "ctrl",
+        "iso",
+        "bulk",
+        "intr"
+};
 
 /** String representation for USB transfer type.
@@ -42 +63 @@
  * @return Transfer type as a string (in English).
  */
-const char * usb_str_transfer_type(usb_transfer_type_t t)
+const char *usb_str_transfer_type(usb_transfer_type_t t)
 {
-        switch (t) {
-                case USB_TRANSFER_ISOCHRONOUS:
-                        return "isochronous";
-                case USB_TRANSFER_INTERRUPT:
-                        return "interrupt";
-                case USB_TRANSFER_CONTROL:
-                        return "control";
-                case USB_TRANSFER_BULK:
-                        return "bulk";
-                default:
-                        return "unknown";
+        if (t >= ARR_SIZE(str_transfer_type)) {
+                return "invalid";
         }
+        return str_transfer_type[t];
+}
+
+/** String representation for USB transfer type (short version).
+ *
+ * @param t Transfer type.
+ * @return Transfer type as a short string for debugging messages.
+ */
+const char *usb_str_transfer_type_short(usb_transfer_type_t t)
+{
+        if (t >= ARR_SIZE(str_transfer_type_short)) {
+                return "invl";
+        }
+        return str_transfer_type_short[t];
+}
+
+/** String representation of USB speed.
+ *
+ * @param s The speed.
+ * @return USB speed as a string (in English).
+ */
+const char *usb_str_speed(usb_speed_t s)
+{
+        if (s >= ARR_SIZE(str_speed)) {
+                return "invalid";
+        }
+        return str_speed[s];
 }