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
|
/***************************************************************************
* 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_references_get PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* Return object references associated with an object handle. */
/* The pima class will call the application to get the array of */
/* references. */
/* */
/* INPUT */
/* */
/* pima Pointer to pima class */
/* object_handle Object Handle for which */
/* references are obtained. */
/* */
/* 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_device_class_pima_response_send Send PIMA response */
/* */
/* CALLED BY */
/* */
/* Device Pima Class */
/* */
/**************************************************************************/
UINT _ux_device_class_pima_object_references_get(UX_SLAVE_CLASS_PIMA *pima,
ULONG object_handle)
{
UINT status;
UX_SLAVE_TRANSFER *transfer_request;
UCHAR *pima_data_buffer;
UCHAR *pima_data_buffer_end;
UCHAR *object_references;
ULONG object_references_length;
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_DEVICE_CLASS_PIMA_GET_OBJECT_REFERENCES, pima, object_handle, 0, 0, UX_TRACE_DEVICE_CLASS_EVENTS, 0, 0)
/* 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. */
pima_data_buffer = transfer_request -> ux_slave_transfer_request_data_pointer;
/* Save end of buffer. */
pima_data_buffer_end = pima_data_buffer + UX_DEVICE_CLASS_PIMA_TRANSFER_BUFFER_LENGTH;
/* Fill in the data container type. */
_ux_utility_short_put(pima_data_buffer + UX_DEVICE_CLASS_PIMA_DATA_HEADER_TYPE,
UX_DEVICE_CLASS_PIMA_CT_DATA_BLOCK);
/* Fill in the data code. */
_ux_utility_short_put(pima_data_buffer + UX_DEVICE_CLASS_PIMA_DATA_HEADER_CODE,
UX_DEVICE_CLASS_PIMA_OC_GET_OBJECT_REFERENCES);
/* Fill in the Transaction ID. */
_ux_utility_long_put(pima_data_buffer + UX_DEVICE_CLASS_PIMA_DATA_HEADER_TRANSACTION_ID,
pima -> ux_device_class_pima_transaction_id);
/* Ask the application to retrieve for us the object references. */
object_references_length = UX_DEVICE_CLASS_PIMA_MAX_PAYLOAD;
status = pima -> ux_device_class_pima_object_references_get(pima, object_handle, &object_references, &object_references_length);
/* Result should always be OK, but to be sure .... */
if (status != UX_SUCCESS)
/* We return an error. */
_ux_device_class_pima_response_send(pima, status, 0, 0, 0, 0);
else
{
/* Check if there enough space in our buffer. */
if (pima_data_buffer + UX_DEVICE_CLASS_PIMA_DATA_HEADER_SIZE + object_references_length <= pima_data_buffer_end)
{
/* Copy the property dataset into the local buffer. */
_ux_utility_memory_copy(pima_data_buffer + UX_DEVICE_CLASS_PIMA_DATA_HEADER_SIZE, object_references, object_references_length); /* Use case of memcpy is verified. */
/* Add the header size to the payload. */
object_references_length += UX_DEVICE_CLASS_PIMA_DATA_HEADER_SIZE;
/* Fill in the size of the response header. */
_ux_utility_long_put(pima_data_buffer + UX_DEVICE_CLASS_PIMA_DATA_HEADER_LENGTH,
object_references_length);
/* Send a data payload with the object references array. */
status = _ux_device_stack_transfer_request(transfer_request, object_references_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);
}
else
{
/* Report the error to the application. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_MEMORY_INSUFFICIENT);
/* We return an error code to the host. */
_ux_device_class_pima_response_send(pima, UX_DEVICE_CLASS_PIMA_RC_GENERAL_ERROR, 0, 0, 0, 0);
/* Return error. */
status = UX_MEMORY_INSUFFICIENT;
}
}
/* Return completion status. */
return(status);
}
|
