reworking device hid class driver

6 files changed, 63 insertions, 48 deletions

diff --git a/examples/device/device_virtual_com/src/tusb_config.h b/examples/device/device_virtual_com/src/tusb_config.h
index 511b81b78..38930505b 100644
--- a/examples/device/device_virtual_com/src/tusb_config.h
+++ b/examples/device/device_virtual_com/src/tusb_config.h
@@ -77,7 +77,6 @@
 #define CFG_TUD_MSC               0
 #define CFG_TUD_HID_KEYBOARD      0
 #define CFG_TUD_HID_MOUSE         0
-#define CFG_TUD_HID_GENERIC       0 // not supported yet
 
 
 /*------------------------------------------------------------------*/
diff --git a/examples/device/nrf52840/src/tusb_config.h b/examples/device/nrf52840/src/tusb_config.h
index 62c788413..da7dc793b 100644
--- a/examples/device/nrf52840/src/tusb_config.h
+++ b/examples/device/nrf52840/src/tusb_config.h
@@ -43,61 +43,60 @@
  extern "C" {
 #endif
 
-//--------------------------------------------------------------------+
+//--------------------------------------------------------------------
 // COMMON CONFIGURATION
-//--------------------------------------------------------------------+
-#define CFG_TUSB_MCU              OPT_MCU_NRF5X
-#define CFG_TUSB_RHPORT0_MODE     OPT_MODE_DEVICE
+//--------------------------------------------------------------------
+#define CFG_TUSB_MCU                OPT_MCU_NRF5X
+#define CFG_TUSB_RHPORT0_MODE       OPT_MODE_DEVICE
 
-#define CFG_TUSB_DEBUG            2
+#define CFG_TUSB_DEBUG              2
 
 /*------------- RTOS -------------*/
-#define CFG_TUSB_OS               OPT_OS_NONE // be passed from IDE/command line for easy project switching
+#define CFG_TUSB_OS                 OPT_OS_NONE // be passed from IDE/command line for easy project switching
 //#define CFG_TUD_TASK_PRIO         0
 //#define CFG_TUD_TASK_QUEUE_SZ     16
 //#define CFG_TUD_TASK_STACK_SZ     150
 
-//--------------------------------------------------------------------+
+//--------------------------------------------------------------------
 // DEVICE CONFIGURATION
-//--------------------------------------------------------------------+
+//--------------------------------------------------------------------
 
 /*------------- Core -------------*/
-#define CFG_TUD_DESC_AUTO         1
+#define CFG_TUD_DESC_AUTO           1
 
 // #define CFG_TUD_DESC_VID          0xCAFE
 // #define CFG_TUD_DESC_PID          0x0001
 
-#define CFG_TUD_ENDOINT0_SIZE     64
+#define CFG_TUD_ENDOINT0_SIZE       64
 
 //------------- CLASS -------------//
-#define CFG_TUD_CDC               1
-#define CFG_TUD_MSC               1
+#define CFG_TUD_CDC                 1
+#define CFG_TUD_MSC                 1
 
-#define CFG_TUD_HID_KEYBOARD      0 // TODO need update
-#define CFG_TUD_HID_MOUSE         0 // TODO need update
-#define CFG_TUD_HID_GENERIC       0 // TODO need update
+#define CFG_TUD_HID_KEYBOARD        1
+#define CFG_TUD_HID_MOUSE           1
 
-/*------------------------------------------------------------------*/
-/* CDC DEVICE
- *------------------------------------------------------------------*/
+//--------------------------------------------------------------------
+// CDC
+//--------------------------------------------------------------------
 
 // FIFO size of CDC TX and RX
-#define CFG_TUD_CDC_RX_BUFSIZE    64
-#define CFG_TUD_CDC_TX_BUFSIZE    64
+#define CFG_TUD_CDC_RX_BUFSIZE      64
+#define CFG_TUD_CDC_TX_BUFSIZE      64
 
 // TX is sent automatically every Start of Frame event.
 // If not enabled, application must call tud_cdc_write_flush() periodically
 #define CFG_TUD_CDC_FLUSH_ON_SOF    0
 
-/*------------------------------------------------------------------*/
-/* MSC DEVICE
- *------------------------------------------------------------------*/
+//--------------------------------------------------------------------
+// MSC
+//--------------------------------------------------------------------
 
 // Number of supported Logical Unit Number (At least 1)
-#define CFG_TUD_MSC_MAXLUN        1
+#define CFG_TUD_MSC_MAXLUN          1
 
 // Buffer size of Device Mass storage
-#define CFG_TUD_MSC_BUFSIZE       512
+#define CFG_TUD_MSC_BUFSIZE         512
 
 // Number of Blocks
 #define CFG_TUD_MSC_BLOCK_NUM       16
@@ -114,9 +113,22 @@
 // Product revision string included in Inquiry response, max 4 bytes
 #define CFG_TUD_MSC_PRODUCT_REV     "1.0"
 
-//--------------------------------------------------------------------+
+//--------------------------------------------------------------------
+// HID
+//--------------------------------------------------------------------
+
+/* Enable boot protocol will create separated HID interface for Keyboard,
+ * Consumer Key and Mouse --> require more In endpoints. Otherwise they
+ * are all packed into a single Multiple Report Interface.
+ *
+ * Note: If your device is meant to work with simple host running on
+ * an MCU (e.g with tinyusb host), boot protocol should be enabled.
+ */
+#define CFG_TUD_HID_BOOT_PROTOCOL   1
+
+//--------------------------------------------------------------------
 // USB RAM PLACEMENT
-//--------------------------------------------------------------------+
+//--------------------------------------------------------------------
 #define CFG_TUSB_ATTR_USBRAM
 #define CFG_TUSB_MEM_ALIGN          ATTR_ALIGNED(4)
 
diff --git a/examples/device/nrf52840/src/tusb_descriptors.c b/examples/device/nrf52840/src/tusb_descriptors.c
index e5d73333d..c088fec7f 100644
--- a/examples/device/nrf52840/src/tusb_descriptors.c
+++ b/examples/device/nrf52840/src/tusb_descriptors.c
@@ -57,11 +57,15 @@ uint16_t const * const string_desc_arr [] =
     // 3: Serials TODO use chip ID
     TUD_DESC_STRCONV('1', '2', '3', '4', '5', '6'),
 
+#if CFG_TUD_CDC
     // 4: CDC Interface
     TUD_DESC_STRCONV('t','u','s','b',' ','c','d','c'),
+#endif
 
+#if CFG_TUD_MSC
     // 5: MSC Interface
     TUD_DESC_STRCONV('t','u','s','b',' ','m','s','c'),
+#endif
 };
 
 // tud_desc_set is required by tinyusb stack
@@ -71,5 +75,11 @@ tud_desc_set_t tud_desc_set =
     .device     = NULL,
     .config     = NULL,
     .string_arr = (uint8_t const **) string_desc_arr,
-    .hid_report = NULL
+
+    .hid_report =
+    {
+        .composite     = NULL,
+        .boot_keyboard = NULL,
+        .boot_mouse    = NULL
+    }
 };
diff --git a/examples/obsolete/device/src/keyboard_device_app.c b/examples/obsolete/device/src/keyboard_device_app.c
index df9172c68..4e4de8996 100644
--- a/examples/obsolete/device/src/keyboard_device_app.c
+++ b/examples/obsolete/device/src/keyboard_device_app.c
@@ -77,21 +77,21 @@ void tud_hid_keyboard_cb(uint8_t rhport, tusb_event_t event, uint32_t xferred_by
   }
 }
 
-uint16_t tud_hid_keyboard_get_report_cb(uint8_t rhport, hid_request_report_type_t report_type, void** pp_report, uint16_t requested_length)
+uint16_t tud_hid_keyboard_get_report_cb(hid_report_type_t report_type, uint8_t* buffer, uint16_t reqlen)
 {
   // get other than input report is not supported by this keyboard demo
-  if ( report_type != HID_REQUEST_REPORT_INPUT ) return 0;
+  if ( report_type != HID_REPORT_TYPE_INPUT ) return 0;
 
-  (*pp_report) = &keyboard_report;
-  return requested_length;
+  memcpy(buffer, &keyboard_report, reqlen);
+  return reqlen;
 }
 
-void tud_hid_keyboard_set_report_cb(uint8_t rhport, hid_request_report_type_t report_type, uint8_t p_report_data[], uint16_t length)
+void tud_hid_keyboard_set_report_cb(hid_report_type_t report_type, uint8_t* buffer, uint16_t reqlen)
 {
   // set other than output report is not supported by this keyboard demo
-  if ( report_type != HID_REQUEST_REPORT_OUTPUT ) return;
+  if ( report_type != HID_REPORT_TYPE_OUTPUT ) return;
 
-  uint8_t kbd_led = p_report_data[0];
+  uint8_t kbd_led = buffer[0];
   uint32_t interval_divider = 1; // each LED will reduce blinking interval by a half
 
   if (kbd_led & KEYBOARD_LED_NUMLOCK   ) interval_divider *= 2;
diff --git a/examples/obsolete/device/src/mouse_device_app.c b/examples/obsolete/device/src/mouse_device_app.c
index 9bbb799df..d6145026a 100644
--- a/examples/obsolete/device/src/mouse_device_app.c
+++ b/examples/obsolete/device/src/mouse_device_app.c
@@ -77,17 +77,12 @@ void tud_hid_mouse_cb(uint8_t rhport, tusb_event_t event, uint32_t xferred_bytes
   }
 }
 
-uint16_t tud_hid_mouse_get_report_cb(uint8_t rhport, hid_request_report_type_t report_type, void** pp_report, uint16_t requested_length)
+uint16_t tud_hid_mouse_get_report_cb(hid_report_type_t report_type, uint8_t* buffer, uint16_t reqlen)
 {
-  if ( report_type != HID_REQUEST_REPORT_INPUT ) return 0; // not support other report type for this mouse demo
+  if ( report_type != HID_REPORT_TYPE_INPUT ) return 0; // not support other report type for this mouse demo
 
-  (*pp_report) =  &mouse_report;
-  return requested_length;
-}
-
-void tud_hid_mouse_set_report_cb(uint8_t rhport, hid_request_report_type_t report_type, uint8_t report_data[], uint16_t length)
-{
-  // mouse demo does not support set report --> do nothing
+  memcpy(buffer, &mouse_report, reqlen);
+  return reqlen;
 }
 
 //--------------------------------------------------------------------+
diff --git a/examples/obsolete/device/src/tusb_config.h b/examples/obsolete/device/src/tusb_config.h
index 8c8d32514..fc6807aef 100644
--- a/examples/obsolete/device/src/tusb_config.h
+++ b/examples/obsolete/device/src/tusb_config.h
@@ -72,11 +72,10 @@
 #define CFG_TUD_ENDOINT0_SIZE     64
 
 //------------- CLASS -------------//
-#define CFG_TUD_HID_KEYBOARD      0
-#define CFG_TUD_HID_MOUSE         0
-#define CFG_TUD_HID_GENERIC       0 // not supported yet
 #define CFG_TUD_MSC               1
 #define CFG_TUD_CDC               1
+#define CFG_TUD_HID_KEYBOARD      0
+#define CFG_TUD_HID_MOUSE         0
 
 /*------------------------------------------------------------------*/
 /* CLASS DRIVER