Changes in uspace/drv/usbhid/usbhid.c [fec47d4:36f737a] in mainline

File:

• uspace/drv/usbhid/usbhid.c (modified) (12 diffs)

uspace/drv/usbhid/usbhid.c

@@ -42 +42 @@
 #include <usb/classes/hidreq.h>
 #include <errno.h>
+#include <str_error.h>
 
 #include "usbhid.h"
@@ -47 +48 @@
 #include "kbd/kbddev.h"
 #include "generic/hiddev.h"
-
-/*----------------------------------------------------------------------------*/
-
-/** Mouse polling endpoint description for boot protocol class. */
-static usb_endpoint_description_t usb_hid_mouse_poll_endpoint_description = {
-        .transfer_type = USB_TRANSFER_INTERRUPT,
-        .direction = USB_DIRECTION_IN,
-        .interface_class = USB_CLASS_HID,
-        .interface_subclass = USB_HID_SUBCLASS_BOOT,
-        .interface_protocol = USB_HID_PROTOCOL_MOUSE,
-        .flags = 0
-};
+#include "mouse/mousedev.h"
+#include "subdrivers.h"
+
+/*----------------------------------------------------------------------------*/
 
 /* Array of endpoints expected on the device, NULL terminated. */
@@ -68 +61 @@
 };
 
-static const char *HID_MOUSE_FUN_NAME = "mouse";
-static const char *HID_MOUSE_CLASS_NAME = "mouse";
+static const int USB_HID_MAX_SUBDRIVERS = 10;
+
+/*----------------------------------------------------------------------------*/
+
+static int usb_hid_set_boot_kbd_subdriver(usb_hid_dev_t *hid_dev)
+{
+        assert(hid_dev != NULL && hid_dev->subdriver_count == 0);
+        
+        hid_dev->subdrivers = (usb_hid_subdriver_t *)malloc(
+            sizeof(usb_hid_subdriver_t));
+        if (hid_dev->subdrivers == NULL) {
+                return ENOMEM;
+        }
+        
+        // set the init callback
+        hid_dev->subdrivers[0].init = usb_kbd_init;
+        
+        // set the polling callback
+        hid_dev->subdrivers[0].poll = usb_kbd_polling_callback;
+        
+        // set the polling ended callback
+        hid_dev->subdrivers[0].poll_end = NULL;
+        
+        // set the deinit callback
+        hid_dev->subdrivers[0].deinit = usb_kbd_deinit;
+        
+        // set subdriver count
+        hid_dev->subdriver_count = 1;
+        
+        return EOK;
+}
+
+/*----------------------------------------------------------------------------*/
+
+static int usb_hid_set_boot_mouse_subdriver(usb_hid_dev_t *hid_dev)
+{
+        assert(hid_dev != NULL && hid_dev->subdriver_count == 0);
+        
+        hid_dev->subdrivers = (usb_hid_subdriver_t *)malloc(
+            sizeof(usb_hid_subdriver_t));
+        if (hid_dev->subdrivers == NULL) {
+                return ENOMEM;
+        }
+        
+        // set the init callback
+        hid_dev->subdrivers[0].init = usb_mouse_init;
+        
+        // set the polling callback
+        hid_dev->subdrivers[0].poll = usb_mouse_polling_callback;
+        
+        // set the polling ended callback
+        hid_dev->subdrivers[0].poll_end = NULL;
+        
+        // set the deinit callback
+        hid_dev->subdrivers[0].deinit = usb_mouse_deinit;
+        
+        // set subdriver count
+        hid_dev->subdriver_count = 1;
+        
+        return EOK;
+}
+
+/*----------------------------------------------------------------------------*/
+
+static int usb_hid_set_generic_hid_subdriver(usb_hid_dev_t *hid_dev)
+{
+        assert(hid_dev != NULL && hid_dev->subdriver_count == 0);
+        
+        hid_dev->subdrivers = (usb_hid_subdriver_t *)malloc(
+            sizeof(usb_hid_subdriver_t));
+        if (hid_dev->subdrivers == NULL) {
+                return ENOMEM;
+        }
+        
+        // set the init callback
+        hid_dev->subdrivers[0].init = NULL;
+        
+        // set the polling callback
+        hid_dev->subdrivers[0].poll = usb_generic_hid_polling_callback;
+        
+        // set the polling ended callback
+        hid_dev->subdrivers[0].poll_end = NULL;
+        
+        // set the deinit callback
+        hid_dev->subdrivers[0].deinit = NULL;
+        
+        // set subdriver count
+        hid_dev->subdriver_count = 1;
+        
+        return EOK;
+}
+
+/*----------------------------------------------------------------------------*/
+
+static bool usb_hid_ids_match(usb_hid_dev_t *hid_dev, 
+    const usb_hid_subdriver_mapping_t *mapping)
+{
+        assert(hid_dev != NULL);
+        assert(hid_dev->usb_dev != NULL);
+        
+        return (hid_dev->usb_dev->descriptors.device.vendor_id 
+            == mapping->vendor_id
+            && hid_dev->usb_dev->descriptors.device.product_id 
+            == mapping->product_id);
+}
+
+/*----------------------------------------------------------------------------*/
+
+static bool usb_hid_path_matches(usb_hid_dev_t *hid_dev, 
+    const usb_hid_subdriver_mapping_t *mapping)
+{
+        assert(hid_dev != NULL);
+        assert(mapping != NULL);
+        
+        usb_hid_report_path_t *usage_path = usb_hid_report_path();
+        if (usage_path == NULL) {
+                usb_log_debug("Failed to create usage path.\n");
+                return false;
+        }
+        int i = 0;
+        while (mapping->usage_path[i].usage != 0 
+            || mapping->usage_path[i].usage_page != 0) {
+                if (usb_hid_report_path_append_item(usage_path, 
+                    mapping->usage_path[i].usage_page, 
+                    mapping->usage_path[i].usage) != EOK) {
+                        usb_log_debug("Failed to append to usage path.\n");
+                        usb_hid_report_path_free(usage_path);
+                        return false;
+                }
+                ++i;
+        }
+        
+        if (mapping->report_id >= 0) {
+                usb_hid_report_path_set_report_id(usage_path, 
+                    mapping->report_id);
+        }
+        
+        assert(hid_dev->report != NULL);
+        
+        usb_log_debug("Compare flags: %d\n", mapping->compare);
+        size_t size = usb_hid_report_input_length(hid_dev->report, usage_path, 
+            mapping->compare);
+        usb_log_debug("Size of the input report: %zuB\n", size);
+        
+        usb_hid_report_path_free(usage_path);
+        
+        return (size > 0);
+}
+
+/*----------------------------------------------------------------------------*/
+
+static int usb_hid_save_subdrivers(usb_hid_dev_t *hid_dev, 
+    const usb_hid_subdriver_t **subdrivers, int count)
+{
+        int i;
+        
+        if (count <= 0) {
+                hid_dev->subdriver_count = 0;
+                hid_dev->subdrivers = NULL;
+                return EOK;
+        }
+        
+        hid_dev->subdrivers = (usb_hid_subdriver_t *)malloc(count * 
+            sizeof(usb_hid_subdriver_t));
+        if (hid_dev->subdrivers == NULL) {
+                return ENOMEM;
+        }
+        
+        for (i = 0; i < count; ++i) {
+                hid_dev->subdrivers[i].init = subdrivers[i]->init;
+                hid_dev->subdrivers[i].deinit = subdrivers[i]->deinit;
+                hid_dev->subdrivers[i].poll = subdrivers[i]->poll;
+                hid_dev->subdrivers[i].poll_end = subdrivers[i]->poll_end;
+        }
+        
+        hid_dev->subdriver_count = count;
+        
+        return EOK;
+}
+
+/*----------------------------------------------------------------------------*/
+
+static int usb_hid_find_subdrivers(usb_hid_dev_t *hid_dev)
+{
+        assert(hid_dev != NULL);
+        
+        const usb_hid_subdriver_t *subdrivers[USB_HID_MAX_SUBDRIVERS];
+        
+        int i = 0, count = 0;
+        const usb_hid_subdriver_mapping_t *mapping = &usb_hid_subdrivers[i];
+
+        bool ids_matched;
+        bool matched;
+        
+        while (count < USB_HID_MAX_SUBDRIVERS &&
+            (mapping->usage_path != NULL
+            || mapping->vendor_id >= 0 || mapping->product_id >= 0)) {
+                // check the vendor & product ID
+                if (mapping->vendor_id >= 0 && mapping->product_id < 0) {
+                        usb_log_warning("Missing Product ID for Vendor ID %d\n",
+                            mapping->vendor_id);
+                        return EINVAL;
+                }
+                if (mapping->product_id >= 0 && mapping->vendor_id < 0) {
+                        usb_log_warning("Missing Vendor ID for Product ID %d\n",
+                            mapping->product_id);
+                        return EINVAL;
+                }
+                
+                ids_matched = false;
+                matched = false;
+                
+                if (mapping->vendor_id >= 0) {
+                        assert(mapping->product_id >= 0);
+                        usb_log_debug("Comparing device against vendor ID %u"
+                            " and product ID %u.\n", mapping->vendor_id,
+                            mapping->product_id);
+                        if (usb_hid_ids_match(hid_dev, mapping)) {
+                                usb_log_debug("IDs matched.\n");
+                                ids_matched = true;
+                        }
+                }
+                
+                if (mapping->usage_path != NULL) {
+                        usb_log_debug("Comparing device against usage path.\n");
+                        if (usb_hid_path_matches(hid_dev, mapping)) {
+                                // does not matter if IDs were matched
+                                matched = true;
+                        }
+                } else {
+                        // matched only if IDs were matched and there is no path
+                        matched = ids_matched;
+                }
+                
+                if (matched) {
+                        subdrivers[count++] = &mapping->subdriver;
+                }
+                
+                mapping = &usb_hid_subdrivers[++i];
+        }
+        
+        // we have all subdrivers determined, save them into the hid device
+        return usb_hid_save_subdrivers(hid_dev, subdrivers, count);
+}
+
+/*----------------------------------------------------------------------------*/
+
+static int usb_hid_check_pipes(usb_hid_dev_t *hid_dev, usb_device_t *dev)
+{
+        assert(hid_dev != NULL && dev != NULL);
+        
+        int rc = EOK;
+        
+        if (dev->pipes[USB_HID_KBD_POLL_EP_NO].present) {
+                usb_log_debug("Found keyboard endpoint.\n");
+                // save the pipe index
+                hid_dev->poll_pipe_index = USB_HID_KBD_POLL_EP_NO;
+        } else if (dev->pipes[USB_HID_MOUSE_POLL_EP_NO].present) {
+                usb_log_debug("Found mouse endpoint.\n");
+                // save the pipe index
+                hid_dev->poll_pipe_index = USB_HID_MOUSE_POLL_EP_NO;
+        } else if (dev->pipes[USB_HID_GENERIC_POLL_EP_NO].present) {
+                usb_log_debug("Found generic HID endpoint.\n");
+                // save the pipe index
+                hid_dev->poll_pipe_index = USB_HID_GENERIC_POLL_EP_NO;
+        } else {
+                usb_log_error("None of supported endpoints found - probably"
+                    " not a supported device.\n");
+                rc = ENOTSUP;
+        }
+        
+        return rc;
+}
 
 /*----------------------------------------------------------------------------*/
@@ -83 +347 @@
         }
         
-        hid_dev->parser = (usb_hid_report_parser_t *)(malloc(sizeof(
-            usb_hid_report_parser_t)));
-        if (hid_dev->parser == NULL) {
+        hid_dev->report = (usb_hid_report_t *)(malloc(sizeof(
+            usb_hid_report_t)));
+        if (hid_dev->report == NULL) {
                 usb_log_fatal("No memory!\n");
                 free(hid_dev);
@@ -91 +355 @@
         }
         
+        hid_dev->poll_pipe_index = -1;
+        
         return hid_dev;
 }
@@ -96 +362 @@
 /*----------------------------------------------------------------------------*/
 
-static bool usb_dummy_polling_callback(usb_device_t *dev, uint8_t *buffer,
-     size_t buffer_size, void *arg)
-{
-        usb_log_debug("Dummy polling callback.\n");
-        return false;
-}
-
-/*----------------------------------------------------------------------------*/
-
-static int usb_hid_check_pipes(usb_hid_dev_t *hid_dev, usb_device_t *dev)
-{
-        if (dev->pipes[USB_HID_KBD_POLL_EP_NO].present) {
-                usb_log_debug("Found keyboard endpoint.\n");
-                
-                // save the pipe index and device type
-                hid_dev->poll_pipe_index = USB_HID_KBD_POLL_EP_NO;
-                hid_dev->device_type = USB_HID_PROTOCOL_KEYBOARD;
-                
-                // set the polling callback
-                hid_dev->poll_callback = usb_kbd_polling_callback;
-
-        } else if (dev->pipes[USB_HID_MOUSE_POLL_EP_NO].present) {
-                usb_log_debug("Found mouse endpoint.\n");
-                
-                // save the pipe index and device type
-                hid_dev->poll_pipe_index = USB_HID_MOUSE_POLL_EP_NO;
-                hid_dev->device_type = USB_HID_PROTOCOL_MOUSE;
-                
-                // set the polling callback
-                hid_dev->poll_callback = usb_dummy_polling_callback;
-                
-        } else if (dev->pipes[USB_HID_GENERIC_POLL_EP_NO].present) {
-                usb_log_debug("Found generic HID endpoint.\n");
-                
-                // save the pipe index and device type
-                hid_dev->poll_pipe_index = USB_HID_GENERIC_POLL_EP_NO;
-                hid_dev->device_type = USB_HID_PROTOCOL_NONE;
-                
-                // set the polling callback
-                hid_dev->poll_callback = usb_hid_polling_callback;
-                
-        } else {
-                usb_log_warning("None of supported endpoints found - probably"
-                    " not a supported device.\n");
-                return ENOTSUP;
-        }
-        
-        return EOK;
-}
-
-/*----------------------------------------------------------------------------*/
-
-static int usb_hid_init_parser(usb_hid_dev_t *hid_dev)
-{
-        /* Initialize the report parser. */
-        int rc = usb_hid_parser_init(hid_dev->parser);
-        if (rc != EOK) {
-                usb_log_error("Failed to initialize report parser.\n");
-                return rc;
-        }
-        
-        /* Get the report descriptor and parse it. */
-        rc = usb_hid_process_report_descriptor(hid_dev->usb_dev, 
-            hid_dev->parser);
-        
-        if (rc != EOK) {
-                usb_log_warning("Could not process report descriptor.\n");
-                
-                if (hid_dev->device_type == USB_HID_PROTOCOL_KEYBOARD) {
-                        usb_log_warning("Falling back to boot protocol.\n");
-                        
-                        rc = usb_kbd_set_boot_protocol(hid_dev);
-                        
-                } else if (hid_dev->device_type == USB_HID_PROTOCOL_MOUSE) {
-                        usb_log_warning("No boot protocol for mouse yet.\n");
-                        rc = ENOTSUP;
-                }
-        }
-        
-        return rc;
-}
-
-/*----------------------------------------------------------------------------*/
-
 int usb_hid_init(usb_hid_dev_t *hid_dev, usb_device_t *dev)
 {
-        int rc;
+        int rc, i;
         
         usb_log_debug("Initializing HID structure...\n");
@@ -203 +385 @@
         rc = usb_hid_check_pipes(hid_dev, dev);
         if (rc != EOK) {
+                //usb_hid_free(&hid_dev);
                 return rc;
         }
-        
-        rc = usb_hid_init_parser(hid_dev);
+                
+        /* Get the report descriptor and parse it. */
+        rc = usb_hid_process_report_descriptor(hid_dev->usb_dev, 
+            hid_dev->report);
+        
+        bool fallback = false;
+        
+        if (rc == EOK) {
+                // try to find subdrivers that may want to handle this device
+                rc = usb_hid_find_subdrivers(hid_dev);
+                if (rc != EOK || hid_dev->subdriver_count == 0) {
+                        // try to fall back to the boot protocol if available
+                        usb_log_info("No subdrivers found to handle this"
+                            " device.\n");
+                        fallback = true;
+                        assert(hid_dev->subdrivers == NULL);
+                        assert(hid_dev->subdriver_count == 0);
+                }
+        } else {
+                usb_log_error("Failed to parse Report descriptor.\n");
+                // try to fall back to the boot protocol if available
+                fallback = true;
+        }
+        
+        // TODO: remove the mouse hack
+        if (hid_dev->poll_pipe_index == USB_HID_MOUSE_POLL_EP_NO ||
+            fallback) {
+                // fall back to boot protocol
+                switch (hid_dev->poll_pipe_index) {
+                case USB_HID_KBD_POLL_EP_NO:
+                        usb_log_info("Falling back to kbd boot protocol.\n");
+                        rc = usb_kbd_set_boot_protocol(hid_dev);
+                        if (rc == EOK) {
+                                rc = usb_hid_set_boot_kbd_subdriver(hid_dev);
+                        }
+                        break;
+                case USB_HID_MOUSE_POLL_EP_NO:
+                        usb_log_info("Falling back to mouse boot protocol.\n");
+                        rc = usb_mouse_set_boot_protocol(hid_dev);
+                        if (rc == EOK) {
+                                rc = usb_hid_set_boot_mouse_subdriver(hid_dev);
+                        }
+                        break;
+                default:
+                        assert(hid_dev->poll_pipe_index 
+                            == USB_HID_GENERIC_POLL_EP_NO);
+                        
+                        /* TODO: this has no meaning if the report descriptor
+                                 is not parsed */
+                        usb_log_info("Falling back to generic HID driver.\n");
+                        rc = usb_hid_set_generic_hid_subdriver(hid_dev);
+                }
+        }
+        
         if (rc != EOK) {
-                usb_log_error("Failed to initialize HID parser.\n");
-                return rc;
-        }
-        
-        switch (hid_dev->device_type) {
-        case USB_HID_PROTOCOL_KEYBOARD:
-                // initialize the keyboard structure
-                rc = usb_kbd_init(hid_dev);
-                if (rc != EOK) {
-                        usb_log_warning("Failed to initialize KBD structure."
-                            "\n");
-                }
-                break;
-        case USB_HID_PROTOCOL_MOUSE:
-                break;
-        default:
-//              usbhid_req_set_idle(&hid_dev->usb_dev->ctrl_pipe, 
-//                  hid_dev->usb_dev->interface_no, 0);
-                break;
+                usb_log_error("No subdriver for handling this device could be"
+                    " initialized: %s.\n", str_error(rc));
+                usb_log_debug("Subdriver count: %d\n", 
+                    hid_dev->subdriver_count);
+                //usb_hid_free(&hid_dev);
+        } else {
+                bool ok = false;
+                
+                usb_log_debug("Subdriver count: %d\n", 
+                    hid_dev->subdriver_count);
+                
+                for (i = 0; i < hid_dev->subdriver_count; ++i) {
+                        if (hid_dev->subdrivers[i].init != NULL) {
+                                usb_log_debug("Initializing subdriver %d.\n",i);
+                                rc = hid_dev->subdrivers[i].init(hid_dev);
+                                if (rc != EOK) {
+                                        usb_log_warning("Failed to initialize"
+                                            " HID subdriver structure.\n");
+                                } else {
+                                        // at least one subdriver initialized
+                                        ok = true;
+                                }
+                        } else {
+                                ok = true;
+                        }
+                }
+                
+                rc = (ok) ? EOK : -1;   // what error to report
         }
         
         return rc;
+}
+
+/*----------------------------------------------------------------------------*/
+
+bool usb_hid_polling_callback(usb_device_t *dev, uint8_t *buffer, 
+    size_t buffer_size, void *arg)
+{
+        int i;
+        
+        if (dev == NULL || arg == NULL || buffer == NULL) {
+                usb_log_error("Missing arguments to polling callback.\n");
+                return false;
+        }
+        
+        usb_hid_dev_t *hid_dev = (usb_hid_dev_t *)arg;
+        
+        bool cont = false;
+        
+        // continue if at least one of the subdrivers want to continue
+        for (i = 0; i < hid_dev->subdriver_count; ++i) {
+                if (hid_dev->subdrivers[i].poll != NULL
+                    && hid_dev->subdrivers[i].poll(hid_dev, buffer, 
+                    buffer_size)) {
+                        cont = true;
+                }
+        }
+        
+        return cont;
 }
 
@@ -237 +509 @@
      void *arg)
 {
+        int i; 
+        
         if (dev == NULL || arg == NULL) {
                 return;
@@ -243 +517 @@
         usb_hid_dev_t *hid_dev = (usb_hid_dev_t *)arg;
         
+        for (i = 0; i < hid_dev->subdriver_count; ++i) {
+                if (hid_dev->subdrivers[i].poll_end != NULL) {
+                        hid_dev->subdrivers[i].poll_end(hid_dev, reason);
+                }
+        }
+        
         usb_hid_free(&hid_dev);
 }
@@ -248 +528 @@
 /*----------------------------------------------------------------------------*/
 
-const char *usb_hid_get_function_name(usb_hid_iface_protocol_t device_type)
-{
-        switch (device_type) {
-        case USB_HID_PROTOCOL_KEYBOARD:
+const char *usb_hid_get_function_name(const usb_hid_dev_t *hid_dev)
+{
+        switch (hid_dev->poll_pipe_index) {
+        case USB_HID_KBD_POLL_EP_NO:
                 return HID_KBD_FUN_NAME;
                 break;
-        case USB_HID_PROTOCOL_MOUSE:
+        case USB_HID_MOUSE_POLL_EP_NO:
                 return HID_MOUSE_FUN_NAME;
                 break;
@@ -264 +544 @@
 /*----------------------------------------------------------------------------*/
 
-const char *usb_hid_get_class_name(usb_hid_iface_protocol_t device_type)
-{
-        switch (device_type) {
-        case USB_HID_PROTOCOL_KEYBOARD:
+const char *usb_hid_get_class_name(const usb_hid_dev_t *hid_dev)
+{
+        // this means that only boot protocol keyboards will be connected
+        // to the console; there is probably no better way to do this
+        
+        switch (hid_dev->poll_pipe_index) {
+        case USB_HID_KBD_POLL_EP_NO:
                 return HID_KBD_CLASS_NAME;
                 break;
-        case USB_HID_PROTOCOL_MOUSE:
+        case USB_HID_MOUSE_POLL_EP_NO:
                 return HID_MOUSE_CLASS_NAME;
                 break;
@@ -282 +565 @@
 void usb_hid_free(usb_hid_dev_t **hid_dev)
 {
+        int i;
+        
         if (hid_dev == NULL || *hid_dev == NULL) {
                 return;
         }
         
-        switch ((*hid_dev)->device_type) {
-        case USB_HID_PROTOCOL_KEYBOARD:
-                usb_kbd_deinit(*hid_dev);
-                break;
-        case USB_HID_PROTOCOL_MOUSE:
-                break;
-        default:
-                break;
+        usb_log_debug("Subdrivers: %p, subdriver count: %d\n", 
+            (*hid_dev)->subdrivers, (*hid_dev)->subdriver_count);
+        
+        assert((*hid_dev)->subdrivers != NULL 
+            || (*hid_dev)->subdriver_count == 0);
+        
+        for (i = 0; i < (*hid_dev)->subdriver_count; ++i) {
+                if ((*hid_dev)->subdrivers[i].deinit != NULL) {
+                        (*hid_dev)->subdrivers[i].deinit(*hid_dev);
+                }
+        }
+        
+        // free the subdrivers info
+        if ((*hid_dev)->subdrivers != NULL) {
+                free((*hid_dev)->subdrivers);
         }
 
         // destroy the parser
-        if ((*hid_dev)->parser != NULL) {
-                usb_hid_free_report_parser((*hid_dev)->parser);
+        if ((*hid_dev)->report != NULL) {
+                usb_hid_free_report((*hid_dev)->report);
         }