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 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_acm.h" |
28 |
|
|
#include "ux_device_stack.h" |
29 |
|
|
|
30 |
|
|
|
31 |
|
|
/**************************************************************************/ |
32 |
|
|
/* */ |
33 |
|
|
/* FUNCTION RELEASE */ |
34 |
|
|
/* */ |
35 |
|
|
/* _ux_device_class_cdc_acm_entry PORTABLE C */ |
36 |
|
|
/* 6.x */ |
37 |
|
|
/* AUTHOR */ |
38 |
|
|
/* */ |
39 |
|
|
/* Chaoqiong Xiao, Microsoft Corporation */ |
40 |
|
|
/* */ |
41 |
|
|
/* DESCRIPTION */ |
42 |
|
|
/* */ |
43 |
|
|
/* This function is the entry point of the cdc_acm 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_acm 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_acm_initialize Initialize cdc_acm class */ |
59 |
|
|
/* _ux_device_class_cdc_acm_uninitialize Uninitialize cdc_acm class*/ |
60 |
|
|
/* _ux_device_class_cdc_acm_activate Activate cdc_acm class */ |
61 |
|
|
/* _ux_device_class_cdc_acm_deactivate Deactivate cdc_acm class */ |
62 |
|
|
/* _ux_device_class_cdc_acm_control_request Request control */ |
63 |
|
|
/* */ |
64 |
|
|
/* CALLED BY */ |
65 |
|
|
/* */ |
66 |
|
|
/* CDC Class */ |
67 |
|
|
/* */ |
68 |
|
|
/* RELEASE HISTORY */ |
69 |
|
|
/* */ |
70 |
|
|
/* DATE NAME DESCRIPTION */ |
71 |
|
|
/* */ |
72 |
|
|
/* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */ |
73 |
|
|
/* 09-30-2020 Chaoqiong Xiao Modified comment(s), */ |
74 |
|
|
/* resulting in version 6.1 */ |
75 |
|
|
/* xx-xx-xxxx Mohamed ayed Modified comment(s), */ |
76 |
|
|
/* fix typo, */ |
77 |
|
|
/* remove extra spaces, */ |
78 |
|
|
/* resulting in version 6.x */ |
79 |
|
|
/* */ |
80 |
|
|
/**************************************************************************/ |
81 |
|
689 |
UINT _ux_device_class_cdc_acm_entry(UX_SLAVE_CLASS_COMMAND *command) |
82 |
|
|
{ |
83 |
|
|
|
84 |
|
|
UINT status; |
85 |
|
|
|
86 |
|
|
|
87 |
|
|
/* The command request will tell us we need to do here, either a enumeration |
88 |
|
|
query, an activation or a deactivation. */ |
89 |
✓✓✓✓ ✓✓✓ |
689 |
switch (command -> ux_slave_class_command_request) |
90 |
|
|
{ |
91 |
|
|
|
92 |
|
68 |
case UX_SLAVE_CLASS_COMMAND_INITIALIZE: |
93 |
|
|
|
94 |
|
|
/* Call the init function of the CDC ACM class. */ |
95 |
|
68 |
status = _ux_device_class_cdc_acm_initialize(command); |
96 |
|
|
|
97 |
|
|
/* Return the completion status. */ |
98 |
|
68 |
return(status); |
99 |
|
|
|
100 |
|
50 |
case UX_SLAVE_CLASS_COMMAND_UNINITIALIZE: |
101 |
|
|
|
102 |
|
|
/* Call the uninit function of the CDC ACM class. */ |
103 |
|
50 |
status = _ux_device_class_cdc_acm_uninitialize(command); |
104 |
|
|
|
105 |
|
|
/* Return the completion status. */ |
106 |
|
50 |
return(status); |
107 |
|
|
|
108 |
|
182 |
case UX_SLAVE_CLASS_COMMAND_QUERY: |
109 |
|
|
|
110 |
|
|
/* Check the CLASS definition in the interface descriptor. */ |
111 |
✓✓ |
182 |
if (command -> ux_slave_class_command_class == UX_SLAVE_CLASS_CDC_ACM_CLASS) |
112 |
|
90 |
return(UX_SUCCESS); |
113 |
|
|
else |
114 |
|
92 |
return(UX_NO_CLASS_MATCH); |
115 |
|
|
|
116 |
|
90 |
case UX_SLAVE_CLASS_COMMAND_ACTIVATE: |
117 |
|
|
|
118 |
|
|
/* The activate command is used when the host has sent a SET_CONFIGURATION command |
119 |
|
|
and this interface has to be mounted. Both Bulk endpoints have to be mounted |
120 |
|
|
and the cdc_acm thread needs to be activated. */ |
121 |
|
90 |
status = _ux_device_class_cdc_acm_activate(command); |
122 |
|
|
|
123 |
|
|
/* Return the completion status. */ |
124 |
|
90 |
return(status); |
125 |
|
|
|
126 |
|
73 |
case UX_SLAVE_CLASS_COMMAND_DEACTIVATE: |
127 |
|
|
|
128 |
|
|
/* The deactivate command is used when the device has been extracted. |
129 |
|
|
The device endpoints have to be dismounted and the cdc_acm thread canceled. */ |
130 |
|
73 |
status = _ux_device_class_cdc_acm_deactivate(command); |
131 |
|
|
|
132 |
|
|
/* Return the completion status. */ |
133 |
|
73 |
return(status); |
134 |
|
|
|
135 |
|
225 |
case UX_SLAVE_CLASS_COMMAND_REQUEST: |
136 |
|
|
|
137 |
|
|
/* The request command is used when the host sends a command on the control endpoint. */ |
138 |
|
225 |
status = _ux_device_class_cdc_acm_control_request(command); |
139 |
|
|
|
140 |
|
|
/* Return the completion status. */ |
141 |
|
225 |
return(status); |
142 |
|
|
|
143 |
|
1 |
default: |
144 |
|
|
|
145 |
|
|
/* If trace is enabled, insert this event into the trace buffer. */ |
146 |
|
|
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_FUNCTION_NOT_SUPPORTED, 0, 0, 0, UX_TRACE_ERRORS, 0, 0) |
147 |
|
|
|
148 |
|
|
/* Return an error. */ |
149 |
|
1 |
return(UX_FUNCTION_NOT_SUPPORTED); |
150 |
|
|
} |
151 |
|
|
} |
152 |
|
|
|