Changeset 7fc260ff in mainline

Timestamp:

2011-11-05T14:33:07Z (12 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

ab27e01

Parents:

904dcc6

Message:

libusbdev: Merge init_wire_and_ctrl_pipe to the only place it was called.

Add usb_device_release_descriptors function that properly clears the descriptor
structure.

Location:

uspace/lib/usbdev

Files:

• include/usb/dev/driver.h (modified) (4 diffs)
• src/devdrv.c (modified) (7 diffs)
• src/pipes.c (modified) (1 diff)

uspace/lib/usbdev/include/usb/dev/driver.h

@@ -72 +72 @@
 /** USB device structure. */
 typedef struct {
+        /** Connection backing the pipes.
+         * Typically, you will not need to use this attribute at all.
+         */
+        usb_device_connection_t wire;
         /** The default control pipe. */
         usb_pipe_t ctrl_pipe;
@@ -93 +97 @@
         usb_device_descriptors_t descriptors;
 
-        /** Generic DDF device backing this one. RO: DO NOT TOUCH!*/
+        /** Generic DDF device backing this one. DO NOT TOUCH! */
         ddf_dev_t *ddf_dev;
         /** Custom driver data.
@@ -100 +104 @@
          */
         void *driver_data;
-
-        /** Connection backing the pipes.
-         * Typically, you will not need to use this attribute at all.
-         */
-        usb_device_connection_t wire;
 } usb_device_t;
 
@@ -160 +159 @@
 int usb_driver_main(const usb_driver_t *);
 
+int usb_device_init(usb_device_t *, ddf_dev_t *,
+    const usb_endpoint_description_t **, const char **);
+void usb_device_deinit(usb_device_t *);
+
 int usb_device_select_interface(usb_device_t *, uint8_t,
     const usb_endpoint_description_t **);
 
 int usb_device_retrieve_descriptors(usb_pipe_t *, usb_device_descriptors_t *);
+void usb_device_release_descriptors(usb_device_descriptors_t *);
+
 int usb_device_create_pipes(const ddf_dev_t *, usb_device_connection_t *,
     const usb_endpoint_description_t **, const uint8_t *, size_t, int, int,
     usb_endpoint_mapping_t **, size_t *);
 int usb_device_destroy_pipes(const ddf_dev_t *, usb_endpoint_mapping_t *, size_t);
-int usb_device_init(usb_device_t *, ddf_dev_t *,
-    const usb_endpoint_description_t **, const char **);
-void usb_device_deinit(usb_device_t *);
 
 void * usb_device_data_alloc(usb_device_t *, size_t);

uspace/lib/usbdev/src/devdrv.c

@@ -300 +300 @@
 
         return rc;
+}
+
+/** Cleanup structure initialized via usb_device_retrieve_descriptors.
+ *
+ * @param[in] descriptors Where to store the descriptors.
+ */
+void usb_device_release_descriptors(usb_device_descriptors_t *descriptors)
+{
+        assert(descriptors);
+        free(descriptors->configuration);
+        descriptors->configuration = NULL;
 }
 
@@ -490 +501 @@
 }
 
-/** 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;
-}
-
-
 /** Initialize new instance of USB device.
  *
@@ -533 +516 @@
         assert(ddf_dev != NULL);
 
+        *errstr_ptr = NULL;
+
         usb_dev->ddf_dev = ddf_dev;
         usb_dev->driver_data = NULL;
@@ -540 +525 @@
 
         /* Initialize backing wire and control pipe. */
-        int rc = init_wire_and_ctrl_pipe(usb_dev, errstr_ptr);
-        if (rc != EOK) {
+        int rc = usb_device_connection_initialize_from_device(
+            &usb_dev->wire, ddf_dev);
+        if (rc != EOK) {
+                *errstr_ptr = "device connection initialization";
+                return rc;
+        }
+
+        /* This pipe was registered by the hub driver,
+         * during device initialization. */
+        rc = usb_pipe_initialize_default_control(&usb_dev->ctrl_pipe,
+            &usb_dev->wire);
+        if (rc != EOK) {
+                *errstr_ptr = "default control pipe initialization";
                 return rc;
         }
@@ -552 +548 @@
             &usb_dev->descriptors);
         if (rc != EOK) {
-                /* Nothing allocated, nothing to free. */
                 *errstr_ptr = "descriptor retrieval";
                 return rc;
         }
 
-        /* Create alternate interfaces. We will silently ignore failure. */
-        //TODO Why ignore?
+        /* Create alternate interfaces. We will silently ignore failure.
+         * We might either control one interface or an entire device,
+         * it makes no sense to speak about alternate interfaces when
+         * controlling a device. */
         usb_alternate_interfaces_init(&usb_dev->alternate_interfaces,
             usb_dev->descriptors.configuration,
             usb_dev->descriptors.configuration_size, usb_dev->interface_no);
 
+        /* TODO Add comment here. */
         rc = initialize_other_pipes(endpoints, usb_dev, 0);
         if (rc != EOK) {
                 /* Full configuration descriptor is allocated. */
-                free(usb_dev->descriptors.configuration);
+                usb_device_release_descriptors(&usb_dev->descriptors);
                 /* Alternate interfaces may be allocated */
                 usb_alternate_interfaces_deinit(&usb_dev->alternate_interfaces);
@@ -573 +571 @@
         }
 
-        *errstr_ptr = NULL;
-
         return EOK;
 }
@@ -591 +587 @@
 
                 usb_alternate_interfaces_deinit(&dev->alternate_interfaces);
-                free(dev->descriptors.configuration);
+                usb_device_release_descriptors(&dev->descriptors);
                 free(dev->driver_data);
         }

uspace/lib/usbdev/src/pipes.c

@@ -75 +75 @@
 int usb_device_get_assigned_interface(const ddf_dev_t *device)
 {
+        assert(device);
         async_sess_t *parent_sess =
             devman_parent_device_connect(EXCHANGE_ATOMIC, device->handle,