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
|
/***************************************************************************
* 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_get PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function returns the object info structure to the host. */
/* */
/* INPUT */
/* */
/* pima Pointer to pima class */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_device_stack_transfer_request Transfer request */
/* _ux_utility_long_put Put 32-bit value */
/* _ux_utility_short_put Put 32-bit value */
/* _ux_utility_memory_copy Copy memory */
/* _ux_utility_descriptor_pack Pack descriptor */
/* _ux_device_class_pima_response_send Send PIMA response */
/* */
/* CALLED BY */
/* */
/* Device Storage Class */
/* */
/**************************************************************************/
UINT _ux_device_class_pima_object_info_get(UX_SLAVE_CLASS_PIMA *pima, ULONG object_handle)
{
UINT status;
UX_SLAVE_TRANSFER *transfer_request;
UX_SLAVE_CLASS_PIMA_OBJECT *object;
ULONG object_info_length;
UCHAR *object_info;
UCHAR *object_info_pointer;
ULONG file_name_length;
ULONG capture_date_length;
ULONG modification_date_length;
ULONG keywords_length;
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_DEVICE_CLASS_PIMA_OBJECT_INFO_GET, pima, object_handle, 0, 0, UX_TRACE_DEVICE_CLASS_EVENTS, 0, 0)
/* Obtain the object info from the application. */
status = pima -> ux_device_class_pima_object_info_get(pima, object_handle, &object);
/* Check for error. */
if (status != UX_SUCCESS)
/* We return an error. */
_ux_device_class_pima_response_send(pima, status, 0, 0, 0, 0);
else
{
/* Length calculation and overflow check. */
file_name_length = ((ULONG) *object -> ux_device_class_pima_object_filename * 2 ) + 1;
capture_date_length = ((ULONG) *object -> ux_device_class_pima_object_capture_date *2 ) + 1;
modification_date_length = ((ULONG) *object -> ux_device_class_pima_object_modification_date * 2 ) + 1;
keywords_length = ((ULONG) *object -> ux_device_class_pima_object_keywords * 2 ) +1;
object_info_length = UX_DEVICE_CLASS_PIMA_DATA_HEADER_SIZE +
UX_DEVICE_CLASS_PIMA_OBJECT_VARIABLE_OFFSET +
file_name_length +
capture_date_length +
modification_date_length +
keywords_length;
/* Ensure the object info data can fit in the endpoint's data buffer. */
if (object_info_length > UX_DEVICE_CLASS_PIMA_TRANSFER_BUFFER_LENGTH)
{
/* 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);
/* Return overflow error. */
return(UX_MEMORY_INSUFFICIENT);
}
/* Obtain the pointer to the transfer request. */
transfer_request = &pima -> ux_device_class_pima_bulk_in_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;
/* Fill in the data container type. */
_ux_utility_short_put(object_info + UX_DEVICE_CLASS_PIMA_DATA_HEADER_TYPE,
UX_DEVICE_CLASS_PIMA_CT_DATA_BLOCK);
/* Fill in the data code. */
_ux_utility_short_put(object_info + UX_DEVICE_CLASS_PIMA_DATA_HEADER_CODE,
UX_DEVICE_CLASS_PIMA_OC_GET_OBJECT_INFO);
/* Fill in the Transaction ID. */
_ux_utility_long_put(object_info + UX_DEVICE_CLASS_PIMA_DATA_HEADER_TRANSACTION_ID,
pima -> ux_device_class_pima_transaction_id);
/* 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;
/* 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_DEVICE_CLASS_PIMA_OBJECT_ENTRIES,
object_info_pointer);
/* Copy the object filename field. Point to the beginning of the object description string. */
object_info_pointer += UX_DEVICE_CLASS_PIMA_OBJECT_VARIABLE_OFFSET;
/* Copy that string into the object description field. */
_ux_utility_memory_copy(object_info_pointer, object -> ux_device_class_pima_object_filename, file_name_length); /* Use case of memcpy is verified. */
/* Point to the next field. */
object_info_pointer += file_name_length;
/* Copy that string into the capture date field. */
_ux_utility_memory_copy(object_info_pointer, object -> ux_device_class_pima_object_capture_date, capture_date_length); /* Use case of memcpy is verified. */
/* Point to the next field. */
object_info_pointer += capture_date_length;
/* Copy that string into the modification date field. */
_ux_utility_memory_copy(object_info_pointer, object -> ux_device_class_pima_object_modification_date, modification_date_length); /* Use case of memcpy is verified. */
/* Point to the next field. */
object_info_pointer += modification_date_length;
/* Copy that string into the keywords field. */
_ux_utility_memory_copy(object_info_pointer, object -> ux_device_class_pima_object_keywords, keywords_length); /* Use case of memcpy is verified. */
/* Fill in the size of the response header. */
_ux_utility_long_put(object_info + UX_DEVICE_CLASS_PIMA_DATA_HEADER_LENGTH,
object_info_length);
/* Send a data payload with the object info data set. */
status = _ux_device_stack_transfer_request(transfer_request, object_info_length, 0);
/* Now we return a response with success. */
_ux_device_class_pima_response_send(pima, UX_DEVICE_CLASS_PIMA_RC_OK, 0, 0, 0, 0);
}
/* Return completion status. */
return(status);
}
|
