aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJohan Hovold <johan@kernel.org>2017-11-09 12:07:19 -0500
committerRob Herring <robh@kernel.org>2017-11-16 12:01:15 -0500
commitf877918cdd793373fb7a960c72ba3639786e8e8f (patch)
tree4509f3bb46a531d168f535f73dfc3bef2682f965
parentbfebcf54608a749800a171ffd01f7d5b450e9a55 (diff)
dt-bindings: usb: document hub and host-controller properties
Hub nodes and host-controller nodes with child nodes must specify values for #address-cells (1) and #size-cells (0). Also make the definition of the related reg property a bit more stringent, and add comments to the example source. Signed-off-by: Johan Hovold <johan@kernel.org> Signed-off-by: Rob Herring <robh@kernel.org>
-rw-r--r--Documentation/devicetree/bindings/usb/usb-device.txt20
1 files changed, 16 insertions, 4 deletions
diff --git a/Documentation/devicetree/bindings/usb/usb-device.txt b/Documentation/devicetree/bindings/usb/usb-device.txt
index e0b562e35a0c..1b27cebb47f4 100644
--- a/Documentation/devicetree/bindings/usb/usb-device.txt
+++ b/Documentation/devicetree/bindings/usb/usb-device.txt
@@ -4,22 +4,34 @@ Usually, we only use device tree for hard wired USB device.
4The reference binding doc is from: 4The reference binding doc is from:
5http://www.devicetree.org/open-firmware/bindings/usb/usb-1_0.ps 5http://www.devicetree.org/open-firmware/bindings/usb/usb-1_0.ps
6 6
7
7Required properties: 8Required properties:
8- compatible: "usbVID,PID", where VID is the vendor id and PID the product id. 9- compatible: "usbVID,PID", where VID is the vendor id and PID the product id.
9 The textual representation of VID and PID shall be in lower case hexadecimal 10 The textual representation of VID and PID shall be in lower case hexadecimal
10 with leading zeroes suppressed. The other compatible strings from the above 11 with leading zeroes suppressed. The other compatible strings from the above
11 standard binding could also be used, but a device adhering to this binding 12 standard binding could also be used, but a device adhering to this binding
12 may leave out all except for "usbVID,PID". 13 may leave out all except for "usbVID,PID".
13- reg: the port number which this device is connecting to, the range 14- reg: the number of the USB hub port or the USB host-controller port to which
14 is 1-255. 15 this device is attached. The range is 1-255.
16
17
18Required properties for hub nodes with device nodes:
19- #address-cells: shall be 1
20- #size-cells: shall be 0
21
22
23Required properties for host-controller nodes with device nodes:
24- #address-cells: shall be 1
25- #size-cells: shall be 0
26
15 27
16Example: 28Example:
17 29
18&usb1 { 30&usb1 { /* host controller */
19 #address-cells = <1>; 31 #address-cells = <1>;
20 #size-cells = <0>; 32 #size-cells = <0>;
21 33
22 hub@1 { 34 hub@1 { /* hub connected to port 1 */
23 compatible = "usb5e3,608"; 35 compatible = "usb5e3,608";
24 reg = <1>; 36 reg = <1>;
25 }; 37 };