add tud_hid_mode_changed_cb()

src/class/hid/hid_device.c

@@ -41,17 +41,15 @@
 
 #define REPORT_BUFSIZE     16
 
-#define ITF_IDX_GENERIC    0
-
 typedef struct
 {
   uint8_t itf_num;
   uint8_t ep_in;
 
-  uint8_t idle_rate;  // Idle Rate = 0 : only send report if there is changes, i.e skip duplication
+  uint8_t idle_rate;     // Idle Rate = 0 : only send report if there is changes, i.e skip duplication
-                      // Idle Rate > 0 : skip duplication, but send at least 1 report every idle rate (in unit of 4 ms).
+                         // Idle Rate > 0 : skip duplication, but send at least 1 report every idle rate (in unit of 4 ms).
-                      //                 If idle time is less than interrupt polling then use the polling.
+                         //                 If idle time is less than interrupt polling then use the polling.
-  uint8_t boot_protocol;
+  uint8_t boot_protocol; // Boot mouse or keyboard
   bool    boot_mode;
 
   uint16_t reprot_desc_len;
@@ -77,7 +75,8 @@ static inline hidd_interface_t* get_interface_by_itfnum(uint8_t itf_num)
 //--------------------------------------------------------------------+
 bool tud_hid_ready(void)
 {
-  uint8_t const ep_in = _hidd_itf[ITF_IDX_GENERIC].ep_in;
+  uint8_t itf = 0;
+  uint8_t const ep_in = _hidd_itf[itf].ep_in;
   return tud_ready() && (ep_in != 0) && !dcd_edpt_busy(TUD_OPT_RHPORT, ep_in);
 }
 
@@ -85,7 +84,8 @@ bool tud_hid_report(uint8_t report_id, void const* report, uint8_t len)
 {
   TU_VERIFY( tud_hid_ready() && (len < REPORT_BUFSIZE) );
 
-  hidd_interface_t * p_hid = &_hidd_itf[ITF_IDX_GENERIC];
+  uint8_t itf = 0;
+  hidd_interface_t * p_hid = &_hidd_itf[itf];
 
   // If report id = 0, skip ID field
   if (report_id)
@@ -103,8 +103,8 @@ bool tud_hid_report(uint8_t report_id, void const* report, uint8_t len)
 
 bool tud_hid_boot_mode(void)
 {
-  hidd_interface_t * p_hid = &_hidd_itf[ITF_IDX_GENERIC];
+  uint8_t itf = 0;
-  return p_hid->boot_mode;
+  return _hidd_itf[itf].boot_mode;
 }
 
 //--------------------------------------------------------------------+
@@ -114,7 +114,9 @@ bool tud_hid_boot_mode(void)
 static bool hidd_kbd_report(hid_keyboard_report_t const *p_report)
 {
   TU_VERIFY( tud_hid_ready() );
-  hidd_interface_t * p_hid = &_hidd_itf[ITF_IDX_GENERIC];
+
+  uint8_t itf = 0;
+  hidd_interface_t * p_hid = &_hidd_itf[itf];
 
   // only send report if there is changes, i.e skip duplication
 //  if ( _kbd_rpt.idle_rate == 0 )
@@ -168,7 +170,8 @@ static bool hidd_mouse_report(hid_mouse_report_t const *p_report)
 {
   TU_VERIFY( tud_hid_ready() );
 
-  hidd_interface_t * p_hid = &_hidd_itf[ITF_IDX_GENERIC];
+  uint8_t itf = 0;
+  hidd_interface_t * p_hid = &_hidd_itf[itf];
 
 // only send report if there is changes, i.e skip duplication
   memcpy(p_hid->report_buf, p_report, sizeof(hid_mouse_report_t));
@@ -194,7 +197,9 @@ bool tud_hid_mouse_move(int8_t x, int8_t y)
 {
   TU_VERIFY( tud_hid_mouse_ready() );
 
-  hidd_interface_t * p_hid = &_hidd_itf[ITF_IDX_GENERIC];
+  uint8_t itf = 0;
+  hidd_interface_t * p_hid = &_hidd_itf[itf];
+
   uint8_t prev_buttons = p_hid->report_buf[0];
 
   return tud_hid_mouse_data(prev_buttons, x, y, 0, 0);
@@ -204,7 +209,9 @@ bool tud_hid_mouse_scroll(int8_t vertical, int8_t horizontal)
 {
   TU_VERIFY( tud_hid_mouse_ready() );
 
-  hidd_interface_t * p_hid = &_hidd_itf[ITF_IDX_GENERIC];
+  uint8_t itf = 0;
+  hidd_interface_t * p_hid = &_hidd_itf[itf];
+
   uint8_t prev_buttons = p_hid->report_buf[0];
 
   return tud_hid_mouse_data(prev_buttons, 0, 0, vertical, horizontal);
@@ -246,7 +253,8 @@ bool hidd_open(uint8_t rhport, tusb_desc_interface_t const * desc_itf, uint16_t
   TU_ASSERT(dcd_edpt_open(rhport, desc_edpt));
 
   // TODO support multiple HID interface
-  hidd_interface_t * p_hid = &_hidd_itf[0];
+  uint8_t itf = 0;
+  hidd_interface_t * p_hid = &_hidd_itf[itf];
 
   if ( desc_itf->bInterfaceSubClass == HID_SUBCLASS_BOOT ) p_hid->boot_protocol = desc_itf->bInterfaceProtocol;
 
@@ -324,6 +332,9 @@ bool hidd_control_request(uint8_t rhport, tusb_control_request_t const * p_reque
 
       case HID_REQ_CONTROL_SET_PROTOCOL:
         p_hid->boot_mode = 1 - p_request->wValue; // 0 is Boot, 1 is Report protocol
+
+        if (tud_hid_mode_changed_cb) tud_hid_mode_changed_cb(p_hid->boot_mode);
+
         usbd_control_status(rhport, p_request);
       break;
 

src/class/hid/hid_device.h

@@ -52,7 +52,7 @@
 
 
 //--------------------------------------------------------------------+
-// HID GENERIC API
+// Application API
 //--------------------------------------------------------------------+
 
 /** Check if the interface is ready to use
@@ -62,6 +62,7 @@
 bool tud_hid_ready(void);
 bool tud_hid_report(uint8_t report_id, void const* report, uint8_t len);
 
+// Check if current mode is Boot (true) or Report (false)
 bool tud_hid_boot_mode(void);
 
 /*------------- Callbacks (Weak is optional) -------------*/
@@ -87,15 +88,12 @@ uint16_t tud_hid_get_report_cb(uint8_t report_id, hid_report_type_t report_type,
  */
 void     tud_hid_set_report_cb(uint8_t report_id, hid_report_type_t report_type, uint8_t const* buffer, uint16_t bufsize);
 
+ATTR_WEAK void tud_hid_mode_changed_cb(uint8_t boot_mode);
+
 //--------------------------------------------------------------------+
 // KEYBOARD API
 //--------------------------------------------------------------------+
 #if CFG_TUD_HID_KEYBOARD
-/** \addtogroup ClassDriver_HID_Keyboard Keyboard
- *  @{ */
-/** \defgroup Keyboard_Device Device
- *  @{ */
-
 bool tud_hid_keyboard_keycode(uint8_t modifier, uint8_t keycode[6]);
 
 static inline bool tud_hid_keyboard_key_release(void) { return tud_hid_keyboard_keycode(0, NULL); }
@@ -112,22 +110,10 @@ extern const hid_ascii_to_keycode_entry_t HID_ASCII_TO_KEYCODE[128];
 
 #endif
 
-/*------------- Callbacks (Weak is optional) -------------*/
-
-//ATTR_WEAK void tud_hid_keyboard_set_protocol_cb(bool boot_protocol);
-
-/** @} */
-/** @} */
-
 //--------------------------------------------------------------------+
 // MOUSE API
 //--------------------------------------------------------------------+
 #if CFG_TUD_HID_MOUSE
-/** \addtogroup ClassDriver_HID_Mouse Mouse
- *  @{ */
-/** \defgroup Mouse_Device Device
- *  @{ */
-
 bool tud_hid_mouse_data(uint8_t buttons, int8_t x, int8_t y, int8_t scroll, int8_t pan);
 
 bool tud_hid_mouse_move(int8_t x, int8_t y);
@@ -143,8 +129,6 @@ static inline bool tud_hid_mouse_button_release(void)
   return tud_hid_mouse_data(0, 0, 0, 0, 0);
 }
 
-//ATTR_WEAK void tud_hid_mouse_set_protocol_cb(bool boot_protocol);
-
 #endif
 
 
@@ -314,15 +298,11 @@ static inline bool tud_hid_mouse_button_release(void)
     HID_INPUT        ( HID_DATA | HID_VARIABLE | HID_ABSOLUTE ) ,\
   HID_COLLECTION_END \
 
-
-
 /** @} */
 /** @} */
 
-
-
 //--------------------------------------------------------------------+
-// INTERNAL API
+// Internal Class Driver API
 //--------------------------------------------------------------------+
 void hidd_init(void);
 bool hidd_open(uint8_t rhport, tusb_desc_interface_t const * itf_desc, uint16_t *p_length);