Linux-USB Archive on lore.kernel.org
 help / color / Atom feed
From: Rob Herring <robh@kernel.org>
To: Serge Semin <Sergey.Semin@baikalelectronics.ru>
Cc: Mathias Nyman <mathias.nyman@intel.com>,
	Felipe Balbi <balbi@kernel.org>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Serge Semin <fancer.lancer@gmail.com>,
	Alexey Malahov <Alexey.Malahov@baikalelectronics.ru>,
	Pavel Parkhomenko <Pavel.Parkhomenko@baikalelectronics.ru>,
	Andy Gross <agross@kernel.org>,
	Bjorn Andersson <bjorn.andersson@linaro.org>,
	Manu Gautam <mgautam@codeaurora.org>,
	Roger Quadros <rogerq@ti.com>,
	Lad Prabhakar <prabhakar.mahadev-lad.rj@bp.renesas.com>,
	Yoshihiro Shimoda <yoshihiro.shimoda.uh@renesas.com>,
	Neil Armstrong <narmstrong@baylibre.com>,
	Kevin Hilman <khilman@baylibre.com>,
	linux-usb@vger.kernel.org, devicetree@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH 07/18] dt-bindings: usb: Convert xHCI bindings to DT schema
Date: Tue, 13 Oct 2020 07:30:04 -0500
Message-ID: <20201013123004.GB3269269@bogus> (raw)
In-Reply-To: <20201010224121.12672-8-Sergey.Semin@baikalelectronics.ru>

On Sun, Oct 11, 2020 at 01:41:10AM +0300, Serge Semin wrote:
> 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>
> ---
>  .../devicetree/bindings/usb/generic-xhci.yaml | 63 +++++++++++++++++++
>  .../devicetree/bindings/usb/usb-xhci.txt      | 41 ------------
>  .../devicetree/bindings/usb/usb-xhci.yaml     | 40 ++++++++++++
>  3 files changed, 103 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..c5c177f2e055
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/usb/usb-xhci.yaml
> @@ -0,0 +1,40 @@
> +# 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

Having additionalProperties or unevaluatedProperties is going to be 
mandatory, so for this add:

additionalProperties: true

> +
> +examples:
> +  - |
> +    usb@f0930000 {
> +      compatible = "generic-xhci";
> +      reg = <0xf0930000 0x8c8>;
> +      interrupts = <0x0 0x4e 0x0>;
> +      usb2-lpm-disable;
> +      usb3-lpm-capable;
> +    };
> -- 
> 2.27.0
> 

  reply index

Thread overview: 50+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-10-10 22:41 [PATCH 00/18] dt-bindings: usb: Add generic USB HCD, xHCI, DWC USB3 " Serge Semin
2020-10-10 22:41 ` [PATCH 01/18] dt-bindings: usb: usb-hcd: Convert generic USB properties to " Serge Semin
2020-10-13 12:14   ` Rob Herring
2020-10-13 14:00     ` Serge Semin
2020-10-10 22:41 ` [PATCH 02/18] dt-bindings: usb: usb-hcd: Add "wireless" maximum-speed property value Serge Semin
2020-10-11 14:42   ` Greg Kroah-Hartman
2020-10-11 17:53     ` Serge Semin
2020-10-12 15:41       ` Greg Kroah-Hartman
2020-10-12 21:19         ` Serge Semin
2020-10-10 22:41 ` [PATCH 03/18] dt-bindings: usb: usb-hcd: Add "otg-rev" property restriction Serge Semin
2020-10-10 22:41 ` [PATCH 04/18] dt-bindings: usb: usb-hcd: Add "ulpi/serial/hsic" PHY types Serge Semin
2020-10-11  8:49   ` Sergei Shtylyov
2020-10-11 18:03     ` Serge Semin
2020-10-10 22:41 ` [PATCH 05/18] dt-bindings: usb: usb-hcd: Add "tpl-support" property Serge Semin
2020-10-11  8:47   ` Sergei Shtylyov
2020-10-11 18:05     ` Serge Semin
2020-10-11 18:06     ` Serge Semin
2020-10-10 22:41 ` [PATCH 06/18] dt-bindings: usb: usb-hcd: Add generic "usb-phy" property Serge Semin
2020-10-10 22:41 ` [PATCH 07/18] dt-bindings: usb: Convert xHCI bindings to DT schema Serge Semin
2020-10-13 12:30   ` Rob Herring [this message]
2020-10-13 14:29     ` Serge Semin
2020-10-10 22:41 ` [PATCH 08/18] dt-bindings: usb: xhci: Add Broadcom STB v2 compatible device Serge Semin
2020-10-10 22:41 ` [PATCH 09/18] dt-bindings: usb: renesas-xhci: Refer to the usb-xhci.yaml file Serge Semin
2020-10-10 22:41 ` [PATCH 10/18] dt-bindings: usb: Convert DWC USB3 bindings to DT schema Serge Semin
2020-10-13 12:36   ` Rob Herring
2020-10-13 15:16     ` Serge Semin
2020-10-10 22:41 ` [PATCH 11/18] dt-bindings: usb: dwc3: Add interrupt-names property support Serge Semin
2020-10-11  8:53   ` Sergei Shtylyov
2020-10-11 18:09     ` Serge Semin
2020-10-10 22:41 ` [PATCH 12/18] dt-bindings: usb: dwc3: Add synopsys,dwc3 compatible string Serge Semin
2020-10-10 22:41 ` [PATCH 13/18] dt-bindings: usb: dwc3: Add Tx De-emphasis restrictions Serge Semin
2020-10-11  8:56   ` Sergei Shtylyov
2020-10-11 18:14     ` Serge Semin
2020-10-10 22:41 ` [PATCH 14/18] dt-bindings: usb: dwc3: Add Frame Length Adj restrictions Serge Semin
2020-10-13 12:38   ` Rob Herring
2020-10-13 15:45     ` Serge Semin
2020-10-10 22:41 ` [PATCH 15/18] dt-bindings: usb: meson-g12a-usb: Discard FL-adj property Serge Semin
2020-10-12  7:54   ` Neil Armstrong
2020-10-12 14:22     ` Serge Semin
2020-10-12 15:01       ` Neil Armstrong
2020-10-12 15:13         ` Serge Semin
2020-10-12 15:29           ` Neil Armstrong
2020-10-10 22:41 ` [PATCH 16/18] dt-bindings: usb: meson-g12a-usb: Validate DWC2/DWC3 sub-nodes Serge Semin
2020-10-12  7:38   ` Neil Armstrong
2020-10-13 12:42   ` Rob Herring
2020-10-13 15:50     ` Serge Semin
2020-10-10 22:41 ` [PATCH 17/18] dt-bindings: usb: keystone-dwc3: Validate DWC3 sub-node Serge Semin
2020-10-11  9:04   ` Sergei Shtylyov
2020-10-11 18:18     ` Serge Semin
2020-10-10 22:41 ` [PATCH 18/18] dt-bindings: usb: qcom,dwc3: " Serge Semin

Reply instructions:

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

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

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

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

  git send-email \
    --in-reply-to=20201013123004.GB3269269@bogus \
    --to=robh@kernel.org \
    --cc=Alexey.Malahov@baikalelectronics.ru \
    --cc=Pavel.Parkhomenko@baikalelectronics.ru \
    --cc=Sergey.Semin@baikalelectronics.ru \
    --cc=agross@kernel.org \
    --cc=balbi@kernel.org \
    --cc=bjorn.andersson@linaro.org \
    --cc=devicetree@vger.kernel.org \
    --cc=fancer.lancer@gmail.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=khilman@baylibre.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-usb@vger.kernel.org \
    --cc=mathias.nyman@intel.com \
    --cc=mgautam@codeaurora.org \
    --cc=narmstrong@baylibre.com \
    --cc=prabhakar.mahadev-lad.rj@bp.renesas.com \
    --cc=rogerq@ti.com \
    --cc=yoshihiro.shimoda.uh@renesas.com \
    /path/to/YOUR_REPLY

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

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

Linux-USB Archive on lore.kernel.org

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

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

Example config snippet for mirrors

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


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