add host hid api to set/get protocol

Author: ayedm1

common/usbx_device_classes/inc/ux_device_class_hid.h

@@ -249,6 +249,7 @@ typedef struct UX_SLAVE_CLASS_HID_STRUCT
     UINT                            ux_device_class_hid_state;
     UINT                            (*ux_device_class_hid_callback)(struct UX_SLAVE_CLASS_HID_STRUCT *hid, UX_SLAVE_CLASS_HID_EVENT *);
     UINT                            (*ux_device_class_hid_get_callback)(struct UX_SLAVE_CLASS_HID_STRUCT *hid, UX_SLAVE_CLASS_HID_EVENT *);
+    VOID                            (*ux_device_class_hid_set_protocol_callback)(struct UX_SLAVE_CLASS_HID_STRUCT *hid, ULONG protocol);
     VOID                            (*ux_slave_class_hid_instance_activate)(VOID *);
     VOID                            (*ux_slave_class_hid_instance_deactivate)(VOID *);
     UCHAR                           *ux_device_class_hid_report_address;
@@ -365,6 +366,10 @@ typedef struct UX_SLAVE_CLASS_HID_PARAMETER_STRUCT
     ULONG                   ux_device_class_hid_parameter_report_length;
     UINT                    (*ux_device_class_hid_parameter_callback)(struct UX_SLAVE_CLASS_HID_STRUCT *hid, UX_SLAVE_CLASS_HID_EVENT *);
     UINT                    (*ux_device_class_hid_parameter_get_callback)(struct UX_SLAVE_CLASS_HID_STRUCT *hid, UX_SLAVE_CLASS_HID_EVENT *);
+
+    /* Optional callback invoked when protocol changes (boot/report).  */
+    VOID                    (*ux_device_class_hid_parameter_set_protocol_callback)(struct UX_SLAVE_CLASS_HID_STRUCT *hid, ULONG protocol);
+
 #if defined(UX_DEVICE_CLASS_HID_FLEXIBLE_EVENTS_QUEUE)
     ULONG                   ux_device_class_hid_parameter_event_max_number;
     ULONG                   ux_device_class_hid_parameter_event_max_length;

common/usbx_device_classes/src/ux_device_class_hid_control_request.c

@@ -205,15 +205,42 @@ UX_SLAVE_CLASS_HID          *hid;
 
         case UX_DEVICE_CLASS_HID_COMMAND_GET_PROTOCOL:
 
-            /* Send the protocol.  */
+            /* Only boot subclass devices should respond to GET_PROTOCOL.  */
+            if ((hid->ux_slave_class_hid_interface == UX_NULL) ||
+                (hid->ux_slave_class_hid_interface->ux_slave_interface_descriptor.bInterfaceSubClass != 0x01))
+            {
+                return (UX_ERROR);
+            }
+
+            /* Send the protocol to host. */
             *transfer_request -> ux_slave_transfer_request_data_pointer = (UCHAR)hid -> ux_device_class_hid_protocol;
             _ux_device_stack_transfer_request(transfer_request, 1, request_length);
             break;
 
         case UX_DEVICE_CLASS_HID_COMMAND_SET_PROTOCOL:
 
+            /* Check protocol must be 0 (Boot) or 1 (Report).  */
+            if ((request_value != UX_DEVICE_CLASS_HID_PROTOCOL_BOOT) &&
+                (request_value != UX_DEVICE_CLASS_HID_PROTOCOL_REPORT))
+            {
+                /* Invalid value: not handled. */
+                return (UX_ERROR);
+            }
+
+            /* Only boot subclass devices should respond to SET_PROTOCOL.  */
+            if ((hid->ux_slave_class_hid_interface == UX_NULL) ||
+                (hid->ux_slave_class_hid_interface->ux_slave_interface_descriptor.bInterfaceSubClass != 0x01))
+            {
+                return (UX_ERROR);
+            }
+
             /* Accept the protocol.  */
             hid -> ux_device_class_hid_protocol = request_value;
+
+            /* If there is a callback defined by the application, send the protocol to it.  */
+            if (hid -> ux_device_class_hid_set_protocol_callback != UX_NULL)
+                hid -> ux_device_class_hid_set_protocol_callback(hid, request_value);
+
             break;
 
         default:
@@ -225,4 +252,3 @@ UX_SLAVE_CLASS_HID          *hid;
     /* It's handled.  */
     return(UX_SUCCESS);
 }
-

common/usbx_device_classes/src/ux_device_class_hid_initialize.c

@@ -8,6 +8,7 @@
  * SPDX-License-Identifier: MIT
  **************************************************************************/
 
+
 /**************************************************************************/
 /**************************************************************************/
 /**                                                                       */
@@ -196,6 +197,7 @@ UCHAR                                   *buffer;
         /* Store the callback function.  */
         hid -> ux_device_class_hid_callback                   = hid_parameter -> ux_device_class_hid_parameter_callback;
         hid -> ux_device_class_hid_get_callback               = hid_parameter -> ux_device_class_hid_parameter_get_callback;
+        hid -> ux_device_class_hid_set_protocol_callback      = hid_parameter -> ux_device_class_hid_parameter_set_protocol_callback;
 
 #if defined(UX_DEVICE_CLASS_HID_FLEXIBLE_EVENTS_QUEUE)
 

common/usbx_host_classes/CMakeLists.txt

@@ -93,6 +93,8 @@ target_sources(${PROJECT_NAME} PRIVATE
 	${CMAKE_CURRENT_LIST_DIR}/src/ux_host_class_hid_idle_get.c
 	${CMAKE_CURRENT_LIST_DIR}/src/ux_host_class_hid_idle_set.c
 	${CMAKE_CURRENT_LIST_DIR}/src/ux_host_class_hid_idle_set_run.c
+	${CMAKE_CURRENT_LIST_DIR}/src/ux_host_class_hid_protocol_set.c
+	${CMAKE_CURRENT_LIST_DIR}/src/ux_host_class_hid_protocol_get.c
 	${CMAKE_CURRENT_LIST_DIR}/src/ux_host_class_hid_instance_clean.c
 	${CMAKE_CURRENT_LIST_DIR}/src/ux_host_class_hid_interrupt_endpoint_search.c
 	${CMAKE_CURRENT_LIST_DIR}/src/ux_host_class_hid_item_data_get.c