[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <20201016171433.GA1585924@bogus>
Date: Fri, 16 Oct 2020 12:14:33 -0500
From: Rob Herring <robh@...nel.org>
To: Chunfeng Yun <chunfeng.yun@...iatek.com>
Cc: Chun-Kuang Hu <chunkuang.hu@...nel.org>,
Philipp Zabel <p.zabel@...gutronix.de>,
David Airlie <airlied@...ux.ie>,
Daniel Vetter <daniel@...ll.ch>,
Kishon Vijay Abraham I <kishon@...com>,
Vinod Koul <vkoul@...nel.org>,
Matthias Brugger <matthias.bgg@...il.com>,
Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
"David S . Miller" <davem@...emloft.net>,
CK Hu <ck.hu@...iatek.com>,
Stanley Chu <stanley.chu@...iatek.com>,
Min Guo <min.guo@...iatek.com>,
dri-devel@...ts.freedesktop.org, devicetree@...r.kernel.org,
linux-kernel@...r.kernel.org, linux-arm-kernel@...ts.infradead.org,
linux-mediatek@...ts.infradead.org, linux-usb@...r.kernel.org
Subject: Re: [PATCH v2 6/8] dt-bindings: usb: convert mediatek,mtk-xhci.txt
to YAML schema
On Tue, Oct 13, 2020 at 04:52:05PM +0800, Chunfeng Yun wrote:
> Convert mediatek,mtk-xhci.txt to YAML schema mediatek,mtk-xhci.yaml
>
There's some refactoring of usb-hcd.yaml and XHCI schema under review
and this may need some refactoring on top of it.
> Signed-off-by: Chunfeng Yun <chunfeng.yun@...iatek.com>
> ---
> v2: new patch
> ---
> .../bindings/usb/mediatek,mtk-xhci.txt | 121 ------------
> .../bindings/usb/mediatek,mtk-xhci.yaml | 180 ++++++++++++++++++
> 2 files changed, 180 insertions(+), 121 deletions(-)
> delete mode 100644 Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt
> create mode 100644 Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.yaml
> diff --git a/Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.yaml b/Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.yaml
> new file mode 100644
> index 000000000000..ea696c8f1269
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.yaml
> @@ -0,0 +1,180 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +# Copyright (c) 2020 MediaTek
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/usb/mediatek,mtk-xhci.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: MediaTek USB3 xHCI Device Tree Bindings
> +
> +maintainers:
> + - Chunfeng Yun <chunfeng.yun@...iatek.com>
> +
> +allOf:
> + - $ref: "usb-hcd.yaml"
> +
> +description: |
> + There are two scenarios:
> + case 1: only supports xHCI driver;
> + case 2: supports dual-role mode, and the host is based on xHCI driver.
> +
> +properties:
> + #common properties for both case 1 and case 2
> + compatible:
> + items:
> + - enum:
> + - mediatek,mt2712-xhci
> + - mediatek,mt7622-xhci
> + - mediatek,mt7629-xhci
> + - mediatek,mt8173-xhci
> + - mediatek,mt8183-xhci
> + - const: mediatek,mtk-xhci
> +
> + reg:
> + minItems: 1
> + maxItems: 2
> + items:
> + - description: the registers of xHCI MAC
> + - description: the registers of IP Port Control
> +
> + reg-names:
> + minItems: 1
> + maxItems: 2
> + items:
> + - const: mac
> + - const: ippc #optional, only needed for case 1.
> +
> + interrupts:
> + maxItems: 1
> +
> + power-domains:
> + description: A phandle to USB power domain node to control USB's MTCMOS
> + maxItems: 1
> +
> + clocks:
> + minItems: 1
> + maxItems: 5
> + items:
> + - description: Controller clock used by normal mode
> + - description: Reference clock used by low power mode etc
> + - description: Mcu bus clock for register access
> + - description: DMA bus clock for data transfer
> + - description: controller clock
> +
> + clock-names:
> + minItems: 1
> + maxItems: 5
> + items:
> + - const: sys_ck #required, the following ones are optional
> + - const: ref_ck
> + - const: mcu_ck
> + - const: dma_ck
> + - const: xhci_ck
> +
> + phys:
> + $ref: /usb/usb-hcd.yaml#
That doesn't look right...
> +
> + vusb33-supply:
> + description: Regulator of USB AVDD3.3v
> +
> + vbus-supply:
> + description: Regulator of USB VBUS5v
> +
> + usb3-lpm-capable:
> + description: supports USB3.0 LPM
> + type: boolean
> +
> + imod-interval-ns:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: |
> + Interrupt moderation interval value, it is 8 times as much as that
> + defined in the xHCI spec on MTK's controller.
> + default: 5000
> +
> + #the following properties are only used for case 1
> + pinctrl-0:
> + description: A phandle to the default pinctrl state.
> +
> + pinctrl-names:
> + description: A pinctrl state named "default" must be defined.
> + See pinctrl/pinctrl-bindings.txt
> + const: default
Don't need pinctrl-* properties. They are always allowed.
> +
> + wakeup-source:
> + description: enable USB remote wakeup, see power/wakeup-source.txt
> + type: boolean
> +
> + mediatek,syscon-wakeup:
> + $ref: /schemas/types.yaml#/definitions/phandle-array
> + maxItems: 1
> + description: |
> + A phandle to syscon used to access the register of the USB wakeup glue
> + layer between xHCI and SPM, the field should always be a multiple of
> + 3 cells long.
A multiple of 3? How would there be more than 3 cells?
> +
> + items:
> + - description:
> + The first cell represents a phandle to syscon
> + - description:
> + The second cell represents the register base address of the glue
> + layer in syscon
> + - description:
> + The third cell represents the hardware version of the glue layer,
> + 1 is used by mt8173 etc, 2 is used by mt2712 etc
> + enum: [1, 2]
> +
> + mediatek,u3p-dis-msk:
> + $ref: /schemas/types.yaml#/definitions/uint32
> + description: The mask to disable u3ports, bit0 for u3port0,
> + bit1 for u3port1, ... etc
> +
> + "#address-cells":
> + const: 1
> +
> + "#size-cells":
> + const: 0
> +
> +patternProperties:
> + "^[a-f]+@[0-9a-f]+$":
> + $ref: /usb/usb-hcd.yaml#
> + type: object
> + description: The hard wired USB devices.
> +
> +dependencies:
> + wakeup-source: [ 'mediatek,syscon-wakeup' ]
> +
> +required:
> + - compatible
> + - reg
> + - reg-names
> + - interrupts
> + - clocks
> + - clock-names
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/clock/mt8173-clk.h>
> + #include <dt-bindings/interrupt-controller/arm-gic.h>
> + #include <dt-bindings/interrupt-controller/irq.h>
> + #include <dt-bindings/phy/phy.h>
> + #include <dt-bindings/power/mt8173-power.h>
> +
> + usb3: usb@...70000 {
> + compatible = "mediatek,mt8173-xhci", "mediatek,mtk-xhci";
> + reg = <0x11270000 0x1000>, <0x11280700 0x0100>;
> + reg-names = "mac", "ippc";
> + interrupts = <GIC_SPI 115 IRQ_TYPE_LEVEL_LOW>;
> + power-domains = <&scpsys MT8173_POWER_DOMAIN_USB>;
> + clocks = <&topckgen CLK_TOP_USB30_SEL>, <&clk26m>;
> + clock-names = "sys_ck", "ref_ck";
> + phys = <&u3port0 PHY_TYPE_USB3>, <&u2port1 PHY_TYPE_USB2>;
> + vusb33-supply = <&mt6397_vusb_reg>;
> + vbus-supply = <&usb_p1_vbus>;
> + imod-interval-ns = <10000>;
> + mediatek,syscon-wakeup = <&pericfg 0x400 1>;
> + wakeup-source;
> + usb3-lpm-capable;
> + };
> +...
> --
> 2.18.0
Powered by blists - more mailing lists