1 /***************************************************************************
2 * Copyright (c) 2024 Microsoft Corporation
3 *
4 * This program and the accompanying materials are made available under the
5 * terms of the MIT License which is available at
6 * https://opensource.org/licenses/MIT.
7 *
8 * SPDX-License-Identifier: MIT
9 **************************************************************************/
10
11 /**************************************************************************/
12 /**************************************************************************/
13 /** */
14 /** USBX Component */
15 /** */
16 /** Device HID Class */
17 /** */
18 /**************************************************************************/
19 /**************************************************************************/
20
21 #define UX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "ux_api.h"
27 #include "ux_device_class_hid.h"
28 #include "ux_device_stack.h"
29
30
31 /**************************************************************************/
32 /* */
33 /* FUNCTION RELEASE */
34 /* */
35 /* _ux_device_class_hid_entry PORTABLE C */
36 /* 6.1 */
37 /* AUTHOR */
38 /* */
39 /* Chaoqiong Xiao, Microsoft Corporation */
40 /* */
41 /* DESCRIPTION */
42 /* */
43 /* This function is the entry point of the hid class. It */
44 /* will be called by the device stack enumeration module when the */
45 /* host has sent a SET_CONFIGURATION command and the hid interface */
46 /* needs to be mounted. */
47 /* */
48 /* INPUT */
49 /* */
50 /* command Pointer to class command */
51 /* */
52 /* OUTPUT */
53 /* */
54 /* Completion Status */
55 /* */
56 /* CALLS */
57 /* */
58 /* _ux_device_class_hid_initialize Initialize hid class */
59 /* _ux_device_class_hid_uninitialize Uninitialize hid class */
60 /* _ux_device_class_hid_activate Activate hid class */
61 /* _ux_device_class_hid_deactivate Deactivate hid class */
62 /* _ux_device_class_hid_control_request Request control */
63 /* */
64 /* CALLED BY */
65 /* */
66 /* HID Class */
67 /* */
68 /* RELEASE HISTORY */
69 /* */
70 /* DATE NAME DESCRIPTION */
71 /* */
72 /* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
73 /* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
74 /* resulting in version 6.1 */
75 /* 10-31-2023 Chaoqiong Xiao Modified comment(s), */
76 /* added error checks support, */
77 /* resulting in version 6.3.0 */
78 /* */
79 /**************************************************************************/
_ux_device_class_hid_entry(UX_SLAVE_CLASS_COMMAND * command)80 UINT _ux_device_class_hid_entry(UX_SLAVE_CLASS_COMMAND *command)
81 {
82
83 UINT status;
84
85
86 /* The command request will tell us we need to do here, either a enumeration
87 query, an activation or a deactivation. */
88 switch (command -> ux_slave_class_command_request)
89 {
90
91 case UX_SLAVE_CLASS_COMMAND_INITIALIZE:
92
93 /* Call the init function of the HID class. */
94 #if defined(UX_DEVICE_CLASS_HID_ENABLE_ERROR_CHECKING)
95 status = _uxe_device_class_hid_initialize(command);
96 #else
97 status = _ux_device_class_hid_initialize(command);
98 #endif
99
100 /* Return the completion status. */
101 return(status);
102
103 case UX_SLAVE_CLASS_COMMAND_UNINITIALIZE:
104
105 /* Call the init function of the HID class. */
106 status = _ux_device_class_hid_uninitialize(command);
107
108 /* Return the completion status. */
109 return(status);
110
111 case UX_SLAVE_CLASS_COMMAND_QUERY:
112
113 /* Check the CLASS definition in the interface descriptor. */
114 if (command -> ux_slave_class_command_class == UX_DEVICE_CLASS_HID_CLASS)
115 return(UX_SUCCESS);
116 else
117 return(UX_NO_CLASS_MATCH);
118
119 case UX_SLAVE_CLASS_COMMAND_ACTIVATE:
120
121 /* The activate command is used when the host has sent a SET_CONFIGURATION command
122 and this interface has to be mounted. Both Bulk endpoints have to be mounted
123 and the hid thread needs to be activated. */
124 status = _ux_device_class_hid_activate(command);
125
126 /* Return the completion status. */
127 return(status);
128
129 case UX_SLAVE_CLASS_COMMAND_DEACTIVATE:
130
131 /* The deactivate command is used when the device has been extracted.
132 The device endpoints have to be dismounted and the hid thread canceled. */
133 status = _ux_device_class_hid_deactivate(command);
134
135 /* Return the completion status. */
136 return(status);
137
138 case UX_SLAVE_CLASS_COMMAND_REQUEST:
139
140 /* The request command is used when the host sends a command on the control endpoint. */
141 status = _ux_device_class_hid_control_request(command);
142
143 /* Return the completion status. */
144 return(status);
145
146 default:
147
148 /* If trace is enabled, insert this event into the trace buffer. */
149 UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_FUNCTION_NOT_SUPPORTED, 0, 0, 0, UX_TRACE_ERRORS, 0, 0)
150
151 /* Return an error. */
152 return(UX_FUNCTION_NOT_SUPPORTED);
153 }
154 }
155
156
