Changeset 747ef72 in mainline for uspace/lib/usbhost/src/usb_device_manager.c

Timestamp:

2011-11-10T11:29:10Z (13 years ago)

Author:

Jan Vesely <jano.vesely@…>

Branches:

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

Children:

54464f6a, c2245a3, c6f189f7

Parents:

2e1b9dc (diff), 2d1ba51 (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 USB changes.

Interface changes:

• GET_ADDRESS has been renamed to GET_MY_ADDRESS and the handle parameter was dropped. Tis call no longer cascades up to the root hub, but it is answered in the first place the information is available (nearest hub)
• Reintroduced address reservation for USB_DEFAULT_ADDRESS. The interface now enables device drivers to request specific address on initialization and either insists on that address or accept any other if the address is not available. Note that it is not possible to get the default address if the driver does not insist.
• Any endpoint registered is removed when address is released and a warning is produced if there were any such endpoints.
• It is no longer necessary or possible to pass device speed information when registering endpoints.

Driver fixes: memory leaks and crashes (not only) in error paths.
Fixes or removes flaky device_remove implementation in device drivers.

File:

• uspace/lib/usbhost/src/usb_device_manager.c (modified) (5 diffs)

uspace/lib/usbhost/src/usb_device_manager.c

@@ -38 +38 @@
 #include <usb/host/usb_device_manager.h>
 
+/** Get a free USB address
+ *
+ * @param[in] instance Device manager structure to use.
+ * @param[in] speed Speed of the device requiring address.
+ * @return Free address, or error code.
+ */
+static usb_address_t usb_device_manager_get_free_address(
+    usb_device_manager_t *instance)
+{
+
+        usb_address_t new_address = instance->last_address;
+        do {
+                new_address = (new_address + 1) % USB_ADDRESS_COUNT;
+                if (new_address == USB_ADDRESS_DEFAULT)
+                        new_address = 1;
+                if (new_address == instance->last_address) {
+                        return ENOSPC;
+                }
+        } while (instance->devices[new_address].occupied);
+
+        assert(new_address != USB_ADDRESS_DEFAULT);
+        instance->last_address = new_address;
+
+        return new_address;
+}
+/*----------------------------------------------------------------------------*/
 /** Initialize device manager structure.
  *
  * @param[in] instance Memory place to initialize.
+ * @param[in] max_speed Maximum allowed USB speed of devices (inclusive).
  *
  * Set all values to false/0.
  */
-void usb_device_manager_init(usb_device_manager_t *instance)
+void usb_device_manager_init(
+    usb_device_manager_t *instance, usb_speed_t max_speed)
 {
         assert(instance);
@@ -52 +80 @@
                 instance->devices[i].speed = USB_SPEED_MAX;
         }
-        // TODO: is this hack enough?
-        // (it is needed to allow smooth registration at default address)
-        instance->devices[0].occupied = true;
-        instance->last_address = 0;
+        instance->last_address = 1;
+        instance->max_speed = max_speed;
         fibril_mutex_initialize(&instance->guard);
 }
 /*----------------------------------------------------------------------------*/
-/** Get a free USB address
- *
- * @param[in] instance Device manager structure to use.
- * @param[in] speed Speed of the device requiring address.
- * @return Free address, or error code.
- */
-usb_address_t usb_device_manager_get_free_address(
-    usb_device_manager_t *instance, usb_speed_t speed)
-{
-        assert(instance);
-        fibril_mutex_lock(&instance->guard);
-
-        usb_address_t new_address = instance->last_address;
-        do {
-                ++new_address;
-                if (new_address > USB11_ADDRESS_MAX)
-                        new_address = 1; // NOTE it should be safe to put 0 here
-                                         // TODO Use mod
-                if (new_address == instance->last_address) {
+/** Request USB address.
+ * @param instance usb_device_manager
+ * @param address Pointer to requested address value, place to store new address
+ * @parma strict Fail if the requested address is not available.
+ * @return Error code.
+ * @note Default address is only available in strict mode.
+ */
+int usb_device_manager_request_address(usb_device_manager_t *instance,
+    usb_address_t *address, bool strict, usb_speed_t speed)
+{
+        assert(instance);
+        assert(address);
+        if (speed > instance->max_speed)
+                return ENOTSUP;
+
+        if ((*address) < 0 || (*address) >= USB_ADDRESS_COUNT)
+                return EINVAL;
+
+        fibril_mutex_lock(&instance->guard);
+        /* Only grant default address to strict requests */
+        if (( (*address) == USB_ADDRESS_DEFAULT) && !strict) {
+                *address = instance->last_address;
+        }
+
+        if (instance->devices[*address].occupied) {
+                if (strict) {
                         fibril_mutex_unlock(&instance->guard);
-                        return ENOSPC;
+                        return ENOENT;
                 }
-        } while (instance->devices[new_address].occupied);
-
-        assert(new_address != USB_ADDRESS_DEFAULT);
-        assert(instance->devices[new_address].occupied == false);
-        assert(instance->devices[new_address].handle == 0);
-
-        instance->devices[new_address].occupied = true;
-        instance->devices[new_address].speed = speed;
-        instance->last_address = new_address;
-
-        fibril_mutex_unlock(&instance->guard);
-        return new_address;
+                *address = usb_device_manager_get_free_address(instance);
+        }
+        assert(instance->devices[*address].occupied == false);
+        assert(instance->devices[*address].handle == 0);
+        assert(*address != USB_ADDRESS_DEFAULT || strict);
+
+        instance->devices[*address].occupied = true;
+        instance->devices[*address].speed = speed;
+
+        fibril_mutex_unlock(&instance->guard);
+        return EOK;
 }
 /*----------------------------------------------------------------------------*/
@@ -102 +134 @@
  * @return Error code.
  */
-int usb_device_manager_bind(usb_device_manager_t *instance,
+int usb_device_manager_bind_address(usb_device_manager_t *instance,
     usb_address_t address, devman_handle_t handle)
 {
@@ -132 +164 @@
  * @return Error code.
  */
-int usb_device_manager_release(
+int usb_device_manager_release_address(
     usb_device_manager_t *instance, usb_address_t address)
 {
-        if ((address <= 0) || (address >= USB_ADDRESS_COUNT)) {
+        if ((address < 0) || (address >= USB_ADDRESS_COUNT)) {
                 return EINVAL;
         }
@@ -188 +220 @@
 {
         assert(instance);
-        if ((address <= 0) || (address >= USB_ADDRESS_COUNT)) {
+        if ((address < 0) || (address >= USB_ADDRESS_COUNT)) {
                 return EINVAL;
         }