Linux-MIPS Archive on lore.kernel.org
 help / color / Atom feed
From: Serge Semin <Sergey.Semin@baikalelectronics.ru>
To: Mathias Nyman <mathias.nyman@intel.com>,
	Felipe Balbi <balbi@kernel.org>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Rob Herring <robh+dt@kernel.org>
Cc: Serge Semin <Sergey.Semin@baikalelectronics.ru>,
	Serge Semin <fancer.lancer@gmail.com>,
	Alexey Malahov <Alexey.Malahov@baikalelectronics.ru>,
	Pavel Parkhomenko <Pavel.Parkhomenko@baikalelectronics.ru>,
	Andy Gross <agross@kernel.org>,
	Bjorn Andersson <bjorn.andersson@linaro.org>,
	Manu Gautam <mgautam@codeaurora.org>,
	Roger Quadros <rogerq@ti.com>,
	Lad Prabhakar <prabhakar.mahadev-lad.rj@bp.renesas.com>,
	Yoshihiro Shimoda <yoshihiro.shimoda.uh@renesas.com>,
	Neil Armstrong <narmstrong@baylibre.com>,
	Kevin Hilman <khilman@baylibre.com>,
	<linux-arm-kernel@lists.infradead.org>,
	<linux-snps-arc@lists.infradead.org>,
	<linux-mips@vger.kernel.org>, <linuxppc-dev@lists.ozlabs.org>,
	<linux-usb@vger.kernel.org>, <devicetree@vger.kernel.org>,
	<linux-kernel@vger.kernel.org>
Subject: [PATCH 06/20] dt-bindings: usb: Convert xHCI bindings to DT schema
Date: Wed, 14 Oct 2020 13:13:48 +0300
Message-ID: <20201014101402.18271-7-Sergey.Semin@baikalelectronics.ru> (raw)
In-Reply-To: <20201014101402.18271-1-Sergey.Semin@baikalelectronics.ru>

Currently the DT bindings of Generic xHCI Controllers are described by means
of the legacy text file. Since such format is deprecated in favor of the
DT schema, let's convert the Generic xHCI Controllers bindings file to the
corresponding yaml files. There will be two of them: a DT schema for the
xHCI controllers on a generic platform and a DT schema validating a generic
xHCI controllers properties. The later will be used to validate the xHCI
controllers, which aside from some vendor-specific features support the
basic xHCI functionality.

An xHCI-compatible DT node shall support the standard USB HCD properties
and custom ones like: usb2-lpm-disable, usb3-lpm-capable,
quirk-broken-port-ped and imod-interval-ns. In addition if a generic xHCI
controller is being validated against the DT schema it is also supposed to
be equipped with mandatory compatible string, single registers range,
single interrupts source, and is supposed to optionally contain up to two
reference clocks for the controller core and CSRs.

Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>

---

Changelog v2:
- Add explicit "additionalProperties: true" to the usb-xhci.yaml schema,
  since additionalProperties/unevaluatedProperties are going to be mandary
  for each binding.
---
 .../devicetree/bindings/usb/generic-xhci.yaml | 63 +++++++++++++++++++
 .../devicetree/bindings/usb/usb-xhci.txt      | 41 ------------
 .../devicetree/bindings/usb/usb-xhci.yaml     | 42 +++++++++++++
 3 files changed, 105 insertions(+), 41 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/usb/generic-xhci.yaml
 delete mode 100644 Documentation/devicetree/bindings/usb/usb-xhci.txt
 create mode 100644 Documentation/devicetree/bindings/usb/usb-xhci.yaml

diff --git a/Documentation/devicetree/bindings/usb/generic-xhci.yaml b/Documentation/devicetree/bindings/usb/generic-xhci.yaml
new file mode 100644
index 000000000000..1ea1d49a8175
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/generic-xhci.yaml
@@ -0,0 +1,63 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/generic-xhci.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: USB xHCI Controller Device Tree Bindings
+
+maintainers:
+  - Mathias Nyman <mathias.nyman@intel.com>
+
+allOf:
+  - $ref: "usb-xhci.yaml#"
+
+properties:
+  compatible:
+    oneOf:
+      - description: Generic xHCI device
+        const: generic-xhci
+      - description: Armada 37xx/375/38x/8k SoCs
+        items:
+          - enum:
+              - marvell,armada3700-xhci
+              - marvell,armada-375-xhci
+              - marvell,armada-380-xhci
+              - marvell,armada-8k-xhci
+          - const: generic-xhci
+      - description: Broadcom STB SoCs with xHCI
+        const: brcm,bcm7445-xhci
+      - description: Generic xHCI device
+        const: xhci-platform
+        deprecated: true
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+
+  clocks:
+    minItems: 1
+    maxItems: 2
+
+  clock-names:
+    minItems: 1
+    items:
+      - const: core
+      - const: reg
+
+unevaluatedProperties: false
+
+required:
+  - compatible
+  - reg
+  - interrupts
+
+examples:
+  - |
+    usb@f0931000 {
+      compatible = "generic-xhci";
+      reg = <0xf0931000 0x8c8>;
+      interrupts = <0x0 0x4e 0x0>;
+    };
diff --git a/Documentation/devicetree/bindings/usb/usb-xhci.txt b/Documentation/devicetree/bindings/usb/usb-xhci.txt
deleted file mode 100644
index 0c5cff84a969..000000000000
--- a/Documentation/devicetree/bindings/usb/usb-xhci.txt
+++ /dev/null
@@ -1,41 +0,0 @@
-USB xHCI controllers
-
-Required properties:
-  - compatible: should be one or more of
-
-    - "generic-xhci" for generic XHCI device
-    - "marvell,armada3700-xhci" for Armada 37xx SoCs
-    - "marvell,armada-375-xhci" for Armada 375 SoCs
-    - "marvell,armada-380-xhci" for Armada 38x SoCs
-    - "brcm,bcm7445-xhci" for Broadcom STB SoCs with XHCI
-    - "xhci-platform" (deprecated)
-
-    When compatible with the generic version, nodes must list the
-    SoC-specific version corresponding to the platform first
-    followed by the generic version.
-
-  - reg: should contain address and length of the standard XHCI
-    register set for the device.
-  - interrupts: one XHCI interrupt should be described here.
-
-Optional properties:
-  - clocks: reference to the clocks
-  - clock-names: mandatory if there is a second clock, in this case
-    the name must be "core" for the first clock and "reg" for the
-    second one
-  - usb2-lpm-disable: indicate if we don't want to enable USB2 HW LPM
-  - 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.yaml in the current directory
-
-additionally the properties from usb-hcd.yaml (in the current directory) are
-supported.
-
-
-Example:
-	usb@f0931000 {
-		compatible = "generic-xhci";
-		reg = <0xf0931000 0x8c8>;
-		interrupts = <0x0 0x4e 0x0>;
-	};
diff --git a/Documentation/devicetree/bindings/usb/usb-xhci.yaml b/Documentation/devicetree/bindings/usb/usb-xhci.yaml
new file mode 100644
index 000000000000..965f87fef702
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/usb-xhci.yaml
@@ -0,0 +1,42 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/usb-xhci.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Generic USB xHCI Controller Device Tree Bindings
+
+maintainers:
+  - Mathias Nyman <mathias.nyman@intel.com>
+
+allOf:
+  - $ref: "usb-hcd.yaml#"
+
+properties:
+  usb2-lpm-disable:
+    description: Indicates if we don't want to enable USB2 HW LPM
+    type: boolean
+
+  usb3-lpm-capable:
+    description: Determines if platform is USB3 LPM capable
+    type: boolean
+
+  quirk-broken-port-ped:
+    description: Set if the controller has broken port disable mechanism
+    type: boolean
+
+  imod-interval-ns:
+    description: Interrupt moderation interval
+    default: 5000
+
+additionalProperties: true
+
+examples:
+  - |
+    usb@f0930000 {
+      compatible = "generic-xhci";
+      reg = <0xf0930000 0x8c8>;
+      interrupts = <0x0 0x4e 0x0>;
+      usb2-lpm-disable;
+      usb3-lpm-capable;
+    };
-- 
2.27.0


  parent reply index

Thread overview: 73+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-14 10:13 [PATCH 00/20] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 " Serge Semin
2020-10-14 10:13 ` [PATCH 01/20] dt-bindings: usb: usb-hcd: Convert generic USB properties to " Serge Semin
2020-10-16 18:33   ` Rob Herring
2020-10-14 10:13 ` [PATCH 02/20] dt-bindings: usb: usb-hcd: Add "otg-rev" property restriction Serge Semin
2020-10-16 18:33   ` Rob Herring
2020-10-14 10:13 ` [PATCH 03/20] dt-bindings: usb: usb-hcd: Add "ulpi/serial/hsic" PHY types Serge Semin
2020-10-16 18:34   ` Rob Herring
2020-10-14 10:13 ` [PATCH 04/20] dt-bindings: usb: usb-hcd: Add "tpl-support" property Serge Semin
2020-10-14 13:27   ` Rob Herring
2020-10-14 17:27     ` Serge Semin
2020-10-16 15:44       ` Rob Herring
2020-10-16 18:47   ` Rob Herring
2020-10-14 10:13 ` [PATCH 05/20] dt-bindings: usb: usb-hcd: Add generic "usb-phy" property Serge Semin
2020-10-16 18:47   ` Rob Herring
2020-10-14 10:13 ` Serge Semin [this message]
2020-10-16 18:49   ` [PATCH 06/20] dt-bindings: usb: Convert xHCI bindings to DT schema Rob Herring
2020-10-14 10:13 ` [PATCH 07/20] dt-bindings: usb: xhci: Add Broadcom STB v2 compatible device Serge Semin
2020-10-15 16:39   ` Florian Fainelli
2020-10-16 18:49   ` Rob Herring
2020-10-14 10:13 ` [PATCH 08/20] dt-bindings: usb: renesas-xhci: Refer to the usb-xhci.yaml file Serge Semin
2020-10-16 18:50   ` Rob Herring
2020-10-20  4:42   ` Yoshihiro Shimoda
2020-10-14 10:13 ` [PATCH 09/20] dt-bindings: usb: Convert DWC USB3 bindings to DT schema Serge Semin
2020-10-14 13:32   ` Rob Herring
2020-10-14 17:37     ` Serge Semin
2020-10-14 10:13 ` [PATCH 10/20] dt-bindings: usb: dwc3: Add interrupt-names property support Serge Semin
2020-10-16 18:50   ` Rob Herring
2020-10-14 10:13 ` [PATCH 11/20] dt-bindings: usb: dwc3: Add synopsys,dwc3 compatible string Serge Semin
2020-10-14 20:18   ` Krzysztof Kozlowski
2020-10-14 21:35     ` Serge Semin
2020-10-16 18:53       ` Rob Herring
2020-10-19 16:22         ` Serge Semin
2020-10-14 10:13 ` [PATCH 12/20] dt-bindings: usb: dwc3: Add Tx De-emphasis restrictions Serge Semin
2020-10-16 18:54   ` Rob Herring
2020-10-14 10:13 ` [PATCH 13/20] dt-bindings: usb: dwc3: Add Frame Length Adj restrictions Serge Semin
2020-10-16 18:54   ` Rob Herring
2020-10-14 10:13 ` [PATCH 14/20] dt-bindings: usb: meson-g12a-usb: Fix FL-adj property value Serge Semin
2020-10-16 18:54   ` Rob Herring
2020-10-16 20:46   ` Martin Blumenstingl
2020-10-14 10:13 ` [PATCH 15/20] dt-bindings: usb: meson-g12a-usb: Validate DWC2/DWC3 sub-nodes Serge Semin
2020-10-16 18:54   ` Rob Herring
2020-10-16 20:47   ` Martin Blumenstingl
2020-10-14 10:13 ` [PATCH 16/20] dt-bindings: usb: keystone-dwc3: Validate DWC3 sub-node Serge Semin
2020-10-16 18:55   ` Rob Herring
2020-10-14 10:13 ` [PATCH 17/20] dt-bindings: usb: qcom,dwc3: " Serge Semin
2020-10-16 18:55   ` Rob Herring
2020-10-14 10:14 ` [PATCH 18/20] arch: dts: Fix EHCI/OHCI DT nodes name Serge Semin
2020-10-14 18:00   ` Florian Fainelli
2020-10-14 18:11     ` Serge Semin
2020-10-14 18:41       ` Florian Fainelli
2020-10-14 21:21         ` Serge Semin
2020-10-14 18:56   ` Paul Cercueil
2020-10-14 19:12     ` Alexey Brodkin
2020-10-15  8:05   ` Amelie DELAUNAY
2020-10-15 16:37   ` Florian Fainelli
2020-10-16  7:08   ` Alexandre Torgue
2020-10-16  8:52     ` Serge Semin
2020-10-14 10:14 ` [PATCH 19/20] arch: dts: Fix xHCI " Serge Semin
2020-10-14 10:14 ` [PATCH 20/20] arch: dts: Fix DWC USB3 " Serge Semin
2020-10-14 10:33   ` Krzysztof Kozlowski
2020-10-14 17:16     ` Serge Semin
2020-10-14 20:04       ` Krzysztof Kozlowski
2020-10-14 23:51         ` Serge Semin
2020-10-15  6:14           ` Krzysztof Kozlowski
2020-10-15 14:15             ` Serge Semin
2020-10-14 14:09   ` Felipe Balbi
2020-10-14 14:37     ` Serge Semin
2020-10-14 18:35       ` Rob Herring
2020-10-14 21:22         ` Serge Semin
2020-10-15 10:15       ` Felipe Balbi
2020-10-15 13:53         ` Serge Semin
2020-10-15 14:04         ` Maxime Ripard
2020-10-14 17:39 ` [PATCH 00/20] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 DT schema Serge Semin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20201014101402.18271-7-Sergey.Semin@baikalelectronics.ru \
    --to=sergey.semin@baikalelectronics.ru \
    --cc=Alexey.Malahov@baikalelectronics.ru \
    --cc=Pavel.Parkhomenko@baikalelectronics.ru \
    --cc=agross@kernel.org \
    --cc=balbi@kernel.org \
    --cc=bjorn.andersson@linaro.org \
    --cc=devicetree@vger.kernel.org \
    --cc=fancer.lancer@gmail.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=khilman@baylibre.com \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mips@vger.kernel.org \
    --cc=linux-snps-arc@lists.infradead.org \
    --cc=linux-usb@vger.kernel.org \
    --cc=linuxppc-dev@lists.ozlabs.org \
    --cc=mathias.nyman@intel.com \
    --cc=mgautam@codeaurora.org \
    --cc=narmstrong@baylibre.com \
    --cc=prabhakar.mahadev-lad.rj@bp.renesas.com \
    --cc=robh+dt@kernel.org \
    --cc=rogerq@ti.com \
    --cc=yoshihiro.shimoda.uh@renesas.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Linux-MIPS Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-mips/0 linux-mips/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-mips linux-mips/ https://lore.kernel.org/linux-mips \
		linux-mips@vger.kernel.org
	public-inbox-index linux-mips

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-mips


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git