Changeset d083126 in mainline for uspace/lib/usbdev

Timestamp:

2011-10-13T13:20:26Z (14 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

3a5506a

Parents:

cff3fb6 (diff), 22a2b763 (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 initial USB unplug support.

Support device_remove and device_gone in libusbdev.
usbhub and uhcirh try to unbind and destroy functions of attached devices.
add unplug support for usbhub driver (only works on empty hubs as there is no support in other drivers).

Drivers to go:

usbmid
usbflbk
usbhid
usbmast
usbmouse

Tested on:

qemu UHCI and emulated hub,
ICH8 hw and Alcor Micro Corp. USB Hub

Location:

uspace/lib/usbdev

Files:

• include/usb/dev/driver.h (modified) (3 diffs)
• include/usb/dev/hub.h (modified) (2 diffs)
• include/usb/dev/pipes.h (modified) (2 diffs)
• include/usb/dev/recognise.h (modified) (1 diff)
• src/devdrv.c (modified) (9 diffs)
• src/hub.c (modified) (14 diffs)
• src/pipes.c (modified) (3 diffs)
• src/pipesio.c (modified) (2 diffs)
• src/recognise.c (modified) (3 diffs)

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

@@ -96 +96 @@
         usb_device_descriptors_t descriptors;
 
-        /** Generic DDF device backing this one. */
+        /** Generic DDF device backing this one. RO: DO NOT TOUCH!*/
         ddf_dev_t *ddf_dev;
         /** Custom driver data.
@@ -112 +112 @@
 /** USB driver ops. */
 typedef struct {
-        /** Callback when new device is about to be controlled by the driver. */
-        int (*add_device)(usb_device_t *);
+        /** Callback when a new device was added to the system. */
+        int (*device_add)(usb_device_t *);
+        /** Callback when a device is about to be removed from the system. */
+        int (*device_rem)(usb_device_t *);
+        /** Callback when a device was removed from the system. */
+        int (*device_gone)(usb_device_t *);
 } usb_driver_ops_t;
 
@@ -163 +167 @@
 
 int usb_device_retrieve_descriptors(usb_pipe_t *, usb_device_descriptors_t *);
-int usb_device_create_pipes(ddf_dev_t *, usb_device_connection_t *,
+int usb_device_create_pipes(const ddf_dev_t *, usb_device_connection_t *,
     usb_endpoint_description_t **, uint8_t *, size_t, int, int,
     usb_endpoint_mapping_t **, size_t *);
-int usb_device_destroy_pipes(ddf_dev_t *, usb_endpoint_mapping_t *, size_t);
+int usb_device_destroy_pipes(const 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 **);
 void usb_device_destroy(usb_device_t *);

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

@@ -38 +38 @@
 #define LIBUSBDEV_HUB_H_
 
+#include <ddf/driver.h>
 #include <sys/types.h>
 #include <usb/hc.h>
 
 int usb_hc_new_device_wrapper(ddf_dev_t *, usb_hc_connection_t *, usb_speed_t,
-    int (*)(int, void *), int, void *,
-    usb_address_t *, devman_handle_t *,
-    ddf_dev_ops_t *, void *, ddf_fun_t **);
+    int (*)(void *), void *, usb_address_t *, ddf_dev_ops_t *, void *,
+    ddf_fun_t **);
 
 /** Info about device attached to host controller.
@@ -55 +55 @@
         /** Device address. */
         usb_address_t address;
-        /** Devman handle of the device. */
-        devman_handle_t handle;
-} usb_hc_attached_device_t;
+        /** DDF function (external) of the device. */
+        ddf_fun_t *fun;
+} usb_hub_attached_device_t;
 
 usb_address_t usb_hc_request_address(usb_hc_connection_t *, usb_speed_t);
 int usb_hc_register_device(usb_hc_connection_t *,
-    const usb_hc_attached_device_t *);
+    const usb_hub_attached_device_t *);
 int usb_hc_unregister_device(usb_hc_connection_t *, usb_address_t);
 

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

@@ -159 +159 @@
     usb_device_connection_t *, usb_hc_connection_t *);
 int usb_device_connection_initialize_from_device(usb_device_connection_t *,
-    ddf_dev_t *);
+    const ddf_dev_t *);
 int usb_device_connection_initialize(usb_device_connection_t *,
     devman_handle_t, usb_address_t);
 
-int usb_device_get_assigned_interface(ddf_dev_t *);
+int usb_device_get_assigned_interface(const ddf_dev_t *);
 
 int usb_pipe_initialize(usb_pipe_t *, usb_device_connection_t *,
@@ -185 +185 @@
 int usb_pipe_control_read(usb_pipe_t *, const void *, size_t,
     void *, size_t, size_t *);
-int usb_pipe_control_write(usb_pipe_t *, void *, size_t,
-    void *, size_t);
+int usb_pipe_control_write(usb_pipe_t *, const void *, size_t,
+    const void *, size_t);
 
 #endif

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

@@ -51 +51 @@
 
 int usb_device_register_child_in_devman(usb_address_t, devman_handle_t,
-    ddf_dev_t *, devman_handle_t *, ddf_dev_ops_t *, void *, ddf_fun_t **);
+    ddf_dev_t *, ddf_dev_ops_t *, void *, ddf_fun_t **);
 
 #endif

uspace/lib/usbdev/src/devdrv.c

@@ -41 +41 @@
 #include <assert.h>
 
-static int generic_add_device(ddf_dev_t *);
+static int generic_device_add(ddf_dev_t *);
+static int generic_device_remove(ddf_dev_t *);
+static int generic_device_gone(ddf_dev_t *);
 
 static driver_ops_t generic_driver_ops = {
-        .add_device = generic_add_device
+        .add_device = generic_device_add,
+        .dev_remove = generic_device_remove,
+        .dev_gone = generic_device_gone,
 };
 static driver_t generic_driver = {
@@ -123 +127 @@
         return EOK;
 }
-
-/** Callback when new device is supposed to be controlled by this driver.
- *
- * This callback is a wrapper for USB specific version of @c add_device.
+/*----------------------------------------------------------------------------*/
+/** Callback when a new device is supposed to be controlled by this driver.
+ *
+ * This callback is a wrapper for USB specific version of @c device_add.
  *
  * @param gen_dev Device structure as prepared by DDF.
  * @return Error code.
  */
-int generic_add_device(ddf_dev_t *gen_dev)
+int generic_device_add(ddf_dev_t *gen_dev)
 {
         assert(driver);
         assert(driver->ops);
-        assert(driver->ops->add_device);
+        assert(driver->ops->device_add);
 
         int rc;
@@ -147 +151 @@
                 return rc;
         }
-
-        return driver->ops->add_device(dev);
-}
-
+        gen_dev->driver_data = dev;
+
+        return driver->ops->device_add(dev);
+}
+/*----------------------------------------------------------------------------*/
+/** Callback when a device is supposed to be removed from the system.
+ *
+ * This callback is a wrapper for USB specific version of @c device_remove.
+ *
+ * @param gen_dev Device structure as prepared by DDF.
+ * @return Error code.
+ */
+int generic_device_remove(ddf_dev_t *gen_dev)
+{
+        assert(driver);
+        assert(driver->ops);
+        if (driver->ops->device_rem == NULL)
+                return ENOTSUP;
+        /* Just tell the driver to stop whatever it is doing, keep structures */
+        return driver->ops->device_rem(gen_dev->driver_data);
+}
+/*----------------------------------------------------------------------------*/
+/** Callback when a device was removed from the system.
+ *
+ * This callback is a wrapper for USB specific version of @c device_gone.
+ *
+ * @param gen_dev Device structure as prepared by DDF.
+ * @return Error code.
+ */
+int generic_device_gone(ddf_dev_t *gen_dev)
+{
+        assert(driver);
+        assert(driver->ops);
+        if (driver->ops->device_gone == NULL)
+                return ENOTSUP;
+        const int ret = driver->ops->device_gone(gen_dev->driver_data);
+        if (ret == EOK)
+                usb_device_destroy(gen_dev->driver_data);
+
+        return ret;
+}
+/*----------------------------------------------------------------------------*/
 /** Destroy existing pipes of a USB device.
  *
@@ -275 +317 @@
  * @return Error code.
  */
-int usb_device_create_pipes(ddf_dev_t *dev, usb_device_connection_t *wire,
+int usb_device_create_pipes(const ddf_dev_t *dev, usb_device_connection_t *wire,
     usb_endpoint_description_t **endpoints,
     uint8_t *config_descr, size_t config_descr_size,
@@ -349 +391 @@
         }
 
-        usb_hc_connection_close(&hc_conn);
+        if (usb_hc_connection_close(&hc_conn) != EOK)
+                usb_log_warning("usb_device_create_pipes(): "
+                    "Failed to close connection.\n");
 
         *pipes_ptr = pipes;
@@ -371 +415 @@
         }
 
-        usb_hc_connection_close(&hc_conn);
+        if (usb_hc_connection_close(&hc_conn) != EOK)
+                usb_log_warning("usb_device_create_pipes(): "
+                    "Failed to close connection.\n");
 
         /*
@@ -395 +441 @@
  * @param[in] pipes_count Number of endpoints.
  */
-int usb_device_destroy_pipes(ddf_dev_t *dev,
+int usb_device_destroy_pipes(const ddf_dev_t *dev,
     usb_endpoint_mapping_t *pipes, size_t pipes_count)
 {
@@ -426 +472 @@
         }
 
-        usb_hc_connection_close(&hc_conn);
+        if (usb_hc_connection_close(&hc_conn) != EOK)
+                usb_log_warning("usb_device_destroy_pipes(): "
+                    "Failed to close connection.\n");
 
         free(pipes);
@@ -545 +593 @@
         /* Ignore errors and hope for the best. */
         usb_device_destroy_pipes(dev->ddf_dev, dev->pipes, dev->pipes_count);
-        if (dev->descriptors.configuration != NULL) {
-                free(dev->descriptors.configuration);
-        }
+        free(dev->descriptors.configuration);
 
         if (dev->alternate_interfaces != NULL) {
-                if (dev->alternate_interfaces->alternatives != NULL) {
-                        free(dev->alternate_interfaces->alternatives);
-                }
-                free(dev->alternate_interfaces);
-        }
+                free(dev->alternate_interfaces->alternatives);
+        }
+        free(dev->alternate_interfaces);
 
         free(dev);

uspace/lib/usbdev/src/hub.c

@@ -37 +37 @@
 #include <usb/dev/request.h>
 #include <usb/dev/recognise.h>
+#include <usb/debug.h>
 #include <usbhc_iface.h>
 #include <errno.h>
@@ -57 +58 @@
                 assert((conn)); \
                 if (!usb_hc_connection_is_opened((conn))) { \
-                        return ENOENT; \
+                        usb_log_error("Connection not open.\n"); \
+                        return ENOTCONN; \
                 } \
         } while (false)
@@ -95 +97 @@
  */
 int usb_hc_register_device(usb_hc_connection_t * connection,
-    const usb_hc_attached_device_t *attached_device)
+    const usb_hub_attached_device_t *attached_device)
 {
         CHECK_CONNECTION(connection);
@@ -105 +107 @@
         int rc = async_req_3_0(exch, DEV_IFACE_ID(USBHC_DEV_IFACE),
             IPC_M_USBHC_BIND_ADDRESS,
-            attached_device->address, attached_device->handle);
+            attached_device->address, attached_device->fun->handle);
         async_exchange_end(exch);
         
@@ -155 +157 @@
  * The @p enable_port function is expected to enable signaling on given
  * port.
- * The two arguments to it can have arbitrary meaning
- * (the @p port_no is only a suggestion)
- * and are not touched at all by this function
- * (they are passed as is to the @p enable_port function).
+ * The argument can have arbitrary meaning and it is not touched at all
+ * by this function (it is passed as is to the @p enable_port function).
  *
  * If the @p enable_port fails (i.e. does not return EOK), the device
@@ -175 +175 @@
  * @param[in] enable_port Function for enabling signaling through the port the
  *      device is attached to.
- * @param[in] port_no Port number (passed through to @p enable_port).
  * @param[in] arg Any data argument to @p enable_port.
  * @param[out] assigned_address USB address of the device.
- * @param[out] assigned_handle Devman handle of the new device.
  * @param[in] dev_ops Child device ops.
  * @param[in] new_dev_data Arbitrary pointer to be stored in the child
@@ -194 +192 @@
 int usb_hc_new_device_wrapper(ddf_dev_t *parent, usb_hc_connection_t *connection,
     usb_speed_t dev_speed,
-    int (*enable_port)(int port_no, void *arg), int port_no, void *arg,
-    usb_address_t *assigned_address, devman_handle_t *assigned_handle,
+    int (*enable_port)(void *arg), void *arg, usb_address_t *assigned_address,
     ddf_dev_ops_t *dev_ops, void *new_dev_data, ddf_fun_t **new_fun)
 {
@@ -224 +221 @@
         usb_address_t dev_addr = usb_hc_request_address(&hc_conn, dev_speed);
         if (dev_addr < 0) {
-                usb_hc_connection_close(&hc_conn);
-                return EADDRNOTAVAIL;
+                rc = EADDRNOTAVAIL;
+                goto close_connection;
         }
 
@@ -279 +276 @@
          * device address.
          */
-        rc = enable_port(port_no, arg);
+        rc = enable_port(arg);
         if (rc != EOK) {
                 goto leave_release_default_address;
@@ -320 +317 @@
          */
         /* FIXME: create device_register that will get opened ctrl pipe. */
-        devman_handle_t child_handle;
+        ddf_fun_t *child_fun;
         rc = usb_device_register_child_in_devman(dev_addr, dev_conn.hc_handle,
-            parent, &child_handle,
-            dev_ops, new_dev_data, new_fun);
+            parent, dev_ops, new_dev_data, &child_fun);
         if (rc != EOK) {
                 rc = ESTALL;
@@ -332 +328 @@
          * And now inform the host controller about the handle.
          */
-        usb_hc_attached_device_t new_device = {
+        usb_hub_attached_device_t new_device = {
                 .address = dev_addr,
-                .handle = child_handle
+                .fun = child_fun,
         };
         rc = usb_hc_register_device(&hc_conn, &new_device);
@@ -341 +337 @@
                 goto leave_release_free_address;
         }
-        
-        usb_hc_connection_close(&hc_conn);
+
 
         /*
@@ -350 +345 @@
                 *assigned_address = dev_addr;
         }
-        if (assigned_handle != NULL) {
-                *assigned_handle = child_handle;
-        }
-
-        return EOK;
-
-
+        if (new_fun != NULL) {
+                *new_fun = child_fun;
+        }
+
+        rc = EOK;
+        goto close_connection;
 
         /*
@@ -368 +362 @@
         usb_hc_unregister_device(&hc_conn, dev_addr);
 
-        usb_hc_connection_close(&hc_conn);
+close_connection:
+        if (usb_hc_connection_close(&hc_conn) != EOK)
+                usb_log_warning("usb_hc_new_device_wrapper(): Failed to close "
+                    "connection.\n");
 
         return rc;

uspace/lib/usbdev/src/pipes.c

@@ -52 +52 @@
  * @return USB address or error code.
  */
-static usb_address_t get_my_address(async_sess_t *sess, ddf_dev_t *dev)
+static usb_address_t get_my_address(async_sess_t *sess, const ddf_dev_t *dev)
 {
         async_exch_t *exch = async_exchange_begin(sess);
@@ -78 +78 @@
  * @return Interface number (negative code means any).
  */
-int usb_device_get_assigned_interface(ddf_dev_t *device)
+int usb_device_get_assigned_interface(const ddf_dev_t *device)
 {
         async_sess_t *parent_sess =
@@ -108 +108 @@
  */
 int usb_device_connection_initialize_from_device(
-    usb_device_connection_t *connection, ddf_dev_t *dev)
+    usb_device_connection_t *connection, const ddf_dev_t *dev)
 {
         assert(connection);

uspace/lib/usbdev/src/pipesio.c

@@ -469 +469 @@
  */
 static int usb_pipe_control_write_no_check(usb_pipe_t *pipe,
-    void *setup_buffer, size_t setup_buffer_size,
-    void *data_buffer, size_t data_buffer_size)
+    const void *setup_buffer, size_t setup_buffer_size,
+    const void *data_buffer, size_t data_buffer_size)
 {
         /* Ensure serialization over the phone. */
@@ -536 +536 @@
  */
 int usb_pipe_control_write(usb_pipe_t *pipe,
-    void *setup_buffer, size_t setup_buffer_size,
-    void *data_buffer, size_t data_buffer_size)
+    const void *setup_buffer, size_t setup_buffer_size,
+    const void *data_buffer, size_t data_buffer_size)
 {
         assert(pipe);

uspace/lib/usbdev/src/recognise.c

@@ -339 +339 @@
  * @param[in] hc_handle Handle of the host controller.
  * @param[in] parent Parent device.
- * @param[out] child_handle Handle of the child device.
  * @param[in] dev_ops Child device ops.
  * @param[in] dev_data Arbitrary pointer to be stored in the child
@@ -348 +347 @@
  */
 int usb_device_register_child_in_devman(usb_address_t address,
-    devman_handle_t hc_handle,
-    ddf_dev_t *parent, devman_handle_t *child_handle,
+    devman_handle_t hc_handle, ddf_dev_t *parent,
     ddf_dev_ops_t *dev_ops, void *dev_data, ddf_fun_t **child_fun)
 {
@@ -414 +412 @@
         }
 
-        if (child_handle != NULL) {
-                *child_handle = child->handle;
-        }
-
         if (child_fun != NULL) {
                 *child_fun = child;