1 /***************************************************************************
2 * Copyright (c) 2024 Microsoft Corporation
3 *
4 * This program and the accompanying materials are made available under the
5 * terms of the MIT License which is available at
6 * https://opensource.org/licenses/MIT.
7 *
8 * SPDX-License-Identifier: MIT
9 **************************************************************************/
10
11 /**************************************************************************/
12 /**************************************************************************/
13 /** */
14 /** USBX Component */
15 /** */
16 /** Device Printer Class */
17 /** */
18 /**************************************************************************/
19 /**************************************************************************/
20
21 #define UX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "ux_api.h"
27 #include "ux_device_class_printer.h"
28 #include "ux_device_stack.h"
29
30
31 /**************************************************************************/
32 /* */
33 /* FUNCTION RELEASE */
34 /* */
35 /* _ux_device_class_printer_entry PORTABLE C */
36 /* 6.2.1 */
37 /* AUTHOR */
38 /* */
39 /* Chaoqiong Xiao, Microsoft Corporation */
40 /* */
41 /* DESCRIPTION */
42 /* */
43 /* This function is the entry point of the printer class. It */
44 /* will be called by the device stack enumeration module when the */
45 /* host has sent a SET_CONFIGURATION command and the printer interface */
46 /* needs to be mounted. */
47 /* */
48 /* INPUT */
49 /* */
50 /* command Pointer to class command */
51 /* */
52 /* OUTPUT */
53 /* */
54 /* Completion Status */
55 /* */
56 /* CALLS */
57 /* */
58 /* _ux_device_class_printer_initialize Initialize printer class */
59 /* _ux_device_class_printer_uninitialize Uninitialize printer class */
60 /* _ux_device_class_printer_activate Activate printer class */
61 /* _ux_device_class_printer_deactivate Deactivate printer class */
62 /* _ux_device_class_printer_control_request */
63 /* Request control */
64 /* */
65 /* CALLED BY */
66 /* */
67 /* Device Stack */
68 /* */
69 /* RELEASE HISTORY */
70 /* */
71 /* DATE NAME DESCRIPTION */
72 /* */
73 /* 01-31-2022 Chaoqiong Xiao Initial Version 6.1.10 */
74 /* 03-08-2023 Yajun Xia Modified comment(s), */
75 /* added error checks support, */
76 /* resulting in version 6.2.1 */
77 /* */
78 /**************************************************************************/
_ux_device_class_printer_entry(UX_SLAVE_CLASS_COMMAND * command)79 UINT _ux_device_class_printer_entry(UX_SLAVE_CLASS_COMMAND *command)
80 {
81
82 UINT status;
83
84
85 /* The command request will tell us we need to do here, either a enumeration
86 query, an activation or a deactivation. */
87 switch (command -> ux_slave_class_command_request)
88 {
89
90 case UX_SLAVE_CLASS_COMMAND_INITIALIZE:
91
92 /* Call the init function of the Printer class. */
93 #if defined(UX_DEVICE_CLASS_PRINTER_ENABLE_ERROR_CHECKING)
94 status = _uxe_device_class_printer_initialize(command);
95 #else
96 status = _ux_device_class_printer_initialize(command);
97 #endif
98
99 /* Return the completion status. */
100 return(status);
101
102 case UX_SLAVE_CLASS_COMMAND_UNINITIALIZE:
103
104 /* Call the init function of the Printer class. */
105 status = _ux_device_class_printer_uninitialize(command);
106
107 /* Return the completion status. */
108 return(status);
109
110 case UX_SLAVE_CLASS_COMMAND_QUERY:
111
112 /* Check the CLASS definition in the interface descriptor. */
113 if (command -> ux_slave_class_command_class == UX_DEVICE_CLASS_PRINTER_CLASS &&
114 command -> ux_slave_class_command_subclass == UX_DEVICE_CLASS_PRINTER_SUBCLASS)
115 return(UX_SUCCESS);
116 else
117 return(UX_NO_CLASS_MATCH);
118
119 case UX_SLAVE_CLASS_COMMAND_ACTIVATE:
120
121 /* The activate command is used when the host has sent a SET_CONFIGURATION command
122 and this interface has to be mounted. Both Bulk endpoints have to be mounted
123 and the printer thread needs to be activated. */
124 status = _ux_device_class_printer_activate(command);
125
126 /* Return the completion status. */
127 return(status);
128
129 case UX_SLAVE_CLASS_COMMAND_DEACTIVATE:
130
131 /* The deactivate command is used when the device has been extracted.
132 The device endpoints have to be dismounted and the printer thread canceled. */
133 status = _ux_device_class_printer_deactivate(command);
134
135 /* Return the completion status. */
136 return(status);
137
138 case UX_SLAVE_CLASS_COMMAND_REQUEST:
139
140 /* The request command is used when the host sends a command on the control endpoint. */
141 status = _ux_device_class_printer_control_request(command);
142
143 /* Return the completion status. */
144 return(status);
145
146 default:
147
148 /* If trace is enabled, insert this event into the trace buffer. */
149 UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_FUNCTION_NOT_SUPPORTED, 0, 0, 0, UX_TRACE_ERRORS, 0, 0)
150
151 /* Return an error. */
152 return(UX_FUNCTION_NOT_SUPPORTED);
153 }
154 }
155
