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 CDC_ECM 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_cdc_ecm.h"
28 #include "ux_device_stack.h"
29
30
31 /**************************************************************************/
32 /* */
33 /* FUNCTION RELEASE */
34 /* */
35 /* _ux_device_class_cdc_ecm_entry PORTABLE C */
36 /* 6.1 */
37 /* AUTHOR */
38 /* */
39 /* Chaoqiong Xiao, Microsoft Corporation */
40 /* */
41 /* DESCRIPTION */
42 /* */
43 /* This function is the entry point of the cdc_ecm class. It */
44 /* will be called by the device stack enumeration module when the */
45 /* host has sent a SET_CONFIGURATION command and the cdc_ecm 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_cdc_ecm_initialize Initialize cdc_ecm class */
59 /* _ux_device_class_cdc_ecm_uninitialize Uninitialize cdc_ecm class*/
60 /* _ux_device_class_cdc_ecm_activate Activate cdc_ecm class */
61 /* _ux_device_class_cdc_ecm_deactivate Deactivate cdc_ecm class */
62 /* _ux_device_class_cdc_ecm_change Alternate setting change */
63 /* _ux_device_class_cdc_ecm_control_request Request control */
64 /* */
65 /* CALLED BY */
66 /* */
67 /* CDC_ECM Class */
68 /* */
69 /* RELEASE HISTORY */
70 /* */
71 /* DATE NAME DESCRIPTION */
72 /* */
73 /* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
74 /* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
75 /* resulting in version 6.1 */
76 /* */
77 /**************************************************************************/
_ux_device_class_cdc_ecm_entry(UX_SLAVE_CLASS_COMMAND * command)78 UINT _ux_device_class_cdc_ecm_entry(UX_SLAVE_CLASS_COMMAND *command)
79 {
80
81 UINT status;
82
83 /* The command request will tell us we need to do here, either a enumeration
84 query, an activation or a deactivation. */
85 switch (command -> ux_slave_class_command_request)
86 {
87
88 case UX_SLAVE_CLASS_COMMAND_INITIALIZE:
89
90 /* Call the init function of the CDC_ECM class. */
91 status = _ux_device_class_cdc_ecm_initialize(command);
92
93 /* Return the completion status. */
94 return(status);
95
96 case UX_SLAVE_CLASS_COMMAND_UNINITIALIZE:
97
98 /* Call the init function of the CDC_ECM class. */
99 status = _ux_device_class_cdc_ecm_uninitialize(command);
100
101 /* Return the completion status. */
102 return(status);
103
104 case UX_SLAVE_CLASS_COMMAND_QUERY:
105
106 /* Check the CLASS definition in the interface descriptor. */
107 if (command -> ux_slave_class_command_class == UX_DEVICE_CLASS_CDC_ECM_CLASS_COMMUNICATION_CONTROL ||
108 command -> ux_slave_class_command_class == UX_DEVICE_CLASS_CDC_ECM_CLASS_COMMUNICATION_DATA)
109 return(UX_SUCCESS);
110 else
111 return(UX_NO_CLASS_MATCH);
112
113 case UX_SLAVE_CLASS_COMMAND_ACTIVATE:
114
115 /* The activate command is used when the host has sent a SET_CONFIGURATION command
116 and this interface has to be mounted. In CDC ECM, the alternate setting 0 has no endpoints.
117 Only the Alternate Setting 1 has the Bulk IN and OUT endpoints active. */
118 status = _ux_device_class_cdc_ecm_activate(command);
119
120 /* Return the completion status. */
121 return(status);
122
123 case UX_SLAVE_CLASS_COMMAND_CHANGE:
124
125 /* The change command is used when the host has sent a SET_INTERFACE command
126 to go from Alternate Setting 0 to 1 or revert to the default mode. */
127 status = _ux_device_class_cdc_ecm_change(command);
128
129 /* Return the completion status. */
130 return(status);
131
132
133 case UX_SLAVE_CLASS_COMMAND_DEACTIVATE:
134
135 /* The deactivate command is used when the device has been extracted.
136 The device endpoints have to be dismounted and the cdc_ecm thread canceled. */
137 status = _ux_device_class_cdc_ecm_deactivate(command);
138
139 /* Return the completion status. */
140 return(status);
141
142 case UX_SLAVE_CLASS_COMMAND_REQUEST:
143
144 /* The request command is used when the host sends a command on the control endpoint. */
145 status = _ux_device_class_cdc_ecm_control_request(command);
146
147 /* Return the completion status. */
148 return(status);
149
150 default:
151
152 /* Error trap. */
153 _ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_FUNCTION_NOT_SUPPORTED);
154
155 /* If trace is enabled, insert this event into the trace buffer. */
156 UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_FUNCTION_NOT_SUPPORTED, 0, 0, 0, UX_TRACE_ERRORS, 0, 0)
157
158 /* Return an error. */
159 return(UX_FUNCTION_NOT_SUPPORTED);
160 }
161 }
162
163
