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
|
/***************************************************************************
* 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_endpoints_get PORTABLE C */
/* 6.1.10 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function search for the handle of the bulk out endpoint and */
/* optionally the bulk in endpoint of the printer is bidirectional. */
/* */
/* INPUT */
/* */
/* printer Pointer to printer class */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_stack_interface_endpoint_get Get interface endpoint */
/* */
/* CALLED BY */
/* */
/* _ux_host_class_printer_activate Activate printer class */
/* */
/**************************************************************************/
UINT _ux_host_class_printer_endpoints_get(UX_HOST_CLASS_PRINTER *printer)
{
UINT status;
UINT endpoint_index;
UX_ENDPOINT *endpoint;
/* Search the bulk OUT endpoint. It is attached to the interface container. */
for (endpoint_index = 0; endpoint_index < printer -> ux_host_class_printer_interface -> ux_interface_descriptor.bNumEndpoints;
endpoint_index++)
{
/* Get interface endpoint. */
status = _ux_host_stack_interface_endpoint_get(printer -> ux_host_class_printer_interface, endpoint_index, &endpoint);
/* Check the completion status. */
if (status == UX_SUCCESS)
{
/* Check if endpoint is bulk and OUT. */
if (((endpoint -> ux_endpoint_descriptor.bEndpointAddress & UX_ENDPOINT_DIRECTION) == UX_ENDPOINT_OUT) &&
((endpoint -> ux_endpoint_descriptor.bmAttributes & UX_MASK_ENDPOINT_TYPE) == UX_BULK_ENDPOINT))
{
/* This transfer_request always have the OUT direction. */
endpoint -> ux_endpoint_transfer_request.ux_transfer_request_type = UX_REQUEST_OUT;
/* By default wait UX_HOST_CLASS_PRINTER_CLASS_TRANSFER_TIMEOUT. */
endpoint -> ux_endpoint_transfer_request.ux_transfer_request_timeout_value =
UX_MS_TO_TICK(UX_HOST_CLASS_PRINTER_CLASS_TRANSFER_TIMEOUT);
/* We have found the bulk endpoint, save it. */
printer -> ux_host_class_printer_bulk_out_endpoint = endpoint;
break;
}
}
}
/* The bulk out endpoint is mandatory. */
if (printer -> ux_host_class_printer_bulk_out_endpoint == UX_NULL)
{
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_ENDPOINT_HANDLE_UNKNOWN, printer, 0, 0, UX_TRACE_ERRORS, 0, 0)
return(UX_ENDPOINT_HANDLE_UNKNOWN);
}
/* Search the bulk IN endpoint. This endpoint is optional and only valid for
bidirectional printers. It is attached to the interface container. */
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))
{
for (endpoint_index = 0; endpoint_index < printer -> ux_host_class_printer_interface -> ux_interface_descriptor.bNumEndpoints;
endpoint_index++)
{
/* Get the endpoint handle. */
status = _ux_host_stack_interface_endpoint_get(printer -> ux_host_class_printer_interface, endpoint_index, &endpoint);
/* Check the completion status. */
if (status == UX_SUCCESS)
{
/* Check if endpoint is bulk and IN. */
if (((endpoint -> ux_endpoint_descriptor.bEndpointAddress & UX_ENDPOINT_DIRECTION) == UX_ENDPOINT_IN) &&
((endpoint -> ux_endpoint_descriptor.bmAttributes & UX_MASK_ENDPOINT_TYPE) == UX_BULK_ENDPOINT))
{
/* This transfer_request always have the IN direction. */
endpoint -> ux_endpoint_transfer_request.ux_transfer_request_type = UX_REQUEST_IN;
/* By default wait UX_HOST_CLASS_PRINTER_CLASS_TRANSFER_TIMEOUT. */
endpoint -> ux_endpoint_transfer_request.ux_transfer_request_timeout_value =
UX_MS_TO_TICK(UX_HOST_CLASS_PRINTER_CLASS_TRANSFER_TIMEOUT);
/* We have found the bulk endpoint, save it. */
printer -> ux_host_class_printer_bulk_in_endpoint = endpoint;
break;
}
}
}
/* The bulk in endpoint is mandatory for these protocol. */
if (printer -> ux_host_class_printer_bulk_in_endpoint == UX_NULL)
{
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_ENDPOINT_HANDLE_UNKNOWN, printer, 0, 0, UX_TRACE_ERRORS, 0, 0)
return(UX_ENDPOINT_HANDLE_UNKNOWN);
}
}
/* All endpoints have been mounted. */
return(UX_SUCCESS);
}
|
