Changeset 8b71f3e in mainline for uspace/drv/bus/usb/usbhub/usbhub.c

Timestamp:

2018-01-14T21:16:03Z (6 years ago)

Author:

Petr Manek <petr.manek@…>

Branches:

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

Children:

17c1d9db

Parents:

edc51615

git-author:

Petr Manek <petr.manek@…> (2018-01-14 21:16:00)

git-committer:

Petr Manek <petr.manek@…> (2018-01-14 21:16:03)

Message:

usbdev: refactor polling more

For clarity, the opaque usb_device_polling_t and its complementary
configuration data structure usb_device_polling_config_t have been
merged into usb_polling_t. All related methods have dropped the
"device" from their prefix as well.

The usage semantics have transitioned to malloc-free model, where the
user is entirely responsible for (de)allocation of the polling structure
and its data buffer, and (de)initialization happens in designated
functions during its lifetime in the system.

In addition, the distinction between mandatory / optional / internal
parameters has been documented. Optional parameters now have default
values, which are set to sensible constants in order to allow dropping
some lines in USB driver implementations.

The drivers usbhid and usbhub were refactored to match the API
changes.

File:

• uspace/drv/bus/usb/usbhub/usbhub.c (modified) (5 diffs)

uspace/drv/bus/usb/usbhub/usbhub.c

@@ -161 +161 @@
 
         /* Start hub operation. */
-        const usb_device_polling_config_t config = {
-                .debug = 1,
-                .auto_clear_halt = true,
-                .delay = -1,
-                .max_failures = 3,
-                .on_data = hub_port_changes_callback,
-                .on_polling_end = usb_hub_polling_terminated_callback,
-                .on_error = usb_hub_polling_error_callback,
-                .arg = hub_dev,
-        };
-
-        usb_endpoint_mapping_t *epm =
-            usb_device_get_mapped_ep_desc(hub_dev->usb_device,
+        usb_polling_t *polling = &hub_dev->polling;
+        opResult = usb_polling_init(polling);
+        if (opResult != EOK) {
+                ddf_fun_unbind(hub_dev->hub_fun);
+                ddf_fun_destroy(hub_dev->hub_fun);
+                usb_log_error("Failed to initialize polling fibril: %s.\n",
+                    str_error(opResult));
+                return opResult;
+        }
+
+        polling->device = hub_dev->usb_device;
+        polling->ep_mapping = usb_device_get_mapped_ep_desc(hub_dev->usb_device,
             &hub_status_change_endpoint_description);
-        opResult = usb_device_poll(hub_dev->usb_device, epm, &config,
-            ((hub_dev->port_count + 1 + 7) / 8), &hub_dev->polling);
-        
+        polling->request_size = ((hub_dev->port_count + 1 + 7) / 8);
+        polling->buffer = malloc(polling->request_size);
+        polling->on_data = hub_port_changes_callback;
+        polling->on_polling_end = usb_hub_polling_terminated_callback;
+        polling->on_error = usb_hub_polling_error_callback;
+        polling->arg = hub_dev;
+
+        opResult = usb_polling_start(polling);
         if (opResult != EOK) {
                 /* Function is already bound */
+                free(polling->buffer);
                 ddf_fun_unbind(hub_dev->hub_fun);
                 ddf_fun_destroy(hub_dev->hub_fun);
@@ -186 +191 @@
                 return opResult;
         }
+
         hub_dev->running = true;
         usb_log_info("Controlling hub '%s' (%p: %zu ports).\n",
@@ -197 +203 @@
 {
         assert(!hub->running);
+
+        free(hub->polling.buffer);
+        usb_polling_fini(&hub->polling);
 
         for (size_t port = 0; port < hub->port_count; ++port) {
@@ -233 +242 @@
         usb_log_info("(%p) USB hub removed, joining polling fibril.", hub);
 
-        /* Join polling fibril. */
-        usb_device_poll_join(hub->polling);
+        /* Join polling fibril (ignoring error code). */
+        usb_polling_join(&hub->polling);
         usb_log_info("(%p) USB hub polling stopped, freeing memory.", hub);
 
@@ -254 +263 @@
         usb_log_info("(%p) USB hub gone, joining polling fibril.", hub);
 
-        /* Join polling fibril. */
-        usb_device_poll_join(hub->polling);
+        /* Join polling fibril (ignoring error code). */
+        usb_polling_join(&hub->polling);
         usb_log_info("(%p) USB hub polling stopped, freeing memory.", hub);