bd (Product Description)
The bd command provides a description of the architecture of the product. This includes all upstream and downstream ports. This is to provide external software the architecture of the USB connection tree.
Syntax: (see 'Command structure)
bdResponse: (see Response structure)
Name value pairs indicating the presence of features of the product. This is followed by a description of each USB hub in turn, listing what is attached to each port of that hub. Each port of a hub will be attached to a charging port, an expansion port, a downstream hub, a USB device or is unused.
The features are indicated by these entries:
| Parameter | Value |
|---|---|
| Ports | The number of USB ports |
| Sync | A '1' indicates the product provides sync capability |
| Temp | A '1' indicates the product can measure temperature |
| EXTPSU | A '1' indicates the product is supplied with an external PSU that is greater than 5V |
The attachment section can have the following entries, all indices are 1 based:
| Parameter | Value | Description |
|---|---|---|
| Nodes | n | A number indicating the number of nodes this description set includes. A node will be either a USB hub or a USB controller. |
| Node i Type | type | i is an index indicating which node this is. type is an entry from the Node Table below. |
| Node i Ports | n | A number indicating how many ports this node has. |
| Hub <i> Port <p> | Hub <j> |
The USB hub <i> has a down-stream hub <j> connected to its port <p> |
| Control Port | The USB hub <i> has the USB serial port attached to port <p> | |
| Expansion Port <e> | The USB hub <i> has an expansion port attached to port <p> | |
| Port <c> | The USB hub <i> has the charging port <c> attached to port <p> | |
| Optional Hub <j> | The USB hub <i> may have a down-stream hub <j> connected to its port <p> but this is optional so may not be fitted | |
| Turbo Hub <j> |
The USB hub <i> has a USB hub capable of operating in Turbo mode attached to port <p> |
|
| USB3 Hub <j> | The USB hub <i> has a USB 3.x hub attached to port <p> | |
| Unused Port | The USB hub <i> has nothing attached to its port <p> |
Node type can be one of the following:
| Node Type | Description |
|---|---|
| Hub j | A USB 2.0 hub index j |
| Optional Hub j | A USB hub that may be fitted, index j |
| Root r | A USB controller with a root hub which also means the USB bus number will change |
| Turbo Hub j | A USB hub capable of operating in Turbo mode with index j |
| USB3 Hub j | A USB 3.x hub with index j |
Example
>> bd
Ports: 15
Sync: 1
Temp: 1
EXTPSU: 1
Console: none
Nodes : 5
Node 1 Type : USB3 Hub 1
Node 1 Ports : 5
Hub 1 Port 1 : Turbo Hub 2
Hub 1 Port 2 : Turbo Hub 5
Hub 1 Port 3 : Turbo Hub 3
Hub 1 Port 4 : Turbo Hub 4
Hub 1 Port 5 : Control Port
Node 2 Type : Turbo Hub 2
Node 2 Ports : 4
Hub 2 Port 1 : Port 1
Hub 2 Port 2 : Port 2
Hub 2 Port 3 : Port 9
Hub 2 Port 4 : Port 8
Node 3 Type : Turbo Hub 3
Node 3 Ports : 4
Hub 3 Port 1 : Port 3
Hub 3 Port 2 : Port 4
Hub 3 Port 3 : Port 11
Hub 3 Port 4 : Port 10
Node 4 Type : Turbo Hub 4
Node 4 Ports : 4
Hub 4 Port 1 : Port 5
Hub 4 Port 2 : Unused Port
Hub 4 Port 3 : Port 13
Hub 4 Port 4 : Port 12
Node 5 Type : Turbo Hub 5
Node 5 Ports : 4
Hub 5 Port 1 : Port 6
Hub 5 Port 2 : Port 7
Hub 5 Port 3 : Port 15
Hub 5 Port 4 : Port 14