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
|
/***************************************************************************
* 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_activate PORTABLE C */
/* 6.1.12 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function calls the USBX stack to activate the class. */
/* */
/* INPUT */
/* */
/* command Printer class command pointer */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_class_printer_configure Configure printer class */
/* _ux_host_class_printer_endpoints_get Get endpoints of printer */
/* _ux_host_class_printer_name_get Get printer name */
/* _ux_host_stack_class_instance_create Create class instance */
/* _ux_host_stack_class_instance_destroy Destroy the class instance */
/* _ux_utility_memory_allocate Allocate memory block */
/* _ux_utility_memory_free Free memory block */
/* _ux_host_semaphore_create Create printer semaphore */
/* */
/* CALLED BY */
/* */
/* _ux_host_class_printer_entry Entry of printer class */
/* */
/**************************************************************************/
UINT _ux_host_class_printer_activate(UX_HOST_CLASS_COMMAND *command)
{
UX_INTERFACE *interface_ptr;
UX_HOST_CLASS_PRINTER *printer;
#if !defined(UX_HOST_STANDALONE)
UINT status;
#endif
/* The printer is always activated by the interface descriptor and not the
device descriptor. */
interface_ptr = (UX_INTERFACE *) command -> ux_host_class_command_container;
/* Obtain memory for this class instance. */
printer = _ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY, sizeof(UX_HOST_CLASS_PRINTER));
if (printer == UX_NULL)
return(UX_MEMORY_INSUFFICIENT);
/* Store the class container into this instance. */
printer -> ux_host_class_printer_class = command -> ux_host_class_command_class_ptr;
/* Store the interface container into the printer class instance. */
printer -> ux_host_class_printer_interface = interface_ptr;
/* Store the device container into the printer class instance. */
printer -> ux_host_class_printer_device = interface_ptr -> ux_interface_configuration -> ux_configuration_device;
/* This instance of the device must also be stored in the interface container. */
interface_ptr -> ux_interface_class_instance = (VOID *) printer;
/* Create this class instance. */
_ux_host_stack_class_instance_create(printer -> ux_host_class_printer_class, (VOID *) printer);
#if defined(UX_HOST_STANDALONE)
/* Do activate steps. */
printer -> ux_host_class_printer_enum_state = UX_STATE_WAIT;
printer -> ux_host_class_printer_state = UX_HOST_CLASS_INSTANCE_MOUNTING;
return(UX_SUCCESS);
#else
/* Configure the printer. */
status = _ux_host_class_printer_configure(printer);
/* Get the printer endpoint(s). We may need to search for Bulk Out and Bulk In endpoints. */
if (status == UX_SUCCESS)
status = _ux_host_class_printer_endpoints_get(printer);
/* Get the name of the printer from the 1284 descriptor. */
if (status == UX_SUCCESS)
status = _ux_host_class_printer_name_get(printer);
/* Create the semaphore to protect 2 threads from accessing the same printer instance. */
if (status == UX_SUCCESS)
{
status = _ux_host_semaphore_create(&printer -> ux_host_class_printer_semaphore, "ux_host_class_printer_semaphore", 1);
if (status != UX_SUCCESS)
status = UX_SEMAPHORE_ERROR;
}
/* Success things. */
if (status == UX_SUCCESS)
{
/* Mark the printer as live now. */
printer -> ux_host_class_printer_state = UX_HOST_CLASS_INSTANCE_LIVE;
/* If all is fine and the device is mounted, we may need to inform the application
if a function has been programmed in the system structure. */
if (_ux_system_host -> ux_system_host_change_function != UX_NULL)
{
/* Call system change function. */
_ux_system_host -> ux_system_host_change_function(UX_DEVICE_INSERTION, printer -> ux_host_class_printer_class, (VOID *) printer);
}
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_CLASS_PRINTER_ACTIVATE, printer, 0, 0, 0, UX_TRACE_HOST_CLASS_EVENTS, 0, 0)
/* If trace is enabled, register this object. */
UX_TRACE_OBJECT_REGISTER(UX_TRACE_HOST_OBJECT_TYPE_INTERFACE, printer, 0, 0, 0)
/* Return success. */
return(UX_SUCCESS);
}
/* On error, free resources. */
_ux_host_stack_class_instance_destroy(printer -> ux_host_class_printer_class, (VOID *) printer);
interface_ptr -> ux_interface_class_instance = UX_NULL;
_ux_utility_memory_free(printer);
/* Return completion status. */
return(status);
#endif
}
|
