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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
|
/***************************************************************************
* 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 */
/** */
/** HUB Class */
/** */
/**************************************************************************/
/**************************************************************************/
/* Include necessary system files. */
#define UX_SOURCE_CODE
#include "ux_api.h"
#include "ux_host_class_hub.h"
#include "ux_host_stack.h"
#if defined(UX_HOST_STANDALONE)
extern UINT _ux_host_class_hub_descriptor_parse(UX_HOST_CLASS_HUB *hub, UCHAR *descriptor);
static inline UINT _ux_host_class_hub_activate_wait(UX_HOST_CLASS_COMMAND *command);
#endif
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_host_class_hub_entry PORTABLE C */
/* 6.3.0 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function is the entry point of the HUB class. It will be */
/* called by the USBX stack enumeration module when there is a new */
/* device on the bus or when there is a device extraction. */
/* */
/* INPUT */
/* */
/* command Pointer to command */
/* */
/* OUTPUT */
/* */
/* Completion Status */
/* */
/* CALLS */
/* */
/* _ux_host_class_hub_activate Activate HUB class */
/* _ux_host_class_hub_deactivate Deactivate HUB class */
/* */
/* CALLED BY */
/* */
/* Host Stack */
/* */
/**************************************************************************/
UINT _ux_host_class_hub_entry(UX_HOST_CLASS_COMMAND *command)
{
UINT status;
/* The command request will tell us we need to do here, either a enumeration
query, an activation or a deactivation. */
switch (command -> ux_host_class_command_request)
{
case UX_HOST_CLASS_COMMAND_QUERY:
/* The query command is used to let the stack enumeration process know if we want to own
this device or not. */
if ((command -> ux_host_class_command_usage == UX_HOST_CLASS_COMMAND_USAGE_DCSP) &&
(command -> ux_host_class_command_class == UX_HOST_CLASS_HUB_CLASS))
return(UX_SUCCESS);
else
return(UX_NO_CLASS_MATCH);
case UX_HOST_CLASS_COMMAND_ACTIVATE:
/* The activate command is used when the device inserted has found a parent and
is ready to complete the enumeration. */
status = _ux_host_class_hub_activate(command);
/* Return completion status. */
return(status);
#if defined(UX_HOST_STANDALONE)
case UX_HOST_CLASS_COMMAND_ACTIVATE_WAIT:
status = _ux_host_class_hub_activate_wait(command);
return(status);
#endif
case UX_HOST_CLASS_COMMAND_DEACTIVATE:
/* The deactivate command is used when the device has been extracted either
directly or when its parents has been extracted */
status = _ux_host_class_hub_deactivate(command);
/* Return completion status. */
return(status);
default:
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, UX_FUNCTION_NOT_SUPPORTED);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, UX_FUNCTION_NOT_SUPPORTED, 0, 0, 0, UX_TRACE_ERRORS, 0, 0)
/* Return error status. */
return(UX_FUNCTION_NOT_SUPPORTED);
}
}
#if defined(UX_HOST_STANDALONE)
#define UX_HOST_STACK_ENUM_TRANS_ERROR(t) ( \
(t)->ux_transfer_request_completion_code != UX_SUCCESS || \
(t)->ux_transfer_request_actual_length != \
(t)->ux_transfer_request_requested_length)
static inline UINT _ux_host_class_hub_enum_get_status(UX_HOST_CLASS_HUB *hub, UX_TRANSFER *trans)
{
hub -> ux_host_class_hub_allocated = _ux_utility_memory_allocate(UX_NO_ALIGN, UX_CACHE_SAFE_MEMORY, 2);
if (hub -> ux_host_class_hub_allocated == UX_NULL)
return(UX_MEMORY_INSUFFICIENT);
trans -> ux_transfer_request_requested_length = 2;
trans -> ux_transfer_request_data_pointer = hub -> ux_host_class_hub_allocated;
trans -> ux_transfer_request_function = UX_GET_STATUS;
trans -> ux_transfer_request_type = UX_REQUEST_IN | UX_REQUEST_TYPE_STANDARD | UX_REQUEST_TARGET_DEVICE;
trans -> ux_transfer_request_value = 0;
trans -> ux_transfer_request_index = 0;
return(UX_SUCCESS);
}
static inline VOID _ux_host_class_hub_enum_set_config(UX_HOST_CLASS_HUB *hub, UX_TRANSFER *trans, UX_CONFIGURATION *configuration)
{
UX_PARAMETER_NOT_USED(hub);
trans -> ux_transfer_request_requested_length = 0;
trans -> ux_transfer_request_function = UX_SET_CONFIGURATION;
trans -> ux_transfer_request_type = UX_REQUEST_OUT | UX_REQUEST_TYPE_STANDARD | UX_REQUEST_TARGET_DEVICE;
trans -> ux_transfer_request_value = (USHORT) configuration -> ux_configuration_descriptor.bConfigurationValue;
trans -> ux_transfer_request_index = 0;
}
static inline UINT _ux_host_class_hub_activate_wait(UX_HOST_CLASS_COMMAND *command)
{
UX_DEVICE *device;
UX_ENDPOINT *ep0;
UX_TRANSFER *trans0, *trans;
UX_HOST_CLASS_HUB *hub;
UINT status;
ULONG current_ms, elapsed_ms;
/* Get the instance for this class. */
device = (UX_DEVICE *)command -> ux_host_class_command_container;
hub = (UX_HOST_CLASS_HUB *) device -> ux_device_class_instance;
/* Get endpoint 0 and transfer request. */
ep0 = &device -> ux_device_control_endpoint;
trans0 = &ep0 -> ux_endpoint_transfer_request;
/* Get current transfer request. */
trans = hub -> ux_host_class_hub_transfer;
/* Immediate state change: continue.
Wait/pending state : return. */
while(1)
{
/* Run initialize state machine. */
switch(hub -> ux_host_class_hub_enum_state)
{
case UX_HOST_CLASS_HUB_ENUM_GET_STATUS :
status = _ux_host_class_hub_enum_get_status(hub, trans0);
if (status != UX_SUCCESS)
{
hub -> ux_host_class_hub_enum_state = UX_HOST_CLASS_HUB_ENUM_DONE;
hub -> ux_host_class_hub_run_status = status;
continue;
}
UX_TRANSFER_STATE_RESET(trans0);
hub -> ux_host_class_hub_transfer = trans0;
hub -> ux_host_class_hub_enum_state = UX_HOST_CLASS_HUB_ENUM_TRANS_WAIT;
hub -> ux_host_class_hub_next_state = UX_HOST_CLASS_HUB_ENUM_POWER_CHECK;
continue;
case UX_HOST_CLASS_HUB_ENUM_POWER_CHECK :
/* Transfer request error check. */
if (UX_HOST_STACK_ENUM_TRANS_ERROR(trans))
{
hub -> ux_host_class_hub_enum_state = UX_HOST_CLASS_HUB_ENUM_DONE;
hub -> ux_host_class_hub_run_status = UX_CONNECTION_INCOMPATIBLE;
continue;
}
/* Save power source setting. */
if (hub -> ux_host_class_hub_allocated[0] & UX_STATUS_DEVICE_SELF_POWERED)
device -> ux_device_power_source = UX_DEVICE_SELF_POWERED;
else
device -> ux_device_power_source = UX_DEVICE_BUS_POWERED;
/* Free allocated buffer. */
_ux_utility_memory_free(hub -> ux_host_class_hub_allocated);
hub -> ux_host_class_hub_allocated = UX_NULL;
#if UX_MAX_DEVICES > 1
/* Check the HUB power source and check the parent power source. */
if (device -> ux_device_power_source == UX_DEVICE_BUS_POWERED)
{
/* Check parent power. */
if (device -> ux_device_parent != UX_NULL)
{
if (device -> ux_device_parent -> ux_device_power_source == UX_DEVICE_BUS_POWERED)
{
hub -> ux_host_class_hub_enum_state = UX_HOST_CLASS_HUB_ENUM_DONE;
hub -> ux_host_class_hub_run_status = UX_CONNECTION_INCOMPATIBLE;
continue;
}
}
}
#endif
/* Fall through. */
case UX_HOST_CLASS_HUB_ENUM_SET_CONFIG :
_ux_host_class_hub_enum_set_config(hub, trans0,
device -> ux_device_first_configuration);
UX_TRANSFER_STATE_RESET(trans0);
hub -> ux_host_class_hub_transfer = trans0;
hub -> ux_host_class_hub_enum_state = UX_HOST_CLASS_HUB_ENUM_TRANS_WAIT;
hub -> ux_host_class_hub_next_state = UX_HOST_CLASS_HUB_ENUM_SET_CONFIG_DONE;
continue;
case UX_HOST_CLASS_HUB_ENUM_SET_CONFIG_DONE :
/* Transfer request error check. */
if (UX_HOST_STACK_ENUM_TRANS_ERROR(trans))
{
hub -> ux_host_class_hub_enum_state = UX_HOST_CLASS_HUB_ENUM_DONE;
hub -> ux_host_class_hub_run_status = UX_CONNECTION_INCOMPATIBLE;
continue;
}
/* Create configuration instance. */
status = _ux_host_stack_configuration_instance_create(device -> ux_device_first_configuration);
if (status != UX_SUCCESS)
{
hub -> ux_host_class_hub_enum_state = UX_HOST_CLASS_HUB_ENUM_DONE;
hub -> ux_host_class_hub_run_status = status;
continue;
}
/* Change device state. */
device -> ux_device_state = UX_DEVICE_CONFIGURED;
device -> ux_device_current_configuration = device -> ux_device_first_configuration;
/* Fall through. */
case UX_HOST_CLASS_HUB_ENUM_GET_HUB_DESC :
status = _ux_host_class_hub_descriptor_get(hub);
if (UX_SUCCESS != status)
{
hub -> ux_host_class_hub_enum_state = UX_HOST_CLASS_HUB_ENUM_DONE;
hub -> ux_host_class_hub_run_status = status;
continue;
}
/* Request already updated, to transfer state. */
hub -> ux_host_class_hub_enum_state = UX_HOST_CLASS_HUB_ENUM_TRANS_WAIT;
hub -> ux_host_class_hub_next_state = UX_HOST_CLASS_HUB_ENUM_GET_HUB_DESC_DONE;
continue;
case UX_HOST_CLASS_HUB_ENUM_GET_HUB_DESC_DONE:
/* Transfer request error check. */
if (UX_HOST_STACK_ENUM_TRANS_ERROR(trans))
{
hub -> ux_host_class_hub_enum_state = UX_HOST_CLASS_HUB_ENUM_DONE;
hub -> ux_host_class_hub_run_status = UX_DESCRIPTOR_CORRUPTED;
continue;
}
/* Parse descriptor. */
status = _ux_host_class_hub_descriptor_parse(hub, hub -> ux_host_class_hub_allocated);
if (status != UX_SUCCESS)
{
hub -> ux_host_class_hub_enum_state = UX_HOST_CLASS_HUB_ENUM_DONE;
hub -> ux_host_class_hub_run_status = status;
continue;
}
/* Free the allocated descriptor. */
_ux_utility_memory_free(hub -> ux_host_class_hub_allocated);
hub -> ux_host_class_hub_allocated = UX_NULL;
/* Initialize for port power ON. */
hub -> ux_host_class_hub_run_port = 1;
/* Fall through. */
case UX_HOST_CLASS_HUB_ENUM_PORT_POWER :
/* Prepare for SetPortFeature(POWER). */
status = _ux_host_class_hub_feature(hub,
hub -> ux_host_class_hub_run_port,
UX_SET_FEATURE, UX_HOST_CLASS_HUB_PORT_POWER);
/* Request already updated, to transfer state. */
hub -> ux_host_class_hub_enum_state = UX_HOST_CLASS_HUB_ENUM_TRANS_WAIT;
hub -> ux_host_class_hub_next_state = UX_HOST_CLASS_HUB_ENUM_PORT_POWER_DELAY;
continue;
case UX_HOST_CLASS_HUB_ENUM_PORT_POWER_DELAY :
/* Transfer request error check. */
if (UX_HOST_STACK_ENUM_TRANS_ERROR(trans))
{
/* Set the HUB status to not powered. */
hub -> ux_host_class_hub_port_power &=
(UINT)~(1u << hub -> ux_host_class_hub_run_port);
hub -> ux_host_class_hub_enum_state = UX_HOST_CLASS_HUB_ENUM_PORT_NEXT;
continue;
}
/* Delay a while (as described by hub descriptor). */
hub -> ux_host_class_hub_wait_start = _ux_utility_time_get();
hub -> ux_host_class_hub_wait_ms = UX_MS_TO_TICK_NON_ZERO((ULONG)hub -> ux_host_class_hub_descriptor.bPwrOn2PwrGood << 1);
hub -> ux_host_class_hub_enum_state = UX_HOST_CLASS_HUB_ENUM_TRANS_WAIT;
hub -> ux_host_class_hub_next_state = UX_HOST_CLASS_HUB_ENUM_PORT_POWER_ON;
continue;
case UX_HOST_CLASS_HUB_ENUM_PORT_POWER_ON:
hub -> ux_host_class_hub_port_power |= (UINT)(1u << hub -> ux_host_class_hub_run_port);
/* Fall through. */
case UX_HOST_CLASS_HUB_ENUM_PORT_NEXT :
/* Check if the last port is powered. */
if (hub -> ux_host_class_hub_run_port <
hub -> ux_host_class_hub_descriptor.bNbPorts)
{
/* Start another port power. */
hub -> ux_host_class_hub_run_port ++;
hub -> ux_host_class_hub_enum_state = UX_HOST_CLASS_HUB_ENUM_PORT_POWER;
continue;
}
/* All port is powered. */
/* Fall through. */
case UX_HOST_CLASS_HUB_ENUM_INTERRUPT_START :
status = _ux_host_class_hub_interrupt_endpoint_start(hub);
if (status != UX_SUCCESS)
hub -> ux_host_class_hub_run_status = status;
/* Fall through. */
case UX_HOST_CLASS_HUB_ENUM_DONE :
/* Free buffer allocated while enumerating. */
if (hub -> ux_host_class_hub_allocated)
{
_ux_utility_memory_free(hub -> ux_host_class_hub_allocated);
hub -> ux_host_class_hub_allocated = UX_NULL;
}
/* Error cases. */
if (hub -> ux_host_class_hub_run_status != UX_SUCCESS)
{
/* Unlink from device. */
device -> ux_device_class_instance = UX_NULL;
/* Error trap. */
_ux_system_error_handler(UX_SYSTEM_LEVEL_THREAD, UX_SYSTEM_CONTEXT_CLASS, hub -> ux_host_class_hub_run_status);
/* If trace is enabled, insert this event into the trace buffer. */
UX_TRACE_IN_LINE_INSERT(UX_TRACE_ERROR, hub -> ux_host_class_hub_run_status, hub, 0, 0, UX_TRACE_ERRORS, 0, 0)
/* Free hub. */
_ux_utility_memory_free(hub);
return(UX_STATE_ERROR);
}
/* Done success. */
/* Create this class instance. */
_ux_host_stack_class_instance_create(hub -> ux_host_class_hub_class, (VOID *) hub);
/* Store the instance in the device container, this is for the USBX stack
when it needs to invoke the class. */
device -> ux_device_class_instance = (VOID *) hub;
/* Mark the HUB as live now. */
hub -> ux_host_class_hub_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, hub -> ux_host_class_hub_class, (VOID *) hub);
}
/* Next state: CHANGE_CHECK. */
hub -> ux_host_class_hub_enum_state = UX_STATE_IDLE;
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_CHANGE_CHECK;
hub -> ux_host_class_hub_run_port = 0;
/* Done activate. */
return(UX_STATE_NEXT);
case UX_HOST_CLASS_HUB_ENUM_TRANS_WAIT:
/* Poll transfer task. */
status = _ux_host_stack_transfer_run(hub -> ux_host_class_hub_transfer);
hub -> ux_host_class_hub_run_status = hub -> ux_host_class_hub_transfer ->
ux_transfer_request_completion_code;
/* Transfer done - next state. */
if (status == UX_STATE_NEXT || status == UX_STATE_IDLE)
{
hub -> ux_host_class_hub_enum_state = hub -> ux_host_class_hub_next_state;
continue;
}
/* Check error. */
if (status < UX_STATE_NEXT)
{
/* Fail. */
hub -> ux_host_class_hub_enum_state = UX_HOST_CLASS_HUB_ENUM_DONE;
continue;
}
/* Transfer in progress, wait. */
return(UX_STATE_WAIT);
case UX_HOST_CLASS_HUB_ENUM_DELAY_WAIT:
current_ms = _ux_utility_time_get();
elapsed_ms = _ux_utility_time_elapsed(current_ms,
hub -> ux_host_class_hub_wait_start);
if (elapsed_ms < hub -> ux_host_class_hub_wait_ms)
{
/* Keep waiting. */
return(UX_STATE_WAIT);
}
/* Next state. */
hub -> ux_host_class_hub_enum_state = hub -> ux_host_class_hub_next_state;
continue;
default:
return(UX_STATE_NEXT);
}
}
}
#endif
|
