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
|
/***************************************************************************
* 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 */
/** */
/** Printer Class */
/** */
/**************************************************************************/
/**************************************************************************/
/* Include necessary system files. */
#define UX_SOURCE_CODE
#include "ux_api.h"
#include "ux_host_class_printer.h"
#include "ux_host_stack.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_host_class_printer_read PORTABLE C */
/* 6.1.10 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function reads from the printer interface. The call is */
/* blocking and only returns when there is either an error or when */
/* the transfer is complete. */
/* */
/* A read is only allowed on bidirectional printers. */
/* */
/* INPUT */
/* */
/* printer Pointer to printer class */
/* data_pointer Pointer to buffer */
/* requested_length Requested data read */
/* actual_length Actual data read */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_stack_class_instance_verify Verify the class instance */
/* _ux_host_stack_transfer_request Process transfer request */
/* _ux_host_stack_transfer_request_abort Abort transfer request */
/* _ux_host_semaphore_get Get protection semaphore */
/* _ux_host_semaphore_put Release protection semaphore */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/**************************************************************************/
UINT _ux_host_class_printer_read (UX_HOST_CLASS_PRINTER *printer, UCHAR *data_pointer,
ULONG requested_length, ULONG *actual_length)
{
#if defined(UX_HOST_STANDALONE)
UX_INTERRUPT_SAVE_AREA
ULONG transfer_flags;
#endif
UX_TRANSFER *transfer_request;
UINT status;
ULONG transfer_request_length;
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_CLASS_PRINTER_READ, printer, data_pointer, requested_length, 0, UX_TRACE_HOST_CLASS_EVENTS, 0, 0)
/* Ensure the instance is valid. */
if (printer -> ux_host_class_printer_state != UX_HOST_CLASS_INSTANCE_LIVE)
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_HOST_CLASS_INSTANCE_UNKNOWN);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_HOST_CLASS_INSTANCE_UNKNOWN, printer, 0, 0, UX_TRACE_ERRORS, 0, 0)
return(UX_HOST_CLASS_INSTANCE_UNKNOWN);
}
/* Check if the printer is bidirectional. */
if ((printer -> ux_host_class_printer_interface -> ux_interface_descriptor.bInterfaceProtocol !=
UX_HOST_CLASS_PRINTER_PROTOCOL_BI_DIRECTIONAL) &&
(printer -> ux_host_class_printer_interface -> ux_interface_descriptor.bInterfaceProtocol !=
UX_HOST_CLASS_PRINTER_PROTOCOL_IEEE_1284_4_BI_DIR))
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_FUNCTION_NOT_SUPPORTED);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_FUNCTION_NOT_SUPPORTED, 0, 0, 0, UX_TRACE_ERRORS, 0, 0)
/* Return an error. */
return(UX_FUNCTION_NOT_SUPPORTED);
}
/* Protect thread reentry to this instance. */
#if defined(UX_HOST_STANDALONE)
UX_DISABLE
if (printer -> ux_host_class_printer_flags & UX_HOST_CLASS_PRINTER_FLAG_LOCK)
{
UX_RESTORE
return(UX_BUSY);
}
printer -> ux_host_class_printer_flags |= UX_HOST_CLASS_PRINTER_FLAG_LOCK;
UX_RESTORE
#else
status = _ux_host_semaphore_get(&printer -> ux_host_class_printer_semaphore, UX_WAIT_FOREVER);
if (status != UX_SUCCESS)
/* Return error. */
return(status);
#endif
/* Start by resetting the actual length of the transfer to zero. */
*actual_length = 0;
/* Get the pointer to the bulk in endpoint in the transfer_request. */
transfer_request = &printer -> ux_host_class_printer_bulk_in_endpoint -> ux_endpoint_transfer_request;
#if defined(UX_HOST_STANDALONE)
/* Enable blocking transfer flags. */
transfer_flags = transfer_request -> ux_transfer_request_flags;
transfer_request -> ux_transfer_request_flags |= UX_TRANSFER_FLAG_AUTO_WAIT;
#endif
/* Perform a transfer on the bulk in endpoint until either the transfer is
completed or until there is an error. */
while (requested_length)
{
/* Program the maximum authorized length for this transfer request. */
if (requested_length > transfer_request -> ux_transfer_request_maximum_length)
transfer_request_length = transfer_request -> ux_transfer_request_maximum_length;
else
transfer_request_length = requested_length;
/* Initialize the transfer request. */
transfer_request -> ux_transfer_request_data_pointer = data_pointer;
transfer_request -> ux_transfer_request_requested_length = transfer_request_length;
/* Perform the transfer. */
status = _ux_host_stack_transfer_request(transfer_request);
/* If the transfer is successful, we need to wait for the transfer request to be completed. */
if (status == UX_SUCCESS)
{
#if !defined(UX_HOST_STANDALONE)
/* Wait for the completion of the transfer_request. */
status = _ux_host_semaphore_get(&transfer_request -> ux_transfer_request_semaphore, UX_MS_TO_TICK(UX_HOST_CLASS_PRINTER_CLASS_TRANSFER_TIMEOUT));
/* If the semaphore did not succeed we probably have a time out. */
if (status != UX_SUCCESS)
{
/* All transfers pending need to abort. There may have been a partial transfer. */
_ux_host_stack_transfer_request_abort(transfer_request);
/* Update the length of the actual data transferred. We do this after the
abort of the transfer request in case some data was actually received. */
*actual_length += transfer_request -> ux_transfer_request_actual_length;
/* Unprotect thread reentry to this instance. */
_ux_host_class_printer_unlock(printer);
/* Set the completion code. */
transfer_request -> ux_transfer_request_completion_code = UX_TRANSFER_TIMEOUT;
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_TRANSFER_TIMEOUT);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_TRANSFER_TIMEOUT, transfer_request, 0, 0, UX_TRACE_ERRORS, 0, 0)
/* There was an error, return to the caller */
return(UX_TRANSFER_TIMEOUT);
}
#endif
}
else
{
#if defined(UX_HOST_STANDALONE)
/* Restore transfer options. */
transfer_request -> ux_transfer_request_flags = transfer_flags;
#endif
/* Unprotect thread reentry to this instance. */
_ux_host_class_printer_unlock(printer);
/* There was a non transfer error, no partial transfer to be checked. */
return(status);
}
/* Update the length of the transfer. Normally all the data has to be received. */
*actual_length += transfer_request -> ux_transfer_request_actual_length;
/* Check for completion of transfer. If the transfer is partial, return to caller.
The transfer is marked as successful but the caller will need to check the length
actually received and determine if a partial transfer is OK. */
if (transfer_request_length != transfer_request -> ux_transfer_request_actual_length)
{
#if defined(UX_HOST_STANDALONE)
/* Restore transfer options. */
transfer_request -> ux_transfer_request_flags = transfer_flags;
#endif
/* Unprotect thread reentry to this instance. */
_ux_host_class_printer_unlock(printer);
/* Return success to caller. */
return(UX_SUCCESS);
}
/* Update the data pointer for next transfer. */
data_pointer += transfer_request_length;
/* Update what is left to receive. */
requested_length -= transfer_request_length;
}
#if defined(UX_HOST_STANDALONE)
/* Restore transfer options. */
transfer_request -> ux_transfer_request_flags = transfer_flags;
#endif
/* Unprotect thread reentry to this instance. */
_ux_host_class_printer_unlock(printer);
/* We get here when all the transfers went through without errors. */
return(UX_SUCCESS);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _uxe_host_class_printer_read PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Yajun Xia, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function checks errors in printer read function call. */
/* */
/* INPUT */
/* */
/* printer Pointer to printer class */
/* data_pointer Pointer to buffer */
/* requested_length Requested data read */
/* actual_length Actual data read */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_class_printer_read Printer read */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/**************************************************************************/
UINT _uxe_host_class_printer_read (UX_HOST_CLASS_PRINTER *printer, UCHAR *data_pointer,
ULONG requested_length, ULONG *actual_length)
{
/* Sanity checks. */
if ((printer == UX_NULL) || (data_pointer == UX_NULL) || (actual_length == UX_NULL))
return(UX_INVALID_PARAMETER);
/* Call the actual printer read function. */
return(_ux_host_class_printer_read(printer, data_pointer, requested_length, actual_length));
}
|
