Changeset 1c6f4ff in mainline

Timestamp:

2011-04-08T07:58:15Z (13 years ago)

Author:

Lubos Slovak <lubos.slovak@…>

Branches:

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

Children:

8b74997f

Parents:

a8a7063 (diff), fec47d4 (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:

General HID driver for handling all HID devices.

Now handles only keyboard. For generic HID device and mouse there are some
dummy functions.

Files:

• boot/arch/amd64/Makefile.inc (modified) (1 diff)
• uspace/Makefile (modified) (2 diffs)
• uspace/drv/usbhid/Makefile (added)
• uspace/drv/usbhid/generic/hiddev.c (added)
• uspace/drv/usbhid/generic/hiddev.h (added)
• uspace/drv/usbhid/kbd.h (added)
• uspace/drv/usbhid/kbd/conv.c (added)
• uspace/drv/usbhid/kbd/conv.h (added)
• uspace/drv/usbhid/kbd/kbddev.c (added)
• uspace/drv/usbhid/kbd/kbddev.h (added)
• uspace/drv/usbhid/kbd/kbdrepeat.c (added)
• uspace/drv/usbhid/kbd/kbdrepeat.h (added)
• uspace/drv/usbhid/kbd/layout.h (added)
• uspace/drv/usbhid/kbd/main.c (added)
• uspace/drv/usbhid/layout.h (added)
• uspace/drv/usbhid/main.c (added)
• uspace/drv/usbhid/usbhid.c (added)
• uspace/drv/usbhid/usbhid.h (added)
• uspace/drv/usbhid/usbhid.ma (added)
• uspace/drv/usbkbd/kbddev.c (modified) (9 diffs)
• uspace/drv/usbkbd/main.c (modified) (6 diffs)
• uspace/drv/usbkbd/usbkbd.ma (modified) (1 diff)
• uspace/lib/usb/include/usb/classes/hidparser.h (modified) (4 diffs)
• uspace/lib/usb/src/devpoll.c (modified) (2 diffs)
• uspace/lib/usb/src/hidparser.c (modified) (19 diffs)
• uspace/lib/usb/src/hidreport.c (modified) (1 diff)

boot/arch/amd64/Makefile.inc

@@ -50 +50 @@
         usbhub \
         usbkbd \
+        usbhid \
         usbmid \
         usbmouse \

uspace/Makefile

@@ -123 +123 @@
                 drv/usbflbk \
                 drv/usbkbd \
+                drv/usbhid \
                 drv/usbhub \
                 drv/usbmid \
@@ -143 +144 @@
                 drv/usbflbk \
                 drv/usbkbd \
+                drv/usbhid \
                 drv/usbhub \
                 drv/usbmid \

uspace/drv/usbkbd/kbddev.c

@@ -265 +265 @@
 static void usb_kbd_set_led(usb_kbd_t *kbd_dev) 
 {
+        if (kbd_dev->output_size == 0) {
+                return;
+        }
+        
         unsigned i = 0;
         
@@ -288 +292 @@
         
         int rc = usb_hid_report_output_translate(kbd_dev->parser, 
-            kbd_dev->led_path, USB_HID_PATH_COMPARE_END, kbd_dev->output_buffer, 
+            kbd_dev->led_path, 
+            USB_HID_PATH_COMPARE_END | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY, 
+            kbd_dev->output_buffer, 
             kbd_dev->output_size, kbd_dev->led_data, kbd_dev->led_output_size);
         
@@ -539 +545 @@
  *                  according to HID Usage Tables.
  * @param count Number of key codes in report (size of the report).
- * @param modifiers Bitmap of modifiers (Ctrl, Alt, Shift, GUI).
+ * @param report_id
  * @param arg User-specified argument. Expects pointer to the keyboard device
  *            structure representing the keyboard.
@@ -546 +552 @@
  */
 static void usb_kbd_process_keycodes(const uint8_t *key_codes, size_t count,
-    uint8_t modifiers, void *arg)
+    uint8_t report_id, void *arg)
 {
         if (arg == NULL) {
@@ -557 +563 @@
         assert(kbd_dev != NULL);
 
-        usb_log_debug("Got keys from parser: %s\n", 
-            usb_debug_str_buffer(key_codes, count, 0));
+        usb_log_debug("Got keys from parser (report id: %u): %s\n", 
+            report_id, usb_debug_str_buffer(key_codes, count, 0));
         
         if (count != kbd_dev->key_count) {
@@ -608 +614 @@
         usb_hid_report_path_t *path = usb_hid_report_path();
         usb_hid_report_path_append_item(path, USB_HIDUT_PAGE_KEYBOARD, 0);
+        usb_hid_report_path_set_report_id(path, 0);
         
         int rc = usb_hid_parse_report(kbd_dev->parser, buffer,
-            actual_size, path, USB_HID_PATH_COMPARE_STRICT, callbacks, kbd_dev);
+            actual_size, path, 
+            USB_HID_PATH_COMPARE_END | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY, 
+            callbacks, kbd_dev);
 
         usb_hid_report_path_free (path);
@@ -758 +767 @@
         usb_hid_report_path_t *path = usb_hid_report_path();
         usb_hid_report_path_append_item(path, USB_HIDUT_PAGE_KEYBOARD, 0);
+        
+        usb_hid_report_path_set_report_id(path, 0);
+        
         kbd_dev->key_count = usb_hid_report_input_length(
-            kbd_dev->parser, path, USB_HID_PATH_COMPARE_STRICT);
+            kbd_dev->parser, path, 
+            USB_HID_PATH_COMPARE_END | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY);
         usb_hid_report_path_free (path);
         
@@ -777 +790 @@
         kbd_dev->output_buffer = usb_hid_report_output(kbd_dev->parser, 
             &kbd_dev->output_size);
-        if (kbd_dev->output_buffer == NULL) {
+        if (kbd_dev->output_buffer == NULL && kbd_dev->output_size != 0) {
                 usb_log_warning("Error creating output report buffer.\n");
                 free(kbd_dev->keys);
@@ -790 +803 @@
         
         kbd_dev->led_output_size = usb_hid_report_output_size(kbd_dev->parser, 
-            kbd_dev->led_path, USB_HID_PATH_COMPARE_END);
+            kbd_dev->led_path, 
+            USB_HID_PATH_COMPARE_END | USB_HID_PATH_COMPARE_USAGE_PAGE_ONLY);
         
         usb_log_debug("Output report size (in items): %zu\n", 

uspace/drv/usbkbd/main.c

@@ -33 +33 @@
 /**
  * @file
- * Main routines of USB HID driver.
+ * Main routines of USB KBD driver.
  */
 
@@ -75 +75 @@
  * @sa usb_kbd_fibril(), usb_kbd_repeat_fibril()
  */
-static int usbhid_try_add_device(usb_device_t *dev)
+static int usb_kbd_try_add_device(usb_device_t *dev)
 {
         /* Create the function exposed under /dev/devices. */
@@ -105 +105 @@
                 usb_kbd_free(&kbd_dev);
                 return rc;
-        }       
+        }
         
         usb_log_debug("USB/HID KBD device structure initialized.\n");
@@ -195 +195 @@
  * @retval EREFUSED if the device is not supported.
  */
-static int usbhid_add_device(usb_device_t *dev)
+static int usb_kbd_add_device(usb_device_t *dev)
 {
-        usb_log_debug("usbhid_add_device()\n");
+        usb_log_debug("usb_kbd_add_device()\n");
         
         if (dev->interface_no < 0) {
                 usb_log_warning("Device is not a supported keyboard.\n");
-                usb_log_error("Failed to add HID device: endpoint not found."
-                    "\n");
+                usb_log_error("Failed to add USB KBD device: endpoint not "
+                    "found.\n");
                 return ENOTSUP;
         }
         
-        int rc = usbhid_try_add_device(dev);
+        int rc = usb_kbd_try_add_device(dev);
         
         if (rc != EOK) {
                 usb_log_warning("Device is not a supported keyboard.\n");
-                usb_log_error("Failed to add HID device: %s.\n",
+                usb_log_error("Failed to add KBD device: %s.\n",
                     str_error(rc));
                 return rc;
@@ -224 +224 @@
 /* Currently, the framework supports only device adding. Once the framework
  * supports unplug, more callbacks will be added. */
-static usb_driver_ops_t usbhid_driver_ops = {
-        .add_device = usbhid_add_device,
+static usb_driver_ops_t usb_kbd_driver_ops = {
+        .add_device = usb_kbd_add_device,
 };
 
 
 /* The driver itself. */
-static usb_driver_t usbhid_driver = {
+static usb_driver_t usb_kbd_driver = {
         .name = NAME,
-        .ops = &usbhid_driver_ops,
+        .ops = &usb_kbd_driver_ops,
         .endpoints = usb_kbd_endpoints
 };
@@ -238 +238 @@
 /*----------------------------------------------------------------------------*/
 
-//static driver_ops_t kbd_driver_ops = {
-//      .add_device = usbhid_add_device,
-//};
-
-///*----------------------------------------------------------------------------*/
-
-//static driver_t kbd_driver = {
-//      .name = NAME,
-//      .driver_ops = &kbd_driver_ops
-//};
-
-/*----------------------------------------------------------------------------*/
-
 int main(int argc, char *argv[])
 {
-        printf(NAME ": HelenOS USB HID driver.\n");
+        printf(NAME ": HelenOS USB KBD driver.\n");
 
         usb_log_enable(USB_LOG_LEVEL_DEBUG, NAME);
 
-        return usb_driver_main(&usbhid_driver);
+        return usb_driver_main(&usb_kbd_driver);
 }
 

uspace/drv/usbkbd/usbkbd.ma

@@ -1 @@
-100 usb&interface&class=HID&subclass=0x01&protocol=0x01
-10 usb&interface&class=HID
+10 usb&interface&class=HID&subclass=0x01&protocol=0x01

uspace/lib/usb/include/usb/classes/hidparser.h

@@ -88 +88 @@
         /** */  
         int depth;      
+        uint8_t report_id;
         
         /** */  
         link_t link;
+
 } usb_hid_report_path_t;
 
@@ -155 +157 @@
         /** */  
         link_t feature;
+        
+        int use_report_id;
+
+        /** */
+        link_t stack;
 } usb_hid_report_parser_t;      
 
@@ -166 +173 @@
          * @param arg Custom argument.
          */
-        void (*keyboard)(const uint8_t *key_codes, size_t count, const uint8_t modifiers, void *arg);
+        void (*keyboard)(const uint8_t *key_codes, size_t count, const uint8_t report_id, void *arg);
 } usb_hid_report_in_callbacks_t;
 
@@ -269 +276 @@
 
 /** */
+int usb_hid_report_path_set_report_id(usb_hid_report_path_t *usage_path, uint8_t report_id);
+
+/** */
 int usb_hid_report_path_append_item(usb_hid_report_path_t *usage_path, int32_t usage_page, int32_t usage);
 

uspace/lib/usb/src/devpoll.c

@@ -66 +66 @@
         usb_pipe_t *pipe
             = polling_data->dev->pipes[polling_data->pipe_index].pipe;
+        
+        usb_log_debug("Pipe interface number: %d, protocol: %d, subclass: %d, max packet size: %d\n", 
+            polling_data->dev->pipes[polling_data->pipe_index].interface_no,
+            polling_data->dev->pipes[polling_data->pipe_index].description->interface_protocol,
+            polling_data->dev->pipes[polling_data->pipe_index].description->interface_subclass,
+            pipe->max_packet_size);
 
         size_t failed_attempts = 0;
@@ -83 +89 @@
                 /* Quit the session regardless of errors. */
                 usb_pipe_end_session(pipe);
+                
+//              if (rc == ESTALL) {
+//                      usb_log_debug("Seding clear feature...\n");
+//                      usb_request_clear_feature(pipe, USB_REQUEST_TYPE_STANDARD,
+//                        USB_REQUEST_RECIPIENT_ENDPOINT, 0, pipe->endpoint_no);
+//                      continue;
+//              }
 
                 if (rc != EOK) {

uspace/lib/usb/src/hidparser.c

@@ -64 +64 @@
 int usb_hid_report_reset_local_items();
 void usb_hid_free_report_list(link_t *head);
-
+usb_hid_report_item_t *usb_hid_report_item_clone(const usb_hid_report_item_t *item);
 /*
  * Data translation private functions
@@ -106 +106 @@
     list_initialize(&(parser->feature));
 
+        list_initialize(&(parser->stack));
+
+        parser->use_report_id = 0;
     return EOK;   
 }
@@ -186 +189 @@
                                         tmp_usage_path = NULL;
 
+                                        usb_hid_report_path_set_report_id(report_item->usage_path, report_item->id);    
+                                        if(report_item->id != 0){
+                                                parser->use_report_id = 1;
+                                        }
                                         
                                         switch(tag) {
@@ -215 +222 @@
                                         if(!(new_report_item = malloc(sizeof(usb_hid_report_item_t)))) {
                                                 return ENOMEM;
-                                        }
+                                        }                                       
                                         memcpy(new_report_item,report_item, sizeof(usb_hid_report_item_t));
+                                        link_initialize(&(new_report_item->link));
+                                        
                                         /* reset local items */
                                         new_report_item->usage_minimum = 0;
                                         new_report_item->usage_maximum = 0;
+                                        new_report_item->designator_index = 0;
+                                        new_report_item->designator_minimum = 0;
+                                        new_report_item->designator_maximum = 0;
+                                        new_report_item->string_index = 0;
+                                        new_report_item->string_minimum = 0;
+                                        new_report_item->string_maximum = 0;
+
+                                        /* reset usage from current usage path */
+                                        usb_hid_report_usage_path_t *path = list_get_instance(&usage_path->link, usb_hid_report_usage_path_t, link);
+                                        path->usage = 0;
                                         
-                                        link_initialize(&(new_report_item->link));
                                         report_item = new_report_item;
                                                                                 
@@ -227 +245 @@
                                 case USB_HID_REPORT_TAG_PUSH:
                                         // push current state to stack
-                                        // not yet implemented
+                                        new_report_item = usb_hid_report_item_clone(report_item);
+                                        list_prepend (&parser->stack, &new_report_item->link);
+                                        
                                         break;
                                 case USB_HID_REPORT_TAG_POP:
                                         // restore current state from stack
-                                        // not yet implemented                                             
+                                        if(list_empty (&parser->stack)) {
+                                                return EINVAL;
+                                        }
+                                        
+                                        report_item = list_get_instance(&parser->stack, usb_hid_report_item_t, link);
+                                        list_remove (parser->stack.next);
+                                        
                                         break;
                                         
@@ -647 +673 @@
         }
 
+        parser->use_report_id = 0;
+
         usb_hid_free_report_list(&parser->input);
         usb_hid_free_report_list(&parser->output);
@@ -676 +704 @@
         size_t i=0;
         size_t j=0;
+        uint8_t report_id = 0;
 
         if(parser == NULL) {
@@ -686 +715 @@
         if(!(keys = malloc(sizeof(uint8_t) * key_count))){
                 return ENOMEM;
+        }
+
+        if(parser->use_report_id != 0) {
+                report_id = data[0];
+                usb_hid_report_path_set_report_id(path, report_id);
         }
 
@@ -693 +727 @@
 
                 item = list_get_instance(list_item, usb_hid_report_item_t, link);
+
                 if(!USB_HID_ITEM_FLAG_CONSTANT(item->item_flags) && 
                    (usb_hid_report_compare_usage_path(item->usage_path, path, flags) == EOK)) {
@@ -715 +750 @@
         }
 
-        callbacks->keyboard(keys, key_count, 0, arg);
+        callbacks->keyboard(keys, key_count, report_id, arg);
            
         free(keys);     
@@ -739 +774 @@
         int32_t mask;
         const uint8_t *foo;
-        
+
         // now only common numbers llowed
         if(item->size > 32) {
@@ -758 +793 @@
                 (usb_pow(10,(item->unit_exponent))));
         }
+
         offset = item->offset + (j * item->size);
+        if(item->id != 0) {
+                offset += 8;
+                usb_log_debug("MOVED OFFSET BY 1Byte, REPORT_ID(%d)\n", item->id);
+        }
         
         // FIXME
@@ -942 +982 @@
 
         int only_page;
+
+        if(report_path->report_id != path->report_id) {
+                return 1;
+        }
 
         if(path->depth == 0){
@@ -1038 +1082 @@
         else {
                 path->depth = 0;
+                path->report_id = 0;
                 list_initialize(&path->link);
                 return path;
@@ -1155 +1200 @@
                 return 0;
         }
-        
+
         item = parser->output.next;
         while(&parser->output != item) {
@@ -1195 +1240 @@
         int length;
         int32_t tmp_value;
+        size_t offset_prefix = 0;
         
         if(parser == NULL) {
                 return EINVAL;
+        }
+
+        if(parser->use_report_id != 0) {
+                buffer[0] = path->report_id;
+                offset_prefix = 8;
         }
 
@@ -1218 +1269 @@
 //                              // variable item
                                 value = usb_hid_translate_data_reverse(report_item, data[idx++]);
-                                offset = report_item->offset + (i * report_item->size);
+                                offset = report_item->offset + (i * report_item->size) + offset_prefix;
                                 length = report_item->size;
                         }
@@ -1224 +1275 @@
                                 //bitmap
                                 value += usb_hid_translate_data_reverse(report_item, data[idx++]);
-                                offset = report_item->offset;
+                                offset = report_item->offset + offset_prefix;
                                 length = report_item->size * report_item->count;
                         }
@@ -1323 +1374 @@
 
 
+int usb_hid_report_path_set_report_id(usb_hid_report_path_t *path, uint8_t report_id)
+{
+        if(path == NULL){
+                return EINVAL;
+        }
+
+        path->report_id = report_id;
+        return EOK;
+}
+
+
+usb_hid_report_item_t *usb_hid_report_item_clone(const usb_hid_report_item_t *item)
+{
+        usb_hid_report_item_t *new_report_item;
+        
+        if(!(new_report_item = malloc(sizeof(usb_hid_report_item_t)))) {
+                return NULL;
+        }                                       
+        memcpy(new_report_item,item, sizeof(usb_hid_report_item_t));
+        link_initialize(&(new_report_item->link));
+
+        return new_report_item;
+}
+
 /**
  * @}

uspace/lib/usb/src/hidreport.c

@@ -80 +80 @@
                 d = usb_dp_get_sibling_descriptor(&parser, &parser_data, 
                     dev->descriptors.configuration, d);
+                ++i;
         }