Outline ![]()
Files ![]()
loading...
CodeScope![]()
STM32 Libraries and Samples![]()
usbx![]()
common/usbx_host_classes/src/ux_host_class_cdc_acm_configure.c
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
/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** USBX Component */
/** */
/** CDC ACM Class */
/** */
/**************************************************************************/
/**************************************************************************/
/* Include necessary system files. */
#define UX_SOURCE_CODE
#include "ux_api.h"
#include "ux_host_class_cdc_acm.h"
#include "ux_host_stack.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_host_class_cdc_acm_configure PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function calls the USBX stack to do a SET_CONFIGURATION to the */
/* cdc_acm. Once the cdc_acm is configured, its interface will be */
/* activated. The bulk endpoints (1 IN, 1 OUT ) and the optional */
/* interrupt endpoint are enumerated. */
/* */
/* INPUT */
/* */
/* cdc_acm Pointer to cdc_acm class */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_stack_configuration_interface_get Get interface */
/* _ux_host_stack_device_configuration_get Get configuration */
/* _ux_host_stack_device_configuration_select Select configuration */
/* */
/* CALLED BY */
/* */
/* _ux_host_class_cdc_acm_activate Data Pump class activate */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Chaoqiong Xiao Initial Version 6.0 */
/* 09-30-2020 Chaoqiong Xiao Modified comment(s), */
/* optimized based on compile */
/* definitions, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _ux_host_class_cdc_acm_configure(UX_HOST_CLASS_CDC_ACM *cdc_acm)
{
UINT status;
UX_CONFIGURATION *configuration;
#if UX_MAX_DEVICES > 1
UX_DEVICE *parent_device;
#endif
/* If the device has been configured already, we don't need to do it
again. */
if (cdc_acm -> ux_host_class_cdc_acm_device -> ux_device_state == UX_DEVICE_CONFIGURED)
return(UX_SUCCESS);
/* A cdc_acm normally has one configuration. So retrieve the 1st configuration
only. */
status = _ux_host_stack_device_configuration_get(cdc_acm -> ux_host_class_cdc_acm_device, 0, &configuration);
if (status != UX_SUCCESS)
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_CONFIGURATION_HANDLE_UNKNOWN);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_CONFIGURATION_HANDLE_UNKNOWN, cdc_acm -> ux_host_class_cdc_acm_device, 0, 0, UX_TRACE_ERRORS, 0, 0)
return(UX_CONFIGURATION_HANDLE_UNKNOWN);
}
#if UX_MAX_DEVICES > 1
/* Check the cdc_acm power source and check the parent power source for
incompatible connections. */
if (cdc_acm -> ux_host_class_cdc_acm_device -> ux_device_power_source == UX_DEVICE_BUS_POWERED)
{
/* Get parent device pointer. */
parent_device = cdc_acm -> ux_host_class_cdc_acm_device -> ux_device_parent;
/* If the device is NULL, the parent is the root cdc_acm and we don't have to worry
if the parent is not the root cdc_acm, check for its power source. */
if ((parent_device != UX_NULL) && (parent_device -> ux_device_power_source == UX_DEVICE_BUS_POWERED))
{
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_CONNECTION_INCOMPATIBLE);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_CONNECTION_INCOMPATIBLE, cdc_acm, 0, 0, UX_TRACE_ERRORS, 0, 0)
return(UX_CONNECTION_INCOMPATIBLE);
}
}
#endif
/* We have the valid configuration. Ask the USBX stack to set this configuration. */
status = _ux_host_stack_device_configuration_select(configuration);
if (status != UX_SUCCESS)
return(status);
/* If the operation went well, the cdc_acm default alternate setting for the cdc_acm interface is
active and the interrupt endpoint is now enabled. We have to memorize the first interface since
the interrupt endpoint is hooked to it. */
status = _ux_host_stack_configuration_interface_get(configuration, 0, 0, &cdc_acm -> ux_host_class_cdc_acm_interface);
if (status != UX_SUCCESS)
{
/* Store the instance in the interface container, this is for the USB stack
when it needs to invoke the class. */
cdc_acm -> ux_host_class_cdc_acm_interface -> ux_interface_class_instance = (VOID *) cdc_acm;
}
/* Return completion status. */
return(status);
}