[PATCH v3 09/11] dt-bindings: usb: convert mediatek,mtk-xhci.txt to YAML schema
Chunfeng Yun
chunfeng.yun at mediatek.com
Tue Dec 8 04:11:47 EST 2020
On Mon, 2020-12-07 at 15:24 -0600, Rob Herring wrote:
> On Wed, Nov 18, 2020 at 04:21:24PM +0800, Chunfeng Yun wrote:
> > Convert mediatek,mtk-xhci.txt to YAML schema mediatek,mtk-xhci.yaml
> >
> > Signed-off-by: Chunfeng Yun <chunfeng.yun at mediatek.com>
> > ---
> > v3:
> > 1. fix yamllint warning
> > 2. remove pinctrl* properties supported by default suggested by Rob
> > 3. drop unused labels
> > 4. modify description of mediatek,syscon-wakeup
> > 5. remove type of imod-interval-ns
> >
> > v2: new patch
> > ---
> > .../bindings/usb/mediatek,mtk-xhci.txt | 121 -------------
> > .../bindings/usb/mediatek,mtk-xhci.yaml | 171 ++++++++++++++++++
> > 2 files changed, 171 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..4a36ad5c4d25
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.yaml
> > @@ -0,0 +1,171 @@
> > +# 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 at mediatek.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's not right.
>
> You need 'items' and list each entry.
Will add minItems/maxItems instead due to it's variable and phy-names is
not used
>
> > + description: List of all the USB PHYs on this HCD
> > +
> > + 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:
> > + 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
> > + 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:
>
> Indentation is wrong here. Should be 2 fewer spaces.
Will fix it
>
> > + - 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#
>
> This $ref isn't right. You already referenced it at the top.
Will drop it
Thank you
>
> > + 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>
> > +
> > + usb at 11270000 {
> > + 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
> >
More information about the linux-arm-kernel
mailing list