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
|
/***************************************************************************
* 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_object_info_send PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function sends an object information block prior to sending */
/* a new object. */
/* */
/* INPUT */
/* */
/* pima Pointer to pima class */
/* pima_session Pointer to pima session */
/* storage_id StorageID where to store */
/* parent_object_id Parent object id */
/* object Object info structure */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_class_pima_command Pima command function */
/* _ux_utility_memory_allocate Allocate memory */
/* _ux_utility_memory_copy Copy memory */
/* _ux_utility_memory_free Free allocated memory */
/* _ux_utility_descriptor_pack Pack descriptor */
/* */
/* CALLED BY */
/* */
/* USB application */
/* */
/**************************************************************************/
UINT _ux_host_class_pima_object_info_send(UX_HOST_CLASS_PIMA *pima,
UX_HOST_CLASS_PIMA_SESSION *pima_session,
ULONG storage_id,
ULONG parent_object_id,
UX_HOST_CLASS_PIMA_OBJECT *object)
{
UX_HOST_CLASS_PIMA_COMMAND command;
UCHAR *object_buffer;
UCHAR *object_buffer_end;
UCHAR *object_pointer;
ULONG unicode_string_length;
ULONG object_info_length;
UINT status;
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_CLASS_PIMA_OBJECT_INFO_SEND, pima, object, 0, 0, UX_TRACE_HOST_CLASS_EVENTS, 0, 0)
/* Check if this session is valid or not. */
if (pima_session -> ux_host_class_pima_session_magic != UX_HOST_CLASS_PIMA_MAGIC_NUMBER)
return (UX_HOST_CLASS_PIMA_RC_SESSION_NOT_OPEN);
/* Check if this session is opened or not. */
if (pima_session -> ux_host_class_pima_session_state != UX_HOST_CLASS_PIMA_SESSION_STATE_OPENED)
return (UX_HOST_CLASS_PIMA_RC_SESSION_NOT_OPEN);
/* Issue command to set the object info. 2 parameter. */
command.ux_host_class_pima_command_nb_parameters = 2;
/* Parameter 1 is the Storage ID. */
command.ux_host_class_pima_command_parameter_1 = storage_id;
/* Parameter 2 is the Parent Object ID. */
command.ux_host_class_pima_command_parameter_2 = parent_object_id;
/* Other parameters unused. */
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 SEND_OBJECT_INFO. */
command.ux_host_class_pima_command_operation_code = UX_HOST_CLASS_PIMA_OC_SEND_OBJECT_INFO;
/* Allocate some DMA safe memory for sending the object info block. */
object_buffer = _ux_utility_memory_allocate(UX_SAFE_ALIGN, UX_CACHE_SAFE_MEMORY, UX_HOST_CLASS_PIMA_OBJECT_MAX_LENGTH);
if (object_buffer == UX_NULL)
return(UX_MEMORY_INSUFFICIENT);
/* Get the end of the object buffer. */
object_buffer_end = object_buffer + UX_HOST_CLASS_PIMA_OBJECT_MAX_LENGTH;
/* The object info structure coming from the application needs to be packed. */
_ux_utility_descriptor_pack((UCHAR *) object,
_ux_system_class_pima_object_structure,
UX_HOST_CLASS_PIMA_OBJECT_ENTRIES,
object_buffer);
/* Copy the object filename field. Point to the beginning of the object description string. */
object_pointer = object_buffer + UX_HOST_CLASS_PIMA_OBJECT_VARIABLE_OFFSET;
/* Get the unicode string length for the filename. */
unicode_string_length = ((ULONG) *object -> ux_host_class_pima_object_filename * 2) + 1;
/* Is there enough room for this string? */
if (object_pointer + unicode_string_length > object_buffer_end)
/* Return error. */
status = UX_MEMORY_INSUFFICIENT;
else
/* Continue. */
status = UX_SUCCESS;
/* Is there enough space? */
if (status == UX_SUCCESS)
{
/* Copy that string into the object description field. */
_ux_utility_memory_copy(object_pointer, object -> ux_host_class_pima_object_filename, unicode_string_length); /* Use case of memcpy is verified. */
/* Point to the next field. */
object_pointer += unicode_string_length;
/* Get the unicode string length of the capture date. */
unicode_string_length = ((ULONG) *object -> ux_host_class_pima_object_capture_date * 2) + 1;
/* Is there enough room for this string? */
if (object_pointer + unicode_string_length > object_buffer_end)
/* Return error. */
status = UX_MEMORY_INSUFFICIENT;
}
/* Is there enough space? */
if (status == UX_SUCCESS)
{
/* Copy that string into the capture date field. */
_ux_utility_memory_copy(object_pointer, object -> ux_host_class_pima_object_capture_date, unicode_string_length); /* Use case of memcpy is verified. */
/* Point to the next field. */
object_pointer += unicode_string_length;
/* Get the unicode string length. */
unicode_string_length = ((ULONG) *object -> ux_host_class_pima_object_modification_date * 2) + 1;
/* Is there enough room for this string? */
if (object_pointer + unicode_string_length > object_buffer_end)
/* Return error. */
status = UX_MEMORY_INSUFFICIENT;
}
/* Is there enough space? */
if (status == UX_SUCCESS)
{
/* Copy that string into the modification date field. */
_ux_utility_memory_copy(object_pointer, object -> ux_host_class_pima_object_modification_date, unicode_string_length); /* Use case of memcpy is verified. */
/* Point to the next field. */
object_pointer += unicode_string_length;
/* Get the unicode string length. */
unicode_string_length = ((ULONG) *object -> ux_host_class_pima_object_keywords * 2) + 1;
/* Is there enough room for this string? */
if (object_pointer + unicode_string_length > object_buffer_end)
/* Return error. */
status = UX_MEMORY_INSUFFICIENT;
}
/* Is there enough space? */
if (status == UX_SUCCESS)
{
/* Copy that string into the keywords field. */
_ux_utility_memory_copy(object_pointer, object -> ux_host_class_pima_object_keywords, unicode_string_length); /* Use case of memcpy is verified. */
/* Point to the next field. */
object_pointer += unicode_string_length;
/* Calculate the length of the payload. */
object_info_length = (ULONG ) (object_pointer - object_buffer);
/* Issue the command. */
status = _ux_host_class_pima_command(pima, &command, UX_HOST_CLASS_PIMA_DATA_PHASE_OUT , object_buffer,
object_info_length, object_info_length);
/* If the status is OK, the device sent us the Object handle in the response. */
if (status == UX_SUCCESS)
/* Update the object handle. */
object -> ux_host_class_pima_object_handle_id = command.ux_host_class_pima_command_parameter_2;
}
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(object_buffer);
/* Return completion status. */
return(status);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _uxe_host_class_pima_object_info_send PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Yajun Xia, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function checks errors in pima object info send function call. */
/* */
/* INPUT */
/* */
/* pima Pointer to pima class */
/* pima_session Pointer to pima session */
/* storage_id StorageID where to store */
/* parent_object_id Parent object id */
/* object Object info structure */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_class_pima_object_info_send Send pima device info */
/* */
/* CALLED BY */
/* */
/* USB application */
/* */
/**************************************************************************/
UINT _uxe_host_class_pima_object_info_send(UX_HOST_CLASS_PIMA *pima,
UX_HOST_CLASS_PIMA_SESSION *pima_session,
ULONG storage_id,
ULONG parent_object_id,
UX_HOST_CLASS_PIMA_OBJECT *object)
{
/* Sanity Checks. */
if ((pima == UX_NULL) || (pima_session == UX_NULL) || (object == UX_NULL))
return(UX_INVALID_PARAMETER);
return(_ux_host_class_pima_object_info_send(pima, pima_session, storage_id, parent_object_id, object));
}
|
