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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
|
/***************************************************************************
* Copyright (c) 2024 Microsoft Corporation
* Copyright (c) 2026-present Eclipse ThreadX contributors
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** USBX Component */
/** */
/** PIMA Class */
/** */
/**************************************************************************/
/**************************************************************************/
/* Include necessary system files. */
#define UX_SOURCE_CODE
#include "ux_api.h"
#include "ux_host_class_pima.h"
#include "ux_host_stack.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_host_class_pima_device_info_get PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function gets the device information block. */
/* */
/* INPUT */
/* */
/* pima Pointer to pima class */
/* pima_device Device structure to fill */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_class_pima_command Pima command function */
/* _ux_utility_descriptor_parse Unpack descriptor */
/* _ux_utility_memory_allocate Allocate memory */
/* _ux_utility_memory_copy Copy memory */
/* _ux_utility_memory_free Free allocated memory */
/* _ux_utility_short_get Get 16-bit value */
/* _ux_utility_long_get Get 32-bit value */
/* */
/* CALLED BY */
/* */
/* USB application */
/* */
/**************************************************************************/
UINT _ux_host_class_pima_device_info_get(UX_HOST_CLASS_PIMA *pima,
UX_HOST_CLASS_PIMA_DEVICE *pima_device)
{
UX_HOST_CLASS_PIMA_COMMAND command;
UCHAR *device_buffer;
UCHAR *device_pointer;
ULONG unicode_string_length;
ULONG array_length = 0;
UINT status;
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_CLASS_PIMA_DEVICE_INFO_GET, pima, pima_device, 0, 0, UX_TRACE_HOST_CLASS_EVENTS, 0, 0)
/* Issue command to get the device info. no parameter. */
command.ux_host_class_pima_command_nb_parameters = 0;
/* Other parameters unused. */
command.ux_host_class_pima_command_parameter_1 = 0;
command.ux_host_class_pima_command_parameter_2 = 0;
command.ux_host_class_pima_command_parameter_3 = 0;
command.ux_host_class_pima_command_parameter_4 = 0;
command.ux_host_class_pima_command_parameter_5 = 0;
/* Then set the command to GET_DEVICE_INFO. */
command.ux_host_class_pima_command_operation_code = UX_HOST_CLASS_PIMA_OC_GET_DEVICE_INFO;
/* Allocate some DMA safe memory for receiving the device info block. */
device_buffer = _ux_utility_memory_allocate(UX_SAFE_ALIGN, UX_CACHE_SAFE_MEMORY, UX_HOST_CLASS_PIMA_DEVICE_MAX_LENGTH);
if (device_buffer == UX_NULL)
return(UX_MEMORY_INSUFFICIENT);
/* Issue the command. */
status = _ux_host_class_pima_command(pima, &command, UX_HOST_CLASS_PIMA_DATA_PHASE_IN , device_buffer,
UX_HOST_CLASS_PIMA_DEVICE_MAX_LENGTH, UX_HOST_CLASS_PIMA_DEVICE_MAX_LENGTH);
/* Check the result. If the result is OK, the device info block was read properly. */
if (status == UX_SUCCESS)
{
/* Read and store the Standard Version field (2). */
pima_device -> ux_host_class_pima_device_standard_version = _ux_utility_short_get(device_buffer +
UX_HOST_CLASS_PIMA_DEVICE_STANDARD_VERSION);
/* Read and store the Vendor Extension ID (4). */
pima_device -> ux_host_class_pima_device_vendor_extension_id = _ux_utility_long_get(device_buffer +
UX_HOST_CLASS_PIMA_DEVICE_VENDOR_EXTENSION_ID);
/* Read and store the Vendor Extension Version (2). */
pima_device -> ux_host_class_pima_device_vendor_extension_version = _ux_utility_long_get(device_buffer +
UX_HOST_CLASS_PIMA_DEVICE_VENDOR_EXTENSION_VERSION);
/* Copy the vendor extension descriptor (String). */
device_pointer = device_buffer + UX_HOST_CLASS_PIMA_DEVICE_VENDOR_EXTENSION_DESC;
/* Get the unicode string length in chars. */
unicode_string_length = (ULONG) *device_pointer;
/* Check if the string can fit in our buffer. */
if (unicode_string_length > UX_HOST_CLASS_PIMA_UNICODE_MAX_LENGTH / 2)
/* Return error. */
status = UX_MEMORY_INSUFFICIENT;
/* Is there enough space? */
if (status == UX_SUCCESS)
{
/* Copy that unicode string (with null ending) into the object description field. */
_ux_utility_memory_copy(pima_device -> ux_host_class_pima_device_vendor_extension_desc, device_pointer + 1, unicode_string_length << 1); /* Use case of memcpy is verified. */
/* Point to the next field. */
device_pointer += 1 + (unicode_string_length << 1);
/* Read and store the Functional Mode (2). */
pima_device -> ux_host_class_pima_device_functional_mode = _ux_utility_short_get(device_pointer);
/* Point to the next field (OperationsSupported OperationCode Array of 16-bit). */
device_pointer += sizeof(USHORT);
/* Get the number of elements in array and compute total length. */
array_length = _ux_utility_long_get(device_pointer);
if (array_length > (UX_HOST_CLASS_PIMA_ARRAY_MAX_LENGTH - sizeof(ULONG)) / 2)
status = UX_MEMORY_INSUFFICIENT;
else
{
array_length <<= 1;
array_length += (ULONG)sizeof(ULONG);
}
}
/* Is there enough space? */
if (status == UX_SUCCESS)
{
/* Copy the array of supported operations (OperationCode). */
_ux_utility_memory_copy(pima_device -> ux_host_class_pima_device_operations_supported, device_pointer, array_length); /* Use case of memcpy is verified. */
/* Point to the next field (EventsSupported EventCode Array of 16-bit). */
device_pointer += array_length;
/* Get the number of elements in array and compute total length. */
array_length = _ux_utility_long_get(device_pointer);
if (array_length > (UX_HOST_CLASS_PIMA_ARRAY_MAX_LENGTH - sizeof(ULONG)) / 2)
status = UX_MEMORY_INSUFFICIENT;
else
{
array_length <<= 1;
array_length += (ULONG)sizeof(ULONG);
}
}
/* Is there enough space? */
if (status == UX_SUCCESS)
{
/* Copy the array of events supported (EventCode). */
_ux_utility_memory_copy(pima_device -> ux_host_class_pima_device_events_supported, device_pointer, array_length); /* Use case of memcpy is verified. */
/* Point to the next field (DevicePropertiesSupported DevicePropCode Array of 16-bit). */
device_pointer += array_length;
/* Get the number of elements in array and compute total length. */
array_length = _ux_utility_long_get(device_pointer);
if (array_length > (UX_HOST_CLASS_PIMA_ARRAY_MAX_LENGTH - sizeof(ULONG)) / 2)
status = UX_MEMORY_INSUFFICIENT;
else
{
array_length <<= 1;
array_length += (ULONG)sizeof(ULONG);
}
}
/* Is there enough space? */
if (status == UX_SUCCESS)
{
/* Copy the array of device properties (DevicePropCode). */
_ux_utility_memory_copy(pima_device -> ux_host_class_pima_device_properties_supported, device_pointer, array_length); /* Use case of memcpy is verified. */
/* Point to the next field (CaptureFormats ObjectFormatCode Array of 16-bit). */
device_pointer += array_length;
/* Get the number of elements in array and compute total length. */
array_length = _ux_utility_long_get(device_pointer);
if (array_length > (UX_HOST_CLASS_PIMA_ARRAY_MAX_LENGTH - sizeof(ULONG)) / 2)
status = UX_MEMORY_INSUFFICIENT;
else
{
array_length <<= 1;
array_length += (ULONG)sizeof(ULONG);
}
}
/* Is there enough space? */
if (status == UX_SUCCESS)
{
/* Copy the array of capture formats (CaptureFormats ObjectFormatCode). */
_ux_utility_memory_copy(pima_device -> ux_host_class_pima_device_capture_formats, device_pointer, array_length); /* Use case of memcpy is verified. */
/* Point to the next field (ImageFormats ObjectFormatCode Array of 16-bit). */
device_pointer += array_length;
/* Get the number of elements in array and compute total length. */
array_length = _ux_utility_long_get(device_pointer);
if (array_length > (UX_HOST_CLASS_PIMA_ARRAY_MAX_LENGTH - sizeof(ULONG)) / 2)
status = UX_MEMORY_INSUFFICIENT;
else
{
array_length <<= 1;
array_length += (ULONG)sizeof(ULONG);
}
}
/* Is there enough space? */
if (status == UX_SUCCESS)
{
/* Copy the array of supported operations (ImageFormats ObjectFormatCode). */
_ux_utility_memory_copy(pima_device -> ux_host_class_pima_device_image_formats, device_pointer, array_length); /* Use case of memcpy is verified. */
/* Point to the next field (Manufacturer String). */
device_pointer += array_length;
/* Get the unicode string length. */
unicode_string_length = (ULONG) *device_pointer;
/* Ensure the string can fit in our buffer. */
if (unicode_string_length > UX_HOST_CLASS_PIMA_UNICODE_MAX_LENGTH / 2)
/* Return overflow error. */
status = UX_MEMORY_INSUFFICIENT;
}
/* Is there enough space? */
if (status == UX_SUCCESS)
{
/* Copy that string into the manufacturer field (Manufacturer String). */
_ux_utility_memory_copy(pima_device -> ux_host_class_pima_device_manufacturer, device_pointer + 1, unicode_string_length << 1); /* Use case of memcpy is verified. */
/* Point to the next field (Model String). */
device_pointer += (unicode_string_length << 1) + 1;
/* Get the unicode string length. */
unicode_string_length = (ULONG) *device_pointer ;
/* Ensure the string can fit in our buffer. */
if (unicode_string_length > UX_HOST_CLASS_PIMA_DATE_TIME_STRING_MAX_LENGTH / 2)
/* Return overflow error. */
status = UX_MEMORY_INSUFFICIENT;
}
/* Is there enough space? */
if (status == UX_SUCCESS)
{
/* Copy that string into the model date field (Model String). */
_ux_utility_memory_copy(pima_device -> ux_host_class_pima_device_model, device_pointer + 1, unicode_string_length << 1); /* Use case of memcpy is verified. */
/* Point to the next field (DeviceVersion String). */
device_pointer += (unicode_string_length << 1) + 1;
/* Get the unicode string length. */
unicode_string_length = (ULONG) *device_pointer ;
/* Ensure the string can fit in our buffer. */
if (unicode_string_length > UX_HOST_CLASS_PIMA_DATE_TIME_STRING_MAX_LENGTH / 2)
/* Return overflow error. */
status = UX_MEMORY_INSUFFICIENT;
}
/* Is there enough space? */
if (status == UX_SUCCESS)
{
/* Copy that string into the version field (DeviceVersion String). */
_ux_utility_memory_copy(pima_device -> ux_host_class_pima_device_version, device_pointer + 1, unicode_string_length << 1); /* Use case of memcpy is verified. */
/* Point to the next field (SerialNumber String). */
device_pointer += (unicode_string_length << 1) + 1;
/* Get the unicode string length. */
unicode_string_length = (ULONG) *device_pointer ;
/* Ensure the string can fit in our buffer. */
if (unicode_string_length > UX_HOST_CLASS_PIMA_UNICODE_MAX_LENGTH / 2)
/* Return overflow error. */
status = UX_MEMORY_INSUFFICIENT;
}
/* Is there enough space? */
if (status == UX_SUCCESS)
/* Copy that string into the serial number field (SerialNumber String). */
_ux_utility_memory_copy(pima_device -> ux_host_class_pima_device_serial_number, device_pointer + 1, unicode_string_length << 1); /* Use case of memcpy is verified. */
else
{
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_MEMORY_INSUFFICIENT, 0, 0, 0, UX_TRACE_ERRORS, 0, 0)
/* Report error to application. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_MEMORY_INSUFFICIENT);
}
}
/* Free the original object info buffer. */
_ux_utility_memory_free(device_buffer);
/* Return completion status. */
return(status);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _uxe_host_class_pima_device_info_get PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Yajun Xia, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function checks errors in pima device info get function call. */
/* */
/* INPUT */
/* */
/* pima Pointer to pima class */
/* pima_device Device structure to fill */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_class_pima_device_info_get Get pima device info */
/* */
/* CALLED BY */
/* */
/* USB application */
/* */
/**************************************************************************/
UINT _uxe_host_class_pima_device_info_get(UX_HOST_CLASS_PIMA *pima,
UX_HOST_CLASS_PIMA_DEVICE *pima_device)
{
/* Sanity Checks. */
if ((pima == UX_NULL) || (pima_device == UX_NULL))
return(UX_INVALID_PARAMETER);
/* Call the actual pima device info get function. */
return(_ux_host_class_pima_device_info_get(pima, pima_device));
}
|
