Changeset 6e3c005 in mainline for uspace/lib/usbdev/src

Timestamp:

2011-12-14T15:29:41Z (14 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

a0487a2

Parents:

22ecbde

Message:

libusbdev: Doxygen and minor cleanup/renaming.

Location:

uspace/lib/usbdev/src

Files:

• altiface.c (modified) (1 diff)
• devdrv.c (modified) (2 diffs)
• devpoll.c (modified) (1 diff)
• hub.c (modified) (8 diffs)
• recognise.c (modified) (1 diff)

uspace/lib/usbdev/src/altiface.c

@@ -167 +167 @@
 }
 
-void usb_alternate_interfaces_deinit(usb_alternate_interfaces_t *alternate)
+/** Clean initialized structure.
+ * @param instance structure do deinitialize.
+ */
+void usb_alternate_interfaces_deinit(usb_alternate_interfaces_t *instance)
 {
-        if (!alternate)
+        if (!instance)
                 return;
-        free(alternate->alternatives);
+        free(instance->alternatives);
+        instance->alternatives = NULL;
 }
 /**

uspace/lib/usbdev/src/devdrv.c

@@ -516 +516 @@
         }
 
+        /* Open hc connection for pipe registration. */
         rc = usb_hc_connection_open(&usb_dev->hc_conn);
         if (rc != EOK) {
@@ -575 +576 @@
 }
 
+/** Allocate driver specific data.
+ * @param usb_dev usb_device structure.
+ * @param size requested data size.
+ * @return Pointer to the newly allocated space, NULL on failure.
+ */
 void * usb_device_data_alloc(usb_device_t *usb_dev, size_t size)
 {

uspace/lib/usbdev/src/devpoll.c

@@ -46 +46 @@
 /** Data needed for polling. */
 typedef struct {
+        /** Parameters for automated polling. */
         usb_device_auto_polling_t auto_polling;
 
+        /** USB device to poll. */
         usb_device_t *dev;
+        /** Device pipe to use for polling. */
         size_t pipe_index;
+        /** Size of the recieved data. */
         size_t request_size;
+        /** Data buffer. */
         uint8_t *buffer;
+        /** Argument to pass to callbacks. */
         void *custom_arg;
 } polling_data_t;

uspace/lib/usbdev/src/hub.c

@@ -38 +38 @@
 #include <usb/dev/recognise.h>
 #include <usb/debug.h>
-#include <usbhc_iface.h>
 #include <errno.h>
 #include <assert.h>
@@ -45 +44 @@
 #include <async.h>
 
-/** How much time to wait between attempts to register endpoint 0:0.
+/** How much time to wait between attempts to get the default address.
  * The value is based on typical value for port reset + some overhead.
  */
-#define ENDPOINT_0_0_REGISTER_ATTEMPT_DELAY_USEC (1000 * (10 + 2))
-
-/** Check that HC connection is alright.
- *
- * @param conn Connection to be checked.
- */
-#define CHECK_CONNECTION(conn) \
-        do { \
-                assert((conn)); \
-                if (!usb_hc_connection_is_opened((conn))) { \
-                        usb_log_error("Connection not open.\n"); \
-                        return ENOTCONN; \
-                } \
-        } while (false)
-
+#define DEFAULT_ADDRESS_ATTEMPT_DELAY_USEC (1000 * (10 + 2))
 
 /** Inform host controller about new device.
@@ -70 +55 @@
  * @return Error code.
  */
-int usb_hc_register_device(usb_hc_connection_t *connection,
+int usb_hub_register_device(usb_hc_connection_t *connection,
     const usb_hub_attached_device_t *attached_device)
 {
-//      CHECK_CONNECTION(connection);
+        assert(connection);
         if (attached_device == NULL || attached_device->fun == NULL)
-                return EINVAL;
-
-        async_exch_t *exch = async_exchange_begin(connection->hc_sess);
-        if (!exch)
-                return ENOMEM;
-        const int ret = usbhc_bind_address(exch,
+                return EBADMEM;
+        return usb_hc_bind_address(connection,
             attached_device->address, attached_device->fun->handle);
-        async_exchange_end(exch);
-
-        return ret;
-}
-
-/** Inform host controller about device removal.
- *
- * @param connection Opened connection to host controller.
- * @param address Address of the device that is being removed.
- * @return Error code.
- */
-int usb_hc_unregister_device(usb_hc_connection_t *connection,
-    usb_address_t address)
-{
-//      CHECK_CONNECTION(connection);
-
-        async_exch_t *exch = async_exchange_begin(connection->hc_sess);
-        if (!exch)
-                return ENOMEM;
-        const int ret = usbhc_release_address(exch, address);
-        async_exchange_end(exch);
-
-        return ret;
 }
 
@@ -144 +102 @@
                     "Failed to unregister the old pipe on address change.\n");
         }
-        /* Address changed. We can release the default, thus
-         * allowing other to access the default address. */
-        usb_hc_unregister_device(pipe->wire->hc_connection,
-            pipe->wire->address);
+        /* Address changed. We can release the old one, thus
+         * allowing other to us it. */
+        usb_hc_release_address(pipe->wire->hc_connection, pipe->wire->address);
 
         /* The address is already changed so set it in the wire */
@@ -256 +213 @@
                 if (rc == ENOENT) {
                         /* Do not overheat the CPU ;-). */
-                        async_usleep(ENDPOINT_0_0_REGISTER_ATTEMPT_DELAY_USEC);
+                        async_usleep(DEFAULT_ADDRESS_ATTEMPT_DELAY_USEC);
                 }
         } while (rc == ENOENT);
@@ -328 +285 @@
 
         /* Inform the host controller about the handle. */
-        rc = usb_hc_register_device(hc_conn, &new_device);
+        rc = usb_hub_register_device(hc_conn, &new_device);
         if (rc != EOK) {
                 /* We know nothing about that data. */
@@ -353 +310 @@
          */
 leave_release_default_address:
-        if (usb_hc_unregister_device(hc_conn, USB_ADDRESS_DEFAULT) != EOK)
-                usb_log_warning("%s: Failed to unregister defaut device.\n",
+        if (usb_hc_release_address(hc_conn, USB_ADDRESS_DEFAULT) != EOK)
+                usb_log_warning("%s: Failed to release defaut address.\n",
                     __FUNCTION__);
 
@@ -363 +320 @@
                     __FUNCTION__);
 
-        if (usb_hc_unregister_device(hc_conn, dev_addr) != EOK)
-                usb_log_warning("%s: Failed to unregister device.\n",
-                    __FUNCTION__);
+        if (usb_hc_release_address(hc_conn, dev_addr) != EOK)
+                usb_log_warning("%s: Failed to release address: %d.\n",
+                    __FUNCTION__, dev_addr);
 
 close_connection:

uspace/lib/usbdev/src/recognise.c

@@ -324 +324 @@
         }
 
-
         /** Index to append after device name for uniqueness. */
         static atomic_t device_name_index = {0};