Outline ![]()
Files ![]()
loading...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** USBX Component */
/** */
/** HID Class */
/** */
/**************************************************************************/
/**************************************************************************/
/* Include necessary system files. */
#define UX_SOURCE_CODE
#include "ux_api.h"
#include "ux_host_class_hid.h"
#include "ux_host_stack.h"
#if !defined(UX_HOST_STANDALONE)
/* Inline the function to let compiler optimize. */
static inline
#else
/* Prototype the function to remove warnings. */
UINT ux_host_class_hid_report_set_buffer_allocate(
UX_HOST_CLASS_HID *hid, UX_HOST_CLASS_HID_CLIENT_REPORT *client_report,
UCHAR **allocated);
#endif
UINT ux_host_class_hid_report_set_buffer_allocate(
UX_HOST_CLASS_HID *hid, UX_HOST_CLASS_HID_CLIENT_REPORT *client_report,
UCHAR **allocated)
{
UX_HOST_CLASS_HID_REPORT *hid_report;
UCHAR *report_buffer;
UCHAR *current_report_buffer;
/* Get the report pointer from the caller. */
hid_report = client_report -> ux_host_class_hid_client_report;
/* Ensure this is NOT an INPUT report. */
if (hid_report -> ux_host_class_hid_report_type == UX_HOST_CLASS_HID_REPORT_TYPE_INPUT)
{
/* Return error code. */
return(UX_HOST_CLASS_HID_REPORT_ERROR);
}
/* Get some memory for sending the report. */
if (hid_report -> ux_host_class_hid_report_id == 0)
report_buffer = _ux_utility_memory_allocate(UX_SAFE_ALIGN, UX_CACHE_SAFE_MEMORY, hid_report -> ux_host_class_hid_report_byte_length);
else
report_buffer = _ux_utility_memory_allocate_add_safe(UX_SAFE_ALIGN, UX_CACHE_SAFE_MEMORY, hid_report -> ux_host_class_hid_report_byte_length, 1);
if (report_buffer == UX_NULL)
{
/* Return error code. */
return(UX_MEMORY_INSUFFICIENT);
}
/* Memorize the start of the real report buffer. */
current_report_buffer = report_buffer;
/* Check if there is a report ID to be inserted in front of the buffer. */
if (hid_report -> ux_host_class_hid_report_id != 0)
*current_report_buffer++ = (UCHAR)(hid_report -> ux_host_class_hid_report_id);
/* The report is in the client's buffer. It may be raw or or decompressed. If decompressed,
we need to create the report. */
if (client_report -> ux_host_class_hid_client_report_flags & UX_HOST_CLASS_HID_REPORT_RAW)
{
/* Ensure the user is not trying to overflow the report buffer. */
if (hid_report -> ux_host_class_hid_report_byte_length >= client_report -> ux_host_class_hid_client_report_length)
{
/* We have enough memory to store the raw buffer. */
_ux_utility_memory_copy(current_report_buffer, client_report -> ux_host_class_hid_client_report_buffer, hid_report -> ux_host_class_hid_report_byte_length); /* Use case of memcpy is verified. */
}
else
{
/* Free allocated buffer. */
_ux_utility_memory_free(report_buffer);
/* Return error code. */
return(UX_HOST_CLASS_HID_REPORT_OVERFLOW);
}
}
else
{
/* The report buffer has to be compressed. */
_ux_host_class_hid_report_compress(hid, client_report, current_report_buffer, client_report -> ux_host_class_hid_client_report_length);
}
/* Buffer is allocated and report data copied. */
*allocated = report_buffer;
return(UX_SUCCESS);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_host_class_hid_report_set PORTABLE C */
/* 6.1.10 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function sets a report (input/output/feature) to the device. */
/* The report can be either decompressed by the stack or raw. */
/* */
/* INPUT */
/* */
/* hid Pointer to HID class */
/* client_report Pointer to client report */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_class_hid_report_compress Compress HID report */
/* _ux_host_stack_class_instance_verify Verify the instance is valid */
/* _ux_host_stack_transfer_request Process transfer request */
/* _ux_utility_memory_allocate Allocate memory block */
/* _ux_utility_memory_copy Copy memory block */
/* _ux_utility_memory_free Release memory block */
/* _ux_host_semaphore_get Get protection semaphore */
/* _ux_host_semaphore_put Release protection semaphore */
/* */
/* CALLED BY */
/* */
/* Application */
/* HID Class */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
/* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
/* verified memset and memcpy */
/* cases, */
/* resulting in version 6.1 */
/* 01-31-2022 Xiuwen Cai, CQ Xiao Modified comment(s), */
/* added interrupt OUT support,*/
/* added standalone support, */
/* refined code sequence, */
/* resulting in version 6.1.10 */
/* */
/**************************************************************************/
UINT _ux_host_class_hid_report_set(UX_HOST_CLASS_HID *hid, UX_HOST_CLASS_HID_CLIENT_REPORT *client_report)
{
#if defined(UX_HOST_STANDALONE)
UINT status;
do
{
status = _ux_host_class_hid_report_set_run(hid, client_report);
} while(status == UX_STATE_WAIT || status == UX_STATE_LOCK);
return(hid -> ux_host_class_hid_status);
#else
UX_ENDPOINT *control_endpoint;
UX_TRANSFER *transfer_request;
UCHAR *report_buffer;
UX_HOST_CLASS_HID_REPORT *hid_report;
UINT status;
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_CLASS_HID_REPORT_SET, hid, client_report, 0, 0, UX_TRACE_HOST_CLASS_EVENTS, 0, 0)
/* Ensure the instance is valid. */
if (_ux_host_stack_class_instance_verify(_ux_system_host_class_hid_name, (VOID *) hid) != UX_SUCCESS)
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_HOST_CLASS_INSTANCE_UNKNOWN);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_HOST_CLASS_INSTANCE_UNKNOWN, hid, 0, 0, UX_TRACE_ERRORS, 0, 0)
return(UX_HOST_CLASS_INSTANCE_UNKNOWN);
}
/* Protect thread reentry to this instance. */
_ux_host_class_hid_lock_fail_return(hid);
/* Get the report pointer from the caller. */
hid_report = client_report -> ux_host_class_hid_client_report;
#if defined(UX_HOST_CLASS_HID_INTERRUPT_OUT_SUPPORT)
/* Check if there is an interrupt OUT endpoint. */
if (hid -> ux_host_class_hid_interrupt_out_endpoint != UX_NULL)
{
/* Transfer the report by using the interrupt OUT endpoint. */
transfer_request = &hid -> ux_host_class_hid_interrupt_out_endpoint -> ux_endpoint_transfer_request;
}
else
{
#endif
/* We need to get the default control endpoint transfer request pointer. */
control_endpoint = &hid -> ux_host_class_hid_device -> ux_device_control_endpoint;
transfer_request = &control_endpoint -> ux_endpoint_transfer_request;
/* Protect the control endpoint semaphore here. It will be unprotected in the
transfer request function. */
status = _ux_host_semaphore_get(&hid -> ux_host_class_hid_device -> ux_device_protection_semaphore, UX_WAIT_FOREVER);
/* Check for status. */
if (status != UX_SUCCESS)
{
/* Something went wrong. */
/* Unprotect thread reentry to this instance. */
_ux_host_class_hid_unlock(hid);
return(status);
}
#if defined(UX_HOST_CLASS_HID_INTERRUPT_OUT_SUPPORT)
}
#endif
/* Build the report buffer for SET_REPORT request. */
status = ux_host_class_hid_report_set_buffer_allocate(hid, client_report, &report_buffer);
if (status != UX_SUCCESS)
{
/* Unlock device control endpoint. */
_ux_host_semaphore_put(&hid -> ux_host_class_hid_device -> ux_device_protection_semaphore);
/* Unprotect thread reentry to this instance. */
_ux_host_class_hid_unlock(hid);
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, status);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, status, hid, 0, 0, UX_TRACE_ERRORS, 0, 0)
return(status);
}
/* Create a transfer request for the SET_REPORT request. */
transfer_request -> ux_transfer_request_data_pointer = report_buffer;
transfer_request -> ux_transfer_request_requested_length = hid_report -> ux_host_class_hid_report_byte_length;
transfer_request -> ux_transfer_request_function = UX_HOST_CLASS_HID_SET_REPORT;
transfer_request -> ux_transfer_request_type = UX_REQUEST_OUT | UX_REQUEST_TYPE_CLASS | UX_REQUEST_TARGET_INTERFACE;
transfer_request -> ux_transfer_request_value = (UINT)((USHORT) hid_report -> ux_host_class_hid_report_id | (USHORT) hid_report -> ux_host_class_hid_report_type << 8);
transfer_request -> ux_transfer_request_index = hid -> ux_host_class_hid_interface -> ux_interface_descriptor.bInterfaceNumber;
/* Send request to HCD layer. */
status = _ux_host_stack_transfer_request(transfer_request);
#if defined(UX_HOST_CLASS_HID_INTERRUPT_OUT_SUPPORT)
/* Check if interrupt OUT endpoint is used. */
if ((hid -> ux_host_class_hid_interrupt_out_endpoint != UX_NULL) && (status == UX_SUCCESS))
{
/* We need to wait for the completion of the transfer request. */
status = _ux_host_semaphore_get(&transfer_request -> ux_transfer_request_semaphore, UX_MS_TO_TICK(UX_HOST_CLASS_HID_REPORT_TRANSFER_TIMEOUT));
}
#endif
/* Check for correct transfer and the actual transfer length. */
if ((status != UX_SUCCESS) || (transfer_request -> ux_transfer_request_actual_length != hid_report -> ux_host_class_hid_report_byte_length))
{
#if defined(UX_HOST_CLASS_HID_INTERRUPT_OUT_SUPPORT)
/* Check if interrupt OUT endpoint is used. */
if ((hid -> ux_host_class_hid_interrupt_out_endpoint != UX_NULL) && (status != UX_SUCCESS))
{
/* We need to abort the transfer request. */
_ux_host_stack_transfer_request_abort(transfer_request);
}
#endif
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_HOST_CLASS_HID_REPORT_ERROR);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_HOST_CLASS_HID_REPORT_ERROR, hid, 0, 0, UX_TRACE_ERRORS, 0, 0)
status = UX_HOST_CLASS_HID_REPORT_ERROR;
}
/* Free all resources. */
_ux_utility_memory_free(report_buffer);
/* Unprotect thread reentry to this instance. */
_ux_host_class_hid_unlock(hid);
/* Return the function status */
return(status);
#endif
}