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
|
/***************************************************************************
* 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 */
/** */
/** Device Pima Class */
/** */
/**************************************************************************/
/**************************************************************************/
#define UX_SOURCE_CODE
/* Include necessary system files. */
#include "ux_api.h"
#include "ux_device_class_pima.h"
#include "ux_device_stack.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_device_class_pima_object_info_send PORTABLE C */
/* 6.1.10 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function receives an object info structure from the host */
/* before receiving the actual data. */
/* */
/* INPUT */
/* */
/* pima Pointer to pima class */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_device_stack_transfer_request Transfer request */
/* _ux_device_stack_endpoint_stall Stall endpoint */
/* _ux_utility_long_put Put 32-bit value */
/* _ux_utility_short_put Put 32-bit value */
/* _ux_utility_memory_allocate Allocate memory */
/* _ux_utility_memory_copy Copy memory */
/* _ux_utility_memory_free Free memory */
/* _ux_utility_descriptor_parse Parse descriptor */
/* _ux_device_class_pima_response_send Send PIMA response */
/* */
/* CALLED BY */
/* */
/* Device Storage Class */
/* */
/**************************************************************************/
UINT _ux_device_class_pima_object_info_send(UX_SLAVE_CLASS_PIMA *pima, ULONG storage_id, ULONG parent_object_handle)
{
UINT status;
UX_SLAVE_TRANSFER *transfer_request;
UX_SLAVE_CLASS_PIMA_OBJECT *object;
UCHAR *object_info;
UCHAR *object_info_pointer;
ULONG unicode_string_length;
ULONG object_handle;
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_DEVICE_CLASS_PIMA_OBJECT_INFO_SEND, pima, 0, 0, 0, UX_TRACE_DEVICE_CLASS_EVENTS, 0, 0)
/* Obtain the pointer to the transfer request. */
transfer_request = &pima -> ux_device_class_pima_bulk_out_endpoint -> ux_slave_endpoint_transfer_request;
/* Obtain memory for this object info. Use the transfer request pre-allocated memory. */
object_info = transfer_request -> ux_slave_transfer_request_data_pointer;
/* Get the data payload. */
status = _ux_device_stack_transfer_request(transfer_request, UX_DEVICE_CLASS_PIMA_TRANSFER_BUFFER_LENGTH,
UX_DEVICE_CLASS_PIMA_TRANSFER_BUFFER_LENGTH);
/* Check if there was an error. If so, stall the endpoint. */
if (status != UX_SUCCESS)
{
/* Stall the endpoint. */
_ux_device_stack_endpoint_stall(pima -> ux_device_class_pima_bulk_out_endpoint);
/* Return the status. */
return(status);
}
/* Allocate some memory for the object. */
object = _ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY, sizeof(UX_SLAVE_CLASS_PIMA_OBJECT));
/* Check for successful allocation. */
if (object == UX_NULL)
return(UX_MEMORY_INSUFFICIENT);
/* Allocate the device info pointer to the beginning of the dynamic object info field. */
object_info_pointer = object_info + UX_DEVICE_CLASS_PIMA_DATA_HEADER_SIZE;
/* Uncompress the object descriptor, at least the fixed part. */
_ux_utility_descriptor_parse(object_info_pointer,
_ux_system_class_pima_object_structure,
UX_DEVICE_CLASS_PIMA_OBJECT_ENTRIES,
(UCHAR *) object);
/* Copy the object filename field. Point to the beginning of the object description string. */
object_info_pointer = object_info_pointer + UX_DEVICE_CLASS_PIMA_OBJECT_VARIABLE_OFFSET;
/* Get the unicode string length. */
unicode_string_length = ((ULONG) *object_info_pointer * 2) + 1;
/* Ensure there's enough space for this string. */
if (unicode_string_length > UX_DEVICE_CLASS_PIMA_UNICODE_MAX_LENGTH)
/* Return overflow error. */
status = UX_MEMORY_INSUFFICIENT;
/* Is there enough space? */
if (status == UX_SUCCESS)
{
/* Copy that string into the object description field. */
_ux_utility_memory_copy(object -> ux_device_class_pima_object_filename, object_info_pointer, unicode_string_length); /* Use case of memcpy is verified. */
/* Point to the next field. */
object_info_pointer += unicode_string_length;
/* Get the unicode string length. */
unicode_string_length = ((ULONG) *object_info_pointer * 2) + 1;
/* Ensure there's enough space for this string. */
if (unicode_string_length > UX_DEVICE_CLASS_PIMA_DATE_TIME_STRING_MAX_LENGTH)
/* Return overflow 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 -> ux_device_class_pima_object_capture_date, object_info_pointer, unicode_string_length); /* Use case of memcpy is verified. */
/* Point to the next field. */
object_info_pointer += unicode_string_length;
/* Get the unicode string length. */
unicode_string_length = ((ULONG) *object_info_pointer * 2) + 1;
/* Ensure there's enough space for this string. */
if (unicode_string_length > UX_DEVICE_CLASS_PIMA_DATE_TIME_STRING_MAX_LENGTH)
/* Return overflow 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 -> ux_device_class_pima_object_modification_date, object_info_pointer, unicode_string_length); /* Use case of memcpy is verified. */
/* Point to the next field. */
object_info_pointer += unicode_string_length;
/* Get the unicode string length. */
unicode_string_length = ((ULONG) *object_info_pointer * 2) + 1;
/* Ensure there's enough space for this string. */
if (unicode_string_length > UX_DEVICE_CLASS_PIMA_DATE_TIME_STRING_MAX_LENGTH)
/* Return overflow 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 -> ux_device_class_pima_object_keywords, object_info_pointer, unicode_string_length); /* Use case of memcpy is verified. */
/* Reset the rest of the other parameters. */
object -> ux_device_class_pima_object_state = 0;
object -> ux_device_class_pima_object_offset = 0;
object -> ux_device_class_pima_object_transfer_status = 0;
object -> ux_device_class_pima_object_handle_id = 0;
object -> ux_device_class_pima_object_length = 0;
/* Send the object to the application. */
status = pima -> ux_device_class_pima_object_info_send(pima, object, storage_id, parent_object_handle, &object_handle);
if (status != UX_SUCCESS)
{
/* Now we return a response with error. */
_ux_device_class_pima_response_send(pima, status, 3, pima -> ux_device_class_pima_storage_id,
object -> ux_device_class_pima_object_parent_object, object_handle);
}
else
{
/* Now we return a response with success. */
_ux_device_class_pima_response_send(pima, UX_DEVICE_CLASS_PIMA_RC_OK, 3, pima -> ux_device_class_pima_storage_id,
object -> ux_device_class_pima_object_parent_object, object_handle);
}
/* Store the object handle. It will be used for the OBJECT_SEND command. */
pima -> ux_device_class_pima_current_object_handle = object_handle;
}
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)
/* We return an error. */
_ux_device_class_pima_response_send(pima, UX_DEVICE_CLASS_PIMA_RC_GENERAL_ERROR, 0, 0, 0, 0);
}
/* Free the resources. */
_ux_utility_memory_free(object);
/* Return completion status. */
return(status);
}
|
