Access Restricted
This page contains internal documentation that is not publicly available.
DHWCtrl.UsbHostWaitPortStatus
Block until the attach state on Index matches State,
or until TimeoutMs milliseconds elapse. Always returns
OK with the current Speed (NoDevice if no device is
attached, Low / Full / High otherwise) - the host
compares the response against its requested State to
decide whether the wait condition was met. Use
TimeoutMs = 0 to probe.
Properties
- Command code: 0xE125
- Command timeout: 100 ms
- Possible status codes: General status codes, DHWCtrl.ErrInvalidIndex, DHWCtrl.ErrNotActive
Parameters (request frame)
| Name | Type/Size | Description | |
|---|---|---|---|
| Index | Integer (8 bits) | Zero-based instance index within this peripheral category. The valid range is firmware / hardware-variant specific; discoverable via ListPeripherals. | |
| State | Enumeration (8 bits) |
Desired attach state to wait for.
Attach state of a USB host port. Used as the target state for UsbHostWaitPortStatus. Values (2):
|
|
| TimeoutMs | Integer (16 bits) | Maximum time the firmware will wait for the operation to complete, in milliseconds. | |
Returned values (response frame)
| Name | Type/Size | Description | |
|---|---|---|---|
| Speed | Enumeration (8 bits) |
Current bus speed of the attached USB device.
Values (4):
|
|