linux-usb.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH v3 00/16] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 DT schema
@ 2020-10-20 11:20 Serge Semin
  2020-10-20 11:20 ` [PATCH v3 01/16] dt-bindings: usb: usb-hcd: Convert generic USB properties to " Serge Semin
                   ` (15 more replies)
  0 siblings, 16 replies; 23+ messages in thread
From: Serge Semin @ 2020-10-20 11:20 UTC (permalink / raw)
  To: Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Greg Kroah-Hartman, Rob Herring
  Cc: Serge Semin, Serge Semin, Alexey Malahov, Pavel Parkhomenko,
	Andy Gross, Bjorn Andersson, Manu Gautam, Roger Quadros,
	Lad Prabhakar, Yoshihiro Shimoda, Neil Armstrong, Kevin Hilman,
	Martin Blumenstingl, linux-arm-kernel, linux-snps-arc,
	linux-mips, linuxppc-dev, linux-usb, devicetree, linux-kernel

We've performed some work on the Generic USB HCD, xHCI and DWC USB3 DT
bindings in the framework of the Baikal-T1 SoC support integration into
the kernel. This patchset is a result of that work.

First of all we moved the generic USB properties from the legacy text
bindings into the USB HCD DT schema. So now the generic USB HCD-compatible
DT nodes are validated taking into account the optional properties like:
maximum-speed, dr_mode, otg-rev, usb-role-switch, etc. We've fixed these
properties a bit so they would correspond to what functionality kernel
currently supports.

Secondly we converted generic USB xHCI text bindings file into the DT
schema. It had to be split up into two bindings: DT schema with generic
xHCI properties and a generic xHCI device DT schema. The later will be
used to validate the pure xHCI-based nodes, while the former can be
utilized by some vendor-specific versions of xHCI.

Thirdly, what was primarily intended to be done for Baikal-T1 SoC USB we
converted the legacy text-based DWC USB3 bindings to DT schema and altered
the result a bit so it would be more coherent with what actually
controller and its driver support. Since we've now got the DWC USB3 DT
schema, we made it used to validate the sub-nodes of the Qualcom, TI and
Amlogic DWC3 DT nodes.

Finally we've also fixed all the OHCI/EHCI, xHCI and DW USB3 compatible DT
nodes so they would comply with the nodes naming scema declared in the USB
HCD DT bindings file.

Link: https://lore.kernel.org/linux-usb/20201010224121.12672-1-Sergey.Semin@baikalelectronics.ru/
Changelog v2:
- Thanks to Sergei Shtylyov for suggesting the commit logs grammar fixes:
  [PATCH 04/18] dt-bindings: usb: usb-hcd: Add "ulpi/serial/hsic" PHY types
  [PATCH 05/18] dt-bindings: usb: usb-hcd: Add "tpl-support" property
  [PATCH 11/18] dt-bindings: usb: dwc3: Add interrupt-names property support
  [PATCH 13/18] dt-bindings: usb: dwc3: Add Tx De-emphasis restrictions
  [PATCH 17/18] dt-bindings: usb: keystone-dwc3: Validate DWC3 sub-node
- Set FL-adj of the amlogiv,meson-g12a-usb controller with value 0x20 instead
  of completely removing the property.
- Drop the patch:
  [PATCH 02/18] dt-bindings: usb: usb-hcd: Add "wireless" maximum-speed
                property value
  since "wireless" speed type is depracated due to lack of the device
  supporting it.
- Drop quotes from around the compat string constant.
- Discard '|' from the property descriptions, since we don't need to preserve
  the text formatting.
- Convert abbreviated form of the "maximum-speed" enum constraint into
  the multi-lined version of the list.
- Fix the DW USB3 "clock-names" prop description to be refererring to the
  enumerated clock-names instead of the ones from the Databook.
- Add explicit "additionalProperties: true" to the usb-xhci.yaml schema,
  since additionalProperties/unevaluatedProperties are going to be mandary
  for each binding.
- Use "oneOf: [dwc2.yaml#, snps,dwc3.yaml#]" instead of the bulky "if:
  properties: compatibe: ..." statement.
- Discard the "^dwc3@[0-9a-f]+$" nodes from being acceptable as sub-nodes
  of the Qualcomm DWC3 DT nodes.
- Add new patches:
  [PATCH 18/20] arch: dts: Fix EHCI/OHCI DT nodes name
  [PATCH 19/20] arch: dts: Fix xHCI DT nodes name
  [PATCH 20/20] arch: dts: Fix DWC USB3 DT nodes name

Link: https://lore.kernel.org/linux-usb/20201014101402.18271-1-Sergey.Semin@baikalelectronics.ru
Changelog v3:
- Drop the patches:
  [PATCH 18/20] arch: dts: Fix EHCI/OHCI DT nodes name
  [PATCH 19/20] arch: dts: Fix xHCI DT nodes name
  [PATCH 20/20] arch: dts: Fix DWC USB3 DT nodes name
  as they are going to be submitted in the framework of a dedicated patchset.
- Drop the patch:
  [PATCH 11/20] dt-bindings: usb: dwc3: Add synopsys,dwc3 compatible string
  since it's going to be replaced with the driver/dts fixup and moved to a
  dedicated patchset.
- Apply usb-xhci.yaml# schema for the DWC USB3 node only if the controller is
  supposed to work as either host or otg.

Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
Cc: Alexey Malahov <Alexey.Malahov@baikalelectronics.ru>
Cc: Pavel Parkhomenko <Pavel.Parkhomenko@baikalelectronics.ru>
Cc: Andy Gross <agross@kernel.org>
Cc: Bjorn Andersson <bjorn.andersson@linaro.org>
Cc: Manu Gautam <mgautam@codeaurora.org>
Cc: Roger Quadros <rogerq@ti.com>
Cc: Lad Prabhakar <prabhakar.mahadev-lad.rj@bp.renesas.com>
Cc: Yoshihiro Shimoda <yoshihiro.shimoda.uh@renesas.com>
Cc: Neil Armstrong <narmstrong@baylibre.com>
Cc: Kevin Hilman <khilman@baylibre.com>
Cc: Martin Blumenstingl <martin.blumenstingl@googlemail.com>
Cc: linux-arm-kernel@lists.infradead.org
Cc: linux-snps-arc@lists.infradead.org
Cc: linux-mips@vger.kernel.org
Cc: linuxppc-dev@lists.ozlabs.org
Cc: linux-usb@vger.kernel.org
Cc: devicetree@vger.kernel.org
Cc: linux-kernel@vger.kernel.org

Serge Semin (16):
  dt-bindings: usb: usb-hcd: Convert generic USB properties to DT schema
  dt-bindings: usb: usb-hcd: Add "otg-rev" property restriction
  dt-bindings: usb: usb-hcd: Add "ulpi/serial/hsic" PHY types
  dt-bindings: usb: usb-hcd: Add "tpl-support" property
  dt-bindings: usb: usb-hcd: Add generic "usb-phy" property
  dt-bindings: usb: Convert xHCI bindings to DT schema
  dt-bindings: usb: xhci: Add Broadcom STB v2 compatible device
  dt-bindings: usb: renesas-xhci: Refer to the usb-xhci.yaml file
  dt-bindings: usb: Convert DWC USB3 bindings to DT schema
  dt-bindings: usb: dwc3: Add interrupt-names property support
  dt-bindings: usb: dwc3: Add Tx De-emphasis constraints
  dt-bindings: usb: dwc3: Add Frame Length Adj constraints
  dt-bindings: usb: meson-g12a-usb: Fix FL-adj property value
  dt-bindings: usb: meson-g12a-usb: Validate DWC2/DWC3 sub-nodes
  dt-bindings: usb: keystone-dwc3: Validate DWC3 sub-node
  dt-bindings: usb: qcom,dwc3: Validate DWC3 sub-node

 .../usb/amlogic,meson-g12a-usb-ctrl.yaml      |   6 +-
 .../devicetree/bindings/usb/dwc3.txt          | 125 -------
 .../devicetree/bindings/usb/generic-xhci.yaml |  65 ++++
 .../devicetree/bindings/usb/generic.txt       |  57 ----
 .../devicetree/bindings/usb/qcom,dwc3.yaml    |   9 +-
 .../bindings/usb/renesas,usb-xhci.yaml        |   4 +-
 .../devicetree/bindings/usb/snps,dwc3.yaml    | 319 ++++++++++++++++++
 .../bindings/usb/ti,keystone-dwc3.yaml        |   4 +-
 .../devicetree/bindings/usb/usb-hcd.yaml      | 104 ++++++
 .../devicetree/bindings/usb/usb-xhci.txt      |  41 ---
 .../devicetree/bindings/usb/usb-xhci.yaml     |  42 +++
 11 files changed, 540 insertions(+), 236 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/usb/dwc3.txt
 create mode 100644 Documentation/devicetree/bindings/usb/generic-xhci.yaml
 delete mode 100644 Documentation/devicetree/bindings/usb/generic.txt
 create mode 100644 Documentation/devicetree/bindings/usb/snps,dwc3.yaml
 delete mode 100644 Documentation/devicetree/bindings/usb/usb-xhci.txt
 create mode 100644 Documentation/devicetree/bindings/usb/usb-xhci.yaml

-- 
2.27.0


^ permalink raw reply	[flat|nested] 23+ messages in thread

* [PATCH v3 01/16] dt-bindings: usb: usb-hcd: Convert generic USB properties to DT schema
  2020-10-20 11:20 [PATCH v3 00/16] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 DT schema Serge Semin
@ 2020-10-20 11:20 ` Serge Semin
  2020-10-21  3:00   ` Chunfeng Yun
  2020-10-20 11:20 ` [PATCH v3 02/16] dt-bindings: usb: usb-hcd: Add "otg-rev" property restriction Serge Semin
                   ` (14 subsequent siblings)
  15 siblings, 1 reply; 23+ messages in thread
From: Serge Semin @ 2020-10-20 11:20 UTC (permalink / raw)
  To: Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Greg Kroah-Hartman, Rob Herring
  Cc: Serge Semin, Serge Semin, Alexey Malahov, Pavel Parkhomenko,
	Andy Gross, Bjorn Andersson, Manu Gautam, Roger Quadros,
	Lad Prabhakar, Yoshihiro Shimoda, Neil Armstrong, Kevin Hilman,
	Martin Blumenstingl, linux-arm-kernel, linux-snps-arc,
	linux-mips, linuxppc-dev, linux-usb, devicetree, linux-kernel,
	Rob Herring

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>
Reviewed-by: Rob Herring <robh@kernel.org>

---

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


^ permalink raw reply related	[flat|nested] 23+ messages in thread

* [PATCH v3 02/16] dt-bindings: usb: usb-hcd: Add "otg-rev" property restriction
  2020-10-20 11:20 [PATCH v3 00/16] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 DT schema Serge Semin
  2020-10-20 11:20 ` [PATCH v3 01/16] dt-bindings: usb: usb-hcd: Convert generic USB properties to " Serge Semin
@ 2020-10-20 11:20 ` Serge Semin
  2020-10-20 11:20 ` [PATCH v3 03/16] dt-bindings: usb: usb-hcd: Add "ulpi/serial/hsic" PHY types Serge Semin
                   ` (13 subsequent siblings)
  15 siblings, 0 replies; 23+ messages in thread
From: Serge Semin @ 2020-10-20 11:20 UTC (permalink / raw)
  To: Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Greg Kroah-Hartman, Rob Herring
  Cc: Serge Semin, Serge Semin, Alexey Malahov, Pavel Parkhomenko,
	Andy Gross, Bjorn Andersson, Manu Gautam, Roger Quadros,
	Lad Prabhakar, Yoshihiro Shimoda, Neil Armstrong, Kevin Hilman,
	Martin Blumenstingl, linux-arm-kernel, linux-snps-arc,
	linux-mips, linuxppc-dev, linux-usb, devicetree, linux-kernel,
	Rob Herring

There are only four OTG revisions are currently supported by the kernel:
0x0100, 0x0120, 0x0130, 0x0200. Any another value is considered as
invalid.

Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
Reviewed-by: Rob Herring <robh@kernel.org>
---
 Documentation/devicetree/bindings/usb/usb-hcd.yaml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/devicetree/bindings/usb/usb-hcd.yaml b/Documentation/devicetree/bindings/usb/usb-hcd.yaml
index ee7ea205c71d..e01d8a54971e 100644
--- a/Documentation/devicetree/bindings/usb/usb-hcd.yaml
+++ b/Documentation/devicetree/bindings/usb/usb-hcd.yaml
@@ -60,6 +60,7 @@ properties:
       features (HNP/SRP/ADP) is enabled. If ADP is required, otg-rev should be
       0x0200 or above.
     $ref: /schemas/types.yaml#/definitions/uint32
+    enum: [0x0100, 0x0120, 0x0130, 0x0200]
 
   companion:
     description: Phandle of a companion device
-- 
2.27.0


^ permalink raw reply related	[flat|nested] 23+ messages in thread

* [PATCH v3 03/16] dt-bindings: usb: usb-hcd: Add "ulpi/serial/hsic" PHY types
  2020-10-20 11:20 [PATCH v3 00/16] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 DT schema Serge Semin
  2020-10-20 11:20 ` [PATCH v3 01/16] dt-bindings: usb: usb-hcd: Convert generic USB properties to " Serge Semin
  2020-10-20 11:20 ` [PATCH v3 02/16] dt-bindings: usb: usb-hcd: Add "otg-rev" property restriction Serge Semin
@ 2020-10-20 11:20 ` Serge Semin
  2020-10-20 11:20 ` [PATCH v3 04/16] dt-bindings: usb: usb-hcd: Add "tpl-support" property Serge Semin
                   ` (12 subsequent siblings)
  15 siblings, 0 replies; 23+ messages in thread
From: Serge Semin @ 2020-10-20 11:20 UTC (permalink / raw)
  To: Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Greg Kroah-Hartman, Rob Herring
  Cc: Serge Semin, Serge Semin, Alexey Malahov, Pavel Parkhomenko,
	Andy Gross, Bjorn Andersson, Manu Gautam, Roger Quadros,
	Lad Prabhakar, Yoshihiro Shimoda, Neil Armstrong, Kevin Hilman,
	Martin Blumenstingl, linux-arm-kernel, linux-snps-arc,
	linux-mips, linuxppc-dev, linux-usb, devicetree, linux-kernel,
	Rob Herring

Aside from the UTMI+ there are also ULPI, Serial and HSIC PHY types
that can be specified in the phy_type HCD property. Add them to the
enumeration of the acceptable values.

Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
Reviewed-by: Rob Herring <robh@kernel.org>

---

Changelog v2:
- Grammar fix: "s/PHY types can be/PHY types that can be"
- Drop quotes from around the string constants.
---
 Documentation/devicetree/bindings/usb/usb-hcd.yaml | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/Documentation/devicetree/bindings/usb/usb-hcd.yaml b/Documentation/devicetree/bindings/usb/usb-hcd.yaml
index e01d8a54971e..a1a6cde7327d 100644
--- a/Documentation/devicetree/bindings/usb/usb-hcd.yaml
+++ b/Documentation/devicetree/bindings/usb/usb-hcd.yaml
@@ -46,11 +46,13 @@ properties:
   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.
+      UTMI+ PHY with an 8- or 16-bit interface if UTMI+ is selected, UTMI+ low
+      pin interface if ULPI is specified, Serial core/PHY interconnect if
+      serial is specified and High-Speed Inter-Chip feature if HSIC 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]
+    enum: [utmi, utmi_wide, ulpi, serial, hsic]
 
   otg-rev:
     description:
-- 
2.27.0


^ permalink raw reply related	[flat|nested] 23+ messages in thread

* [PATCH v3 04/16] dt-bindings: usb: usb-hcd: Add "tpl-support" property
  2020-10-20 11:20 [PATCH v3 00/16] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 DT schema Serge Semin
                   ` (2 preceding siblings ...)
  2020-10-20 11:20 ` [PATCH v3 03/16] dt-bindings: usb: usb-hcd: Add "ulpi/serial/hsic" PHY types Serge Semin
@ 2020-10-20 11:20 ` Serge Semin
  2020-10-20 11:20 ` [PATCH v3 05/16] dt-bindings: usb: usb-hcd: Add generic "usb-phy" property Serge Semin
                   ` (11 subsequent siblings)
  15 siblings, 0 replies; 23+ messages in thread
From: Serge Semin @ 2020-10-20 11:20 UTC (permalink / raw)
  To: Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Greg Kroah-Hartman, Rob Herring
  Cc: Serge Semin, Serge Semin, Alexey Malahov, Pavel Parkhomenko,
	Andy Gross, Bjorn Andersson, Manu Gautam, Roger Quadros,
	Lad Prabhakar, Yoshihiro Shimoda, Neil Armstrong, Kevin Hilman,
	Martin Blumenstingl, linux-arm-kernel, linux-snps-arc,
	linux-mips, linuxppc-dev, linux-usb, devicetree, linux-kernel,
	Rob Herring

The host controller device might be designed to work for the particular
products or applications. In that case its DT node is supposed to be
equipped with the tpl-support property.

Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
Reviewed-by: Rob Herring <robh@kernel.org>

---

Changelog v2:
- Grammar fix: "s/it'/its"
- Discard '|' from the property description, since we don't need to preserve
  the text formatting.
---
 Documentation/devicetree/bindings/usb/usb-hcd.yaml | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/Documentation/devicetree/bindings/usb/usb-hcd.yaml b/Documentation/devicetree/bindings/usb/usb-hcd.yaml
index a1a6cde7327d..1f9b40fdea70 100644
--- a/Documentation/devicetree/bindings/usb/usb-hcd.yaml
+++ b/Documentation/devicetree/bindings/usb/usb-hcd.yaml
@@ -101,6 +101,12 @@ properties:
     enum: [host, peripheral]
     default: peripheral
 
+  tpl-support:
+    description:
+      Indicates if the Targeted Peripheral List is supported for given
+      targeted hosts (non-PC hosts).
+    type: boolean
+
 examples:
   - |
     usb {
-- 
2.27.0


^ permalink raw reply related	[flat|nested] 23+ messages in thread

* [PATCH v3 05/16] dt-bindings: usb: usb-hcd: Add generic "usb-phy" property
  2020-10-20 11:20 [PATCH v3 00/16] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 DT schema Serge Semin
                   ` (3 preceding siblings ...)
  2020-10-20 11:20 ` [PATCH v3 04/16] dt-bindings: usb: usb-hcd: Add "tpl-support" property Serge Semin
@ 2020-10-20 11:20 ` Serge Semin
  2020-10-20 19:34   ` Martin Blumenstingl
  2020-10-20 11:20 ` [PATCH v3 06/16] dt-bindings: usb: Convert xHCI bindings to DT schema Serge Semin
                   ` (10 subsequent siblings)
  15 siblings, 1 reply; 23+ messages in thread
From: Serge Semin @ 2020-10-20 11:20 UTC (permalink / raw)
  To: Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Greg Kroah-Hartman, Rob Herring
  Cc: Serge Semin, Serge Semin, Alexey Malahov, Pavel Parkhomenko,
	Andy Gross, Bjorn Andersson, Manu Gautam, Roger Quadros,
	Lad Prabhakar, Yoshihiro Shimoda, Neil Armstrong, Kevin Hilman,
	Martin Blumenstingl, linux-arm-kernel, linux-snps-arc,
	linux-mips, linuxppc-dev, linux-usb, devicetree, linux-kernel,
	Rob Herring

Even though the Generic PHY framework is the more preferable way of
setting the USB PHY up, there are still many dts-files and DT bindings
which rely on having the legacy "usb-phy" specified to attach particular
USB PHYs to USB cores. Let's have the "usb-phy" property described in
the generic USB HCD binding file so it would be validated against the
nodes in which it's specified. Mark the property as deprecated to
discourage the developers from using it.

Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
Reviewed-by: Rob Herring <robh@kernel.org>

---

Changelog v2:
- Discard '|' from the property description, since we don't need to preserve
  the text formatting.
---
 Documentation/devicetree/bindings/usb/usb-hcd.yaml | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/Documentation/devicetree/bindings/usb/usb-hcd.yaml b/Documentation/devicetree/bindings/usb/usb-hcd.yaml
index 1f9b40fdea70..264a660dc6ea 100644
--- a/Documentation/devicetree/bindings/usb/usb-hcd.yaml
+++ b/Documentation/devicetree/bindings/usb/usb-hcd.yaml
@@ -22,6 +22,13 @@ properties:
     description:
       Name specifier for the USB PHY
 
+  usb-phy:
+    $ref: /schemas/types.yaml#/definitions/phandle-array
+    description:
+      List of all the USB PHYs on this HCD to be accepted by the legacy USB
+      Physical Layer subsystem.
+    deprecated: true
+
   maximum-speed:
    description:
      Tells USB controllers we want to work up to a certain speed. In case this
-- 
2.27.0


^ permalink raw reply related	[flat|nested] 23+ messages in thread

* [PATCH v3 06/16] dt-bindings: usb: Convert xHCI bindings to DT schema
  2020-10-20 11:20 [PATCH v3 00/16] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 DT schema Serge Semin
                   ` (4 preceding siblings ...)
  2020-10-20 11:20 ` [PATCH v3 05/16] dt-bindings: usb: usb-hcd: Add generic "usb-phy" property Serge Semin
@ 2020-10-20 11:20 ` Serge Semin
  2020-10-20 11:20 ` [PATCH v3 07/16] dt-bindings: usb: xhci: Add Broadcom STB v2 compatible device Serge Semin
                   ` (9 subsequent siblings)
  15 siblings, 0 replies; 23+ messages in thread
From: Serge Semin @ 2020-10-20 11:20 UTC (permalink / raw)
  To: Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Greg Kroah-Hartman, Rob Herring
  Cc: Serge Semin, Serge Semin, Alexey Malahov, Pavel Parkhomenko,
	Andy Gross, Bjorn Andersson, Manu Gautam, Roger Quadros,
	Lad Prabhakar, Yoshihiro Shimoda, Neil Armstrong, Kevin Hilman,
	Martin Blumenstingl, linux-arm-kernel, linux-snps-arc,
	linux-mips, linuxppc-dev, linux-usb, devicetree, linux-kernel,
	Rob Herring

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>
Reviewed-by: Rob Herring <robh@kernel.org>

---

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


^ permalink raw reply related	[flat|nested] 23+ messages in thread

* [PATCH v3 07/16] dt-bindings: usb: xhci: Add Broadcom STB v2 compatible device
  2020-10-20 11:20 [PATCH v3 00/16] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 DT schema Serge Semin
                   ` (5 preceding siblings ...)
  2020-10-20 11:20 ` [PATCH v3 06/16] dt-bindings: usb: Convert xHCI bindings to DT schema Serge Semin
@ 2020-10-20 11:20 ` Serge Semin
  2020-10-20 11:20 ` [PATCH v3 08/16] dt-bindings: usb: renesas-xhci: Refer to the usb-xhci.yaml file Serge Semin
                   ` (8 subsequent siblings)
  15 siblings, 0 replies; 23+ messages in thread
From: Serge Semin @ 2020-10-20 11:20 UTC (permalink / raw)
  To: Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Greg Kroah-Hartman, Rob Herring
  Cc: Serge Semin, Serge Semin, Alexey Malahov, Pavel Parkhomenko,
	Andy Gross, Bjorn Andersson, Manu Gautam, Roger Quadros,
	Lad Prabhakar, Yoshihiro Shimoda, Neil Armstrong, Kevin Hilman,
	Martin Blumenstingl, linux-arm-kernel, linux-snps-arc,
	linux-mips, linuxppc-dev, linux-usb, devicetree, linux-kernel,
	Florian Fainelli, Rob Herring

For some reason the "brcm,xhci-brcm-v2" compatible string has been missing
in the original bindings file. Add it to the Generic xHCI Controllers DT
schema since the controller driver expects it to be supported.

Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
Acked-by: Florian Fainelli <f.fainelli@gmail.com>
Reviewed-by: Rob Herring <robh@kernel.org>
---
 Documentation/devicetree/bindings/usb/generic-xhci.yaml | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/Documentation/devicetree/bindings/usb/generic-xhci.yaml b/Documentation/devicetree/bindings/usb/generic-xhci.yaml
index 1ea1d49a8175..23d73df96ea3 100644
--- a/Documentation/devicetree/bindings/usb/generic-xhci.yaml
+++ b/Documentation/devicetree/bindings/usb/generic-xhci.yaml
@@ -26,7 +26,9 @@ properties:
               - marvell,armada-8k-xhci
           - const: generic-xhci
       - description: Broadcom STB SoCs with xHCI
-        const: brcm,bcm7445-xhci
+        enum:
+          - brcm,xhci-brcm-v2
+          - brcm,bcm7445-xhci
       - description: Generic xHCI device
         const: xhci-platform
         deprecated: true
-- 
2.27.0


^ permalink raw reply related	[flat|nested] 23+ messages in thread

* [PATCH v3 08/16] dt-bindings: usb: renesas-xhci: Refer to the usb-xhci.yaml file
  2020-10-20 11:20 [PATCH v3 00/16] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 DT schema Serge Semin
                   ` (6 preceding siblings ...)
  2020-10-20 11:20 ` [PATCH v3 07/16] dt-bindings: usb: xhci: Add Broadcom STB v2 compatible device Serge Semin
@ 2020-10-20 11:20 ` Serge Semin
  2020-10-20 11:20 ` [PATCH v3 09/16] dt-bindings: usb: Convert DWC USB3 bindings to DT schema Serge Semin
                   ` (7 subsequent siblings)
  15 siblings, 0 replies; 23+ messages in thread
From: Serge Semin @ 2020-10-20 11:20 UTC (permalink / raw)
  To: Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Greg Kroah-Hartman, Rob Herring, Lad Prabhakar,
	Yoshihiro Shimoda
  Cc: Serge Semin, Serge Semin, Alexey Malahov, Pavel Parkhomenko,
	Andy Gross, Bjorn Andersson, Manu Gautam, Roger Quadros,
	Neil Armstrong, Kevin Hilman, Martin Blumenstingl,
	linux-arm-kernel, linux-snps-arc, linux-mips, linuxppc-dev,
	linux-usb, devicetree, linux-kernel, Rob Herring

With minor peculiarities (like uploading some vendor-specific firmware)
these are just Generic xHCI controllers fully compatible with its
properties. Make sure the Renesas USB xHCI DT nodes are also validated
against the Generic xHCI DT schema.

Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
Reviewed-by: Rob Herring <robh@kernel.org>
Reviewed-by: Yoshihiro Shimoda <yoshihiro.shimoda.uh@renesas.com>
---
 Documentation/devicetree/bindings/usb/renesas,usb-xhci.yaml | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/devicetree/bindings/usb/renesas,usb-xhci.yaml b/Documentation/devicetree/bindings/usb/renesas,usb-xhci.yaml
index add9f7b66da0..4491567152a1 100644
--- a/Documentation/devicetree/bindings/usb/renesas,usb-xhci.yaml
+++ b/Documentation/devicetree/bindings/usb/renesas,usb-xhci.yaml
@@ -11,7 +11,7 @@ maintainers:
   - Yoshihiro Shimoda <yoshihiro.shimoda.uh@renesas.com>
 
 allOf:
-  - $ref: "usb-hcd.yaml"
+  - $ref: "usb-xhci.yaml"
 
 properties:
   compatible:
@@ -68,7 +68,7 @@ required:
   - power-domains
   - resets
 
-additionalProperties: false
+unevaluatedProperties: false
 
 examples:
   - |
-- 
2.27.0


^ permalink raw reply related	[flat|nested] 23+ messages in thread

* [PATCH v3 09/16] dt-bindings: usb: Convert DWC USB3 bindings to DT schema
  2020-10-20 11:20 [PATCH v3 00/16] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 DT schema Serge Semin
                   ` (7 preceding siblings ...)
  2020-10-20 11:20 ` [PATCH v3 08/16] dt-bindings: usb: renesas-xhci: Refer to the usb-xhci.yaml file Serge Semin
@ 2020-10-20 11:20 ` Serge Semin
  2020-10-20 15:40   ` Rob Herring
  2020-10-20 11:20 ` [PATCH v3 10/16] dt-bindings: usb: dwc3: Add interrupt-names property support Serge Semin
                   ` (6 subsequent siblings)
  15 siblings, 1 reply; 23+ messages in thread
From: Serge Semin @ 2020-10-20 11:20 UTC (permalink / raw)
  To: Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Greg Kroah-Hartman, Rob Herring
  Cc: Serge Semin, Serge Semin, Alexey Malahov, Pavel Parkhomenko,
	Andy Gross, Bjorn Andersson, Manu Gautam, Roger Quadros,
	Lad Prabhakar, Yoshihiro Shimoda, Neil Armstrong, Kevin Hilman,
	Martin Blumenstingl, linux-arm-kernel, linux-snps-arc,
	linux-mips, linuxppc-dev, linux-usb, devicetree, linux-kernel

DWC USB3 DT node is supposed to be compliant with the Generic xHCI
Controller schema, but with additional vendor-specific properties, the
controller-specific reference clocks and PHYs. So let's convert the
currently available legacy text-based DWC USB3 bindings to the DT schema
and make sure the DWC USB3 nodes are also validated against the
usb-xhci.yaml schema.

Note we have to discard the nodename restriction of being prefixed with
"dwc3@" string, since in accordance with the usb-hcd.yaml schema USB nodes
are supposed to be named as "^usb(@.*)".

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

---

Changelog v2:
- Discard '|' from the descriptions, since we don't need to preserve
  the text formatting in any of them.
- Drop quotes from around the string constants.
- Fix the "clock-names" prop description to be referring the enumerated
  clock-names instead of the ones from the Databook.

Changelog v3:
- Apply usb-xhci.yaml# schema only if the controller is supposed to work
  as either host or otg.
---
 .../devicetree/bindings/usb/dwc3.txt          | 125 --------
 .../devicetree/bindings/usb/snps,dwc3.yaml    | 302 ++++++++++++++++++
 2 files changed, 302 insertions(+), 125 deletions(-)
 delete mode 100644 Documentation/devicetree/bindings/usb/dwc3.txt
 create mode 100644 Documentation/devicetree/bindings/usb/snps,dwc3.yaml

diff --git a/Documentation/devicetree/bindings/usb/dwc3.txt b/Documentation/devicetree/bindings/usb/dwc3.txt
deleted file mode 100644
index d03edf9d3935..000000000000
--- a/Documentation/devicetree/bindings/usb/dwc3.txt
+++ /dev/null
@@ -1,125 +0,0 @@
-synopsys DWC3 CORE
-
-DWC3- USB3 CONTROLLER. Complies to the generic USB binding properties
-      as described in 'usb/generic.txt'
-
-Required properties:
- - compatible: must be "snps,dwc3"
- - reg : Address and length of the register set for the device
- - interrupts: Interrupts used by the dwc3 controller.
- - clock-names: list of clock names. Ideally should be "ref",
-                "bus_early", "suspend" but may be less or more.
- - clocks: list of phandle and clock specifier pairs corresponding to
-           entries in the clock-names property.
-
-Exception for clocks:
-  clocks are optional if the parent node (i.e. glue-layer) is compatible to
-  one of the following:
-    "cavium,octeon-7130-usb-uctl"
-    "qcom,dwc3"
-    "samsung,exynos5250-dwusb3"
-    "samsung,exynos5433-dwusb3"
-    "samsung,exynos7-dwusb3"
-    "sprd,sc9860-dwc3"
-    "st,stih407-dwc3"
-    "ti,am437x-dwc3"
-    "ti,dwc3"
-    "ti,keystone-dwc3"
-    "rockchip,rk3399-dwc3"
-    "xlnx,zynqmp-dwc3"
-
-Optional properties:
- - usb-phy : array of phandle for the PHY device.  The first element
-   in the array is expected to be a handle to the USB2/HS PHY and
-   the second element is expected to be a handle to the USB3/SS PHY
- - phys: from the *Generic PHY* bindings
- - phy-names: from the *Generic PHY* bindings; supported names are "usb2-phy"
-	or "usb3-phy".
- - resets: set of phandle and reset specifier pairs
- - snps,usb2-lpm-disable: indicate if we don't want to enable USB2 HW LPM
- - snps,usb3_lpm_capable: determines if platform is USB3 LPM capable
- - snps,dis-start-transfer-quirk: when set, disable isoc START TRANSFER command
-			failure SW work-around for DWC_usb31 version 1.70a-ea06
-			and prior.
- - snps,disable_scramble_quirk: true when SW should disable data scrambling.
-	Only really useful for FPGA builds.
- - snps,has-lpm-erratum: true when DWC3 was configured with LPM Erratum enabled
- - snps,lpm-nyet-threshold: LPM NYET threshold
- - snps,u2exit_lfps_quirk: set if we want to enable u2exit lfps quirk
- - snps,u2ss_inp3_quirk: set if we enable P3 OK for U2/SS Inactive quirk
- - snps,req_p1p2p3_quirk: when set, the core will always request for
-			P1/P2/P3 transition sequence.
- - snps,del_p1p2p3_quirk: when set core will delay P1/P2/P3 until a certain
-			amount of 8B10B errors occur.
- - snps,del_phy_power_chg_quirk: when set core will delay PHY power change
-			from P0 to P1/P2/P3.
- - snps,lfps_filter_quirk: when set core will filter LFPS reception.
- - snps,rx_detect_poll_quirk: when set core will disable a 400us delay to start
-			Polling LFPS after RX.Detect.
- - snps,tx_de_emphasis_quirk: when set core will set Tx de-emphasis value.
- - snps,tx_de_emphasis: the value driven to the PHY is controlled by the
-			LTSSM during USB3 Compliance mode.
- - snps,dis_u3_susphy_quirk: when set core will disable USB3 suspend phy.
- - snps,dis_u2_susphy_quirk: when set core will disable USB2 suspend phy.
- - snps,dis_enblslpm_quirk: when set clears the enblslpm in GUSB2PHYCFG,
-			disabling the suspend signal to the PHY.
- - snps,dis-u1-entry-quirk: set if link entering into U1 needs to be disabled.
- - snps,dis-u2-entry-quirk: set if link entering into U2 needs to be disabled.
- - snps,dis_rxdet_inp3_quirk: when set core will disable receiver detection
-			in PHY P3 power state.
- - snps,dis-u2-freeclk-exists-quirk: when set, clear the u2_freeclk_exists
-			in GUSB2PHYCFG, specify that USB2 PHY doesn't provide
-			a free-running PHY clock.
- - snps,dis-del-phy-power-chg-quirk: when set core will change PHY power
-			from P0 to P1/P2/P3 without delay.
- - snps,dis-tx-ipgap-linecheck-quirk: when set, disable u2mac linestate check
-			during HS transmit.
- - snps,parkmode-disable-ss-quirk: when set, all SuperSpeed bus instances in
-			park mode are disabled.
- - snps,dis_metastability_quirk: when set, disable metastability workaround.
-			CAUTION: use only if you are absolutely sure of it.
- - snps,is-utmi-l1-suspend: true when DWC3 asserts output signal
-			utmi_l1_suspend_n, false when asserts utmi_sleep_n
- - snps,hird-threshold: HIRD threshold
- - snps,hsphy_interface: High-Speed PHY interface selection between "utmi" for
-   UTMI+ and "ulpi" for ULPI when the DWC_USB3_HSPHY_INTERFACE has value 3.
- - snps,quirk-frame-length-adjustment: Value for GFLADJ_30MHZ field of GFLADJ
-	register for post-silicon frame length adjustment when the
-	fladj_30mhz_sdbnd signal is invalid or incorrect.
- - snps,rx-thr-num-pkt-prd: periodic ESS RX packet threshold count - host mode
-			only. Set this and rx-max-burst-prd to a valid,
-			non-zero value 1-16 (DWC_usb31 programming guide
-			section 1.2.4) to enable periodic ESS RX threshold.
- - snps,rx-max-burst-prd: max periodic ESS RX burst size - host mode only. Set
-			this and rx-thr-num-pkt-prd to a valid, non-zero value
-			1-16 (DWC_usb31 programming guide section 1.2.4) to
-			enable periodic ESS RX threshold.
- - snps,tx-thr-num-pkt-prd: periodic ESS TX packet threshold count - host mode
-			only. Set this and tx-max-burst-prd to a valid,
-			non-zero value 1-16 (DWC_usb31 programming guide
-			section 1.2.3) to enable periodic ESS TX threshold.
- - snps,tx-max-burst-prd: max periodic ESS TX burst size - host mode only. Set
-			this and tx-thr-num-pkt-prd to a valid, non-zero value
-			1-16 (DWC_usb31 programming guide section 1.2.3) to
-			enable periodic ESS TX threshold.
-
- - <DEPRECATED> tx-fifo-resize: determines if the FIFO *has* to be reallocated.
- - snps,incr-burst-type-adjustment: Value for INCR burst type of GSBUSCFG0
-			register, undefined length INCR burst type enable and INCRx type.
-			When just one value, which means INCRX burst mode enabled. When
-			more than one value, which means undefined length INCR burst type
-			enabled. The values can be 1, 4, 8, 16, 32, 64, 128 and 256.
-
- - in addition all properties from usb-xhci.txt from the current directory are
-   supported as well
-
-
-This is usually a subnode to DWC3 glue to which it is connected.
-
-dwc3@4a030000 {
-	compatible = "snps,dwc3";
-	reg = <0x4a030000 0xcfff>;
-	interrupts = <0 92 4>
-	usb-phy = <&usb2_phy>, <&usb3,phy>;
-	snps,incr-burst-type-adjustment = <1>, <4>, <8>, <16>;
-};
diff --git a/Documentation/devicetree/bindings/usb/snps,dwc3.yaml b/Documentation/devicetree/bindings/usb/snps,dwc3.yaml
new file mode 100644
index 000000000000..65bc66ec67d0
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/snps,dwc3.yaml
@@ -0,0 +1,302 @@
+# SPDX-License-Identifier: GPL-2.0
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/snps,dwc3.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Synopsys DesignWare USB3 Controller
+
+maintainers:
+  - Felipe Balbi <balbi@kernel.org>
+
+description:
+  This is usually a subnode to DWC3 glue to which it is connected, but can also
+  be presented as a standalone DT node with an optional vendor-specific
+  compatible string.
+
+allOf:
+  - if:
+      properties:
+        dr_mode:
+          const: peripheral
+    then:
+      $ref: usb-hcd.yaml#
+    else:
+      $ref: usb-xhci.yaml#
+
+properties:
+  compatible:
+    contains:
+      const: snps,dwc3
+
+  interrupts:
+    minItems: 1
+    maxItems: 3
+
+  clocks:
+    description:
+      In general the core supports three types of clocks. bus_early is a
+      SoC Bus Clock (AHB/AXI/Native). ref generates ITP when the UTMI/ULPI
+      PHY is suspended. suspend clocks a small part of the USB3 core when
+      SS PHY in P3. But particular cases may differ from that having less
+      or more clock sources with another names.
+
+  clock-names:
+    contains:
+      anyOf:
+        - enum: [bus_early, ref, suspend]
+        - true
+
+  usb-phy:
+   minItems: 1
+   items:
+     - description: USB2/HS PHY
+     - description: USB3/SS PHY
+
+  phys:
+    minItems: 1
+    items:
+      - description: USB2/HS PHY
+      - description: USB3/SS PHY
+
+  phy-names:
+    minItems: 1
+    items:
+      - const: usb2-phy
+      - const: usb3-phy
+
+  resets:
+    minItems: 1
+
+  snps,usb2-lpm-disable:
+    description: Indicate if we don't want to enable USB2 HW LPM
+    type: boolean
+
+  snps,usb3_lpm_capable:
+    description: Determines if platform is USB3 LPM capable
+    type: boolean
+
+  snps,dis-start-transfer-quirk:
+    description:
+      When set, disable isoc START TRANSFER command failure SW work-around
+      for DWC_usb31 version 1.70a-ea06 and prior.
+    type: boolean
+
+  snps,disable_scramble_quirk:
+    description:
+      True when SW should disable data scrambling. Only really useful for FPGA
+      builds.
+    type: boolean
+
+  snps,has-lpm-erratum:
+    description: True when DWC3 was configured with LPM Erratum enabled
+    type: boolean
+
+  snps,lpm-nyet-threshold:
+    description: LPM NYET threshold
+    $ref: /schemas/types.yaml#/definitions/uint8
+
+  snps,u2exit_lfps_quirk:
+    description: Set if we want to enable u2exit lfps quirk
+    type: boolean
+
+  snps,u2ss_inp3_quirk:
+    description: Set if we enable P3 OK for U2/SS Inactive quirk
+    type: boolean
+
+  snps,req_p1p2p3_quirk:
+    description:
+      When set, the core will always request for P1/P2/P3 transition sequence.
+    type: boolean
+
+  snps,del_p1p2p3_quirk:
+    description:
+      When set core will delay P1/P2/P3 until a certain amount of 8B10B errors
+      occur.
+    type: boolean
+
+  snps,del_phy_power_chg_quirk:
+    description: When set core will delay PHY power change from P0 to P1/P2/P3.
+    type: boolean
+
+  snps,lfps_filter_quirk:
+    description: When set core will filter LFPS reception.
+    type: boolean
+
+  snps,rx_detect_poll_quirk:
+    description:
+      when set core will disable a 400us delay to start Polling LFPS after
+      RX.Detect.
+    type: boolean
+
+  snps,tx_de_emphasis_quirk:
+    description: When set core will set Tx de-emphasis value
+    type: boolean
+
+  snps,tx_de_emphasis:
+    description:
+      The value driven to the PHY is controlled by the LTSSM during USB3
+      Compliance mode.
+    $ref: /schemas/types.yaml#/definitions/uint8
+
+  snps,dis_u3_susphy_quirk:
+    description: When set core will disable USB3 suspend phy
+    type: boolean
+
+  snps,dis_u2_susphy_quirk:
+    description: When set core will disable USB2 suspend phy
+    type: boolean
+
+  snps,dis_enblslpm_quirk:
+    description:
+      When set clears the enblslpm in GUSB2PHYCFG, disabling the suspend signal
+      to the PHY.
+    type: boolean
+
+  snps,dis-u1-entry-quirk:
+    description: Set if link entering into U1 needs to be disabled
+    type: boolean
+
+  snps,dis-u2-entry-quirk:
+    description: Set if link entering into U2 needs to be disabled
+    type: boolean
+
+  snps,dis_rxdet_inp3_quirk:
+    description:
+      When set core will disable receiver detection in PHY P3 power state.
+    type: boolean
+
+  snps,dis-u2-freeclk-exists-quirk:
+    description:
+      When set, clear the u2_freeclk_exists in GUSB2PHYCFG, specify that USB2
+      PHY doesn't provide a free-running PHY clock.
+    type: boolean
+
+  snps,dis-del-phy-power-chg-quirk:
+    description:
+      When set core will change PHY power from P0 to P1/P2/P3 without delay.
+    type: boolean
+
+  snps,dis-tx-ipgap-linecheck-quirk:
+    description: When set, disable u2mac linestate check during HS transmit
+    type: boolean
+
+  snps,parkmode-disable-ss-quirk:
+    description:
+      When set, all SuperSpeed bus instances in park mode are disabled.
+    type: boolean
+
+  snps,dis_metastability_quirk:
+    description:
+      When set, disable metastability workaround. CAUTION! Use only if you are
+      absolutely sure of it.
+    type: boolean
+
+  snps,is-utmi-l1-suspend:
+    description:
+      True when DWC3 asserts output signal utmi_l1_suspend_n, false when
+      asserts utmi_sleep_n.
+    type: boolean
+
+  snps,hird-threshold:
+    description: HIRD threshold
+    $ref: /schemas/types.yaml#/definitions/uint8
+
+  snps,hsphy_interface:
+    description:
+      High-Speed PHY interface selection between UTMI+ and ULPI when the
+      DWC_USB3_HSPHY_INTERFACE has value 3.
+    $ref: /schemas/types.yaml#/definitions/uint8
+    enum: [utmi, ulpi]
+
+  snps,quirk-frame-length-adjustment:
+    description:
+      Value for GFLADJ_30MHZ field of GFLADJ register for post-silicon frame
+      length adjustment when the fladj_30mhz_sdbnd signal is invalid or
+      incorrect.
+    $ref: /schemas/types.yaml#/definitions/uint32
+
+  snps,rx-thr-num-pkt-prd:
+    description:
+      Periodic ESS RX packet threshold count (host mode only). Set this and
+      snps,rx-max-burst-prd to a valid, non-zero value 1-16 (DWC_usb31
+      programming guide section 1.2.4) to enable periodic ESS RX threshold.
+    $ref: /schemas/types.yaml#/definitions/uint8
+    minimum: 1
+    maximum: 16
+
+  snps,rx-max-burst-prd:
+    description:
+      Max periodic ESS RX burst size (host mode only). Set this and
+      snps,rx-thr-num-pkt-prd to a valid, non-zero value 1-16 (DWC_usb31
+      programming guide section 1.2.4) to enable periodic ESS RX threshold.
+    $ref: /schemas/types.yaml#/definitions/uint8
+    minimum: 1
+    maximum: 16
+
+  snps,tx-thr-num-pkt-prd:
+    description:
+      Periodic ESS TX packet threshold count (host mode only). Set this and
+      snps,tx-max-burst-prd to a valid, non-zero value 1-16 (DWC_usb31
+      programming guide section 1.2.3) to enable periodic ESS TX threshold.
+    $ref: /schemas/types.yaml#/definitions/uint8
+    minimum: 1
+    maximum: 16
+
+  snps,tx-max-burst-prd:
+    description:
+      Max periodic ESS TX burst size (host mode only). Set this and
+      snps,tx-thr-num-pkt-prd to a valid, non-zero value 1-16 (DWC_usb31
+      programming guide section 1.2.3) to enable periodic ESS TX threshold.
+    $ref: /schemas/types.yaml#/definitions/uint8
+    minimum: 1
+    maximum: 16
+
+  tx-fifo-resize:
+    description: Determines if the FIFO *has* to be reallocated
+    deprecated: true
+    type: boolean
+
+  snps,incr-burst-type-adjustment:
+    description:
+      Value for INCR burst type of GSBUSCFG0 register, undefined length INCR
+      burst type enable and INCRx type. A single value means INCRX burst mode
+      enabled. If more than one value specified, undefined length INCR burst
+      type will be enabled with burst lengths utilized up to the maximum
+      of the values passed in this property.
+    $ref: /schemas/types.yaml#/definitions/uint32-array
+    minItems: 1
+    maxItems: 8
+    uniqueItems: true
+    items:
+      enum: [1, 4, 8, 16, 32, 64, 128, 256]
+
+unevaluatedProperties: false
+
+required:
+  - compatible
+  - reg
+  - interrupts
+
+examples:
+  - |
+    usb@4a030000 {
+      compatible = "snps,dwc3";
+      reg = <0x4a030000 0xcfff>;
+      interrupts = <0 92 4>;
+      usb-phy = <&usb2_phy>, <&usb3_phy>;
+      snps,incr-burst-type-adjustment = <1>, <4>, <8>, <16>;
+    };
+  - |
+    usb@4a000000 {
+      compatible = "snps,dwc3";
+      reg = <0x4a000000 0xcfff>;
+      interrupts = <0 92 4>;
+      clocks = <&clk 1>, <&clk 2>, <&clk 3>;
+      clock-names = "bus_early", "ref", "suspend";
+      phys = <&usb2_phy>, <&usb3_phy>;
+      phy-names = "usb2-phy", "usb3-phy";
+      snps,dis_u2_susphy_quirk;
+      snps,dis_enblslpm_quirk;
+    };
+...
-- 
2.27.0


^ permalink raw reply related	[flat|nested] 23+ messages in thread

* [PATCH v3 10/16] dt-bindings: usb: dwc3: Add interrupt-names property support
  2020-10-20 11:20 [PATCH v3 00/16] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 DT schema Serge Semin
                   ` (8 preceding siblings ...)
  2020-10-20 11:20 ` [PATCH v3 09/16] dt-bindings: usb: Convert DWC USB3 bindings to DT schema Serge Semin
@ 2020-10-20 11:20 ` Serge Semin
  2020-10-20 11:20 ` [PATCH v3 11/16] dt-bindings: usb: dwc3: Add Tx De-emphasis constraints Serge Semin
                   ` (5 subsequent siblings)
  15 siblings, 0 replies; 23+ messages in thread
From: Serge Semin @ 2020-10-20 11:20 UTC (permalink / raw)
  To: Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Greg Kroah-Hartman, Rob Herring
  Cc: Serge Semin, Serge Semin, Alexey Malahov, Pavel Parkhomenko,
	Andy Gross, Bjorn Andersson, Manu Gautam, Roger Quadros,
	Lad Prabhakar, Yoshihiro Shimoda, Neil Armstrong, Kevin Hilman,
	Martin Blumenstingl, linux-arm-kernel, linux-snps-arc,
	linux-mips, linuxppc-dev, linux-usb, devicetree, linux-kernel,
	Rob Herring

The controller driver supports two types of DWC USB3 devices: with a
common interrupt lane and with individual interrupts for each mode. Add
support for both these cases to the DWC USB3 DT schema.

Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
Reviewed-by: Rob Herring <robh@kernel.org>

---

Changelog v2:
- Grammar fix: "s/both of these cases support/support for both these cases"
- Drop quotes from around the string constants.
---
 Documentation/devicetree/bindings/usb/snps,dwc3.yaml | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/Documentation/devicetree/bindings/usb/snps,dwc3.yaml b/Documentation/devicetree/bindings/usb/snps,dwc3.yaml
index 65bc66ec67d0..23f07222d3d7 100644
--- a/Documentation/devicetree/bindings/usb/snps,dwc3.yaml
+++ b/Documentation/devicetree/bindings/usb/snps,dwc3.yaml
@@ -30,9 +30,20 @@ properties:
       const: snps,dwc3
 
   interrupts:
+    description: |
+      It's either a single common DWC3 interrupt (dwc_usb3) or individual
+      interrupts for the host, gadget and DRD modes.
     minItems: 1
     maxItems: 3
 
+  interrupt-names:
+    minItems: 1
+    maxItems: 3
+    oneOf:
+      - const: dwc_usb3
+      - items:
+          enum: [host, peripheral, otg]
+
   clocks:
     description:
       In general the core supports three types of clocks. bus_early is a
-- 
2.27.0


^ permalink raw reply related	[flat|nested] 23+ messages in thread

* [PATCH v3 11/16] dt-bindings: usb: dwc3: Add Tx De-emphasis constraints
  2020-10-20 11:20 [PATCH v3 00/16] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 DT schema Serge Semin
                   ` (9 preceding siblings ...)
  2020-10-20 11:20 ` [PATCH v3 10/16] dt-bindings: usb: dwc3: Add interrupt-names property support Serge Semin
@ 2020-10-20 11:20 ` Serge Semin
  2020-10-20 11:20 ` [PATCH v3 12/16] dt-bindings: usb: dwc3: Add Frame Length Adj constraints Serge Semin
                   ` (4 subsequent siblings)
  15 siblings, 0 replies; 23+ messages in thread
From: Serge Semin @ 2020-10-20 11:20 UTC (permalink / raw)
  To: Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Greg Kroah-Hartman, Rob Herring
  Cc: Serge Semin, Serge Semin, Alexey Malahov, Pavel Parkhomenko,
	Andy Gross, Bjorn Andersson, Manu Gautam, Roger Quadros,
	Lad Prabhakar, Yoshihiro Shimoda, Neil Armstrong, Kevin Hilman,
	Martin Blumenstingl, linux-arm-kernel, linux-snps-arc,
	linux-mips, linuxppc-dev, linux-usb, devicetree, linux-kernel,
	Rob Herring

In accordance with the driver comments the PIPE3 de-emphasis can be tuned
to be either -6dB, -2.5dB or disabled. Let's add the de-emphasis
property constraints so the DT schema would make sure the controller DT
node is equipped with correct value.

Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
Reviewed-by: Rob Herring <robh@kernel.org>

---

Changelog v2:
- Grammar fix: "s/tunned/tuned"
- Grammar fix: remove redundant "or" conjunction.
---
 Documentation/devicetree/bindings/usb/snps,dwc3.yaml | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/Documentation/devicetree/bindings/usb/snps,dwc3.yaml b/Documentation/devicetree/bindings/usb/snps,dwc3.yaml
index 23f07222d3d7..6ab7cba56059 100644
--- a/Documentation/devicetree/bindings/usb/snps,dwc3.yaml
+++ b/Documentation/devicetree/bindings/usb/snps,dwc3.yaml
@@ -149,6 +149,10 @@ properties:
       The value driven to the PHY is controlled by the LTSSM during USB3
       Compliance mode.
     $ref: /schemas/types.yaml#/definitions/uint8
+    enum:
+      - 0 # -6dB de-emphasis
+      - 1 # -3.5dB de-emphasis
+      - 2 # No de-emphasis
 
   snps,dis_u3_susphy_quirk:
     description: When set core will disable USB3 suspend phy
-- 
2.27.0


^ permalink raw reply related	[flat|nested] 23+ messages in thread

* [PATCH v3 12/16] dt-bindings: usb: dwc3: Add Frame Length Adj constraints
  2020-10-20 11:20 [PATCH v3 00/16] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 DT schema Serge Semin
                   ` (10 preceding siblings ...)
  2020-10-20 11:20 ` [PATCH v3 11/16] dt-bindings: usb: dwc3: Add Tx De-emphasis constraints Serge Semin
@ 2020-10-20 11:20 ` Serge Semin
  2020-10-20 11:20 ` [PATCH v3 13/16] dt-bindings: usb: meson-g12a-usb: Fix FL-adj property value Serge Semin
                   ` (3 subsequent siblings)
  15 siblings, 0 replies; 23+ messages in thread
From: Serge Semin @ 2020-10-20 11:20 UTC (permalink / raw)
  To: Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Greg Kroah-Hartman, Rob Herring
  Cc: Serge Semin, Serge Semin, Alexey Malahov, Pavel Parkhomenko,
	Andy Gross, Bjorn Andersson, Manu Gautam, Roger Quadros,
	Lad Prabhakar, Yoshihiro Shimoda, Neil Armstrong, Kevin Hilman,
	Martin Blumenstingl, linux-arm-kernel, linux-snps-arc,
	linux-mips, linuxppc-dev, linux-usb, devicetree, linux-kernel,
	Rob Herring

In accordance with the IP core databook the
snps,quirk-frame-length-adjustment property can be set within [0, 0x3F].
Let's make sure the DT schema applies a correct constraints on the
property.

Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
Reviewed-by: Rob Herring <robh@kernel.org>
---
 Documentation/devicetree/bindings/usb/snps,dwc3.yaml | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/Documentation/devicetree/bindings/usb/snps,dwc3.yaml b/Documentation/devicetree/bindings/usb/snps,dwc3.yaml
index 6ab7cba56059..2a269624983a 100644
--- a/Documentation/devicetree/bindings/usb/snps,dwc3.yaml
+++ b/Documentation/devicetree/bindings/usb/snps,dwc3.yaml
@@ -230,6 +230,8 @@ properties:
       length adjustment when the fladj_30mhz_sdbnd signal is invalid or
       incorrect.
     $ref: /schemas/types.yaml#/definitions/uint32
+    minimum: 0
+    maximum: 0x3f
 
   snps,rx-thr-num-pkt-prd:
     description:
-- 
2.27.0


^ permalink raw reply related	[flat|nested] 23+ messages in thread

* [PATCH v3 13/16] dt-bindings: usb: meson-g12a-usb: Fix FL-adj property value
  2020-10-20 11:20 [PATCH v3 00/16] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 DT schema Serge Semin
                   ` (11 preceding siblings ...)
  2020-10-20 11:20 ` [PATCH v3 12/16] dt-bindings: usb: dwc3: Add Frame Length Adj constraints Serge Semin
@ 2020-10-20 11:20 ` Serge Semin
  2020-10-20 11:20 ` [PATCH v3 14/16] dt-bindings: usb: meson-g12a-usb: Validate DWC2/DWC3 sub-nodes Serge Semin
                   ` (2 subsequent siblings)
  15 siblings, 0 replies; 23+ messages in thread
From: Serge Semin @ 2020-10-20 11:20 UTC (permalink / raw)
  To: Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Greg Kroah-Hartman, Rob Herring, Kevin Hilman, Neil Armstrong,
	Jerome Brunet, Martin Blumenstingl
  Cc: Serge Semin, Serge Semin, Alexey Malahov, Pavel Parkhomenko,
	Andy Gross, Bjorn Andersson, Manu Gautam, Roger Quadros,
	Lad Prabhakar, Yoshihiro Shimoda, linux-arm-kernel,
	linux-snps-arc, linux-mips, linuxppc-dev, linux-usb, devicetree,
	linux-kernel, Rob Herring, linux-amlogic

An empty snps,quirk-frame-length-adjustment won't cause any change
performed by the driver. Moreover the DT schema validation will fail,
since it expects the property being assigned with some value. So set
fix the example by setting a valid FL-adj value in accordance with
Neil Armstrong comment.

Link: https://lore.kernel.org/linux-usb/20201010224121.12672-16-Sergey.Semin@baikalelectronics.ru/
Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
Acked-by: Neil Armstrong <narmstrong@baylibre.com>
Reviewed-by: Rob Herring <robh@kernel.org>
Reviewed-by: Martin Blumenstingl <martin.blumenstingl@googlemail.com>

---

Note the same problem is in the DT source file
arch/arm64/boot/dts/amlogic/meson-g12-common.dtsi .
---
 .../devicetree/bindings/usb/amlogic,meson-g12a-usb-ctrl.yaml    | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/devicetree/bindings/usb/amlogic,meson-g12a-usb-ctrl.yaml b/Documentation/devicetree/bindings/usb/amlogic,meson-g12a-usb-ctrl.yaml
index 5b04a7dfa018..a4b44a16aaef 100644
--- a/Documentation/devicetree/bindings/usb/amlogic,meson-g12a-usb-ctrl.yaml
+++ b/Documentation/devicetree/bindings/usb/amlogic,meson-g12a-usb-ctrl.yaml
@@ -209,6 +209,6 @@ examples:
               interrupts = <30>;
               dr_mode = "host";
               snps,dis_u2_susphy_quirk;
-              snps,quirk-frame-length-adjustment;
+              snps,quirk-frame-length-adjustment = <0x20>;
           };
     };
-- 
2.27.0


^ permalink raw reply related	[flat|nested] 23+ messages in thread

* [PATCH v3 14/16] dt-bindings: usb: meson-g12a-usb: Validate DWC2/DWC3 sub-nodes
  2020-10-20 11:20 [PATCH v3 00/16] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 DT schema Serge Semin
                   ` (12 preceding siblings ...)
  2020-10-20 11:20 ` [PATCH v3 13/16] dt-bindings: usb: meson-g12a-usb: Fix FL-adj property value Serge Semin
@ 2020-10-20 11:20 ` Serge Semin
  2020-10-20 11:21 ` [PATCH v3 15/16] dt-bindings: usb: keystone-dwc3: Validate DWC3 sub-node Serge Semin
  2020-10-20 11:21 ` [PATCH v3 16/16] dt-bindings: usb: qcom,dwc3: " Serge Semin
  15 siblings, 0 replies; 23+ messages in thread
From: Serge Semin @ 2020-10-20 11:20 UTC (permalink / raw)
  To: Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Greg Kroah-Hartman, Rob Herring, Kevin Hilman, Neil Armstrong,
	Jerome Brunet, Martin Blumenstingl
  Cc: Serge Semin, Serge Semin, Alexey Malahov, Pavel Parkhomenko,
	Andy Gross, Bjorn Andersson, Manu Gautam, Roger Quadros,
	Lad Prabhakar, Yoshihiro Shimoda, linux-arm-kernel,
	linux-snps-arc, linux-mips, linuxppc-dev, linux-usb, devicetree,
	linux-kernel, Rob Herring, linux-amlogic

Amlogic G12A USB DT sub-nodes are supposed to be compatible with the
generic DWC USB2 and USB3 devices. Since now we've got DT schemas for
both of the later IP cores let's make sure that the Amlogic G12A USB
DT nodes are fully evaluated including the DWC sub-nodes.

Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
Reviewed-by: Neil Armstrong <narmstrong@baylibre.com>
Reviewed-by: Rob Herring <robh@kernel.org>
Reviewed-by: Martin Blumenstingl <martin.blumenstingl@googlemail.com>

---

Changelog v2:
- Use "oneOf: [dwc2.yaml#, snps,dwc3.yaml#]" instead of the bulky "if:
  properties: compatibe: ..." statement.
---
 .../devicetree/bindings/usb/amlogic,meson-g12a-usb-ctrl.yaml  | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/Documentation/devicetree/bindings/usb/amlogic,meson-g12a-usb-ctrl.yaml b/Documentation/devicetree/bindings/usb/amlogic,meson-g12a-usb-ctrl.yaml
index a4b44a16aaef..7b2dc905c8ce 100644
--- a/Documentation/devicetree/bindings/usb/amlogic,meson-g12a-usb-ctrl.yaml
+++ b/Documentation/devicetree/bindings/usb/amlogic,meson-g12a-usb-ctrl.yaml
@@ -78,7 +78,9 @@ properties:
 
 patternProperties:
   "^usb@[0-9a-f]+$":
-    type: object
+    oneOf:
+      - $ref: dwc2.yaml#
+      - $ref: snps,dwc3.yaml#
 
 additionalProperties: false
 
-- 
2.27.0


^ permalink raw reply related	[flat|nested] 23+ messages in thread

* [PATCH v3 15/16] dt-bindings: usb: keystone-dwc3: Validate DWC3 sub-node
  2020-10-20 11:20 [PATCH v3 00/16] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 DT schema Serge Semin
                   ` (13 preceding siblings ...)
  2020-10-20 11:20 ` [PATCH v3 14/16] dt-bindings: usb: meson-g12a-usb: Validate DWC2/DWC3 sub-nodes Serge Semin
@ 2020-10-20 11:21 ` Serge Semin
  2020-10-20 11:21 ` [PATCH v3 16/16] dt-bindings: usb: qcom,dwc3: " Serge Semin
  15 siblings, 0 replies; 23+ messages in thread
From: Serge Semin @ 2020-10-20 11:21 UTC (permalink / raw)
  To: Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Greg Kroah-Hartman, Rob Herring, Roger Quadros
  Cc: Serge Semin, Serge Semin, Alexey Malahov, Pavel Parkhomenko,
	Andy Gross, Bjorn Andersson, Manu Gautam, Lad Prabhakar,
	Yoshihiro Shimoda, Neil Armstrong, Kevin Hilman,
	Martin Blumenstingl, linux-arm-kernel, linux-snps-arc,
	linux-mips, linuxppc-dev, linux-usb, devicetree, linux-kernel,
	Rob Herring

TI Keystone DWC3 compatible DT node is supposed to have a DWC USB3
compatible sub-node to describe a fully functioning USB interface.
Since DWC USB3 has now got a DT schema describing its DT node, let's make
sure the TI Keystone DWC3 sub-node passes validation against it.

Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
Reviewed-by: Rob Herring <robh@kernel.org>

---

Changelog v2:
- Grammar fix: "s/it'/its"
---
 Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

diff --git a/Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml b/Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml
index c1b19fc5d0a2..ca7fbe3ed22e 100644
--- a/Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml
+++ b/Documentation/devicetree/bindings/usb/ti,keystone-dwc3.yaml
@@ -64,9 +64,7 @@ properties:
 
 patternProperties:
   "usb@[a-f0-9]+$":
-    type: object
-    description: This is the node representing the DWC3 controller instance
-      Documentation/devicetree/bindings/usb/dwc3.txt
+    $ref: snps,dwc3.yaml#
 
 required:
   - compatible
-- 
2.27.0


^ permalink raw reply related	[flat|nested] 23+ messages in thread

* [PATCH v3 16/16] dt-bindings: usb: qcom,dwc3: Validate DWC3 sub-node
  2020-10-20 11:20 [PATCH v3 00/16] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 DT schema Serge Semin
                   ` (14 preceding siblings ...)
  2020-10-20 11:21 ` [PATCH v3 15/16] dt-bindings: usb: keystone-dwc3: Validate DWC3 sub-node Serge Semin
@ 2020-10-20 11:21 ` Serge Semin
  15 siblings, 0 replies; 23+ messages in thread
From: Serge Semin @ 2020-10-20 11:21 UTC (permalink / raw)
  To: Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Greg Kroah-Hartman, Rob Herring, Andy Gross, Bjorn Andersson,
	Manu Gautam
  Cc: Serge Semin, Serge Semin, Alexey Malahov, Pavel Parkhomenko,
	Roger Quadros, Lad Prabhakar, Yoshihiro Shimoda, Neil Armstrong,
	Kevin Hilman, Martin Blumenstingl, linux-arm-kernel,
	linux-snps-arc, linux-mips, linuxppc-dev, linux-usb, devicetree,
	linux-kernel, Rob Herring, linux-arm-msm

Qualcomm msm8996/sc7180/sdm845 DWC3 compatible DT nodes are supposed to
have a DWC USB3 compatible sub-node to describe a fully functioning USB
interface. Let's use the available DWC USB3 DT schema to validate the
Qualcomm DWC3 sub-nodes.

Note since the generic DWC USB3 DT node is supposed to be named as generic
USB HCD ("^usb(@.*)?") one we have to accordingly fix the sub-nodes name
regexp and fix the DT node example.

Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
Reviewed-by: Rob Herring <robh@kernel.org>

---

Changelog v2:
- Discard the "^dwc3@[0-9a-f]+$" nodes from being acceptable as sub-nodes.
---
 Documentation/devicetree/bindings/usb/qcom,dwc3.yaml | 9 +++------
 1 file changed, 3 insertions(+), 6 deletions(-)

diff --git a/Documentation/devicetree/bindings/usb/qcom,dwc3.yaml b/Documentation/devicetree/bindings/usb/qcom,dwc3.yaml
index dac10848dd7f..8f8d781e73a0 100644
--- a/Documentation/devicetree/bindings/usb/qcom,dwc3.yaml
+++ b/Documentation/devicetree/bindings/usb/qcom,dwc3.yaml
@@ -103,11 +103,8 @@ properties:
 # Required child node:
 
 patternProperties:
-  "^dwc3@[0-9a-f]+$":
-    type: object
-    description:
-      A child node must exist to represent the core DWC3 IP block
-      The content of the node is defined in dwc3.txt.
+  "^usb@[0-9a-f]+$":
+    $ref: snps,dwc3.yaml#
 
 required:
   - compatible
@@ -160,7 +157,7 @@ examples:
 
             resets = <&gcc GCC_USB30_PRIM_BCR>;
 
-            dwc3@a600000 {
+            usb@a600000 {
                 compatible = "snps,dwc3";
                 reg = <0 0x0a600000 0 0xcd00>;
                 interrupts = <GIC_SPI 133 IRQ_TYPE_LEVEL_HIGH>;
-- 
2.27.0


^ permalink raw reply related	[flat|nested] 23+ messages in thread

* Re: [PATCH v3 09/16] dt-bindings: usb: Convert DWC USB3 bindings to DT schema
  2020-10-20 11:20 ` [PATCH v3 09/16] dt-bindings: usb: Convert DWC USB3 bindings to DT schema Serge Semin
@ 2020-10-20 15:40   ` Rob Herring
  0 siblings, 0 replies; 23+ messages in thread
From: Rob Herring @ 2020-10-20 15:40 UTC (permalink / raw)
  To: Serge Semin
  Cc: Alexey Malahov, Mathias Nyman, linux-mips, linux-snps-arc,
	Krzysztof Kozlowski, linux-kernel, Lad Prabhakar, Felipe Balbi,
	Greg Kroah-Hartman, Rob Herring, Andy Gross, Serge Semin,
	linux-arm-kernel, Kevin Hilman, Yoshihiro Shimoda,
	Pavel Parkhomenko, Roger Quadros, devicetree, Neil Armstrong,
	linux-usb, linuxppc-dev, Bjorn Andersson, Manu Gautam,
	Martin Blumenstingl

On Tue, 20 Oct 2020 14:20:54 +0300, Serge Semin wrote:
> DWC USB3 DT node is supposed to be compliant with the Generic xHCI
> Controller schema, but with additional vendor-specific properties, the
> controller-specific reference clocks and PHYs. So let's convert the
> currently available legacy text-based DWC USB3 bindings to the DT schema
> and make sure the DWC USB3 nodes are also validated against the
> usb-xhci.yaml schema.
> 
> Note we have to discard the nodename restriction of being prefixed with
> "dwc3@" string, since in accordance with the usb-hcd.yaml schema USB nodes
> are supposed to be named as "^usb(@.*)".
> 
> Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
> 
> ---
> 
> Changelog v2:
> - Discard '|' from the descriptions, since we don't need to preserve
>   the text formatting in any of them.
> - Drop quotes from around the string constants.
> - Fix the "clock-names" prop description to be referring the enumerated
>   clock-names instead of the ones from the Databook.
> 
> Changelog v3:
> - Apply usb-xhci.yaml# schema only if the controller is supposed to work
>   as either host or otg.
> ---
>  .../devicetree/bindings/usb/dwc3.txt          | 125 --------
>  .../devicetree/bindings/usb/snps,dwc3.yaml    | 302 ++++++++++++++++++
>  2 files changed, 302 insertions(+), 125 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/usb/dwc3.txt
>  create mode 100644 Documentation/devicetree/bindings/usb/snps,dwc3.yaml
> 

Reviewed-by: Rob Herring <robh@kernel.org>

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PATCH v3 05/16] dt-bindings: usb: usb-hcd: Add generic "usb-phy" property
  2020-10-20 11:20 ` [PATCH v3 05/16] dt-bindings: usb: usb-hcd: Add generic "usb-phy" property Serge Semin
@ 2020-10-20 19:34   ` Martin Blumenstingl
  0 siblings, 0 replies; 23+ messages in thread
From: Martin Blumenstingl @ 2020-10-20 19:34 UTC (permalink / raw)
  To: Serge Semin
  Cc: Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Greg Kroah-Hartman, Rob Herring, Serge Semin, Alexey Malahov,
	Pavel Parkhomenko, Andy Gross, Bjorn Andersson, Manu Gautam,
	Roger Quadros, Lad Prabhakar, Yoshihiro Shimoda, Neil Armstrong,
	Kevin Hilman, linux-arm-kernel, linux-snps-arc, linux-mips,
	linuxppc-dev, linux-usb, devicetree, linux-kernel, Rob Herring

On Tue, Oct 20, 2020 at 1:21 PM Serge Semin
<Sergey.Semin@baikalelectronics.ru> wrote:
>
> Even though the Generic PHY framework is the more preferable way of
> setting the USB PHY up, there are still many dts-files and DT bindings
> which rely on having the legacy "usb-phy" specified to attach particular
> USB PHYs to USB cores. Let's have the "usb-phy" property described in
> the generic USB HCD binding file so it would be validated against the
> nodes in which it's specified. Mark the property as deprecated to
> discourage the developers from using it.
>
> Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
> Reviewed-by: Rob Herring <robh@kernel.org>
Acked-by: Martin Blumenstingl <martin.blumenstingl@googlemail.com>

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PATCH v3 01/16] dt-bindings: usb: usb-hcd: Convert generic USB properties to DT schema
  2020-10-20 11:20 ` [PATCH v3 01/16] dt-bindings: usb: usb-hcd: Convert generic USB properties to " Serge Semin
@ 2020-10-21  3:00   ` Chunfeng Yun
  2020-10-21 15:46     ` Serge Semin
  0 siblings, 1 reply; 23+ messages in thread
From: Chunfeng Yun @ 2020-10-21  3:00 UTC (permalink / raw)
  To: Serge Semin
  Cc: Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Greg Kroah-Hartman, Rob Herring, Serge Semin, Alexey Malahov,
	Pavel Parkhomenko, Andy Gross, Bjorn Andersson, Manu Gautam,
	Roger Quadros, Lad Prabhakar, Yoshihiro Shimoda, Neil Armstrong,
	Kevin Hilman, Martin Blumenstingl, linux-arm-kernel,
	linux-snps-arc, linux-mips, linuxppc-dev, linux-usb, devicetree,
	linux-kernel, Rob Herring

On Tue, 2020-10-20 at 14:20 +0300, Serge Semin wrote:
> 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
          ^ its?
> nodes would be validated to have them properly utilized.
> 
> Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
> Reviewed-by: Rob Herring <robh@kernel.org>
> 
> ---
> 
> 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 +++++++++++++++++++
Do we need change the file name or modify it's title?
the title is "Generic USB Host Controller Device Tree Bindings", but
some generic properties, such as, dr_mode, usb-role-switch, otg related
ones, are usually used by DRD controller, this may cause some confusion.

>  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;
> +    };


^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PATCH v3 01/16] dt-bindings: usb: usb-hcd: Convert generic USB properties to DT schema
  2020-10-21  3:00   ` Chunfeng Yun
@ 2020-10-21 15:46     ` Serge Semin
  2020-10-26 16:46       ` Serge Semin
  0 siblings, 1 reply; 23+ messages in thread
From: Serge Semin @ 2020-10-21 15:46 UTC (permalink / raw)
  To: Chunfeng Yun, Rob Herring, Greg Kroah-Hartman, Rob Herring
  Cc: Serge Semin, Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Alexey Malahov, Pavel Parkhomenko, Andy Gross, Bjorn Andersson,
	Manu Gautam, Roger Quadros, Lad Prabhakar, Yoshihiro Shimoda,
	Neil Armstrong, Kevin Hilman, Martin Blumenstingl,
	linux-arm-kernel, linux-snps-arc, linux-mips, linuxppc-dev,
	linux-usb, devicetree, linux-kernel

On Wed, Oct 21, 2020 at 11:00:36AM +0800, Chunfeng Yun wrote:
> On Tue, 2020-10-20 at 14:20 +0300, Serge Semin wrote:
> > 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
>           ^ its?
> > nodes would be validated to have them properly utilized.
> > 
> > Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
> > Reviewed-by: Rob Herring <robh@kernel.org>
> > 
> > ---
> > 
> > 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 +++++++++++++++++++

> Do we need change the file name or modify it's title?
> the title is "Generic USB Host Controller Device Tree Bindings", but
> some generic properties, such as, dr_mode, usb-role-switch, otg related
> ones, are usually used by DRD controller, this may cause some confusion.

Hm, good question. A problem of the naming and the properties inclusion do
exist here. I haven't thought that through when moved all the generic
properties into the usb-hcd.yaml bindings file. But I don't think it's a good
idea to rename the file. Most likely the best solution would be to split the
functionality up as follows:

1) usb.yaml - common USB controller with generic properties for all USB modes (host, peripheral, otg):
   + $nodename
   + phys
   + phy-names
   + usb-phy
   + maximum-speed
   + phy_type
2) usb-hcd.yaml - DT schema for USB host controllers (EHCI/OHCI/UHCI):
   + allOf: [usb.yaml#]
   + companion
3) usb-xhci.yaml - DT schema for USB host controllers (xHCI):
   + allOf: [usb-hcd.yaml#]
   + usb2-lpm-disable
   + usb3-lpm-capable
   + quirk-broken-port-ped
   + imod-interval-ns
4) usb-drd.yaml - DT schema for USB OTG controllers:
   + otg-rev
   + hnp-disable
   + srp-disable
   + adp-disable
   + usb-role-switch
   + role-switch-default-mode
   + tpl-support
   + dr_mode: [host, peripheral, otg]

So in case if an USB controller is DRD with EHCI host, then it will need
to pass evaluation of allOf: [usb-hcd.yaml#, usb-drd.yaml#]. If an USB
controller is DRD with xHCI host, then the next schema can be applied:
[usb-xhci.yaml#, usb-drd.yaml#]. A conditional schema is also applicable
here, like this:
allOf:
  - $ref: usb-drd.yaml#
  - if:
      properties:
        dr_mode:
          const: host
    then:
      $ref: usb-hcd.yaml# (or usb-xhci.yaml#)
    else:
      #ref: usb.yaml#

What do you think? @Rob, @Greg, we need your opinion here.

-Sergey

> 
> >  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;
> > +    };
> 

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PATCH v3 01/16] dt-bindings: usb: usb-hcd: Convert generic USB properties to DT schema
  2020-10-21 15:46     ` Serge Semin
@ 2020-10-26 16:46       ` Serge Semin
  2020-11-10 15:05         ` Serge Semin
  0 siblings, 1 reply; 23+ messages in thread
From: Serge Semin @ 2020-10-26 16:46 UTC (permalink / raw)
  To: Chunfeng Yun, Rob Herring, Greg Kroah-Hartman, Rob Herring
  Cc: Serge Semin, Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Alexey Malahov, Pavel Parkhomenko, Andy Gross, Bjorn Andersson,
	Manu Gautam, Roger Quadros, Lad Prabhakar, Yoshihiro Shimoda,
	Neil Armstrong, Kevin Hilman, Martin Blumenstingl,
	linux-arm-kernel, linux-snps-arc, linux-mips, linuxppc-dev,
	linux-usb, devicetree, linux-kernel

Folks, any comment on my previous message below?

On Wed, Oct 21, 2020 at 06:46:21PM +0300, Serge Semin wrote:
> On Wed, Oct 21, 2020 at 11:00:36AM +0800, Chunfeng Yun wrote:
> > On Tue, 2020-10-20 at 14:20 +0300, Serge Semin wrote:
> > > 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
> >           ^ its?
> > > nodes would be validated to have them properly utilized.
> > > 
> > > Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
> > > Reviewed-by: Rob Herring <robh@kernel.org>
> > > 
> > > ---
> > > 
> > > 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 +++++++++++++++++++
> 
> > Do we need change the file name or modify it's title?
> > the title is "Generic USB Host Controller Device Tree Bindings", but
> > some generic properties, such as, dr_mode, usb-role-switch, otg related
> > ones, are usually used by DRD controller, this may cause some confusion.
> 
> Hm, good question. A problem of the naming and the properties inclusion do
> exist here. I haven't thought that through when moved all the generic
> properties into the usb-hcd.yaml bindings file. But I don't think it's a good
> idea to rename the file. Most likely the best solution would be to split the
> functionality up as follows:
> 
> 1) usb.yaml - common USB controller with generic properties for all USB modes (host, peripheral, otg):
>    + $nodename
>    + phys
>    + phy-names
>    + usb-phy
>    + maximum-speed
>    + phy_type
> 2) usb-hcd.yaml - DT schema for USB host controllers (EHCI/OHCI/UHCI):
>    + allOf: [usb.yaml#]
>    + companion
> 3) usb-xhci.yaml - DT schema for USB host controllers (xHCI):
>    + allOf: [usb-hcd.yaml#]
>    + usb2-lpm-disable
>    + usb3-lpm-capable
>    + quirk-broken-port-ped
>    + imod-interval-ns
> 4) usb-drd.yaml - DT schema for USB OTG controllers:
>    + otg-rev
>    + hnp-disable
>    + srp-disable
>    + adp-disable
>    + usb-role-switch
>    + role-switch-default-mode
>    + tpl-support
>    + dr_mode: [host, peripheral, otg]
> 
> So in case if an USB controller is DRD with EHCI host, then it will need
> to pass evaluation of allOf: [usb-hcd.yaml#, usb-drd.yaml#]. If an USB
> controller is DRD with xHCI host, then the next schema can be applied:
> [usb-xhci.yaml#, usb-drd.yaml#]. A conditional schema is also applicable
> here, like this:
> allOf:
>   - $ref: usb-drd.yaml#
>   - if:
>       properties:
>         dr_mode:
>           const: host
>     then:
>       $ref: usb-hcd.yaml# (or usb-xhci.yaml#)
>     else:
>       #ref: usb.yaml#
> 
> What do you think? @Rob, @Greg, we need your opinion here.
> 
> -Sergey
> 
> > 
> > >  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;
> > > +    };
> > 

^ permalink raw reply	[flat|nested] 23+ messages in thread

* Re: [PATCH v3 01/16] dt-bindings: usb: usb-hcd: Convert generic USB properties to DT schema
  2020-10-26 16:46       ` Serge Semin
@ 2020-11-10 15:05         ` Serge Semin
  0 siblings, 0 replies; 23+ messages in thread
From: Serge Semin @ 2020-11-10 15:05 UTC (permalink / raw)
  To: Chunfeng Yun, Rob Herring, Greg Kroah-Hartman, Rob Herring
  Cc: Serge Semin, Mathias Nyman, Felipe Balbi, Krzysztof Kozlowski,
	Alexey Malahov, Pavel Parkhomenko, Andy Gross, Bjorn Andersson,
	Manu Gautam, Roger Quadros, Lad Prabhakar, Yoshihiro Shimoda,
	Neil Armstrong, Kevin Hilman, Martin Blumenstingl,
	linux-arm-kernel, linux-snps-arc, linux-mips, linuxppc-dev,
	linux-usb, devicetree, linux-kernel

It seems noone is going to get involved in the discussion. Therefore I'll
fix the patch in the way I suggested in my previous message. Alas I'll
have to remove the reviewed-by tags of Rob from some patches.

-Sergey

On Mon, Oct 26, 2020 at 07:46:49PM +0300, Serge Semin wrote:
> Folks, any comment on my previous message below?
> 
> On Wed, Oct 21, 2020 at 06:46:21PM +0300, Serge Semin wrote:
> > On Wed, Oct 21, 2020 at 11:00:36AM +0800, Chunfeng Yun wrote:
> > > On Tue, 2020-10-20 at 14:20 +0300, Serge Semin wrote:
> > > > 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
> > >           ^ its?
> > > > nodes would be validated to have them properly utilized.
> > > > 
> > > > Signed-off-by: Serge Semin <Sergey.Semin@baikalelectronics.ru>
> > > > Reviewed-by: Rob Herring <robh@kernel.org>
> > > > 
> > > > ---
> > > > 
> > > > 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 +++++++++++++++++++
> > 
> > > Do we need change the file name or modify it's title?
> > > the title is "Generic USB Host Controller Device Tree Bindings", but
> > > some generic properties, such as, dr_mode, usb-role-switch, otg related
> > > ones, are usually used by DRD controller, this may cause some confusion.
> > 
> > Hm, good question. A problem of the naming and the properties inclusion do
> > exist here. I haven't thought that through when moved all the generic
> > properties into the usb-hcd.yaml bindings file. But I don't think it's a good
> > idea to rename the file. Most likely the best solution would be to split the
> > functionality up as follows:
> > 
> > 1) usb.yaml - common USB controller with generic properties for all USB modes (host, peripheral, otg):
> >    + $nodename
> >    + phys
> >    + phy-names
> >    + usb-phy
> >    + maximum-speed
> >    + phy_type
> > 2) usb-hcd.yaml - DT schema for USB host controllers (EHCI/OHCI/UHCI):
> >    + allOf: [usb.yaml#]
> >    + companion
> > 3) usb-xhci.yaml - DT schema for USB host controllers (xHCI):
> >    + allOf: [usb-hcd.yaml#]
> >    + usb2-lpm-disable
> >    + usb3-lpm-capable
> >    + quirk-broken-port-ped
> >    + imod-interval-ns
> > 4) usb-drd.yaml - DT schema for USB OTG controllers:
> >    + otg-rev
> >    + hnp-disable
> >    + srp-disable
> >    + adp-disable
> >    + usb-role-switch
> >    + role-switch-default-mode
> >    + tpl-support
> >    + dr_mode: [host, peripheral, otg]
> > 
> > So in case if an USB controller is DRD with EHCI host, then it will need
> > to pass evaluation of allOf: [usb-hcd.yaml#, usb-drd.yaml#]. If an USB
> > controller is DRD with xHCI host, then the next schema can be applied:
> > [usb-xhci.yaml#, usb-drd.yaml#]. A conditional schema is also applicable
> > here, like this:
> > allOf:
> >   - $ref: usb-drd.yaml#
> >   - if:
> >       properties:
> >         dr_mode:
> >           const: host
> >     then:
> >       $ref: usb-hcd.yaml# (or usb-xhci.yaml#)
> >     else:
> >       #ref: usb.yaml#
> > 
> > What do you think? @Rob, @Greg, we need your opinion here.
> > 
> > -Sergey
> > 
> > > 
> > > >  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;
> > > > +    };
> > > 

^ permalink raw reply	[flat|nested] 23+ messages in thread

end of thread, other threads:[~2020-11-10 15:05 UTC | newest]

Thread overview: 23+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-10-20 11:20 [PATCH v3 00/16] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 DT schema Serge Semin
2020-10-20 11:20 ` [PATCH v3 01/16] dt-bindings: usb: usb-hcd: Convert generic USB properties to " Serge Semin
2020-10-21  3:00   ` Chunfeng Yun
2020-10-21 15:46     ` Serge Semin
2020-10-26 16:46       ` Serge Semin
2020-11-10 15:05         ` Serge Semin
2020-10-20 11:20 ` [PATCH v3 02/16] dt-bindings: usb: usb-hcd: Add "otg-rev" property restriction Serge Semin
2020-10-20 11:20 ` [PATCH v3 03/16] dt-bindings: usb: usb-hcd: Add "ulpi/serial/hsic" PHY types Serge Semin
2020-10-20 11:20 ` [PATCH v3 04/16] dt-bindings: usb: usb-hcd: Add "tpl-support" property Serge Semin
2020-10-20 11:20 ` [PATCH v3 05/16] dt-bindings: usb: usb-hcd: Add generic "usb-phy" property Serge Semin
2020-10-20 19:34   ` Martin Blumenstingl
2020-10-20 11:20 ` [PATCH v3 06/16] dt-bindings: usb: Convert xHCI bindings to DT schema Serge Semin
2020-10-20 11:20 ` [PATCH v3 07/16] dt-bindings: usb: xhci: Add Broadcom STB v2 compatible device Serge Semin
2020-10-20 11:20 ` [PATCH v3 08/16] dt-bindings: usb: renesas-xhci: Refer to the usb-xhci.yaml file Serge Semin
2020-10-20 11:20 ` [PATCH v3 09/16] dt-bindings: usb: Convert DWC USB3 bindings to DT schema Serge Semin
2020-10-20 15:40   ` Rob Herring
2020-10-20 11:20 ` [PATCH v3 10/16] dt-bindings: usb: dwc3: Add interrupt-names property support Serge Semin
2020-10-20 11:20 ` [PATCH v3 11/16] dt-bindings: usb: dwc3: Add Tx De-emphasis constraints Serge Semin
2020-10-20 11:20 ` [PATCH v3 12/16] dt-bindings: usb: dwc3: Add Frame Length Adj constraints Serge Semin
2020-10-20 11:20 ` [PATCH v3 13/16] dt-bindings: usb: meson-g12a-usb: Fix FL-adj property value Serge Semin
2020-10-20 11:20 ` [PATCH v3 14/16] dt-bindings: usb: meson-g12a-usb: Validate DWC2/DWC3 sub-nodes Serge Semin
2020-10-20 11:21 ` [PATCH v3 15/16] dt-bindings: usb: keystone-dwc3: Validate DWC3 sub-node Serge Semin
2020-10-20 11:21 ` [PATCH v3 16/16] dt-bindings: usb: qcom,dwc3: " Serge Semin

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).