[PATCH v3 10/11] dt-bindings: usb: convert mediatek,mtu3.txt to YAML schema
Chunfeng Yun
chunfeng.yun at mediatek.com
Tue Dec 8 04:18:10 EST 2020
On Mon, 2020-12-07 at 15:30 -0600, Rob Herring wrote:
> On Wed, Nov 18, 2020 at 04:21:25PM +0800, Chunfeng Yun wrote:
> > Convert mediatek,mtu3.txt to YAML schema mediatek,mtu3.yaml
> >
> > Signed-off-by: Chunfeng Yun <chunfeng.yun at mediatek.com>
> > ---
> > v3:
> > 1. fix yamllint warning
> > 2. remove pinctrl* properties
> > 3. remove unnecessary '|'
> > 4. drop unused labels in example
> >
> > v2: new patch
> > ---
> > .../devicetree/bindings/usb/mediatek,mtu3.txt | 108 ---------
> > .../bindings/usb/mediatek,mtu3.yaml | 218 ++++++++++++++++++
> > 2 files changed, 218 insertions(+), 108 deletions(-)
> > delete mode 100644 Documentation/devicetree/bindings/usb/mediatek,mtu3.txt
> > create mode 100644 Documentation/devicetree/bindings/usb/mediatek,mtu3.yaml
> >
[...]
> > diff --git a/Documentation/devicetree/bindings/usb/mediatek,mtu3.yaml b/Documentation/devicetree/bindings/usb/mediatek,mtu3.yaml
> > new file mode 100644
> > index 000000000000..290e97a06f2a
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/usb/mediatek,mtu3.yaml
> > @@ -0,0 +1,218 @@
> > +# 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,mtu3.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: MediaTek USB3 DRD Controller Device Tree Bindings
> > +
> > +maintainers:
> > + - Chunfeng Yun <chunfeng.yun at mediatek.com>
> > +
> > +description: |
> > + The DRD controller has a glue layer IPPC (IP Port Control), and its host is
> > + based on xHCI.
> > +
> > +properties:
> > + compatible:
> > + items:
> > + - enum:
> > + - mediatek,mt2712-mtu3
> > + - mediatek,mt8173-mtu3
> > + - mediatek,mt8183-mtu3
> > + - const: mediatek,mtu3
> > +
> > + reg:
> > + items:
> > + - description: the registers of device MAC
> > + - description: the registers of IP Port Control
> > +
> > + reg-names:
> > + items:
> > + - const: mac
> > + - const: ippc
> > +
> > + interrupts:
> > + maxItems: 1
> > +
> > + power-domains:
> > + description: A phandle to USB power domain node to control USB's MTCMOS
> > + maxItems: 1
> > +
> > + clocks:
> > + minItems: 1
> > + maxItems: 4
> > + 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
> > +
> > + clock-names:
> > + minItems: 1
> > + maxItems: 4
> > + items:
> > + - const: sys_ck # required, the following ones are optional
> > + - const: ref_ck
> > + - const: mcu_ck
> > + - const: dma_ck
> > +
> > + phys:
> > + $ref: /schemas/types.yaml#/definitions/phandle-array
>
> Drop. Need to say how many entries and what each one is if more than 1.
Ok
>
> > + description: List of all the USB PHYs used
> > +
> > + vusb33-supply:
> > + description: Regulator of USB AVDD3.3v
> > +
> > + vbus-supply:
> > + $ref: /connector/usb-connector.yaml#
>
> Nope.
Will remove it
>
> > + deprecated: true
> > + description: |
> > + Regulator of USB VBUS5v, needed when supports dual-role mode.
> > + Particularly, if use an output GPIO to control a VBUS regulator, should
> > + model it as a regulator. See bindings/regulator/fixed-regulator.yaml
> > + It's considered valid for compatibility reasons, not allowed for
> > + new bindings, and put into a usb-connector node.
> > +
> > + dr_mode:
> > + description: See usb/generic.txt
> > + enum: [host, peripheral, otg]
> > + default: otg
> > +
> > + maximum-speed:
> > + description: See usb/generic.txt
> > + enum: [super-speed-plus, super-speed, high-speed, full-speed]
> > +
> > + "#address-cells":
> > + enum: [1, 2]
> > +
> > + "#size-cells":
> > + enum: [1, 2]
> > +
> > + ranges: true
> > +
> > + extcon:
> > + deprecated: true
> > + description: |
> > + Phandle to the extcon device detecting the IDDIG/VBUS state, neede
> > + when supports dual-role mode.
> > + It's considered valid for compatibility reasons, not allowed for
> > + new bindings, and use "usb-role-switch" property instead.
> > +
> > + usb-role-switch:
> > + $ref: /schemas/types.yaml#/definitions/flag
> > + description: Support role switch. See usb/generic.txt
> > + type: boolean
> > +
> > + connector:
> > + $ref: /connector/usb-connector.yaml#
> > + description:
> > + Connector for dual role switch, especially for "gpio-usb-b-connector"
> > + type: object
> > +
> > + port:
> > + description:
> > + Any connector to the data bus of this controller should be modelled
> > + using the OF graph bindings specified, if the "usb-role-switch"
> > + property is used. See graph.txt
> > + type: object
>
> Please include port and connector in the example.
Ok, thanks
>
> > +
> > + enable-manual-drd:
> > + $ref: /schemas/types.yaml#/definitions/flag
> > + description:
> > + supports manual dual-role switch via debugfs; usually used when
> > + receptacle is TYPE-A and also wants to support dual-role mode.
> > + type: boolean
> > +
> > + 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 3 cells long.
> > +
> > + 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
> > +
> > +# Required child node when support dual-role
> > +patternProperties:
> > + "^usb@[0-9a-f]+$":
> > + type: object
> > + $ref: /usb/mediatek,mtk-xhci.yaml#
> > + description:
> > + The xhci should be added as subnode to mtu3 as shown in the following
> > + example if the host mode is enabled.
> > +
> > +dependencies:
> > + connector: [ 'usb-role-switch' ]
> > + port: [ 'usb-role-switch' ]
> > + wakeup-source: [ 'mediatek,syscon-wakeup' ]
> > +
> > +required:
> > + - compatible
> > + - reg
> > + - reg-names
> > + - interrupts
> > + - clocks
> > + - clock-names
> > + - phys
> > +
> > +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>
> > +
> > + usb at 11271000 {
> > + compatible = "mediatek,mt8173-mtu3", "mediatek,mtu3";
> > + reg = <0x11271000 0x3000>, <0x11280700 0x0100>;
> > + reg-names = "mac", "ippc";
> > + interrupts = <GIC_SPI 64 IRQ_TYPE_LEVEL_LOW>;
> > + phys = <&phy_port0 PHY_TYPE_USB3>, <&phy_port1 PHY_TYPE_USB2>;
> > + power-domains = <&scpsys MT8173_POWER_DOMAIN_USB>;
> > + clocks = <&topckgen CLK_TOP_USB30_SEL>;
> > + clock-names = "sys_ck";
> > + vusb33-supply = <&mt6397_vusb_reg>;
> > + vbus-supply = <&usb_p0_vbus>;
> > + extcon = <&extcon_usb>;
> > + dr_mode = "otg";
> > + wakeup-source;
> > + mediatek,syscon-wakeup = <&pericfg 0x400 1>;
> > + #address-cells = <1>;
> > + #size-cells = <1>;
> > + ranges;
> > +
> > + xhci: usb at 11270000 {
> > + compatible = "mediatek,mt8173-xhci", "mediatek,mtk-xhci";
> > + reg = <0x11270000 0x1000>;
> > + reg-names = "mac";
> > + 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";
> > + vusb33-supply = <&mt6397_vusb_reg>;
> > + };
>
> Please add
> > + };
> > +...
> > --
> > 2.18.0
> >
More information about the linux-arm-kernel
mailing list