From mboxrd@z Thu Jan 1 00:00:00 1970 From: Martin Blumenstingl Subject: [PATCH usb-next v9 1/8] dt-bindings: usb: add the documentation for USB HCDs Date: Sun, 11 Feb 2018 22:06:44 +0100 Message-ID: <20180211210651.2046-2-martin.blumenstingl@googlemail.com> References: <20180211210651.2046-1-martin.blumenstingl@googlemail.com> Return-path: In-Reply-To: <20180211210651.2046-1-martin.blumenstingl-gM/Ye1E23mwN+BqQ9rBEUg@public.gmane.org> Sender: linux-tegra-owner-u79uwXL29TY76Z2rM5mHXA@public.gmane.org To: linux-usb-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, mathias.nyman-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org, arnd-r2nGTMty4D4@public.gmane.org, gregkh-hQyY1W1yCW8ekmWlsbkhG0B+6BGkLq7r@public.gmane.org, felipe.balbi-VuQAYsv1563Yd54FQh9/CA@public.gmane.org Cc: linux-omap-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, linux-tegra-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, linux-mediatek-IAPFreCvJWM7uuMidbF8XUB+6BGkLq7r@public.gmane.org, linux-arm-kernel-IAPFreCvJWM7uuMidbF8XUB+6BGkLq7r@public.gmane.org, devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, jonathanh-DDmLM1+adcrQT0dZR+AlfA@public.gmane.org, thierry.reding-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org, stern-nwvwT67g6+6dFdvTe/nMLpVzexx5G7lz@public.gmane.org, linux-ci5G2KO2hbZ+pU9mqzGVBQ@public.gmane.org, Peter.Chen-3arQi8VN3Tc@public.gmane.org, matthias.bgg-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org, mark.rutland-5wv7dgnIgG8@public.gmane.org, robh+dt-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org, narmstrong-rdvid1DuHRBWk0Htik3J/w@public.gmane.org, linux-amlogic-IAPFreCvJWM7uuMidbF8XUB+6BGkLq7r@public.gmane.org, yixun.lan-LpR1jeaWuhtBDgjK7y7TUQ@public.gmane.org, Martin Blumenstingl List-Id: linux-tegra@vger.kernel.org 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: Martin Blumenstingl Reviewed-by: Rob Herring Tested-by: Yixun Lan --- Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt | 5 ++++- Documentation/devicetree/bindings/usb/mediatek,mtu3.txt | 5 ++++- Documentation/devicetree/bindings/usb/usb-ehci.txt | 6 ++++-- Documentation/devicetree/bindings/usb/usb-hcd.txt | 9 +++++++++ Documentation/devicetree/bindings/usb/usb-ohci.txt | 6 ++++-- Documentation/devicetree/bindings/usb/usb-uhci.txt | 3 +++ Documentation/devicetree/bindings/usb/usb-xhci.txt | 5 +++++ 7 files changed, 33 insertions(+), 6 deletions(-) create mode 100644 Documentation/devicetree/bindings/usb/usb-hcd.txt diff --git a/Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt b/Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt index 88d9f4a4b280..266c2d917a28 100644 --- a/Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt +++ b/Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt @@ -32,7 +32,7 @@ Required properties: "mcu_ck": mcu_bus clock for register access, "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: - wakeup-source : enable USB remote wakeup; @@ -52,6 +52,9 @@ Optional properties: See: Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt - imod-interval-ns: default interrupt moderation interval is 5000ns +additionally the properties from usb-hcd.txt (in the current directory) are +supported. + Example: usb30: usb@11270000 { compatible = "mediatek,mt8173-xhci"; diff --git a/Documentation/devicetree/bindings/usb/mediatek,mtu3.txt b/Documentation/devicetree/bindings/usb/mediatek,mtu3.txt index d589a1ef96a1..3382b5cb471d 100644 --- a/Documentation/devicetree/bindings/usb/mediatek,mtu3.txt +++ b/Documentation/devicetree/bindings/usb/mediatek,mtu3.txt @@ -17,7 +17,7 @@ Required properties: - clock-names : must contain "sys_ck" for clock of controller, the following clocks are optional: "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", refer to usb/generic.txt @@ -53,6 +53,9 @@ Optional properties: - mediatek,u3p-dis-msk : mask to disable u3ports, bit0 for u3port0, bit1 for u3port1, ... etc; +additionally the properties from usb-hcd.txt (in the current directory) are +supported. + Sub-nodes: 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: diff --git a/Documentation/devicetree/bindings/usb/usb-ehci.txt b/Documentation/devicetree/bindings/usb/usb-ehci.txt index 3efde12b5d68..0f1b75386207 100644 --- a/Documentation/devicetree/bindings/usb/usb-ehci.txt +++ b/Documentation/devicetree/bindings/usb/usb-ehci.txt @@ -16,10 +16,12 @@ Optional properties: - has-transaction-translator : boolean, set this if EHCI have a Transaction Translator built into the root hub. - clocks : a list of phandle + clock specifier pairs - - phys : phandle + phy specifier pair - - phy-names : "usb" + - phys : see usb-hcd.txt in the current directory - resets : phandle + reset specifier pair +additionally the properties from usb-hcd.txt (in the current directory) are +supported. + Example (Sequoia 440EPx): ehci@e0000300 { compatible = "ibm,usb-ehci-440epx", "usb-ehci"; diff --git a/Documentation/devicetree/bindings/usb/usb-hcd.txt b/Documentation/devicetree/bindings/usb/usb-hcd.txt new file mode 100644 index 000000000000..50529b838c9c --- /dev/null +++ b/Documentation/devicetree/bindings/usb/usb-hcd.txt @@ -0,0 +1,9 @@ +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>; + }; diff --git a/Documentation/devicetree/bindings/usb/usb-ohci.txt b/Documentation/devicetree/bindings/usb/usb-ohci.txt index 09e70c875bc6..a8d2103d1f3d 100644 --- a/Documentation/devicetree/bindings/usb/usb-ohci.txt +++ b/Documentation/devicetree/bindings/usb/usb-ohci.txt @@ -13,10 +13,12 @@ Optional properties: - remote-wakeup-connected: remote wakeup is wired on the platform - num-ports : u32, to override the detected port count - clocks : a list of phandle + clock specifier pairs -- phys : phandle + phy specifier pair -- phy-names : "usb" +- phys : see usb-hcd.txt in the current directory - resets : a list of phandle + reset specifier pairs +additionally the properties from usb-hcd.txt (in the current directory) are +supported. + Example: ohci0: usb@1c14400 { diff --git a/Documentation/devicetree/bindings/usb/usb-uhci.txt b/Documentation/devicetree/bindings/usb/usb-uhci.txt index 298133416c97..cc2e6f7d602e 100644 --- a/Documentation/devicetree/bindings/usb/usb-uhci.txt +++ b/Documentation/devicetree/bindings/usb/usb-uhci.txt @@ -6,6 +6,9 @@ Required properties: - reg : Should contain 1 register ranges(address and length) - interrupts : UHCI controller interrupt +additionally the properties from usb-hcd.txt (in the current directory) are +supported. + Example: uhci@d8007b00 { diff --git a/Documentation/devicetree/bindings/usb/usb-xhci.txt b/Documentation/devicetree/bindings/usb/usb-xhci.txt index e2ea59bbca93..2f7663bb69ff 100644 --- a/Documentation/devicetree/bindings/usb/usb-xhci.txt +++ b/Documentation/devicetree/bindings/usb/usb-xhci.txt @@ -32,6 +32,11 @@ Optional properties: - usb3-lpm-capable: determines if platform is USB3 LPM capable - quirk-broken-port-ped: set if the controller has broken port disable mechanism - 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: usb@f0931000 { -- 2.16.1 From mboxrd@z Thu Jan 1 00:00:00 1970 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: base64 Subject: [usb-next,v9,1/8] dt-bindings: usb: add the documentation for USB HCDs From: Martin Blumenstingl Message-Id: <20180211210651.2046-2-martin.blumenstingl@googlemail.com> Date: Sun, 11 Feb 2018 22:06:44 +0100 To: linux-usb@vger.kernel.org, mathias.nyman@intel.com, arnd@arndb.de, gregkh@linuxfoundation.org, felipe.balbi@linux.intel.com Cc: linux-omap@vger.kernel.org, linux-tegra@vger.kernel.org, linux-mediatek@lists.infradead.org, linux-arm-kernel@lists.infradead.org, devicetree@vger.kernel.org, jonathanh@nvidia.com, thierry.reding@gmail.com, stern@rowland.harvard.edu, linux@prisktech.co.nz, Peter.Chen@nxp.com, matthias.bgg@gmail.com, mark.rutland@arm.com, robh+dt@kernel.org, narmstrong@baylibre.com, linux-amlogic@lists.infradead.org, yixun.lan@amlogic.com, Martin Blumenstingl List-ID: QSBVU0IgSENEIG1heSBoYXZlIHNldmVyYWwgUEhZcyB3aGljaCBuZWVkIHRvIGJlIGNvbmZpZ3Vy ZWQgYmVmb3JlIHRoZQp0aGUgSENEIHN0YXJ0cyB3b3JraW5nLgpUaGlzIGFkZHMgdGhlIGRvY3Vt ZW50YXRpb24gZm9yIHN1Y2ggYSBVU0IgSENEIGFzIHdlbGwgYXMgYSByZWZlcmVuY2UgdG8KdGhl IG5ldyAidXNiLWhjZC50eHQiIGZyb20gYWxsIGJpbmRpbmdzIHRoYXQgaW1wbGVtZW50IGEgVVNC IEhDRCB3aGljaApzdXBwb3J0IG9uZSBVU0IgUEhZIHBlciBwb3J0LgoKU2lnbmVkLW9mZi1ieTog TWFydGluIEJsdW1lbnN0aW5nbCA8bWFydGluLmJsdW1lbnN0aW5nbEBnb29nbGVtYWlsLmNvbT4K UmV2aWV3ZWQtYnk6IFJvYiBIZXJyaW5nIDxyb2JoQGtlcm5lbC5vcmc+ClRlc3RlZC1ieTogWWl4 dW4gTGFuIDx5aXh1bi5sYW5AYW1sb2dpYy5jb20+Ci0tLQogRG9jdW1lbnRhdGlvbi9kZXZpY2V0 cmVlL2JpbmRpbmdzL3VzYi9tZWRpYXRlayxtdGsteGhjaS50eHQgfCA1ICsrKystCiBEb2N1bWVu dGF0aW9uL2RldmljZXRyZWUvYmluZGluZ3MvdXNiL21lZGlhdGVrLG10dTMudHh0ICAgICB8IDUg KysrKy0KIERvY3VtZW50YXRpb24vZGV2aWNldHJlZS9iaW5kaW5ncy91c2IvdXNiLWVoY2kudHh0 ICAgICAgICAgIHwgNiArKysrLS0KIERvY3VtZW50YXRpb24vZGV2aWNldHJlZS9iaW5kaW5ncy91 c2IvdXNiLWhjZC50eHQgICAgICAgICAgIHwgOSArKysrKysrKysKIERvY3VtZW50YXRpb24vZGV2 aWNldHJlZS9iaW5kaW5ncy91c2IvdXNiLW9oY2kudHh0ICAgICAgICAgIHwgNiArKysrLS0KIERv Y3VtZW50YXRpb24vZGV2aWNldHJlZS9iaW5kaW5ncy91c2IvdXNiLXVoY2kudHh0ICAgICAgICAg IHwgMyArKysKIERvY3VtZW50YXRpb24vZGV2aWNldHJlZS9iaW5kaW5ncy91c2IvdXNiLXhoY2ku dHh0ICAgICAgICAgIHwgNSArKysrKwogNyBmaWxlcyBjaGFuZ2VkLCAzMyBpbnNlcnRpb25zKCsp LCA2IGRlbGV0aW9ucygtKQogY3JlYXRlIG1vZGUgMTAwNjQ0IERvY3VtZW50YXRpb24vZGV2aWNl dHJlZS9iaW5kaW5ncy91c2IvdXNiLWhjZC50eHQKCmRpZmYgLS1naXQgYS9Eb2N1bWVudGF0aW9u L2RldmljZXRyZWUvYmluZGluZ3MvdXNiL21lZGlhdGVrLG10ay14aGNpLnR4dCBiL0RvY3VtZW50 YXRpb24vZGV2aWNldHJlZS9iaW5kaW5ncy91c2IvbWVkaWF0ZWssbXRrLXhoY2kudHh0CmluZGV4 IDg4ZDlmNGE0YjI4MC4uMjY2YzJkOTE3YTI4IDEwMDY0NAotLS0gYS9Eb2N1bWVudGF0aW9uL2Rl dmljZXRyZWUvYmluZGluZ3MvdXNiL21lZGlhdGVrLG10ay14aGNpLnR4dAorKysgYi9Eb2N1bWVu dGF0aW9uL2RldmljZXRyZWUvYmluZGluZ3MvdXNiL21lZGlhdGVrLG10ay14aGNpLnR4dApAQCAt MzIsNyArMzIsNyBAQCBSZXF1aXJlZCBwcm9wZXJ0aWVzOgogCSJtY3VfY2siOiBtY3VfYnVzIGNs b2NrIGZvciByZWdpc3RlciBhY2Nlc3MsCiAJImRtYV9jayI6IGRtYV9idXMgY2xvY2sgZm9yIGRh dGEgdHJhbnNmZXIgYnkgRE1BCiAKLSAtIHBoeXMgOiBhIGxpc3Qgb2YgcGhhbmRsZSArIHBoeSBz cGVjaWZpZXIgcGFpcnMKKyAtIHBoeXMgOiBzZWUgdXNiLWhjZC50eHQgaW4gdGhlIGN1cnJlbnQg ZGlyZWN0b3J5CiAKIE9wdGlvbmFsIHByb3BlcnRpZXM6CiAgLSB3YWtldXAtc291cmNlIDogZW5h YmxlIFVTQiByZW1vdGUgd2FrZXVwOwpAQCAtNTIsNiArNTIsOSBAQCBPcHRpb25hbCBwcm9wZXJ0 aWVzOgogCVNlZTogRG9jdW1lbnRhdGlvbi9kZXZpY2V0cmVlL2JpbmRpbmdzL3BpbmN0cmwvcGlu Y3RybC1iaW5kaW5ncy50eHQKICAtIGltb2QtaW50ZXJ2YWwtbnM6IGRlZmF1bHQgaW50ZXJydXB0 IG1vZGVyYXRpb24gaW50ZXJ2YWwgaXMgNTAwMG5zCiAKK2FkZGl0aW9uYWxseSB0aGUgcHJvcGVy dGllcyBmcm9tIHVzYi1oY2QudHh0IChpbiB0aGUgY3VycmVudCBkaXJlY3RvcnkpIGFyZQorc3Vw cG9ydGVkLgorCiBFeGFtcGxlOgogdXNiMzA6IHVzYkAxMTI3MDAwMCB7CiAJY29tcGF0aWJsZSA9 ICJtZWRpYXRlayxtdDgxNzMteGhjaSI7CmRpZmYgLS1naXQgYS9Eb2N1bWVudGF0aW9uL2Rldmlj ZXRyZWUvYmluZGluZ3MvdXNiL21lZGlhdGVrLG10dTMudHh0IGIvRG9jdW1lbnRhdGlvbi9kZXZp Y2V0cmVlL2JpbmRpbmdzL3VzYi9tZWRpYXRlayxtdHUzLnR4dAppbmRleCBkNTg5YTFlZjk2YTEu LjMzODJiNWNiNDcxZCAxMDA2NDQKLS0tIGEvRG9jdW1lbnRhdGlvbi9kZXZpY2V0cmVlL2JpbmRp bmdzL3VzYi9tZWRpYXRlayxtdHUzLnR4dAorKysgYi9Eb2N1bWVudGF0aW9uL2RldmljZXRyZWUv YmluZGluZ3MvdXNiL21lZGlhdGVrLG10dTMudHh0CkBAIC0xNyw3ICsxNyw3IEBAIFJlcXVpcmVk IHByb3BlcnRpZXM6CiAgLSBjbG9jay1uYW1lcyA6IG11c3QgY29udGFpbiAic3lzX2NrIiBmb3Ig Y2xvY2sgb2YgY29udHJvbGxlciwKIAl0aGUgZm9sbG93aW5nIGNsb2NrcyBhcmUgb3B0aW9uYWw6 CiAJInJlZl9jayIsICJtY3VfY2siIGFuZCAiZGFtX2NrIjsKLSAtIHBoeXMgOiBhIGxpc3Qgb2Yg cGhhbmRsZSArIHBoeSBzcGVjaWZpZXIgcGFpcnMKKyAtIHBoeXMgOiBzZWUgdXNiLWhjZC50eHQg aW4gdGhlIGN1cnJlbnQgZGlyZWN0b3J5CiAgLSBkcl9tb2RlIDogc2hvdWxkIGJlIG9uZSBvZiAi aG9zdCIsICJwZXJpcGhlcmFsIiBvciAib3RnIiwKIAlyZWZlciB0byB1c2IvZ2VuZXJpYy50eHQK IApAQCAtNTMsNiArNTMsOSBAQCBPcHRpb25hbCBwcm9wZXJ0aWVzOgogIC0gbWVkaWF0ZWssdTNw LWRpcy1tc2sgOiBtYXNrIHRvIGRpc2FibGUgdTNwb3J0cywgYml0MCBmb3IgdTNwb3J0MCwKIAli aXQxIGZvciB1M3BvcnQxLCAuLi4gZXRjOwogCithZGRpdGlvbmFsbHkgdGhlIHByb3BlcnRpZXMg ZnJvbSB1c2ItaGNkLnR4dCAoaW4gdGhlIGN1cnJlbnQgZGlyZWN0b3J5KSBhcmUKK3N1cHBvcnRl ZC4KKwogU3ViLW5vZGVzOgogVGhlIHhoY2kgc2hvdWxkIGJlIGFkZGVkIGFzIHN1Ym5vZGUgdG8g bXR1MyBhcyBzaG93biBpbiB0aGUgZm9sbG93aW5nIGV4YW1wbGUKIGlmIGhvc3QgbW9kZSBpcyBl bmFibGVkLiBUaGUgRFQgYmluZGluZyBkZXRhaWxzIG9mIHhoY2kgY2FuIGJlIGZvdW5kIGluOgpk aWZmIC0tZ2l0IGEvRG9jdW1lbnRhdGlvbi9kZXZpY2V0cmVlL2JpbmRpbmdzL3VzYi91c2ItZWhj aS50eHQgYi9Eb2N1bWVudGF0aW9uL2RldmljZXRyZWUvYmluZGluZ3MvdXNiL3VzYi1laGNpLnR4 dAppbmRleCAzZWZkZTEyYjVkNjguLjBmMWI3NTM4NjIwNyAxMDA2NDQKLS0tIGEvRG9jdW1lbnRh dGlvbi9kZXZpY2V0cmVlL2JpbmRpbmdzL3VzYi91c2ItZWhjaS50eHQKKysrIGIvRG9jdW1lbnRh dGlvbi9kZXZpY2V0cmVlL2JpbmRpbmdzL3VzYi91c2ItZWhjaS50eHQKQEAgLTE2LDEwICsxNiwx MiBAQCBPcHRpb25hbCBwcm9wZXJ0aWVzOgogIC0gaGFzLXRyYW5zYWN0aW9uLXRyYW5zbGF0b3Ig OiBib29sZWFuLCBzZXQgdGhpcyBpZiBFSENJIGhhdmUgYSBUcmFuc2FjdGlvbgogCQkJCVRyYW5z bGF0b3IgYnVpbHQgaW50byB0aGUgcm9vdCBodWIuCiAgLSBjbG9ja3MgOiBhIGxpc3Qgb2YgcGhh bmRsZSArIGNsb2NrIHNwZWNpZmllciBwYWlycwotIC0gcGh5cyA6IHBoYW5kbGUgKyBwaHkgc3Bl Y2lmaWVyIHBhaXIKLSAtIHBoeS1uYW1lcyA6ICJ1c2IiCisgLSBwaHlzIDogc2VlIHVzYi1oY2Qu dHh0IGluIHRoZSBjdXJyZW50IGRpcmVjdG9yeQogIC0gcmVzZXRzIDogcGhhbmRsZSArIHJlc2V0 IHNwZWNpZmllciBwYWlyCiAKK2FkZGl0aW9uYWxseSB0aGUgcHJvcGVydGllcyBmcm9tIHVzYi1o Y2QudHh0IChpbiB0aGUgY3VycmVudCBkaXJlY3RvcnkpIGFyZQorc3VwcG9ydGVkLgorCiBFeGFt cGxlIChTZXF1b2lhIDQ0MEVQeCk6CiAgICAgZWhjaUBlMDAwMDMwMCB7CiAJICAgY29tcGF0aWJs ZSA9ICJpYm0sdXNiLWVoY2ktNDQwZXB4IiwgInVzYi1laGNpIjsKZGlmZiAtLWdpdCBhL0RvY3Vt ZW50YXRpb24vZGV2aWNldHJlZS9iaW5kaW5ncy91c2IvdXNiLWhjZC50eHQgYi9Eb2N1bWVudGF0 aW9uL2RldmljZXRyZWUvYmluZGluZ3MvdXNiL3VzYi1oY2QudHh0Cm5ldyBmaWxlIG1vZGUgMTAw NjQ0CmluZGV4IDAwMDAwMDAwMDAwMC4uNTA1MjliODM4YzljCi0tLSAvZGV2L251bGwKKysrIGIv RG9jdW1lbnRhdGlvbi9kZXZpY2V0cmVlL2JpbmRpbmdzL3VzYi91c2ItaGNkLnR4dApAQCAtMCww ICsxLDkgQEAKK0dlbmVyaWMgVVNCIEhDRCAoSG9zdCBDb250cm9sbGVyIERldmljZSkgUHJvcGVy dGllcworCitPcHRpb25hbCBwcm9wZXJ0aWVzOgorLSBwaHlzOiBhIGxpc3Qgb2YgYWxsIFVTQiBQ SFlzIG9uIHRoaXMgSENECisKK0V4YW1wbGU6CisJJnVzYjEgeworCQlwaHlzID0gPCZ1c2IyX3Bo eTE+LCA8JnVzYjNfcGh5MT47CisJfTsKZGlmZiAtLWdpdCBhL0RvY3VtZW50YXRpb24vZGV2aWNl dHJlZS9iaW5kaW5ncy91c2IvdXNiLW9oY2kudHh0IGIvRG9jdW1lbnRhdGlvbi9kZXZpY2V0cmVl L2JpbmRpbmdzL3VzYi91c2Itb2hjaS50eHQKaW5kZXggMDllNzBjODc1YmM2Li5hOGQyMTAzZDFm M2QgMTAwNjQ0Ci0tLSBhL0RvY3VtZW50YXRpb24vZGV2aWNldHJlZS9iaW5kaW5ncy91c2IvdXNi LW9oY2kudHh0CisrKyBiL0RvY3VtZW50YXRpb24vZGV2aWNldHJlZS9iaW5kaW5ncy91c2IvdXNi LW9oY2kudHh0CkBAIC0xMywxMCArMTMsMTIgQEAgT3B0aW9uYWwgcHJvcGVydGllczoKIC0gcmVt b3RlLXdha2V1cC1jb25uZWN0ZWQ6IHJlbW90ZSB3YWtldXAgaXMgd2lyZWQgb24gdGhlIHBsYXRm b3JtCiAtIG51bS1wb3J0cyA6IHUzMiwgdG8gb3ZlcnJpZGUgdGhlIGRldGVjdGVkIHBvcnQgY291 bnQKIC0gY2xvY2tzIDogYSBsaXN0IG9mIHBoYW5kbGUgKyBjbG9jayBzcGVjaWZpZXIgcGFpcnMK LS0gcGh5cyA6IHBoYW5kbGUgKyBwaHkgc3BlY2lmaWVyIHBhaXIKLS0gcGh5LW5hbWVzIDogInVz YiIKKy0gcGh5cyA6IHNlZSB1c2ItaGNkLnR4dCBpbiB0aGUgY3VycmVudCBkaXJlY3RvcnkKIC0g cmVzZXRzIDogYSBsaXN0IG9mIHBoYW5kbGUgKyByZXNldCBzcGVjaWZpZXIgcGFpcnMKIAorYWRk aXRpb25hbGx5IHRoZSBwcm9wZXJ0aWVzIGZyb20gdXNiLWhjZC50eHQgKGluIHRoZSBjdXJyZW50 IGRpcmVjdG9yeSkgYXJlCitzdXBwb3J0ZWQuCisKIEV4YW1wbGU6CiAKIAlvaGNpMDogdXNiQDFj MTQ0MDAgewpkaWZmIC0tZ2l0IGEvRG9jdW1lbnRhdGlvbi9kZXZpY2V0cmVlL2JpbmRpbmdzL3Vz Yi91c2ItdWhjaS50eHQgYi9Eb2N1bWVudGF0aW9uL2RldmljZXRyZWUvYmluZGluZ3MvdXNiL3Vz Yi11aGNpLnR4dAppbmRleCAyOTgxMzM0MTZjOTcuLmNjMmU2ZjdkNjAyZSAxMDA2NDQKLS0tIGEv RG9jdW1lbnRhdGlvbi9kZXZpY2V0cmVlL2JpbmRpbmdzL3VzYi91c2ItdWhjaS50eHQKKysrIGIv RG9jdW1lbnRhdGlvbi9kZXZpY2V0cmVlL2JpbmRpbmdzL3VzYi91c2ItdWhjaS50eHQKQEAgLTYs NiArNiw5IEBAIFJlcXVpcmVkIHByb3BlcnRpZXM6CiAtIHJlZyA6IFNob3VsZCBjb250YWluIDEg cmVnaXN0ZXIgcmFuZ2VzKGFkZHJlc3MgYW5kIGxlbmd0aCkKIC0gaW50ZXJydXB0cyA6IFVIQ0kg Y29udHJvbGxlciBpbnRlcnJ1cHQKIAorYWRkaXRpb25hbGx5IHRoZSBwcm9wZXJ0aWVzIGZyb20g dXNiLWhjZC50eHQgKGluIHRoZSBjdXJyZW50IGRpcmVjdG9yeSkgYXJlCitzdXBwb3J0ZWQuCisK IEV4YW1wbGU6CiAKIAl1aGNpQGQ4MDA3YjAwIHsKZGlmZiAtLWdpdCBhL0RvY3VtZW50YXRpb24v ZGV2aWNldHJlZS9iaW5kaW5ncy91c2IvdXNiLXhoY2kudHh0IGIvRG9jdW1lbnRhdGlvbi9kZXZp Y2V0cmVlL2JpbmRpbmdzL3VzYi91c2IteGhjaS50eHQKaW5kZXggZTJlYTU5YmJjYTkzLi4yZjc2 NjNiYjY5ZmYgMTAwNjQ0Ci0tLSBhL0RvY3VtZW50YXRpb24vZGV2aWNldHJlZS9iaW5kaW5ncy91 c2IvdXNiLXhoY2kudHh0CisrKyBiL0RvY3VtZW50YXRpb24vZGV2aWNldHJlZS9iaW5kaW5ncy91 c2IvdXNiLXhoY2kudHh0CkBAIC0zMiw2ICszMiwxMSBAQCBPcHRpb25hbCBwcm9wZXJ0aWVzOgog ICAtIHVzYjMtbHBtLWNhcGFibGU6IGRldGVybWluZXMgaWYgcGxhdGZvcm0gaXMgVVNCMyBMUE0g Y2FwYWJsZQogICAtIHF1aXJrLWJyb2tlbi1wb3J0LXBlZDogc2V0IGlmIHRoZSBjb250cm9sbGVy IGhhcyBicm9rZW4gcG9ydCBkaXNhYmxlIG1lY2hhbmlzbQogICAtIGltb2QtaW50ZXJ2YWwtbnM6 IGRlZmF1bHQgaW50ZXJydXB0IG1vZGVyYXRpb24gaW50ZXJ2YWwgaXMgNTAwMG5zCisgIC0gcGh5 cyA6IHNlZSB1c2ItaGNkLnR4dCBpbiB0aGUgY3VycmVudCBkaXJlY3RvcnkKKworYWRkaXRpb25h bGx5IHRoZSBwcm9wZXJ0aWVzIGZyb20gdXNiLWhjZC50eHQgKGluIHRoZSBjdXJyZW50IGRpcmVj dG9yeSkgYXJlCitzdXBwb3J0ZWQuCisKIAogRXhhbXBsZToKIAl1c2JAZjA5MzEwMDAgewo= From mboxrd@z Thu Jan 1 00:00:00 1970 From: martin.blumenstingl@googlemail.com (Martin Blumenstingl) Date: Sun, 11 Feb 2018 22:06:44 +0100 Subject: [PATCH usb-next v9 1/8] dt-bindings: usb: add the documentation for USB HCDs In-Reply-To: <20180211210651.2046-1-martin.blumenstingl@googlemail.com> References: <20180211210651.2046-1-martin.blumenstingl@googlemail.com> Message-ID: <20180211210651.2046-2-martin.blumenstingl@googlemail.com> To: linux-arm-kernel@lists.infradead.org List-Id: linux-arm-kernel.lists.infradead.org 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: Martin Blumenstingl Reviewed-by: Rob Herring Tested-by: Yixun Lan --- Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt | 5 ++++- Documentation/devicetree/bindings/usb/mediatek,mtu3.txt | 5 ++++- Documentation/devicetree/bindings/usb/usb-ehci.txt | 6 ++++-- Documentation/devicetree/bindings/usb/usb-hcd.txt | 9 +++++++++ Documentation/devicetree/bindings/usb/usb-ohci.txt | 6 ++++-- Documentation/devicetree/bindings/usb/usb-uhci.txt | 3 +++ Documentation/devicetree/bindings/usb/usb-xhci.txt | 5 +++++ 7 files changed, 33 insertions(+), 6 deletions(-) create mode 100644 Documentation/devicetree/bindings/usb/usb-hcd.txt diff --git a/Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt b/Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt index 88d9f4a4b280..266c2d917a28 100644 --- a/Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt +++ b/Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt @@ -32,7 +32,7 @@ Required properties: "mcu_ck": mcu_bus clock for register access, "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: - wakeup-source : enable USB remote wakeup; @@ -52,6 +52,9 @@ Optional properties: See: Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt - imod-interval-ns: default interrupt moderation interval is 5000ns +additionally the properties from usb-hcd.txt (in the current directory) are +supported. + Example: usb30: usb at 11270000 { compatible = "mediatek,mt8173-xhci"; diff --git a/Documentation/devicetree/bindings/usb/mediatek,mtu3.txt b/Documentation/devicetree/bindings/usb/mediatek,mtu3.txt index d589a1ef96a1..3382b5cb471d 100644 --- a/Documentation/devicetree/bindings/usb/mediatek,mtu3.txt +++ b/Documentation/devicetree/bindings/usb/mediatek,mtu3.txt @@ -17,7 +17,7 @@ Required properties: - clock-names : must contain "sys_ck" for clock of controller, the following clocks are optional: "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", refer to usb/generic.txt @@ -53,6 +53,9 @@ Optional properties: - mediatek,u3p-dis-msk : mask to disable u3ports, bit0 for u3port0, bit1 for u3port1, ... etc; +additionally the properties from usb-hcd.txt (in the current directory) are +supported. + Sub-nodes: 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: diff --git a/Documentation/devicetree/bindings/usb/usb-ehci.txt b/Documentation/devicetree/bindings/usb/usb-ehci.txt index 3efde12b5d68..0f1b75386207 100644 --- a/Documentation/devicetree/bindings/usb/usb-ehci.txt +++ b/Documentation/devicetree/bindings/usb/usb-ehci.txt @@ -16,10 +16,12 @@ Optional properties: - has-transaction-translator : boolean, set this if EHCI have a Transaction Translator built into the root hub. - clocks : a list of phandle + clock specifier pairs - - phys : phandle + phy specifier pair - - phy-names : "usb" + - phys : see usb-hcd.txt in the current directory - resets : phandle + reset specifier pair +additionally the properties from usb-hcd.txt (in the current directory) are +supported. + Example (Sequoia 440EPx): ehci at e0000300 { compatible = "ibm,usb-ehci-440epx", "usb-ehci"; diff --git a/Documentation/devicetree/bindings/usb/usb-hcd.txt b/Documentation/devicetree/bindings/usb/usb-hcd.txt new file mode 100644 index 000000000000..50529b838c9c --- /dev/null +++ b/Documentation/devicetree/bindings/usb/usb-hcd.txt @@ -0,0 +1,9 @@ +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>; + }; diff --git a/Documentation/devicetree/bindings/usb/usb-ohci.txt b/Documentation/devicetree/bindings/usb/usb-ohci.txt index 09e70c875bc6..a8d2103d1f3d 100644 --- a/Documentation/devicetree/bindings/usb/usb-ohci.txt +++ b/Documentation/devicetree/bindings/usb/usb-ohci.txt @@ -13,10 +13,12 @@ Optional properties: - remote-wakeup-connected: remote wakeup is wired on the platform - num-ports : u32, to override the detected port count - clocks : a list of phandle + clock specifier pairs -- phys : phandle + phy specifier pair -- phy-names : "usb" +- phys : see usb-hcd.txt in the current directory - resets : a list of phandle + reset specifier pairs +additionally the properties from usb-hcd.txt (in the current directory) are +supported. + Example: ohci0: usb at 1c14400 { diff --git a/Documentation/devicetree/bindings/usb/usb-uhci.txt b/Documentation/devicetree/bindings/usb/usb-uhci.txt index 298133416c97..cc2e6f7d602e 100644 --- a/Documentation/devicetree/bindings/usb/usb-uhci.txt +++ b/Documentation/devicetree/bindings/usb/usb-uhci.txt @@ -6,6 +6,9 @@ Required properties: - reg : Should contain 1 register ranges(address and length) - interrupts : UHCI controller interrupt +additionally the properties from usb-hcd.txt (in the current directory) are +supported. + Example: uhci at d8007b00 { diff --git a/Documentation/devicetree/bindings/usb/usb-xhci.txt b/Documentation/devicetree/bindings/usb/usb-xhci.txt index e2ea59bbca93..2f7663bb69ff 100644 --- a/Documentation/devicetree/bindings/usb/usb-xhci.txt +++ b/Documentation/devicetree/bindings/usb/usb-xhci.txt @@ -32,6 +32,11 @@ Optional properties: - usb3-lpm-capable: determines if platform is USB3 LPM capable - quirk-broken-port-ped: set if the controller has broken port disable mechanism - 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: usb at f0931000 { -- 2.16.1 From mboxrd@z Thu Jan 1 00:00:00 1970 From: martin.blumenstingl@googlemail.com (Martin Blumenstingl) Date: Sun, 11 Feb 2018 22:06:44 +0100 Subject: [PATCH usb-next v9 1/8] dt-bindings: usb: add the documentation for USB HCDs In-Reply-To: <20180211210651.2046-1-martin.blumenstingl@googlemail.com> References: <20180211210651.2046-1-martin.blumenstingl@googlemail.com> Message-ID: <20180211210651.2046-2-martin.blumenstingl@googlemail.com> To: linus-amlogic@lists.infradead.org List-Id: linus-amlogic.lists.infradead.org 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: Martin Blumenstingl Reviewed-by: Rob Herring Tested-by: Yixun Lan --- Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt | 5 ++++- Documentation/devicetree/bindings/usb/mediatek,mtu3.txt | 5 ++++- Documentation/devicetree/bindings/usb/usb-ehci.txt | 6 ++++-- Documentation/devicetree/bindings/usb/usb-hcd.txt | 9 +++++++++ Documentation/devicetree/bindings/usb/usb-ohci.txt | 6 ++++-- Documentation/devicetree/bindings/usb/usb-uhci.txt | 3 +++ Documentation/devicetree/bindings/usb/usb-xhci.txt | 5 +++++ 7 files changed, 33 insertions(+), 6 deletions(-) create mode 100644 Documentation/devicetree/bindings/usb/usb-hcd.txt diff --git a/Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt b/Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt index 88d9f4a4b280..266c2d917a28 100644 --- a/Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt +++ b/Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt @@ -32,7 +32,7 @@ Required properties: "mcu_ck": mcu_bus clock for register access, "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: - wakeup-source : enable USB remote wakeup; @@ -52,6 +52,9 @@ Optional properties: See: Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt - imod-interval-ns: default interrupt moderation interval is 5000ns +additionally the properties from usb-hcd.txt (in the current directory) are +supported. + Example: usb30: usb at 11270000 { compatible = "mediatek,mt8173-xhci"; diff --git a/Documentation/devicetree/bindings/usb/mediatek,mtu3.txt b/Documentation/devicetree/bindings/usb/mediatek,mtu3.txt index d589a1ef96a1..3382b5cb471d 100644 --- a/Documentation/devicetree/bindings/usb/mediatek,mtu3.txt +++ b/Documentation/devicetree/bindings/usb/mediatek,mtu3.txt @@ -17,7 +17,7 @@ Required properties: - clock-names : must contain "sys_ck" for clock of controller, the following clocks are optional: "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", refer to usb/generic.txt @@ -53,6 +53,9 @@ Optional properties: - mediatek,u3p-dis-msk : mask to disable u3ports, bit0 for u3port0, bit1 for u3port1, ... etc; +additionally the properties from usb-hcd.txt (in the current directory) are +supported. + Sub-nodes: 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: diff --git a/Documentation/devicetree/bindings/usb/usb-ehci.txt b/Documentation/devicetree/bindings/usb/usb-ehci.txt index 3efde12b5d68..0f1b75386207 100644 --- a/Documentation/devicetree/bindings/usb/usb-ehci.txt +++ b/Documentation/devicetree/bindings/usb/usb-ehci.txt @@ -16,10 +16,12 @@ Optional properties: - has-transaction-translator : boolean, set this if EHCI have a Transaction Translator built into the root hub. - clocks : a list of phandle + clock specifier pairs - - phys : phandle + phy specifier pair - - phy-names : "usb" + - phys : see usb-hcd.txt in the current directory - resets : phandle + reset specifier pair +additionally the properties from usb-hcd.txt (in the current directory) are +supported. + Example (Sequoia 440EPx): ehci at e0000300 { compatible = "ibm,usb-ehci-440epx", "usb-ehci"; diff --git a/Documentation/devicetree/bindings/usb/usb-hcd.txt b/Documentation/devicetree/bindings/usb/usb-hcd.txt new file mode 100644 index 000000000000..50529b838c9c --- /dev/null +++ b/Documentation/devicetree/bindings/usb/usb-hcd.txt @@ -0,0 +1,9 @@ +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>; + }; diff --git a/Documentation/devicetree/bindings/usb/usb-ohci.txt b/Documentation/devicetree/bindings/usb/usb-ohci.txt index 09e70c875bc6..a8d2103d1f3d 100644 --- a/Documentation/devicetree/bindings/usb/usb-ohci.txt +++ b/Documentation/devicetree/bindings/usb/usb-ohci.txt @@ -13,10 +13,12 @@ Optional properties: - remote-wakeup-connected: remote wakeup is wired on the platform - num-ports : u32, to override the detected port count - clocks : a list of phandle + clock specifier pairs -- phys : phandle + phy specifier pair -- phy-names : "usb" +- phys : see usb-hcd.txt in the current directory - resets : a list of phandle + reset specifier pairs +additionally the properties from usb-hcd.txt (in the current directory) are +supported. + Example: ohci0: usb at 1c14400 { diff --git a/Documentation/devicetree/bindings/usb/usb-uhci.txt b/Documentation/devicetree/bindings/usb/usb-uhci.txt index 298133416c97..cc2e6f7d602e 100644 --- a/Documentation/devicetree/bindings/usb/usb-uhci.txt +++ b/Documentation/devicetree/bindings/usb/usb-uhci.txt @@ -6,6 +6,9 @@ Required properties: - reg : Should contain 1 register ranges(address and length) - interrupts : UHCI controller interrupt +additionally the properties from usb-hcd.txt (in the current directory) are +supported. + Example: uhci at d8007b00 { diff --git a/Documentation/devicetree/bindings/usb/usb-xhci.txt b/Documentation/devicetree/bindings/usb/usb-xhci.txt index e2ea59bbca93..2f7663bb69ff 100644 --- a/Documentation/devicetree/bindings/usb/usb-xhci.txt +++ b/Documentation/devicetree/bindings/usb/usb-xhci.txt @@ -32,6 +32,11 @@ Optional properties: - usb3-lpm-capable: determines if platform is USB3 LPM capable - quirk-broken-port-ped: set if the controller has broken port disable mechanism - 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: usb at f0931000 { -- 2.16.1