1 /**************************************************************************/
2 /* */
3 /* Copyright (c) Microsoft Corporation. All rights reserved. */
4 /* */
5 /* This software is licensed under the Microsoft Software License */
6 /* Terms for Microsoft Azure RTOS. Full text of the license can be */
7 /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
8 /* and in the root directory of this software. */
9 /* */
10 /**************************************************************************/
11
12
13 /**************************************************************************/
14 /**************************************************************************/
15 /** */
16 /** USBX Component */
17 /** */
18 /** Printer Class */
19 /** */
20 /**************************************************************************/
21 /**************************************************************************/
22
23
24 /* Include necessary system files. */
25
26 #define UX_SOURCE_CODE
27
28 #include "ux_api.h"
29 #include "ux_host_class_printer.h"
30 #include "ux_host_stack.h"
31
32
33 /**************************************************************************/
34 /* */
35 /* FUNCTION RELEASE */
36 /* */
37 /* _ux_host_class_printer_configure PORTABLE C */
38 /* 6.1 */
39 /* AUTHOR */
40 /* */
41 /* Chaoqiong Xiao, Microsoft Corporation */
42 /* */
43 /* DESCRIPTION */
44 /* */
45 /* This function calls the USBX stack to do a SET_CONFIGURATION to the */
46 /* printer. Once the printer is configured, its interface will be */
47 /* activated. The bulk endpoints enumerated(1 IN, 1 OUT ). */
48 /* */
49 /* INPUT */
50 /* */
51 /* printer Pointer to printer class */
52 /* */
53 /* OUTPUT */
54 /* */
55 /* Completion Status */
56 /* */
57 /* CALLS */
58 /* */
59 /* _ux_host_stack_configuration_interface_get Get interface */
60 /* _ux_host_stack_device_configuration_get Get configuration */
61 /* _ux_host_stack_device_configuration_select Select configuration */
62 /* */
63 /* CALLED BY */
64 /* */
65 /* _ux_host_class_printer_activate Printer class activate */
66 /* */
67 /* RELEASE HISTORY */
68 /* */
69 /* DATE NAME DESCRIPTION */
70 /* */
71 /* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
72 /* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
73 /* optimized based on compile */
74 /* definitions, */
75 /* resulting in version 6.1 */
76 /* */
77 /**************************************************************************/
_ux_host_class_printer_configure(UX_HOST_CLASS_PRINTER * printer)78 UINT _ux_host_class_printer_configure(UX_HOST_CLASS_PRINTER *printer)
79 {
80
81 UINT status;
82 UX_CONFIGURATION *configuration;
83 #if UX_MAX_DEVICES > 1
84 UX_DEVICE *parent_device;
85 #endif
86
87
88 /* If the device has been configured already, we don't need to do it
89 again. */
90 if (printer -> ux_host_class_printer_device -> ux_device_state == UX_DEVICE_CONFIGURED)
91 return(UX_SUCCESS);
92
93 /* A printer normally has one configuration. So retrieve the 1st configuration
94 only. */
95 status = _ux_host_stack_device_configuration_get(printer -> ux_host_class_printer_device, 0, &configuration);
96 if (status != UX_SUCCESS)
97 {
98
99 /* Error trap. */
100 _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_CONFIGURATION_HANDLE_UNKNOWN);
101
102 /* If trace is enabled, insert this event into the trace buffer. */
103 UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_CONFIGURATION_HANDLE_UNKNOWN, printer -> ux_host_class_printer_device, 0, 0, UX_TRACE_ERRORS, 0, 0)
104
105 return(UX_CONFIGURATION_HANDLE_UNKNOWN);
106 }
107
108 #if UX_MAX_DEVICES > 1
109 /* Check the printer power source and check the parent power source for
110 incompatible connections. */
111 if (printer -> ux_host_class_printer_device -> ux_device_power_source == UX_DEVICE_BUS_POWERED)
112 {
113
114 /* Get parent device pointer. */
115 parent_device = printer -> ux_host_class_printer_device -> ux_device_parent;
116
117 /* If the device is NULL, the parent is the root printer and we don't have to worry
118 if the parent is not the root printer, check for its power source. */
119 if ((parent_device != UX_NULL) && (parent_device -> ux_device_power_source == UX_DEVICE_BUS_POWERED))
120 {
121
122 /* Error trap. */
123 _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_CONNECTION_INCOMPATIBLE);
124
125 /* If trace is enabled, insert this event into the trace buffer. */
126 UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_CONNECTION_INCOMPATIBLE, printer, 0, 0, UX_TRACE_ERRORS, 0, 0)
127
128 return(UX_CONNECTION_INCOMPATIBLE);
129 }
130 }
131 #endif
132
133 /* We have the valid configuration. Ask the USBX stack to set this configuration. */
134 status = _ux_host_stack_device_configuration_select(configuration);
135 if (status != UX_SUCCESS)
136 return(status);
137
138 /* If the operation went well, the printer default alternate setting for the printer interface is
139 active and the interrupt endpoint is now enabled. We have to memorize the first interface since
140 the interrupt endpoint is hooked to it. */
141 status = _ux_host_stack_configuration_interface_get(configuration, 0, 0, &printer -> ux_host_class_printer_interface);
142 if (status != UX_SUCCESS)
143 {
144
145 /* Store the instance in the interface container, this is for the USB stack
146 when it needs to invoke the class. */
147 printer -> ux_host_class_printer_interface -> ux_interface_class_instance = (VOID *) printer;
148 }
149
150 /* Return completion status. */
151 return(status);
152 }
153
154
