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
|
/***************************************************************************
* 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_status_get PORTABLE C */
/* 6.1.12 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function obtains the printer status. The printer status is */
/* similar to the LPT status (1284 standard). */
/* */
/* INPUT */
/* */
/* printer Pointer to printer class */
/* printer_status Pointer to return status */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_stack_class_instance_verify Verify the class instance */
/* _ux_host_stack_transfer_request Process transfer request */
/* _ux_utility_long_get Get 32-bit long word */
/* _ux_utility_memory_allocate Allocate memory block */
/* _ux_utility_memory_free Free memory block */
/* _ux_host_semaphore_get Get protection semaphore */
/* _ux_host_semaphore_put Release protection semaphore */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/**************************************************************************/
UINT _ux_host_class_printer_status_get(UX_HOST_CLASS_PRINTER *printer, ULONG *printer_status)
{
#if defined(UX_HOST_STANDALONE)
UX_INTERRUPT_SAVE_AREA
#endif
UX_INTERFACE *interface_ptr;
UX_ENDPOINT *control_endpoint;
UX_TRANSFER *transfer_request;
UINT status;
UCHAR * printer_status_buffer;
/* Ensure the instance is valid. */
if (printer -> ux_host_class_printer_state != UX_HOST_CLASS_INSTANCE_LIVE)
{
/* 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);
}
#if defined(UX_HOST_STANDALONE)
UX_DISABLE
if ((printer -> ux_host_class_printer_flags & UX_HOST_CLASS_PRINTER_FLAG_LOCK) ||
(printer -> ux_host_class_printer_device -> ux_device_flags & UX_DEVICE_FLAG_LOCK))
{
UX_RESTORE
return(UX_BUSY);
}
printer -> ux_host_class_printer_flags |= UX_HOST_CLASS_PRINTER_FLAG_LOCK;
printer -> ux_host_class_printer_device -> ux_device_flags |= UX_DEVICE_FLAG_LOCK;
UX_RESTORE
#else
/* Protect thread reentry to this instance. */
status = _ux_host_semaphore_get(&printer -> ux_host_class_printer_semaphore, UX_WAIT_FOREVER);
if (status != UX_SUCCESS)
/* Return error. */
return(status);
/* Protect the control endpoint semaphore here. It will be unprotected in the
transfer request function. */
status = _ux_utility_semaphore_get(&printer -> ux_host_class_printer_device -> ux_device_protection_semaphore, UX_WAIT_FOREVER);
/* Check for status. */
if (status != UX_SUCCESS)
{
_ux_utility_semaphore_put(&printer -> ux_host_class_printer_semaphore);
return(status);
}
#endif
/* We need to get the default control endpoint transfer_request pointer. */
control_endpoint = &printer -> ux_host_class_printer_device -> ux_device_control_endpoint;
transfer_request = &control_endpoint -> ux_endpoint_transfer_request;
/* Need to allocate memory for the descriptor. */
printer_status_buffer = _ux_utility_memory_allocate(UX_SAFE_ALIGN, UX_CACHE_SAFE_MEMORY, UX_HOST_CLASS_PRINTER_STATUS_LENGTH);
if (printer_status_buffer == UX_NULL)
{
/* Unprotect thread reentry to this instance */
_ux_host_class_printer_unlock(printer);
return(UX_MEMORY_INSUFFICIENT);
}
/* Need interface for wIndex. */
interface_ptr = printer -> ux_host_class_printer_interface;
/* Create a transfer_request for the GET_STATUS request. */
transfer_request -> ux_transfer_request_data_pointer = printer_status_buffer;
transfer_request -> ux_transfer_request_requested_length = UX_HOST_CLASS_PRINTER_STATUS_LENGTH;
transfer_request -> ux_transfer_request_function = UX_HOST_CLASS_PRINTER_GET_STATUS;
transfer_request -> ux_transfer_request_type = UX_REQUEST_IN | UX_REQUEST_TYPE_CLASS | UX_REQUEST_TARGET_INTERFACE;
transfer_request -> ux_transfer_request_value = 0;
transfer_request -> ux_transfer_request_index = interface_ptr -> ux_interface_descriptor.bInterfaceNumber;
#if defined(UX_HOST_STANDALONE)
/* Enable auto unlock device. */
transfer_request -> ux_transfer_request_flags |= UX_TRANSFER_FLAG_AUTO_DEVICE_UNLOCK;
#endif
/* Send request to HCD layer. */
status = _ux_host_stack_transfer_request(transfer_request);
/* Check for correct transfer and entire descriptor returned. */
if ((status == UX_SUCCESS) &&
(transfer_request -> ux_transfer_request_actual_length > 0) &&
(transfer_request -> ux_transfer_request_actual_length <= UX_HOST_CLASS_PRINTER_STATUS_LENGTH))
{
/* Retrieve the printer status and translate it locally for endianness. */
*printer_status = printer_status_buffer[0];
if (transfer_request -> ux_transfer_request_actual_length > 1)
*printer_status |= (ULONG)(printer_status_buffer[1] << 8);
if (transfer_request -> ux_transfer_request_actual_length > 2)
*printer_status |= (ULONG)(printer_status_buffer[2] << 16);
if (transfer_request -> ux_transfer_request_actual_length > 3)
*printer_status |= (ULONG)(printer_status_buffer[3] << 24);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_CLASS_PRINTER_STATUS_GET, printer, *printer_status, 0, 0, UX_TRACE_HOST_CLASS_EVENTS, 0, 0)
}
else
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, status);
}
/* Free all used resources. */
_ux_utility_memory_free(printer_status_buffer);
/* Unprotect thread reentry to this instance. */
_ux_host_class_printer_unlock(printer);
/* Return completion status. */
return(status);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _uxe_host_class_printer_status_get PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Yajun Xia, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function checks errors in printer statis get function call. */
/* */
/* INPUT */
/* */
/* printer Pointer to printer class */
/* printer_status Pointer to return status */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_class_printer_status_get Obtains the printer status */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/**************************************************************************/
UINT _uxe_host_class_printer_status_get(UX_HOST_CLASS_PRINTER *printer, ULONG *printer_status)
{
/* Sanity checks. */
if ((printer == UX_NULL) || (printer_status == UX_NULL))
return(UX_INVALID_PARAMETER);
/* Call the actual printer status get function. */
return(_ux_host_class_printer_status_get(printer, printer_status));
}
|
