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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
/***************************************************************************
* 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 */
/** */
/** Host Stack */
/** */
/**************************************************************************/
/**************************************************************************/
/* Include necessary system files. */
#define UX_SOURCE_CODE
#include "ux_api.h"
#include "ux_host_stack.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_host_stack_hcd_register PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function registers a USB controller driver with the USBX stack */
/* and invokes the HCD driver's initialization function. */
/* */
/* Note: The C string of hcd_name must be NULL-terminated and the */
/* length of it (without the NULL-terminator itself) must be no larger */
/* than UX_MAX_HCD_NAME_LENGTH. */
/* */
/* INPUT */
/* */
/* hcd_name Name of HCD to register */
/* hcd_entry_function Entry function of HCD driver */
/* hcd_param1 Parameter 1 of HCD */
/* hcd_param2 Parameter 2 of HCD */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* */
/* CALLS */
/* */
/* _ux_utility_string_length_check Check and return C string */
/* length if no error */
/* _ux_utility_memory_copy Copy name into HCD structure */
/* (hcd_init_function) Init function of HCD driver */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/**************************************************************************/
UINT _ux_host_stack_hcd_register(UCHAR *hcd_name,
UINT (*hcd_init_function)(struct UX_HCD_STRUCT *), ULONG hcd_param1, ULONG hcd_param2)
{
UX_HCD *hcd;
UINT status;
#if !defined(UX_NAME_REFERENCED_BY_POINTER)
UINT hcd_name_length = 0;
#endif
#if UX_MAX_HCD > 1
ULONG hcd_index;
#endif
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_HOST_STACK_HCD_REGISTER, hcd_name, hcd_param1, hcd_param2, 0, UX_TRACE_HOST_STACK_EVENTS, 0, 0)
#if !defined(UX_NAME_REFERENCED_BY_POINTER)
/* Get the length of the class name (exclude null-terminator). */
status = _ux_utility_string_length_check(hcd_name, &hcd_name_length, UX_MAX_HCD_NAME_LENGTH);
if (status)
return(status);
#endif
/* Get HCD. */
hcd = _ux_system_host -> ux_system_host_hcd_array;
#if UX_MAX_HCD > 1
/* We need to parse the controller driver table to find an empty spot. */
for(hcd_index = 0; hcd_index < _ux_system_host -> ux_system_host_max_hcd; hcd_index++)
{
#endif
/* Is this slot available? */
if(hcd -> ux_hcd_status == UX_UNUSED)
{
/* Yes, setup the new HCD entry. */
#if defined(UX_NAME_REFERENCED_BY_POINTER)
hcd -> ux_hcd_name = (const UCHAR *)hcd_name;
#else
/* Initialize the array of the new controller with its name (include null-terminator). */
_ux_utility_memory_copy(hcd -> ux_hcd_name, hcd_name, hcd_name_length + 1); /* Use case of memcpy is verified. */
#endif
/* Store the hardware resources of the controller */
hcd -> ux_hcd_io = hcd_param1;
hcd -> ux_hcd_irq = hcd_param2;
/* This controller is now used */
hcd -> ux_hcd_status = UX_USED;
/* And we have one new controller registered. */
_ux_system_host -> ux_system_host_registered_hcd++;
/* We are now calling the HCD driver initialization. */
status = hcd_init_function(hcd);
/* Return the completion status to the caller. */
return(status);
}
#if UX_MAX_HCD > 1
/* Try the next HCD structure */
hcd++;
}
#endif
/* We have exhausted the array of the HCDs, return an error. */
return(UX_MEMORY_INSUFFICIENT);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _uxe_host_stack_hcd_register PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function checks errors in host stack HCD register function */
/* call. */
/* */
/* INPUT */
/* */
/* endpoint Endpoint to abort transfer */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* _ux_host_stack_hcd_register HCD register */
/* */
/* CALLED BY */
/* */
/* Application */
/* */
/**************************************************************************/
UINT _uxe_host_stack_hcd_register(UCHAR *hcd_name,
UINT (*hcd_init_function)(struct UX_HCD_STRUCT *), ULONG hcd_param1, ULONG hcd_param2)
{
/* Sanity check. */
if ((hcd_name == UX_NULL) || (hcd_init_function == UX_NULL))
return(UX_INVALID_PARAMETER);
/* Invoke HCD register function. */
return(_ux_host_stack_hcd_register(hcd_name, hcd_init_function, hcd_param1, hcd_param2));
}
|
