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
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
|
/***************************************************************************
* 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 Printer Class */
/** */
/**************************************************************************/
/**************************************************************************/
#define UX_SOURCE_CODE
/* Include necessary system files. */
#include "ux_api.h"
#include "ux_device_class_printer.h"
#include "ux_device_stack.h"
#if defined(UX_DEVICE_STANDALONE)
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_device_class_printer_read_run PORTABLE C */
/* 6.2.0 */
/* AUTHOR */
/* */
/* Yajun Xia, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function reads from the Printer class. */
/* */
/* It's for standalone mode. */
/* */
/* INPUT */
/* */
/* printer Address of printer class */
/* instance */
/* buffer Pointer to buffer to save */
/* received data */
/* requested_length Length of bytes to read */
/* actual_length Pointer to save number of */
/* bytes read */
/* */
/* OUTPUT */
/* */
/* State machine Status to check */
/* UX_STATE_NEXT Transfer done, to next state */
/* UX_STATE_EXIT Abnormal, to reset state */
/* (others) Keep running, waiting */
/* */
/* CALLS */
/* */
/* _ux_device_stack_transfer_run Transfer request */
/* _ux_utility_memory_copy Copy memory */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/**************************************************************************/
UINT _ux_device_class_printer_read_run(UX_DEVICE_CLASS_PRINTER *printer, UCHAR *buffer,
ULONG requested_length, ULONG *actual_length)
{
UX_SLAVE_ENDPOINT *endpoint;
UX_SLAVE_DEVICE *device;
UX_SLAVE_TRANSFER *transfer_request;
ULONG max_transfer_length;
UINT status = UX_SUCCESS;
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_DEVICE_CLASS_PRINTER_READ, printer, buffer, requested_length, 0, UX_TRACE_DEVICE_CLASS_EVENTS, 0, 0)
/* Get the pointer to the device. */
device = &_ux_system_slave -> ux_system_slave_device;
/* As long as the device is in the CONFIGURED state. */
if (device -> ux_slave_device_state != UX_DEVICE_CONFIGURED)
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_CONFIGURATION_HANDLE_UNKNOWN);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_CONFIGURATION_HANDLE_UNKNOWN, device, 0, 0, UX_TRACE_ERRORS, 0, 0)
/* Cannot proceed with command, the interface is down. */
printer -> ux_device_class_printer_read_state = UX_STATE_RESET;
printer -> ux_device_class_printer_read_status = UX_CONFIGURATION_HANDLE_UNKNOWN;
return(UX_STATE_EXIT);
}
/* Locate the endpoint. */
endpoint = printer -> ux_device_class_printer_endpoint_out;
/* All Printer reading are on the endpoint OUT, from the host. */
transfer_request = &endpoint -> ux_slave_endpoint_transfer_request;
#if (UX_DEVICE_ENDPOINT_BUFFER_OWNER == 1) && defined(UX_DEVICE_CLASS_PRINTER_ZERO_COPY)
/* Run the transfer state machine. */
if (printer -> ux_device_class_printer_read_state == UX_STATE_RESET)
{
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_DEVICE_CLASS_PRINTER_READ, printer, buffer, requested_length, 0, UX_TRACE_DEVICE_CLASS_EVENTS, 0, 0)
printer -> ux_device_class_printer_read_state = UX_DEVICE_CLASS_PRINTER_READ_START;
printer -> ux_device_class_printer_read_status = UX_TRANSFER_NO_ANSWER;
transfer_request -> ux_slave_transfer_request_data_pointer = buffer;
UX_SLAVE_TRANSFER_STATE_RESET(transfer_request);
}
/* Issue the transfer request. */
max_transfer_length = requested_length;
status = _ux_device_stack_transfer_run(transfer_request, max_transfer_length, max_transfer_length);
/* Error case. */
if (status < UX_STATE_NEXT)
{
printer -> ux_device_class_printer_read_state = UX_STATE_RESET;
printer -> ux_device_class_printer_read_status =
transfer_request -> ux_slave_transfer_request_completion_code;
return(UX_STATE_ERROR);
}
/* Success case. */
if (status == UX_STATE_NEXT)
{
/* Last transfer status. */
printer -> ux_device_class_printer_read_status =
transfer_request -> ux_slave_transfer_request_completion_code;
/* Update actual length. */
*actual_length = transfer_request -> ux_slave_transfer_request_actual_length;
/* It's done. */
printer -> ux_device_class_printer_read_state = UX_STATE_RESET;
}
return(status);
#else
/* Handle state cases. */
switch(printer -> ux_device_class_printer_read_state)
{
case UX_STATE_RESET:
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_DEVICE_CLASS_PRINTER_READ, printer, buffer, requested_length, 0, UX_TRACE_DEVICE_CLASS_EVENTS, 0, 0)
printer -> ux_device_class_printer_read_state = UX_DEVICE_CLASS_PRINTER_READ_START;
printer -> ux_device_class_printer_read_status = UX_TRANSFER_NO_ANSWER;
printer -> ux_device_class_printer_read_buffer = buffer;
printer -> ux_device_class_printer_read_requested_length = requested_length;
printer -> ux_device_class_printer_read_actual_length = 0;
/* Fall through. */
case UX_DEVICE_CLASS_PRINTER_READ_START:
/* Get remaining transfer length. */
requested_length = printer -> ux_device_class_printer_read_requested_length -
printer -> ux_device_class_printer_read_actual_length;
/* There is nothing remaining, it's done. */
if (requested_length == 0)
{
*actual_length = printer -> ux_device_class_printer_read_actual_length;
printer -> ux_device_class_printer_read_state = UX_STATE_RESET;
printer -> ux_device_class_printer_read_status = UX_SUCCESS;
return(UX_STATE_NEXT);
}
printer -> ux_device_class_printer_read_transfer_length = requested_length;
/* Next state. */
printer -> ux_device_class_printer_read_state = UX_DEVICE_CLASS_PRINTER_READ_WAIT;
UX_SLAVE_TRANSFER_STATE_RESET(transfer_request);
/* Fall through. */
case UX_DEVICE_CLASS_PRINTER_READ_WAIT:
/* Get a full packet each time */
max_transfer_length = endpoint -> ux_slave_endpoint_descriptor.wMaxPacketSize;
/* Run the transfer state machine. */
status = _ux_device_stack_transfer_run(transfer_request,
max_transfer_length,
max_transfer_length);
/* Error case. */
if (status < UX_STATE_NEXT)
{
printer -> ux_device_class_printer_read_state = UX_STATE_RESET;
printer -> ux_device_class_printer_read_status =
transfer_request -> ux_slave_transfer_request_completion_code;
return(UX_STATE_ERROR);
}
/* Success case. */
if (status == UX_STATE_NEXT)
{
/* Check overflow */
if (printer -> ux_device_class_printer_read_transfer_length <
transfer_request -> ux_slave_transfer_request_actual_length)
{
printer -> ux_device_class_printer_read_state = UX_STATE_ERROR;
printer -> ux_device_class_printer_read_status = UX_TRANSFER_BUFFER_OVERFLOW;
return(UX_STATE_ERROR);
}
/* We need to copy the buffer locally. */
_ux_utility_memory_copy(printer -> ux_device_class_printer_read_buffer,
transfer_request -> ux_slave_transfer_request_data_pointer,
transfer_request -> ux_slave_transfer_request_actual_length); /* Use case of memcpy is verified. */
/* Next buffer address. */
printer -> ux_device_class_printer_read_buffer +=
transfer_request -> ux_slave_transfer_request_actual_length;
/* Set the length actually received. */
printer -> ux_device_class_printer_read_actual_length +=
transfer_request -> ux_slave_transfer_request_actual_length;
/* Last transfer status. */
printer -> ux_device_class_printer_read_status =
transfer_request -> ux_slave_transfer_request_completion_code;
/* Update actual length. */
*actual_length = printer -> ux_device_class_printer_read_actual_length;
/* Check short packet. */
if (transfer_request -> ux_slave_transfer_request_actual_length <
transfer_request -> ux_slave_transfer_request_requested_length)
{
/* It's done. */
printer -> ux_device_class_printer_read_state = UX_STATE_RESET;
return(UX_STATE_NEXT);
}
/* Next state. */
printer -> ux_device_class_printer_read_state = UX_DEVICE_CLASS_PRINTER_READ_START;
}
/* Keep waiting. */
return(UX_STATE_WAIT);
default: /* Error. */
printer -> ux_device_class_printer_read_state = UX_STATE_RESET;
printer -> ux_device_class_printer_read_status = UX_INVALID_STATE;
break;
}
#endif
/* Error cases. */
return(UX_STATE_EXIT);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _uxe_device_class_printer_read_run PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Yajun Xia, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function checks errors in printer read function call. */
/* */
/* It's for standalone mode. */
/* */
/* INPUT */
/* */
/* printer Address of printer class */
/* instance */
/* buffer Pointer to buffer to save */
/* received data */
/* requested_length Length of bytes to read */
/* actual_length Pointer to save number of */
/* bytes read */
/* */
/* OUTPUT */
/* */
/* State machine Status to check */
/* UX_STATE_NEXT Transfer done, to next state */
/* UX_STATE_EXIT Abnormal, to reset state */
/* UX_STATE_ERROR Error occurred */
/* (others) Keep running, waiting */
/* */
/* CALLS */
/* */
/* _ux_device_class_printer_read_run Printer class read process */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/**************************************************************************/
UINT _uxe_device_class_printer_read_run(UX_DEVICE_CLASS_PRINTER *printer, UCHAR *buffer,
ULONG requested_length, ULONG *actual_length)
{
/* Sanity checks. */
if ((printer == UX_NULL) || ((buffer == UX_NULL) && (requested_length > 0)) || (actual_length == UX_NULL))
{
return (UX_STATE_ERROR);
}
return(_ux_device_class_printer_read_run(printer, buffer, requested_length, actual_length));
}
#endif
|
