Hid micro parser

examples/host/.gitignore

@@ -0,0 +1 @@
+build

examples/host/cdc_msc_hid/CMakeLists.txt

@@ -17,10 +17,19 @@ endif()
 
 add_executable(${PROJECT})
 
+target_compile_definitions(${PROJECT} PRIVATE
+	HID_PROTOCOL_DEFAULT=HID_PROTOCOL_REPORT
+)
+
 # Example source
 target_sources(${PROJECT} PUBLIC
   ${CMAKE_CURRENT_SOURCE_DIR}/src/cdc_app.c
   ${CMAKE_CURRENT_SOURCE_DIR}/src/hid_app.c
+  ${CMAKE_CURRENT_SOURCE_DIR}/src/hid_host_utils.c
+  ${CMAKE_CURRENT_SOURCE_DIR}/src/hid_host_info.c
+  ${CMAKE_CURRENT_SOURCE_DIR}/src/hid_host_common.c
+  ${CMAKE_CURRENT_SOURCE_DIR}/src/hid_host_mouse.c
+  ${CMAKE_CURRENT_SOURCE_DIR}/src/hid_host_joy.c
   ${CMAKE_CURRENT_SOURCE_DIR}/src/main.c
   ${CMAKE_CURRENT_SOURCE_DIR}/src/msc_app.c
   )

examples/host/cdc_msc_hid/Makefile

@@ -8,9 +8,24 @@ INC += \
 EXAMPLE_SOURCE = \
   src/cdc_app.c \
   src/hid_app.c \
+  src/hid_host_utils.c \
+  src/hid_host_info.c \
+  src/hid_host_joy.c \
   src/main.c \
   src/msc_app.c \
 
 SRC_C += $(addprefix $(CURRENT_PATH)/, $(EXAMPLE_SOURCE))
 
+# TinyUSB Host Stack source
+# SRC_C += \
+# 	src/class/cdc/cdc_host.c \
+# 	src/class/hid/hid_host.c \
+# 	src/class/hid/hid_rip.c \
+# 	src/class/hid/hid_ri.c \
+# 	src/class/msc/msc_host.c \
+# 	src/host/hub.c \
+# 	src/host/usbh.c \
+# 	src/portable/ohci/ohci.c \
+# 	src/portable/nxp/lpc17_40/hcd_lpc17_40.c
+
 include ../../build_system/make/rules.mk

examples/host/cdc_msc_hid/src/hid_app.c

@@ -25,6 +25,8 @@
 
 #include "bsp/board_api.h"
 #include "tusb.h"
+#include "hid_host_joy.h"
+#include "hid_host_info.h"
 
 //--------------------------------------------------------------------+
 // MACRO TYPEDEF CONSTANT ENUM DECLARATION
@@ -38,13 +40,6 @@
 
 static uint8_t const keycode2ascii[128][2] =  { HID_KEYCODE_TO_ASCII };
 
-// Each HID instance can has multiple reports
-static struct
-{
-  uint8_t report_count;
-  tuh_hid_report_info_t report_info[MAX_REPORT];
-}hid_info[CFG_TUH_HID];
-
 static void process_kbd_report(hid_keyboard_report_t const *report);
 static void process_mouse_report(hid_mouse_report_t const * report);
 static void process_generic_report(uint8_t dev_addr, uint8_t instance, uint8_t const* report, uint16_t len);
@@ -54,6 +49,61 @@ void hid_app_task(void)
   // nothing to do
 }
 
+void handle_kbd_report(tusb_hid_host_info_t* info, const uint8_t* report, uint8_t report_length, uint8_t report_id)
+{
+  // Stop unused parameter errors
+  (void) info;
+  (void) report_length;
+  (void) report_id;
+
+  TU_LOG1("HID receive keyboard report\r\n");
+  process_kbd_report((hid_keyboard_report_t const *)report);
+}
+
+void handle_mouse_report(tusb_hid_host_info_t* info, const uint8_t* report, uint8_t report_length, uint8_t report_id)
+{
+  // Stop unused parameter errors
+  (void) info;
+  (void) report_length;
+  (void) report_id;
+
+  TU_LOG1("HID receive mouse report\r\n");
+  process_mouse_report((hid_mouse_report_t const *)report);
+}
+
+void handle_joystick_report(tusb_hid_host_info_t* info, const uint8_t* report, uint8_t report_length, uint8_t report_id)
+{ 
+  TU_LOG1("HID receive joystick report\r\n");
+  tusb_hid_simple_joystick_t* simple_joystick = tuh_hid_get_simple_joystick(
+    info->key.elements.dev_addr, 
+    info->key.elements.instance, 
+    report_id);
+
+  if (simple_joystick != NULL) {
+    tusb_hid_simple_joystick_process_report(simple_joystick, report, report_length);
+    tusb_hid_print_simple_joystick_report(simple_joystick);
+  }
+}
+
+void handle_joystick_unmount(tusb_hid_host_info_t* info) {
+  TU_LOG1("HID joystick unmount\n");
+  // Free up joystick definitions
+  tuh_hid_free_simple_joysticks_for_instance(info->key.elements.dev_addr, info->key.elements.instance);
+}
+
+void handle_gamepad_report(tusb_hid_host_info_t* info, const uint8_t* report, uint8_t report_length, uint8_t report_id)
+{
+  // Stop unused parameter errors
+  (void) info;
+  (void) report_id;
+
+  TU_LOG1("HID receive gamepad report ");
+  for(int i = 0; i < report_length; ++i) {
+    printf("%02x", report[i]);
+  }
+  printf("\r\n");
+}
+
 //--------------------------------------------------------------------+
 // TinyUSB Callbacks
 //--------------------------------------------------------------------+
@@ -67,6 +117,10 @@ void tuh_hid_mount_cb(uint8_t dev_addr, uint8_t instance, uint8_t const* desc_re
 {
   printf("HID device address = %d, instance = %d is mounted\r\n", dev_addr, instance);
 
+  printf("HID Report Description \r\n");
+  for(int i = 0; i < desc_len; ++i) printf("%02X ", desc_report[i]);
+  printf("\r\n");
+
   // Interface protocol (hid_interface_protocol_enum_t)
   const char* protocol_str[] = { "None", "Keyboard", "Mouse" };
   uint8_t const itf_protocol = tuh_hid_interface_protocol(dev_addr, instance);
@@ -77,8 +131,50 @@ void tuh_hid_mount_cb(uint8_t dev_addr, uint8_t instance, uint8_t const* desc_re
   // Therefore for this simple example, we only need to parse generic report descriptor (with built-in parser)
   if ( itf_protocol == HID_ITF_PROTOCOL_NONE )
   {
-    hid_info[instance].report_count = tuh_hid_parse_report_descriptor(hid_info[instance].report_info, MAX_REPORT, desc_report, desc_len);
-    printf("HID has %u reports \r\n", hid_info[instance].report_count);
+    tuh_hid_report_info_t reports[MAX_REPORT];
+    uint8_t report_count = tuh_hid_parse_report_descriptor(reports, MAX_REPORT, desc_report, desc_len);
+    printf("HID has %u reports \r\n", report_count);
+
+    for (uint8_t i = 0; i < report_count; ++i) {
+      tuh_hid_report_info_t *report = &reports[i];
+      bool has_report_id = report_count > 1 || (report[0].report_id > 0);
+
+      printf("HID report usage_page=%d, usage=%d, has_report_id=%d dev=%d instance=%d\n", report->usage_page, report->usage, has_report_id, dev_addr, instance);
+
+      if (report->usage_page == HID_USAGE_PAGE_DESKTOP)
+      {
+        switch (report->usage)
+        {
+          case HID_USAGE_DESKTOP_KEYBOARD: {
+            printf("HID receive keyboard report description\r\n");
+            tuh_hid_allocate_info(dev_addr, instance, has_report_id, &handle_kbd_report, NULL);
+            break;
+          }
+          case HID_USAGE_DESKTOP_JOYSTICK: {
+            printf("HID receive joystick report description\r\n");
+            if(tuh_hid_allocate_info(dev_addr, instance, has_report_id, &handle_joystick_report, handle_joystick_unmount)) {
+              tuh_hid_joystick_parse_report_descriptor(desc_report, desc_len, dev_addr, instance);
+            }
+            break;
+          }
+          case HID_USAGE_DESKTOP_MOUSE: {
+            printf("HID receive mouse report description\r\n");
+            tuh_hid_allocate_info(dev_addr, instance, has_report_id, &handle_mouse_report, NULL);
+            break;
+          }
+          case HID_USAGE_DESKTOP_GAMEPAD: {
+            printf("HID receive gamepad report description\r\n");
+            tuh_hid_allocate_info(dev_addr, instance, has_report_id, &handle_gamepad_report, NULL);
+            // May be able to handle this in the same was as a the joystick. Needs a little investigation
+            break;
+          }
+          default: {
+            TU_LOG1("HID usage unknown usage:%d\r\n", report->usage);
+            break;
+          }
+        }
+      }
+    }  
   }
 
   // request to receive report
@@ -93,6 +189,9 @@ void tuh_hid_mount_cb(uint8_t dev_addr, uint8_t instance, uint8_t const* desc_re
 void tuh_hid_umount_cb(uint8_t dev_addr, uint8_t instance)
 {
   printf("HID device address = %d, instance = %d is unmounted\r\n", dev_addr, instance);
+
+  // Invoke unmount functions and free up host info structure
+  tuh_hid_free_info(dev_addr, instance);
 }
 
 // Invoked when received report from device via interrupt endpoint
@@ -113,6 +212,7 @@ void tuh_hid_report_received_cb(uint8_t dev_addr, uint8_t instance, uint8_t cons
     break;
 
     default:
+      TU_LOG2("HID receive boot generic report\r\n");
       // Generic report requires matching ReportID and contents with previous parsed report info
       process_generic_report(dev_addr, instance, report, len);
     break;
@@ -234,66 +334,22 @@ static void process_mouse_report(hid_mouse_report_t const * report)
 //--------------------------------------------------------------------+
 static void process_generic_report(uint8_t dev_addr, uint8_t instance, uint8_t const* report, uint16_t len)
 {
-  (void) dev_addr;
-  (void) len;
-
-  uint8_t const rpt_count = hid_info[instance].report_count;
-  tuh_hid_report_info_t* rpt_info_arr = hid_info[instance].report_info;
-  tuh_hid_report_info_t* rpt_info = NULL;
-
-  if ( rpt_count == 1 && rpt_info_arr[0].report_id == 0)
-  {
-    // Simple report without report ID as 1st byte
-    rpt_info = &rpt_info_arr[0];
-  }else
+  tusb_hid_host_info_t* info = tuh_hid_get_info(dev_addr, instance);
+
+  if (info == NULL)
   {
-    // Composite report, 1st byte is report ID, data starts from 2nd byte
-    uint8_t const rpt_id = report[0];
-
-    // Find report id in the array
-    for(uint8_t i=0; i<rpt_count; i++)
-    {
-      if (rpt_id == rpt_info_arr[i].report_id )
-      {
-        rpt_info = &rpt_info_arr[i];
-        break;
-      }
-    }
-
-    report++;
-    len--;
-  }
-
-  if (!rpt_info)
-  {
-    printf("Couldn't find report info !\r\n");
+    printf("Couldn't find the host report info for dev_addr=%d instance=%d\r\n", dev_addr, instance);
     return;
   }
+
+  uint8_t rpt_id = 0;
 
-  // For complete list of Usage Page & Usage checkout src/class/hid/hid.h. For examples:
-  // - Keyboard                     : Desktop, Keyboard
-  // - Mouse                        : Desktop, Mouse
-  // - Gamepad                      : Desktop, Gamepad
-  // - Consumer Control (Media Key) : Consumer, Consumer Control
-  // - System Control (Power key)   : Desktop, System Control
-  // - Generic (vendor)             : 0xFFxx, xx
-  if ( rpt_info->usage_page == HID_USAGE_PAGE_DESKTOP )
-  {
-    switch (rpt_info->usage)
-    {
-      case HID_USAGE_DESKTOP_KEYBOARD:
-        TU_LOG1("HID receive keyboard report\r\n");
-        // Assume keyboard follow boot report layout
-        process_kbd_report( (hid_keyboard_report_t const*) report );
-      break;
-
-      case HID_USAGE_DESKTOP_MOUSE:
-        TU_LOG1("HID receive mouse report\r\n");
-        // Assume mouse follow boot report layout
-        process_mouse_report( (hid_mouse_report_t const*) report );
-      break;
-
-      default: break;
-    }
+  if (info->has_report_id) {
+    rpt_id = report[0];
+    report++;
+    len--;       
   }
+
+  // TODO check if the length should be 16 bits
+  info->handler(info, report, (uint8_t)len, rpt_id);
 }

examples/host/cdc_msc_hid/src/hid_host_common.c

@@ -0,0 +1,59 @@
+#include "hid_host_common.h"
+
+void tuh_hid_simple_init_axis(
+  tusb_hid_simple_axis_t* simple_axis)
+{
+  simple_axis->start = 0;
+  simple_axis->length = 0;
+  simple_axis->flags.is_signed = true;
+  simple_axis->logical_min = -1;
+  simple_axis->logical_max = 1;
+}
+
+// Fetch some data from the HID parser
+//
+// The data fetched here may be relevant to multiple usage items
+//
+// returns false if obviously not of interest
+bool tuh_hid_get_simple_input_data(
+  tuh_hid_rip_state_t *pstate,        // The current HID report parser state
+  const uint8_t* ri_input,            // Pointer to the input item we have arrived at
+  tuh_hid_simple_input_data_t* data)  // Data structure to complete
+{
+  const uint8_t* ri_report_size = tuh_hid_rip_global(pstate, RI_GLOBAL_REPORT_SIZE);
+  const uint8_t* ri_report_count = tuh_hid_rip_global(pstate, RI_GLOBAL_REPORT_COUNT);
+  const uint8_t* ri_report_id = tuh_hid_rip_global(pstate, RI_GLOBAL_REPORT_ID);
+  const uint8_t* ri_logical_min = tuh_hid_rip_global(pstate, RI_GLOBAL_LOGICAL_MIN);
+  const uint8_t* ri_logical_max = tuh_hid_rip_global(pstate, RI_GLOBAL_LOGICAL_MAX);
+  const uint8_t* ri_usage_page = tuh_hid_rip_global(pstate, RI_GLOBAL_USAGE_PAGE);
+  const uint8_t* ri_usage_min = tuh_hid_rip_local(pstate, RI_LOCAL_USAGE_MIN);
+  const uint8_t* ri_usage_max = tuh_hid_rip_local(pstate, RI_LOCAL_USAGE_MAX);
+
+  // We need to know how the size of the data
+  if (ri_report_size == NULL || ri_report_count == NULL || ri_usage_page == NULL) return false;
+
+  data->report_size = tuh_hid_ri_short_udata32(ri_report_size);
+  data->report_count = tuh_hid_ri_short_udata32(ri_report_count);
+  data->report_id = ri_report_id ? tuh_hid_ri_short_udata8(ri_report_id) : 0;
+  data->logical_min = ri_logical_min ? tuh_hid_ri_short_data32(ri_logical_min) : 0;
+  data->logical_max = ri_logical_max ? tuh_hid_ri_short_data32(ri_logical_max) : 0;
+  data->input_flags.byte = tuh_hid_ri_short_udata8(ri_input);
+  data->usage_page = (uint16_t)tuh_hid_ri_short_udata32(ri_usage_page);
+  data->usage_min = ri_usage_min ? (uint16_t)tuh_hid_ri_short_udata32(ri_usage_min) : 0;
+  data->usage_max = ri_usage_max ? (uint16_t)tuh_hid_ri_short_udata32(ri_usage_max) : 0;
+  data->usage_is_range = (ri_usage_min != NULL) && (ri_usage_max != NULL);
+
+  return true;
+}
+
+void tuh_hid_process_simple_axis(
+  tuh_hid_simple_input_data_t* jdata,
+  uint32_t bitpos,
+  tusb_hid_simple_axis_t* simple_axis)
+{
+  simple_axis->start = (uint16_t)bitpos;
+  simple_axis->length = (uint16_t)jdata->report_size;
+  simple_axis->flags.is_signed = jdata->logical_min < 0;
+  simple_axis->logical_min = jdata->logical_min;
+  simple_axis->logical_max = jdata->logical_max;
+}