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
|
/***************************************************************************
* 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)
static inline VOID _ux_host_class_hub_inst_tasks_run(UX_HOST_CLASS_HUB *hub);
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _ux_host_class_hub_tasks_run PORTABLE C */
/* 6.2.1 */
/* AUTHOR */
/* */
/* Chaoqiong Xiao, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function runs HUB background tasks. */
/* */
/* This function is for standalone mode. */
/* */
/* INPUT */
/* */
/* hub Pointer to HUB instance */
/* */
/* OUTPUT */
/* */
/* None */
/* */
/* CALLS */
/* */
/* _ux_host_class_hub_port_change_connection_process */
/* Process connection */
/* _ux_host_class_hub_port_change_enable_process */
/* Enable process */
/* _ux_host_class_hub_port_change_over_current_process */
/* Change over current process */
/* _ux_host_class_hub_port_change_reset_process */
/* Reset process */
/* _ux_host_class_hub_port_change_suspend_process */
/* Suspend process */
/* _ux_host_class_hub_feature Prepare feature request */
/* _ux_host_class_hub_status_get Prepare get status request */
/* _ux_utility_short_get Get 16-bit word */
/* _ux_utility_memory_free Memory free */
/* _ux_host_stack_new_device_create Obtain a free device instance */
/* _ux_host_stack_transfer_run Process the transfer */
/* */
/* CALLED BY */
/* */
/* USBX Host Stack */
/* */
/**************************************************************************/
UINT _ux_host_class_hub_tasks_run(UX_HOST_CLASS *hub_class)
{
UX_HOST_CLASS_HUB *hub;
/* Validate class entry. */
if (hub_class -> ux_host_class_status != UX_USED ||
hub_class -> ux_host_class_entry_function != _ux_host_class_hub_entry)
return(UX_STATE_IDLE);
/* Run for class instances. */
hub = (UX_HOST_CLASS_HUB *)hub_class -> ux_host_class_first_instance;
while(hub)
{
/* Run tasks for each HUB instance. */
_ux_host_class_hub_inst_tasks_run(hub);
hub = hub -> ux_host_class_hub_next_instance;
}
return(UX_STATE_WAIT);
}
/* Return non-zero if there is change. */
static inline UCHAR _ux_host_class_hub_change_check(UX_HOST_CLASS_HUB *hub)
{
UX_ENDPOINT *endpoint = hub -> ux_host_class_hub_interrupt_endpoint;
UX_TRANSFER *transfer = &endpoint -> ux_endpoint_transfer_request;
UCHAR *buffer = transfer -> ux_transfer_request_data_pointer;
UCHAR byte_i = (UCHAR)(hub -> ux_host_class_hub_run_port >> 3);
UCHAR bit_i = (UCHAR)(hub -> ux_host_class_hub_run_port & 0x7u);
UCHAR res = (UCHAR)(buffer[byte_i] & (1u << bit_i));
buffer[byte_i] = (UCHAR)(buffer[byte_i] & ~(1u << bit_i));
return(res);
}
static inline VOID _ux_host_class_hub_status_process(UX_HOST_CLASS_HUB *hub, UINT port)
{
USHORT port_status = hub -> ux_host_class_hub_run_port_status;
USHORT port_change = hub -> ux_host_class_hub_run_port_change;
/* Next port, if all changes handled. */
if (port_change == 0)
{
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_CHANGE_NEXT;
return;
}
if (port_change & UX_HOST_CLASS_HUB_PORT_CHANGE_OVER_CURRENT)
{
hub -> ux_host_class_hub_run_port_change = (USHORT)
(hub -> ux_host_class_hub_run_port_change &
~UX_HOST_CLASS_HUB_PORT_CHANGE_OVER_CURRENT);
_ux_host_class_hub_port_change_over_current_process(hub, port, port_status);
/* Next: wait transfer done, then check change again. */
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_TRANS_WAIT;
hub -> ux_host_class_hub_next_state = UX_HOST_CLASS_HUB_STATUS_PROCESS;
return;
}
if (port_change & UX_HOST_CLASS_HUB_PORT_CHANGE_ENABLE)
{
hub -> ux_host_class_hub_run_port_change = (USHORT)
(hub -> ux_host_class_hub_run_port_change &
~UX_HOST_CLASS_HUB_PORT_CHANGE_ENABLE);
_ux_host_class_hub_port_change_enable_process(hub, port, port_status);
/* Next: wait transfer done, then check change again. */
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_TRANS_WAIT;
hub -> ux_host_class_hub_next_state = UX_HOST_CLASS_HUB_STATUS_PROCESS;
return;
}
if (port_change & UX_HOST_CLASS_HUB_PORT_CHANGE_SUSPEND)
{
hub -> ux_host_class_hub_run_port_change = (USHORT)
(hub -> ux_host_class_hub_run_port_change &
~UX_HOST_CLASS_HUB_PORT_CHANGE_SUSPEND);
_ux_host_class_hub_port_change_suspend_process(hub, port, port_status);
/* Next: wait transfer done, then check change again. */
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_TRANS_WAIT;
hub -> ux_host_class_hub_next_state = UX_HOST_CLASS_HUB_STATUS_PROCESS;
return;
}
if (port_change & UX_HOST_CLASS_HUB_PORT_CHANGE_RESET)
{
hub -> ux_host_class_hub_run_port_change = (USHORT)
(hub -> ux_host_class_hub_run_port_change &
~UX_HOST_CLASS_HUB_PORT_CHANGE_RESET);
_ux_host_class_hub_port_change_reset_process(hub, port, port_status);
/* Next: wait transfer done, then process reset
(get status and update enum device). */
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_TRANS_WAIT;
hub -> ux_host_class_hub_next_state = UX_HOST_CLASS_HUB_RESET_PROCESS;
return;
}
if (port_change & UX_HOST_CLASS_HUB_PORT_CHANGE_CONNECTION)
{
hub -> ux_host_class_hub_run_port_change = (USHORT)
(hub -> ux_host_class_hub_run_port_change &
~UX_HOST_CLASS_HUB_PORT_CHANGE_CONNECTION);
_ux_host_class_hub_port_change_connection_process(hub, port, port_status);
if (hub -> ux_host_class_hub_port_state & (1u << port))
{
/* Next: clear c_connection, then process connect. */
_ux_host_class_hub_feature(hub, port, UX_CLEAR_FEATURE, UX_HOST_CLASS_HUB_C_PORT_CONNECTION);
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_TRANS_WAIT;
hub -> ux_host_class_hub_next_state = UX_HOST_CLASS_HUB_CONNECT_PROCESS;
return;
}
/* Disable port, then clear c_enable, c_connection. */
_ux_host_class_hub_feature(hub, port, UX_CLEAR_FEATURE, UX_HOST_CLASS_HUB_PORT_ENABLE);
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_TRANS_WAIT;
hub -> ux_host_class_hub_next_state = UX_HOST_CLASS_HUB_DISC_DISABLED;
return;
}
}
static inline VOID _ux_host_class_hub_inst_tasks_run(UX_HOST_CLASS_HUB *hub)
{
UX_HCD *hcd;
UX_DEVICE *device;
UX_DEVICE *hub_device = hub -> ux_host_class_hub_device;
UX_ENDPOINT *ep0 = &hub_device -> ux_device_control_endpoint;
UX_ENDPOINT *dev_ep0;
UX_TRANSFER *trans0 = &ep0 -> ux_endpoint_transfer_request;
UINT status;
/* Task runs when hub is live. */
if (hub -> ux_host_class_hub_state != UX_HOST_CLASS_INSTANCE_LIVE)
return;
while(1)
{
/* Immediate state change: continue.
Wait/pending state : return. */
switch(hub -> ux_host_class_hub_run_state)
{
case UX_HOST_CLASS_HUB_CHANGE_CHECK :
/* Check if current port has changes. */
if (_ux_host_class_hub_change_check(hub))
{
if (hub -> ux_host_class_hub_run_port == 0)
{
/* Device state change. */
/* There is nothing handled now. */
/* Next state: try next, port 1. */
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_CHANGE_NEXT;
continue;
}
/* Port state change. */
/* Next: read status. */
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_STATUS_GET;
continue;
}
/* No change detected,
* still need to check if there is enumeration reset request. */
device = _ux_system_host -> ux_system_host_enum_device;
while(device != UX_NULL)
{
/* Check if a device is waiting on the port for reset. */
if ((device -> ux_device_flags & UX_DEVICE_FLAG_RESET) &&
UX_DEVICE_PARENT_MATCH(device, hub_device) &&
(device -> ux_device_port_location == hub -> ux_host_class_hub_run_port))
{
device -> ux_device_flags &= ~UX_DEVICE_FLAG_RESET;
break;
}
/* Next enumerating device. */
device = device -> ux_device_enum_next;
}
if (device)
{
/* Next: reset then check port status ... */
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_RESET;
continue;
}
/* No change, try next port. */
/* Fall through. */
case UX_HOST_CLASS_HUB_CHANGE_NEXT :
if (hub -> ux_host_class_hub_run_port <
hub -> ux_host_class_hub_descriptor.bNbPorts)
{
/* Check next port. */
hub -> ux_host_class_hub_run_port ++;
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_CHANGE_CHECK;
continue;
}
/* All ports checked, next round. */
hub -> ux_host_class_hub_run_port = 0;
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_CHANGE_CHECK;
return;
case UX_HOST_CLASS_HUB_RESET :
status = _ux_host_class_hub_feature(hub, hub -> ux_host_class_hub_run_port,
UX_SET_FEATURE, UX_HOST_CLASS_HUB_PORT_RESET);
/* Next: check another port, actions are taken on C_RESET detection. */
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_TRANS_WAIT;
hub -> ux_host_class_hub_next_state = UX_HOST_CLASS_HUB_CHANGE_NEXT;
continue;
case UX_HOST_CLASS_HUB_STATUS_GET :
status = _ux_host_class_hub_status_get(hub, hub -> ux_host_class_hub_run_port, UX_NULL, UX_NULL);
if (status != UX_SUCCESS)
{
/* Fail, retry. */
hub -> ux_host_class_hub_run_port = 0;
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_CHANGE_CHECK;
return;
}
hub -> ux_host_class_hub_transfer = trans0;
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_TRANS_WAIT;
hub -> ux_host_class_hub_next_state = UX_HOST_CLASS_HUB_STATUS_GET_DONE;
continue;
case UX_HOST_CLASS_HUB_STATUS_GET_DONE:
/* Store status change for later usage. */
hub -> ux_host_class_hub_run_port_status = (USHORT)
_ux_utility_short_get(hub -> ux_host_class_hub_allocated);
hub -> ux_host_class_hub_run_port_change = (USHORT)
_ux_utility_short_get(hub -> ux_host_class_hub_allocated + 2);
/* Free allocated buffer. */
_ux_utility_memory_free(hub -> ux_host_class_hub_allocated);
hub -> ux_host_class_hub_allocated = UX_NULL;
/* Fall through. */
case UX_HOST_CLASS_HUB_STATUS_PROCESS :
_ux_host_class_hub_status_process(hub, hub -> ux_host_class_hub_run_port);
hub -> ux_host_class_hub_transfer = trans0;
continue;
case UX_HOST_CLASS_HUB_CONNECT_PROCESS:
status = _ux_host_stack_new_device_create(UX_DEVICE_HCD_GET(hub_device),
hub_device, hub -> ux_host_class_hub_run_port,
UX_FULL_SPEED_DEVICE, UX_MAX_SELF_POWER,
&device);
if (status == UX_SUCCESS)
{
/* Put device in enumeration list. */
device -> ux_device_flags |= UX_DEVICE_FLAG_ENUM;
}
/* Try next port. */
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_CHANGE_NEXT;
return;
case UX_HOST_CLASS_HUB_DISC_DISABLED:
/* Next: clear C_ENABLE, then clear C_CONNECTION. */
_ux_host_class_hub_feature(hub, hub -> ux_host_class_hub_run_port, UX_CLEAR_FEATURE, UX_HOST_CLASS_HUB_C_PORT_ENABLE);
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_TRANS_WAIT;
hub -> ux_host_class_hub_next_state = UX_HOST_CLASS_HUB_DISC_CLEAR_1;
continue;
case UX_HOST_CLASS_HUB_DISC_CLEAR_1:
/* Next: clear C_CONNECTION, then next port. */
_ux_host_class_hub_feature(hub, hub -> ux_host_class_hub_run_port, UX_CLEAR_FEATURE, UX_HOST_CLASS_HUB_C_PORT_CONNECTION);
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_TRANS_WAIT;
hub -> ux_host_class_hub_next_state = UX_HOST_CLASS_HUB_CHANGE_NEXT;
continue;
case UX_HOST_CLASS_HUB_RESET_PROCESS :
/* Find enum device, update enum port status, state -> ADDR_SET. */
device = _ux_system_host -> ux_system_host_enum_device;
while(device != UX_NULL)
{
/* If there is a device connected to the port, put its state to ADDR_SET. */
if (UX_DEVICE_PARENT_MATCH(device, hub -> ux_host_class_hub_device) &&
(device -> ux_device_port_location == hub -> ux_host_class_hub_run_port))
{
/* Save status and speed. */
device -> ux_device_enum_port_status = (UCHAR)hub -> ux_host_class_hub_run_port_status;
/* Append speed information. */
switch(hub -> ux_host_class_hub_run_port_status &
(UX_HOST_CLASS_HUB_PORT_STATUS_LOW_SPEED | UX_HOST_CLASS_HUB_PORT_STATUS_HIGH_SPEED))
{
case 0: /* It's Full speed. */
device -> ux_device_enum_port_status |= UX_PS_DS_FS;
device -> ux_device_speed = UX_FULL_SPEED_DEVICE;
break;
case UX_HOST_CLASS_HUB_PORT_STATUS_HIGH_SPEED: /* It's high speed. */
device -> ux_device_enum_port_status |= UX_PS_DS_HS;
device -> ux_device_speed = UX_HIGH_SPEED_DEVICE;
break;
default: /* It's Low speed. */
device -> ux_device_speed = UX_LOW_SPEED_DEVICE;
break;
}
/* Return device address to 0. */
hcd = UX_DEVICE_HCD_GET(device);
#if UX_MAX_DEVICES > 1
if (device -> ux_device_address)
{
/* Free the address. */
hcd -> ux_hcd_address[(device -> ux_device_address-1) >> 3] &=
(UCHAR)(1u << ((device -> ux_device_address-1) & 7u));
}
#endif
/* Assume speed change, re-create EP0 at the HCD level. */
dev_ep0 = &device -> ux_device_control_endpoint;
hcd -> ux_hcd_entry_function(hcd, UX_HCD_DESTROY_ENDPOINT, (VOID *)dev_ep0);
hcd -> ux_hcd_entry_function(hcd, UX_HCD_CREATE_ENDPOINT, (VOID *)dev_ep0);
/* Wait a while and set address. */
device -> ux_device_enum_next_state = UX_HOST_STACK_ENUM_DEVICE_ADDR_SET;
device -> ux_device_enum_state = UX_HOST_STACK_ENUM_WAIT;
device -> ux_device_enum_wait_start = _ux_utility_time_get();
device -> ux_device_enum_wait_ms = UX_MS_TO_TICK_NON_ZERO(2);
break;
}
/* Next device. */
device = device -> ux_device_enum_next;
}
/* Reset processed check other status. */
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_STATUS_PROCESS;
continue;
case UX_HOST_CLASS_HUB_TRANS_WAIT :
/* Poll transfer task. */
status = _ux_host_stack_transfer_run(hub -> ux_host_class_hub_transfer);
/* Transfer done - next state. */
if (status == UX_STATE_NEXT || status == UX_STATE_IDLE)
{
hub -> ux_host_class_hub_run_state = hub -> ux_host_class_hub_next_state;
continue;
}
/* Check error. */
if (status < UX_STATE_NEXT)
{
/* Fail, just check next port. */
hub -> ux_host_class_hub_run_state = UX_HOST_CLASS_HUB_CHANGE_NEXT;
hub -> ux_host_class_hub_run_status =
hub -> ux_host_class_hub_transfer ->
ux_transfer_request_completion_code;
continue;
}
/* Transfer in progress, wait. */
return;
default:
break;
}
}
}
#endif
|
