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
|
/***************************************************************************
* Copyright (c) 2024 Microsoft Corporation
* Copyright (c) 2026-present Eclipse ThreadX contributors
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** USBX Component */
/** */
/** Generic Serial Host module class */
/** */
/**************************************************************************/
/**************************************************************************/
/* Include necessary system files. */
#define UX_SOURCE_CODE
#include "ux_api.h"
#include "ux_host_class_gser.h"
#include "ux_host_stack.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_host_class_gser_activate PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function calls the USBX stack to activate the class. */
/* */
/* INPUT */
/* */
/* command Dpump class command pointer */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_class_gser_configure Configure gser class */
/* _ux_host_class_gser_endpoints_get Get endpoints of gser */
/* _ux_host_stack_class_instance_create Create class instance */
/* _ux_host_stack_class_instance_destroy Destroy the class instance */
/* _ux_utility_memory_allocate Allocate memory block */
/* _ux_utility_memory_free Free memory block */
/* */
/* CALLED BY */
/* */
/* _ux_host_class_gser_entry Entry of gser class */
/* */
/**************************************************************************/
UINT _ux_host_class_gser_activate(UX_HOST_CLASS_COMMAND *command)
{
UX_DEVICE *device;
UX_HOST_CLASS_GSER *gser;
UINT status;
ULONG interface_index;
/* The Generic Modem class is always activated by the device descriptor. */
device = (UX_DEVICE *) command -> ux_host_class_command_container;
/* Obtain memory for this class instance. */
gser = _ux_utility_memory_allocate(UX_NO_ALIGN, UX_REGULAR_MEMORY, sizeof(UX_HOST_CLASS_GSER));
if (gser == UX_NULL)
return(UX_MEMORY_INSUFFICIENT);
/* Store the class container into this instance. */
gser -> ux_host_class_gser_class = command -> ux_host_class_command_class_ptr;
/* Store the device container into the gser class instance. */
gser -> ux_host_class_gser_device = device;
/* Store the instance in the device container, this is for the USBX stack
when it needs to invoke the class for deactivation. */
device -> ux_device_class_instance = (VOID *) gser;
/* Create this class instance. */
_ux_host_stack_class_instance_create(gser -> ux_host_class_gser_class, (VOID *) gser);
/* Configure the gser class. */
status = _ux_host_class_gser_configure(gser);
/* Get the gser endpoint(s). We will need to search for Bulk Out and Bulk In endpoints on each interface . */
if (status == UX_SUCCESS)
status = _ux_host_class_gser_endpoints_get(gser);
/* Success things. */
if (status == UX_SUCCESS)
{
/* Mark the gser as live now. */
gser -> ux_host_class_gser_state = UX_HOST_CLASS_INSTANCE_LIVE;
/* If all is fine and the device is mounted, we may need to inform the application
if a function has been programmed in the system structure. */
if (_ux_system_host -> ux_system_host_change_function != UX_NULL)
{
/* Call system change function. */
_ux_system_host -> ux_system_host_change_function(UX_DEVICE_INSERTION, gser -> ux_host_class_gser_class, (VOID *) gser);
}
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_CLASS_GSER_ACTIVATE, gser, 0, 0, 0, UX_TRACE_HOST_CLASS_EVENTS, 0, 0)
/* If trace is enabled, register this object. */
UX_TRACE_OBJECT_REGISTER(UX_TRACE_HOST_OBJECT_TYPE_INTERFACE, gser, 0, 0, 0)
/* Return success. */
return(UX_SUCCESS);
}
/* Free created resources. */
for (interface_index = 0; interface_index < UX_HOST_CLASS_GSER_INTERFACE_NUMBER; interface_index ++)
{
if (_ux_host_semaphore_created(&gser -> ux_host_class_gser_interface_array[interface_index].ux_host_class_gser_semaphore))
_ux_host_semaphore_delete(&gser -> ux_host_class_gser_interface_array[interface_index].ux_host_class_gser_semaphore);
}
/* Destroy class instance. */
_ux_host_stack_class_instance_destroy(gser -> ux_host_class_gser_class, (VOID *) gser);
/* Clear the instance in the device container. */
device -> ux_device_class_instance = UX_NULL;
/* Free instance memory. */
_ux_utility_memory_free(gser);
/* Return completion status. */
return(status);
}
|