Commit 05db0dcc authored by Martin Blumenstingl's avatar Martin Blumenstingl Committed by Greg Kroah-Hartman

dt-bindings: usb: add the documentation for USB HCDs

A USB HCD may have several PHYs which need to be configured before the
the HCD starts working.
This adds the documentation for such a USB HCD as well as a reference to
the new "usb-hcd.txt" from all bindings that implement a USB HCD which
support one USB PHY per port.
Signed-off-by: default avatarMartin Blumenstingl <martin.blumenstingl@googlemail.com>
Reviewed-by: default avatarRob Herring <robh@kernel.org>
Tested-by: default avatarYixun Lan <yixun.lan@amlogic.com>
Tested-by: default avatarNeil Armstrong <narmstrong@baylibre.con>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 01812ba3
...@@ -32,7 +32,7 @@ Required properties: ...@@ -32,7 +32,7 @@ Required properties:
"mcu_ck": mcu_bus clock for register access, "mcu_ck": mcu_bus clock for register access,
"dma_ck": dma_bus clock for data transfer by DMA "dma_ck": dma_bus clock for data transfer by DMA
- phys : a list of phandle + phy specifier pairs - phys : see usb-hcd.txt in the current directory
Optional properties: Optional properties:
- wakeup-source : enable USB remote wakeup; - wakeup-source : enable USB remote wakeup;
...@@ -52,6 +52,9 @@ Optional properties: ...@@ -52,6 +52,9 @@ Optional properties:
See: Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt See: Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt
- imod-interval-ns: default interrupt moderation interval is 5000ns - imod-interval-ns: default interrupt moderation interval is 5000ns
additionally the properties from usb-hcd.txt (in the current directory) are
supported.
Example: Example:
usb30: usb@11270000 { usb30: usb@11270000 {
compatible = "mediatek,mt8173-xhci"; compatible = "mediatek,mt8173-xhci";
......
...@@ -17,7 +17,7 @@ Required properties: ...@@ -17,7 +17,7 @@ Required properties:
- clock-names : must contain "sys_ck" for clock of controller, - clock-names : must contain "sys_ck" for clock of controller,
the following clocks are optional: the following clocks are optional:
"ref_ck", "mcu_ck" and "dam_ck"; "ref_ck", "mcu_ck" and "dam_ck";
- phys : a list of phandle + phy specifier pairs - phys : see usb-hcd.txt in the current directory
- dr_mode : should be one of "host", "peripheral" or "otg", - dr_mode : should be one of "host", "peripheral" or "otg",
refer to usb/generic.txt refer to usb/generic.txt
...@@ -53,6 +53,9 @@ Optional properties: ...@@ -53,6 +53,9 @@ Optional properties:
- mediatek,u3p-dis-msk : mask to disable u3ports, bit0 for u3port0, - mediatek,u3p-dis-msk : mask to disable u3ports, bit0 for u3port0,
bit1 for u3port1, ... etc; bit1 for u3port1, ... etc;
additionally the properties from usb-hcd.txt (in the current directory) are
supported.
Sub-nodes: Sub-nodes:
The xhci should be added as subnode to mtu3 as shown in the following example The xhci should be added as subnode to mtu3 as shown in the following example
if host mode is enabled. The DT binding details of xhci can be found in: if host mode is enabled. The DT binding details of xhci can be found in:
......
...@@ -16,10 +16,12 @@ Optional properties: ...@@ -16,10 +16,12 @@ Optional properties:
- has-transaction-translator : boolean, set this if EHCI have a Transaction - has-transaction-translator : boolean, set this if EHCI have a Transaction
Translator built into the root hub. Translator built into the root hub.
- clocks : a list of phandle + clock specifier pairs - clocks : a list of phandle + clock specifier pairs
- phys : phandle + phy specifier pair - phys : see usb-hcd.txt in the current directory
- phy-names : "usb"
- resets : phandle + reset specifier pair - resets : phandle + reset specifier pair
additionally the properties from usb-hcd.txt (in the current directory) are
supported.
Example (Sequoia 440EPx): Example (Sequoia 440EPx):
ehci@e0000300 { ehci@e0000300 {
compatible = "ibm,usb-ehci-440epx", "usb-ehci"; compatible = "ibm,usb-ehci-440epx", "usb-ehci";
......
Generic USB HCD (Host Controller Device) Properties
Optional properties:
- phys: a list of all USB PHYs on this HCD
Example:
&usb1 {
phys = <&usb2_phy1>, <&usb3_phy1>;
};
...@@ -13,10 +13,12 @@ Optional properties: ...@@ -13,10 +13,12 @@ Optional properties:
- remote-wakeup-connected: remote wakeup is wired on the platform - remote-wakeup-connected: remote wakeup is wired on the platform
- num-ports : u32, to override the detected port count - num-ports : u32, to override the detected port count
- clocks : a list of phandle + clock specifier pairs - clocks : a list of phandle + clock specifier pairs
- phys : phandle + phy specifier pair - phys : see usb-hcd.txt in the current directory
- phy-names : "usb"
- resets : a list of phandle + reset specifier pairs - resets : a list of phandle + reset specifier pairs
additionally the properties from usb-hcd.txt (in the current directory) are
supported.
Example: Example:
ohci0: usb@1c14400 { ohci0: usb@1c14400 {
......
...@@ -6,6 +6,9 @@ Required properties: ...@@ -6,6 +6,9 @@ Required properties:
- reg : Should contain 1 register ranges(address and length) - reg : Should contain 1 register ranges(address and length)
- interrupts : UHCI controller interrupt - interrupts : UHCI controller interrupt
additionally the properties from usb-hcd.txt (in the current directory) are
supported.
Example: Example:
uhci@d8007b00 { uhci@d8007b00 {
......
...@@ -32,6 +32,11 @@ Optional properties: ...@@ -32,6 +32,11 @@ Optional properties:
- usb3-lpm-capable: determines if platform is USB3 LPM capable - usb3-lpm-capable: determines if platform is USB3 LPM capable
- quirk-broken-port-ped: set if the controller has broken port disable mechanism - quirk-broken-port-ped: set if the controller has broken port disable mechanism
- imod-interval-ns: default interrupt moderation interval is 5000ns - imod-interval-ns: default interrupt moderation interval is 5000ns
- phys : see usb-hcd.txt in the current directory
additionally the properties from usb-hcd.txt (in the current directory) are
supported.
Example: Example:
usb@f0931000 { usb@f0931000 {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment