Linux-USB 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 01/20] dt-bindings: usb: usb-hcd: Convert generic USB properties to DT schema
Date: Wed, 14 Oct 2020 13:13:43 +0300
Message-ID: <20201014101402.18271-2-Sergey.Semin@baikalelectronics.ru> (raw)
In-Reply-To: <20201014101402.18271-1-Sergey.Semin@baikalelectronics.ru>

The generic USB HCD properties have been described in the legacy bindings
text file: Documentation/devicetree/bindings/usb/generic.txt . Let's
convert it' content into the USB HCD DT schema properties so all USB DT
nodes would be validated to have them properly utilized.

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

---

Changelog v2:
- Discard '|' in all the new properties, since we don't need to preserve
  the text formatting.
- Convert abbreviated form of the "maximum-speed" enum restriction into
  the multi-lined version of the list.
- Drop quotes from around the string constants.
---
 .../devicetree/bindings/usb/generic.txt       | 57 ------------
 .../devicetree/bindings/usb/usb-hcd.yaml      | 88 +++++++++++++++++++
 2 files changed, 88 insertions(+), 57 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/usb/generic.txt

diff --git a/Documentation/devicetree/bindings/usb/generic.txt b/Documentation/devicetree/bindings/usb/generic.txt
deleted file mode 100644
index ba472e7aefc9..000000000000
--- a/Documentation/devicetree/bindings/usb/generic.txt
+++ /dev/null
@@ -1,57 +0,0 @@
-Generic USB Properties
-
-Optional properties:
- - maximum-speed: tells USB controllers we want to work up to a certain
-			speed. Valid arguments are "super-speed-plus",
-			"super-speed", "high-speed", "full-speed" and
-			"low-speed". In case this isn't passed via DT, USB
-			controllers should default to their maximum HW
-			capability.
- - dr_mode: tells Dual-Role USB controllers that we want to work on a
-			particular mode. Valid arguments are "host",
-			"peripheral" and "otg". In case this attribute isn't
-			passed via DT, USB DRD controllers should default to
-			OTG.
- - phy_type: tells USB controllers that we want to configure the core to support
-			a UTMI+ PHY with an 8- or 16-bit interface if UTMI+ is
-			selected. Valid arguments are "utmi" and "utmi_wide".
-			In case this isn't passed via DT, USB controllers should
-			default to HW capability.
- - otg-rev: tells usb driver the release number of the OTG and EH supplement
-			with which the device and its descriptors are compliant,
-			in binary-coded decimal (i.e. 2.0 is 0200H). This
-			property is used if any real OTG features(HNP/SRP/ADP)
-			is enabled, if ADP is required, otg-rev should be
-			0x0200 or above.
- - companion: phandle of a companion
- - hnp-disable: tells OTG controllers we want to disable OTG HNP, normally HNP
-			is the basic function of real OTG except you want it
-			to be a srp-capable only B device.
- - srp-disable: tells OTG controllers we want to disable OTG SRP, SRP is
-			optional for OTG device.
- - adp-disable: tells OTG controllers we want to disable OTG ADP, ADP is
-			optional for OTG device.
- - usb-role-switch: boolean, indicates that the device is capable of assigning
-			the USB data role (USB host or USB device) for a given
-			USB connector, such as Type-C, Type-B(micro).
-			see connector/usb-connector.yaml.
- - role-switch-default-mode: indicating if usb-role-switch is enabled, the
-			device default operation mode of controller while usb
-			role is USB_ROLE_NONE. Valid arguments are "host" and
-			"peripheral". Defaults to "peripheral" if not
-			specified.
-
-
-This is an attribute to a USB controller such as:
-
-dwc3@4a030000 {
-	compatible = "synopsys,dwc3";
-	reg = <0x4a030000 0xcfff>;
-	interrupts = <0 92 4>
-	usb-phy = <&usb2_phy>, <&usb3,phy>;
-	maximum-speed = "super-speed";
-	dr_mode = "otg";
-	phy_type = "utmi_wide";
-	otg-rev = <0x0200>;
-	adp-disable;
-};
diff --git a/Documentation/devicetree/bindings/usb/usb-hcd.yaml b/Documentation/devicetree/bindings/usb/usb-hcd.yaml
index 7263b7f2b510..ee7ea205c71d 100644
--- a/Documentation/devicetree/bindings/usb/usb-hcd.yaml
+++ b/Documentation/devicetree/bindings/usb/usb-hcd.yaml
@@ -22,9 +22,97 @@ properties:
     description:
       Name specifier for the USB PHY
 
+  maximum-speed:
+   description:
+     Tells USB controllers we want to work up to a certain speed. In case this
+     isn't passed via DT, USB controllers should default to their maximum HW
+     capability.
+   $ref: /schemas/types.yaml#/definitions/string
+   enum:
+     - low-speed
+     - full-speed
+     - high-speed
+     - super-speed
+     - super-speed-plus
+
+  dr_mode:
+    description:
+      Tells Dual-Role USB controllers that we want to work on a particular
+      mode. In case this attribute isn't passed via DT, USB DRD controllers
+      should default to OTG.
+    $ref: /schemas/types.yaml#/definitions/string
+    enum: [host, peripheral, otg]
+
+  phy_type:
+    description:
+      Tells USB controllers that we want to configure the core to support a
+      UTMI+ PHY with an 8- or 16-bit interface if UTMI+ is selected. In case
+      this isn't passed via DT, USB controllers should default to HW
+      capability.
+    $ref: /schemas/types.yaml#/definitions/string
+    enum: [utmi, utmi_wide]
+
+  otg-rev:
+    description:
+      Tells usb driver the release number of the OTG and EH supplement with
+      which the device and its descriptors are compliant, in binary-coded
+      decimal (i.e. 2.0 is 0200H). This property is used if any real OTG
+      features (HNP/SRP/ADP) is enabled. If ADP is required, otg-rev should be
+      0x0200 or above.
+    $ref: /schemas/types.yaml#/definitions/uint32
+
+  companion:
+    description: Phandle of a companion device
+    $ref: /schemas/types.yaml#/definitions/phandle
+
+  hnp-disable:
+    description:
+      Tells OTG controllers we want to disable OTG HNP. Normally HNP is the
+      basic function of real OTG except you want it to be a srp-capable only B
+      device.
+    type: boolean
+
+  srp-disable:
+    description:
+      Tells OTG controllers we want to disable OTG SRP. SRP is optional for OTG
+      device.
+    type: boolean
+
+  adp-disable:
+    description:
+      Tells OTG controllers we want to disable OTG ADP. ADP is optional for OTG
+      device.
+    type: boolean
+
+  usb-role-switch:
+    description:
+      Indicates that the device is capable of assigning the USB data role
+      (USB host or USB device) for a given USB connector, such as Type-C,
+      Type-B(micro). See connector/usb-connector.yaml.
+
+  role-switch-default-mode:
+    description:
+      Indicates if usb-role-switch is enabled, the device default operation
+      mode of controller while usb role is USB_ROLE_NONE.
+    $ref: /schemas/types.yaml#/definitions/string
+    enum: [host, peripheral]
+    default: peripheral
+
 examples:
   - |
     usb {
         phys = <&usb2_phy1>, <&usb3_phy1>;
         phy-names = "usb";
     };
+  - |
+    usb@4a030000 {
+        compatible = "snps,dwc3";
+        reg = <0x4a030000 0xcfff>;
+        interrupts = <0 92 4>;
+        usb-phy = <&usb2_phy>, <&usb3_phy>;
+        maximum-speed = "super-speed";
+        dr_mode = "otg";
+        phy_type = "utmi_wide";
+        otg-rev = <0x0200>;
+        adp-disable;
+    };
-- 
2.27.0


  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 ` Serge Semin [this message]
2020-10-16 18:33   ` [PATCH 01/20] dt-bindings: usb: usb-hcd: Convert generic USB properties to " 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 ` [PATCH 06/20] dt-bindings: usb: Convert xHCI bindings to DT schema Serge Semin
2020-10-16 18:49   ` 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-2-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-USB Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-usb/0 linux-usb/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-usb linux-usb/ https://lore.kernel.org/linux-usb \
		linux-usb@vger.kernel.org
	public-inbox-index linux-usb

Example config snippet for mirrors

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


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