Access Restricted
This page contains internal documentation that is not publicly available.
DHWCtrl.EthWaitLinkState
Block until the PHY-reported link state on Index matches
State, or until TimeoutMs milliseconds elapse. Returns OK
once the link reaches the requested state, ErrTimeout
otherwise. Use TimeoutMs = 0 to probe the current state
in a single round-trip.
Properties
- Command code: 0xE104
- Command timeout: 100 ms
- Possible status codes: General status codes, DHWCtrl.ErrInvalidIndex, DHWCtrl.ErrNotActive, DHWCtrl.ErrTimeout
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 link state to wait for.
PHY-reported link state of an Ethernet port. Used as the target state for EthWaitLinkState. Values (2):
|
|
| TimeoutMs | Integer (16 bits) | Maximum time the firmware will wait for the operation to complete, in milliseconds. | |
Returned values (response frame)
None