From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-14.0 required=3.0 tests=BAYES_00,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id E20EDC433DB for ; Mon, 21 Dec 2020 19:27:30 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 9B75222B3B for ; Mon, 21 Dec 2020 19:27:30 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1726776AbgLUT1P (ORCPT ); Mon, 21 Dec 2020 14:27:15 -0500 Received: from mail-oi1-f177.google.com ([209.85.167.177]:36735 "EHLO mail-oi1-f177.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1725865AbgLUT1O (ORCPT ); Mon, 21 Dec 2020 14:27:14 -0500 Received: by mail-oi1-f177.google.com with SMTP id 9so12384638oiq.3; Mon, 21 Dec 2020 11:26:57 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to; bh=vtdW1Gk+wgsPrzArM/JZVX511Uev3JxlRkyfJRLs8d4=; b=F9q2feWxY8qAaITcDXKNPlRrugJ1VU6wYTEaw31TlFLW08GSetpPLPVVB6RBxoS48v /FsVBdO5UZAjMKgdx95DOuBWxyA1/2sf9xHOzGD5js1yoX8+n9NEozZktEMQZEO6c+gT fYoqU43iBTGmI1UrCAcKaeeOG0jfxO3ukWE0cDDjPC3L79g7Qhv0sFphxg1dMBFlGDeH wPkyd5+fZ2aX9CRg51isH5TBbjQM69tUkrEDiVTKHBoM1AL3hMXDljlzOqGysHs7xI9n YHBA9scHo1wTw2chssGMlR/Kpi2gU3Wb11TkYrbQbe75eHVX/jHgOvekyBMH+enCSYi1 3s1Q== X-Gm-Message-State: AOAM531q7TEdfy44WzvawqEM9IAGBbZD6z2zR0bU6eVgatQkoetG4Q3U Tfnc9Lq4wwecB9gLjL9mKw== X-Google-Smtp-Source: ABdhPJyT4ht8n63IxaDEo2ROCFrWiVpn1ol2Q50yOG+hthf0DVI3eKfWMFvySLHf/6hLCuosvG7utQ== X-Received: by 2002:aca:b707:: with SMTP id h7mr12335299oif.46.1608578792143; Mon, 21 Dec 2020 11:26:32 -0800 (PST) Received: from robh.at.kernel.org ([64.188.179.253]) by smtp.gmail.com with ESMTPSA id h7sm4021964otq.21.2020.12.21.11.26.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 21 Dec 2020 11:26:30 -0800 (PST) Received: (nullmailer pid 405604 invoked by uid 1000); Mon, 21 Dec 2020 19:26:28 -0000 Date: Mon, 21 Dec 2020 12:26:28 -0700 From: Rob Herring To: Chunfeng Yun Cc: Chun-Kuang Hu , Philipp Zabel , David Airlie , Daniel Vetter , "David S . Miller" , Jakub Kicinski , Kishon Vijay Abraham I , Vinod Koul , Matthias Brugger , Greg Kroah-Hartman , Stanley Chu , Min Guo , dri-devel@lists.freedesktop.org, devicetree@vger.kernel.org, linux-kernel@vger.kernel.org, netdev@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linux-mediatek@lists.infradead.org, linux-usb@vger.kernel.org, Serge Semin Subject: Re: [PATCH v4 10/11] dt-bindings: usb: convert mediatek,mtu3.txt to YAML schema Message-ID: <20201221192628.GA401288@robh.at.kernel.org> References: <20201216093012.24406-1-chunfeng.yun@mediatek.com> <20201216093012.24406-10-chunfeng.yun@mediatek.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20201216093012.24406-10-chunfeng.yun@mediatek.com> Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org On Wed, Dec 16, 2020 at 05:30:11PM +0800, Chunfeng Yun wrote: > Convert mediatek,mtu3.txt to YAML schema mediatek,mtu3.yaml > > Signed-off-by: Chunfeng Yun > --- > v4: > 1. refer to usb-drd.yaml insstead of usb/generic.txt > the following ones suggested by Rob: > 2. add the number of phys supported > 3. fix indentation of wakeup > 4. add examples for port and connector > > 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 | 278 ++++++++++++++++++ > 2 files changed, 278 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.txt b/Documentation/devicetree/bindings/usb/mediatek,mtu3.txt > deleted file mode 100644 > index a82ca438aec1..000000000000 > --- a/Documentation/devicetree/bindings/usb/mediatek,mtu3.txt > +++ /dev/null > @@ -1,108 +0,0 @@ > -The device node for Mediatek USB3.0 DRD controller > - > -Required properties: > - - compatible : should be "mediatek,-mtu3", "mediatek,mtu3", > - soc-model is the name of SoC, such as mt8173, mt2712 etc, > - when using "mediatek,mtu3" compatible string, you need SoC specific > - ones in addition, one of: > - - "mediatek,mt8173-mtu3" > - - reg : specifies physical base address and size of the registers > - - reg-names: should be "mac" for device IP and "ippc" for IP port control > - - interrupts : interrupt used by the device IP > - - power-domains : a phandle to USB power domain node to control USB's > - mtcmos > - - vusb33-supply : regulator of USB avdd3.3v > - - clocks : a list of phandle + clock-specifier pairs, one for each > - entry in clock-names > - - clock-names : must contain "sys_ck" for clock of controller, > - the following clocks are optional: > - "ref_ck", "mcu_ck" and "dma_ck"; > - - phys : see usb-hcd.yaml in the current directory > - - dr_mode : should be one of "host", "peripheral" or "otg", > - refer to usb/generic.txt > - > -Optional properties: > - - #address-cells, #size-cells : should be '2' if the device has sub-nodes > - with 'reg' property > - - ranges : allows valid 1:1 translation between child's address space and > - parent's address space > - - extcon : external connector for vbus and idpin changes detection, needed > - when supports dual-role mode. > - it's considered valid for compatibility reasons, not allowed for > - new bindings, and use "usb-role-switch" property instead. > - - vbus-supply : reference to the VBUS regulator, needed when supports > - dual-role mode. > - it's considered valid for compatibility reasons, not allowed for > - new bindings, and put into a usb-connector node. > - see connector/usb-connector.yaml. > - - pinctrl-names : a pinctrl state named "default" is optional, and need be > - defined if auto drd switch is enabled, that means the property dr_mode > - is set as "otg", and meanwhile the property "mediatek,enable-manual-drd" > - is not set. > - - pinctrl-0 : pin control group > - See: Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt > - > - - maximum-speed : valid arguments are "super-speed", "high-speed" and > - "full-speed"; refer to usb/generic.txt > - - usb-role-switch : use USB Role Switch to support dual-role switch, but > - not extcon; see usb/generic.txt. > - - enable-manual-drd : supports manual dual-role switch via debugfs; usually > - used when receptacle is TYPE-A and also wants to support dual-role > - mode. > - - wakeup-source: enable USB remote wakeup of host mode. > - - mediatek,syscon-wakeup : phandle to syscon used to access the register > - of the USB wakeup glue layer between SSUSB and SPM; it depends on > - "wakeup-source", and has two arguments: > - - the first one : register base address of the glue layer in syscon; > - - the second one : hardware version of the glue layer > - - 1 : used by mt8173 etc > - - 2 : used by mt2712 etc > - - mediatek,u3p-dis-msk : mask to disable u3ports, bit0 for u3port0, > - bit1 for u3port1, ... etc; > - > -additionally the properties from usb-hcd.yaml (in the current directory) are > -supported. > - > -Sub-nodes: > -The xhci should be added as subnode to mtu3 as shown in the following example > -if host mode is enabled. The DT binding details of xhci can be found in: > -Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt > - > -The port would be added as subnode if use "usb-role-switch" property. > - see graph.txt > - > -Example: > -ssusb: usb@11271000 { > - compatible = "mediatek,mt8173-mtu3"; > - reg = <0 0x11271000 0 0x3000>, > - <0 0x11280700 0 0x0100>; > - reg-names = "mac", "ippc"; > - interrupts = ; > - phys = <&phy_port0 PHY_TYPE_USB3>, > - <&phy_port1 PHY_TYPE_USB2>; > - power-domains = <&scpsys MT8173_POWER_DOMAIN_USB>; > - clocks = <&topckgen CLK_TOP_USB30_SEL>, <&clk26m>, > - <&pericfg CLK_PERI_USB0>, > - <&pericfg CLK_PERI_USB1>; > - clock-names = "sys_ck", "ref_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 = <2>; > - #size-cells = <2>; > - ranges; > - > - usb_host: xhci@11270000 { > - compatible = "mediatek,mt8173-xhci"; > - reg = <0 0x11270000 0 0x1000>; > - reg-names = "mac"; > - interrupts = ; > - 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>; > - }; > -}; > diff --git a/Documentation/devicetree/bindings/usb/mediatek,mtu3.yaml b/Documentation/devicetree/bindings/usb/mediatek,mtu3.yaml > new file mode 100644 > index 000000000000..e39850dff073 > --- /dev/null > +++ b/Documentation/devicetree/bindings/usb/mediatek,mtu3.yaml > @@ -0,0 +1,278 @@ > +# 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 > + > +allOf: > + - $ref: "usb-drd.yaml" > + > +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 Don't need maxItems here. > + 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: > + description: List of all the USB PHYs used > + minItems: 0 > + maxItems: 9 Need to define what each one is. > + > + vusb33-supply: > + description: Regulator of USB AVDD3.3v > + > + vbus-supply: > + 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: > + enum: [host, peripheral, otg] > + default: otg > + > + maximum-speed: > + 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. > + 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 > + > + 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: > + 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 > + > +additionalProperties: false > + > +examples: > + # Dual role switch by extcon > + - | > + #include > + #include > + #include > + #include > + #include > + > + usb@11271000 { > + compatible = "mediatek,mt8173-mtu3", "mediatek,mtu3"; > + reg = <0x11271000 0x3000>, <0x11280700 0x0100>; > + reg-names = "mac", "ippc"; > + interrupts = ; > + 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@11270000 { > + compatible = "mediatek,mt8173-xhci", "mediatek,mtk-xhci"; > + reg = <0x11270000 0x1000>; > + reg-names = "mac"; > + interrupts = ; > + 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>; > + }; > + }; > + > + # Enable/disable device by an input gpio for VBUS pin > + - | > + #include > + #include > + > + usb@112c1000 { > + compatible = "mediatek,mt2712-mtu3", "mediatek,mtu3"; > + reg = <0x112c1000 0x3000>, <0x112d0700 0x0100>; > + reg-names = "mac", "ippc"; > + interrupts = ; > + phys = <&u2port2 PHY_TYPE_USB2>; > + power-domains = <&scpsys MT2712_POWER_DOMAIN_USB2>; > + clocks = <&topckgen CLK_TOP_USB30_SEL>; > + clock-names = "sys_ck"; > + dr_mode = "peripheral"; > + usb-role-switch; > + > + connector { > + compatible = "gpio-usb-b-connector", "usb-b-connector"; > + type = "micro"; > + vbus-gpios = <&pio 13 GPIO_ACTIVE_HIGH>; > + }; > + }; > + > + # Dual role switch with type-c > + - | > + usb@11201000 { > + compatible ="mediatek,mt8183-mtu3", "mediatek,mtu3"; > + reg = <0x11201000 0x2e00>, <0x11203e00 0x0100>; > + reg-names = "mac", "ippc"; > + interrupts = ; > + phys = <&u2port0 PHY_TYPE_USB2>; > + clocks = <&clk26m>; > + clock-names = "sys_ck"; > + mediatek,syscon-wakeup = <&pericfg 0x400 1>; > + wakeup-source; > + dr_mode = "otg"; > + usb-role-switch; > + #address-cells = <1>; > + #size-cells = <1>; > + ranges; > + > + host: usb@11200000 { > + compatible = "mediatek,mt8183-xhci", "mediatek,mtk-xhci"; > + reg = <0x11200000 0x1000>; > + reg-names = "mac"; > + interrupts = ; > + clocks = <&clk26m>; > + clock-names = "sys_ck"; > + }; > + > + port { > + usb_role_sw: endpoint { > + remote-endpoint = <&hs_ep>; > + }; > + }; > + }; > + > +... > -- > 2.18.0 > From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-14.0 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,INCLUDES_CR_TRAILER,INCLUDES_PATCH,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 010DCC433E0 for ; Mon, 21 Dec 2020 19:26:48 +0000 (UTC) Received: from merlin.infradead.org (merlin.infradead.org [205.233.59.134]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id AB08E22B3B for ; Mon, 21 Dec 2020 19:26:47 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org AB08E22B3B Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-mediatek-bounces+linux-mediatek=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=merlin.20170209; h=Sender:Content-Transfer-Encoding: Content-Type:Cc:List-Subscribe:List-Help:List-Post:List-Archive: List-Unsubscribe:List-Id:In-Reply-To:MIME-Version:References:Message-ID: Subject:To:From:Date:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=DWJ5pgHTF4tYl3ikcXPNZIFTNWpphbLClqwWNcUpSJ0=; b=LFMoxjaR44qa2R4nrmkBUnbc9 kwXCneAsoY6bIhY9meOkdqiBdePYIJQZKbJjR7sWrPknVAFLCBVPXk+p9rlbtScYTWXz6L/Z7tE5f H813Q2LPxgfiNWsg3424zeSUvesLNMh+VOtoGO4n7iNTz56bEJ6ixaNTJK2Eqe6HBuxP5GZBWWUPe zLjLtlCQHNvpx/npSNGEUFOJGVaK8aGAX/GAZsTEDceTWoB5TPBOkEFBMQCK3uOS2henSWObixyrD kCNK8yjLeB+Q4Ak4V4SOUr5wCn1cAOs72s5mWxIEUdVmjg/PGXUHDs0gvw8lC50PN5IkZgxNrdMqZ UPhysS3fg==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1krQpJ-0002J7-Se; Mon, 21 Dec 2020 19:26:37 +0000 Received: from mail-oi1-f169.google.com ([209.85.167.169]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1krQpF-0002Hu-CH; Mon, 21 Dec 2020 19:26:34 +0000 Received: by mail-oi1-f169.google.com with SMTP id d203so12405616oia.0; Mon, 21 Dec 2020 11:26:32 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to; bh=vtdW1Gk+wgsPrzArM/JZVX511Uev3JxlRkyfJRLs8d4=; b=Mn0ahYze6cFRP0L+DV1ZehwxQ2bQpsJYYYx9FpUOIjHFwFdlBvQsrfeyfS28t7SdpD LjNjC1SBUOt/inlBNOWQ8BguI0MGK8J3+VYri0xHiSnbJqlXGiytgbVoyz/+3IscCJqH YrS8YVdvfdml6kyGrMdBKJZOxX5DIbISkoZj6zuHdwi4Y/ZhhCsh7iBE8Ni5SK4PMU1L eFYWAPB++lUp+e+YQg3zhMcP4UTXyLP8ZshxFmB7MADWyWsdURlGU/rldcUOXFXpjSLx kMk+h6Vwo0pYbLSgxMVlVe6jvwfWpM1vTH7BCFMGVGFGXHvXcjwfuOLpUN03+6+9NwYz L/1Q== X-Gm-Message-State: AOAM533fXZFXm1tpttwhq9L3mWwMaAl9gwY52EJYOHOs6r80/gdgfIRo pXnENyORDyOSeaEOdWjSww== X-Google-Smtp-Source: ABdhPJyT4ht8n63IxaDEo2ROCFrWiVpn1ol2Q50yOG+hthf0DVI3eKfWMFvySLHf/6hLCuosvG7utQ== X-Received: by 2002:aca:b707:: with SMTP id h7mr12335299oif.46.1608578792143; Mon, 21 Dec 2020 11:26:32 -0800 (PST) Received: from robh.at.kernel.org ([64.188.179.253]) by smtp.gmail.com with ESMTPSA id h7sm4021964otq.21.2020.12.21.11.26.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 21 Dec 2020 11:26:30 -0800 (PST) Received: (nullmailer pid 405604 invoked by uid 1000); Mon, 21 Dec 2020 19:26:28 -0000 Date: Mon, 21 Dec 2020 12:26:28 -0700 From: Rob Herring To: Chunfeng Yun Subject: Re: [PATCH v4 10/11] dt-bindings: usb: convert mediatek,mtu3.txt to YAML schema Message-ID: <20201221192628.GA401288@robh.at.kernel.org> References: <20201216093012.24406-1-chunfeng.yun@mediatek.com> <20201216093012.24406-10-chunfeng.yun@mediatek.com> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20201216093012.24406-10-chunfeng.yun@mediatek.com> X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20201221_142633_460314_A729C6BF X-CRM114-Status: GOOD ( 41.39 ) X-BeenThere: linux-mediatek@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Chun-Kuang Hu , Min Guo , Philipp Zabel , devicetree@vger.kernel.org, David Airlie , Greg Kroah-Hartman , linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org, Kishon Vijay Abraham I , Serge Semin , Vinod Koul , linux-mediatek@lists.infradead.org, Daniel Vetter , netdev@vger.kernel.org, Matthias Brugger , Jakub Kicinski , Stanley Chu , "David S . Miller" , linux-arm-kernel@lists.infradead.org Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "Linux-mediatek" Errors-To: linux-mediatek-bounces+linux-mediatek=archiver.kernel.org@lists.infradead.org On Wed, Dec 16, 2020 at 05:30:11PM +0800, Chunfeng Yun wrote: > Convert mediatek,mtu3.txt to YAML schema mediatek,mtu3.yaml > > Signed-off-by: Chunfeng Yun > --- > v4: > 1. refer to usb-drd.yaml insstead of usb/generic.txt > the following ones suggested by Rob: > 2. add the number of phys supported > 3. fix indentation of wakeup > 4. add examples for port and connector > > 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 | 278 ++++++++++++++++++ > 2 files changed, 278 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.txt b/Documentation/devicetree/bindings/usb/mediatek,mtu3.txt > deleted file mode 100644 > index a82ca438aec1..000000000000 > --- a/Documentation/devicetree/bindings/usb/mediatek,mtu3.txt > +++ /dev/null > @@ -1,108 +0,0 @@ > -The device node for Mediatek USB3.0 DRD controller > - > -Required properties: > - - compatible : should be "mediatek,-mtu3", "mediatek,mtu3", > - soc-model is the name of SoC, such as mt8173, mt2712 etc, > - when using "mediatek,mtu3" compatible string, you need SoC specific > - ones in addition, one of: > - - "mediatek,mt8173-mtu3" > - - reg : specifies physical base address and size of the registers > - - reg-names: should be "mac" for device IP and "ippc" for IP port control > - - interrupts : interrupt used by the device IP > - - power-domains : a phandle to USB power domain node to control USB's > - mtcmos > - - vusb33-supply : regulator of USB avdd3.3v > - - clocks : a list of phandle + clock-specifier pairs, one for each > - entry in clock-names > - - clock-names : must contain "sys_ck" for clock of controller, > - the following clocks are optional: > - "ref_ck", "mcu_ck" and "dma_ck"; > - - phys : see usb-hcd.yaml in the current directory > - - dr_mode : should be one of "host", "peripheral" or "otg", > - refer to usb/generic.txt > - > -Optional properties: > - - #address-cells, #size-cells : should be '2' if the device has sub-nodes > - with 'reg' property > - - ranges : allows valid 1:1 translation between child's address space and > - parent's address space > - - extcon : external connector for vbus and idpin changes detection, needed > - when supports dual-role mode. > - it's considered valid for compatibility reasons, not allowed for > - new bindings, and use "usb-role-switch" property instead. > - - vbus-supply : reference to the VBUS regulator, needed when supports > - dual-role mode. > - it's considered valid for compatibility reasons, not allowed for > - new bindings, and put into a usb-connector node. > - see connector/usb-connector.yaml. > - - pinctrl-names : a pinctrl state named "default" is optional, and need be > - defined if auto drd switch is enabled, that means the property dr_mode > - is set as "otg", and meanwhile the property "mediatek,enable-manual-drd" > - is not set. > - - pinctrl-0 : pin control group > - See: Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt > - > - - maximum-speed : valid arguments are "super-speed", "high-speed" and > - "full-speed"; refer to usb/generic.txt > - - usb-role-switch : use USB Role Switch to support dual-role switch, but > - not extcon; see usb/generic.txt. > - - enable-manual-drd : supports manual dual-role switch via debugfs; usually > - used when receptacle is TYPE-A and also wants to support dual-role > - mode. > - - wakeup-source: enable USB remote wakeup of host mode. > - - mediatek,syscon-wakeup : phandle to syscon used to access the register > - of the USB wakeup glue layer between SSUSB and SPM; it depends on > - "wakeup-source", and has two arguments: > - - the first one : register base address of the glue layer in syscon; > - - the second one : hardware version of the glue layer > - - 1 : used by mt8173 etc > - - 2 : used by mt2712 etc > - - mediatek,u3p-dis-msk : mask to disable u3ports, bit0 for u3port0, > - bit1 for u3port1, ... etc; > - > -additionally the properties from usb-hcd.yaml (in the current directory) are > -supported. > - > -Sub-nodes: > -The xhci should be added as subnode to mtu3 as shown in the following example > -if host mode is enabled. The DT binding details of xhci can be found in: > -Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt > - > -The port would be added as subnode if use "usb-role-switch" property. > - see graph.txt > - > -Example: > -ssusb: usb@11271000 { > - compatible = "mediatek,mt8173-mtu3"; > - reg = <0 0x11271000 0 0x3000>, > - <0 0x11280700 0 0x0100>; > - reg-names = "mac", "ippc"; > - interrupts = ; > - phys = <&phy_port0 PHY_TYPE_USB3>, > - <&phy_port1 PHY_TYPE_USB2>; > - power-domains = <&scpsys MT8173_POWER_DOMAIN_USB>; > - clocks = <&topckgen CLK_TOP_USB30_SEL>, <&clk26m>, > - <&pericfg CLK_PERI_USB0>, > - <&pericfg CLK_PERI_USB1>; > - clock-names = "sys_ck", "ref_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 = <2>; > - #size-cells = <2>; > - ranges; > - > - usb_host: xhci@11270000 { > - compatible = "mediatek,mt8173-xhci"; > - reg = <0 0x11270000 0 0x1000>; > - reg-names = "mac"; > - interrupts = ; > - 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>; > - }; > -}; > diff --git a/Documentation/devicetree/bindings/usb/mediatek,mtu3.yaml b/Documentation/devicetree/bindings/usb/mediatek,mtu3.yaml > new file mode 100644 > index 000000000000..e39850dff073 > --- /dev/null > +++ b/Documentation/devicetree/bindings/usb/mediatek,mtu3.yaml > @@ -0,0 +1,278 @@ > +# 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 > + > +allOf: > + - $ref: "usb-drd.yaml" > + > +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 Don't need maxItems here. > + 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: > + description: List of all the USB PHYs used > + minItems: 0 > + maxItems: 9 Need to define what each one is. > + > + vusb33-supply: > + description: Regulator of USB AVDD3.3v > + > + vbus-supply: > + 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: > + enum: [host, peripheral, otg] > + default: otg > + > + maximum-speed: > + 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. > + 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 > + > + 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: > + 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 > + > +additionalProperties: false > + > +examples: > + # Dual role switch by extcon > + - | > + #include > + #include > + #include > + #include > + #include > + > + usb@11271000 { > + compatible = "mediatek,mt8173-mtu3", "mediatek,mtu3"; > + reg = <0x11271000 0x3000>, <0x11280700 0x0100>; > + reg-names = "mac", "ippc"; > + interrupts = ; > + 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@11270000 { > + compatible = "mediatek,mt8173-xhci", "mediatek,mtk-xhci"; > + reg = <0x11270000 0x1000>; > + reg-names = "mac"; > + interrupts = ; > + 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>; > + }; > + }; > + > + # Enable/disable device by an input gpio for VBUS pin > + - | > + #include > + #include > + > + usb@112c1000 { > + compatible = "mediatek,mt2712-mtu3", "mediatek,mtu3"; > + reg = <0x112c1000 0x3000>, <0x112d0700 0x0100>; > + reg-names = "mac", "ippc"; > + interrupts = ; > + phys = <&u2port2 PHY_TYPE_USB2>; > + power-domains = <&scpsys MT2712_POWER_DOMAIN_USB2>; > + clocks = <&topckgen CLK_TOP_USB30_SEL>; > + clock-names = "sys_ck"; > + dr_mode = "peripheral"; > + usb-role-switch; > + > + connector { > + compatible = "gpio-usb-b-connector", "usb-b-connector"; > + type = "micro"; > + vbus-gpios = <&pio 13 GPIO_ACTIVE_HIGH>; > + }; > + }; > + > + # Dual role switch with type-c > + - | > + usb@11201000 { > + compatible ="mediatek,mt8183-mtu3", "mediatek,mtu3"; > + reg = <0x11201000 0x2e00>, <0x11203e00 0x0100>; > + reg-names = "mac", "ippc"; > + interrupts = ; > + phys = <&u2port0 PHY_TYPE_USB2>; > + clocks = <&clk26m>; > + clock-names = "sys_ck"; > + mediatek,syscon-wakeup = <&pericfg 0x400 1>; > + wakeup-source; > + dr_mode = "otg"; > + usb-role-switch; > + #address-cells = <1>; > + #size-cells = <1>; > + ranges; > + > + host: usb@11200000 { > + compatible = "mediatek,mt8183-xhci", "mediatek,mtk-xhci"; > + reg = <0x11200000 0x1000>; > + reg-names = "mac"; > + interrupts = ; > + clocks = <&clk26m>; > + clock-names = "sys_ck"; > + }; > + > + port { > + usb_role_sw: endpoint { > + remote-endpoint = <&hs_ep>; > + }; > + }; > + }; > + > +... > -- > 2.18.0 > _______________________________________________ Linux-mediatek mailing list Linux-mediatek@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-mediatek From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-14.0 required=3.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,INCLUDES_CR_TRAILER,INCLUDES_PATCH,MAILING_LIST_MULTI, SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id CE81FC433DB for ; Mon, 21 Dec 2020 19:27:56 +0000 (UTC) Received: from merlin.infradead.org (merlin.infradead.org [205.233.59.134]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id 756AD22B3F for ; Mon, 21 Dec 2020 19:27:56 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 756AD22B3F Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=lists.infradead.org; s=merlin.20170209; h=Sender:Content-Transfer-Encoding: Content-Type:Cc:List-Subscribe:List-Help:List-Post:List-Archive: List-Unsubscribe:List-Id:In-Reply-To:MIME-Version:References:Message-ID: Subject:To:From:Date:Reply-To:Content-ID:Content-Description:Resent-Date: Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Owner; bh=LrAjkfOYnKIBnNjK6zQt6gbW7Tg3nsLMwJKK4g4ea/M=; b=BgpN+JU5DZLC+OF8bG7MVveuq uCqSxLdNuo9WRE5iIfgkbwN+bVSXHLk/fueEZ8C+ONnRk2w5LLGA4hfJZLRxG3Q87IhDShiXo92eE tSU+whcLVpm1UX31rFO97Bqxia+hy47eHNekS7LnrpyL8hWnIaNycC7Fc7Y5DZST7FQPI/Om9qrJ0 dN6RnG6pOLva0FwlogBgap9jc1cunjlNEccmE4l6mCO748W9JbQsKu5pqTP0Lh6Lxah94GavX0tLK KMYtjyyFGLFfZZ8tOCYJfmHKiprXO3aL+fDnDBhSH5VIM1UnSOTiljzWQGB04H95U8kmMRtDRyjWe 5JOVJQHGA==; Received: from localhost ([::1] helo=merlin.infradead.org) by merlin.infradead.org with esmtp (Exim 4.92.3 #3 (Red Hat Linux)) id 1krQpI-0002IN-6A; Mon, 21 Dec 2020 19:26:36 +0000 Received: from mail-oi1-f169.google.com ([209.85.167.169]) by merlin.infradead.org with esmtps (Exim 4.92.3 #3 (Red Hat Linux)) id 1krQpF-0002Hu-CH; Mon, 21 Dec 2020 19:26:34 +0000 Received: by mail-oi1-f169.google.com with SMTP id d203so12405616oia.0; Mon, 21 Dec 2020 11:26:32 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to; bh=vtdW1Gk+wgsPrzArM/JZVX511Uev3JxlRkyfJRLs8d4=; b=Mn0ahYze6cFRP0L+DV1ZehwxQ2bQpsJYYYx9FpUOIjHFwFdlBvQsrfeyfS28t7SdpD LjNjC1SBUOt/inlBNOWQ8BguI0MGK8J3+VYri0xHiSnbJqlXGiytgbVoyz/+3IscCJqH YrS8YVdvfdml6kyGrMdBKJZOxX5DIbISkoZj6zuHdwi4Y/ZhhCsh7iBE8Ni5SK4PMU1L eFYWAPB++lUp+e+YQg3zhMcP4UTXyLP8ZshxFmB7MADWyWsdURlGU/rldcUOXFXpjSLx kMk+h6Vwo0pYbLSgxMVlVe6jvwfWpM1vTH7BCFMGVGFGXHvXcjwfuOLpUN03+6+9NwYz L/1Q== X-Gm-Message-State: AOAM533fXZFXm1tpttwhq9L3mWwMaAl9gwY52EJYOHOs6r80/gdgfIRo pXnENyORDyOSeaEOdWjSww== X-Google-Smtp-Source: ABdhPJyT4ht8n63IxaDEo2ROCFrWiVpn1ol2Q50yOG+hthf0DVI3eKfWMFvySLHf/6hLCuosvG7utQ== X-Received: by 2002:aca:b707:: with SMTP id h7mr12335299oif.46.1608578792143; Mon, 21 Dec 2020 11:26:32 -0800 (PST) Received: from robh.at.kernel.org ([64.188.179.253]) by smtp.gmail.com with ESMTPSA id h7sm4021964otq.21.2020.12.21.11.26.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 21 Dec 2020 11:26:30 -0800 (PST) Received: (nullmailer pid 405604 invoked by uid 1000); Mon, 21 Dec 2020 19:26:28 -0000 Date: Mon, 21 Dec 2020 12:26:28 -0700 From: Rob Herring To: Chunfeng Yun Subject: Re: [PATCH v4 10/11] dt-bindings: usb: convert mediatek,mtu3.txt to YAML schema Message-ID: <20201221192628.GA401288@robh.at.kernel.org> References: <20201216093012.24406-1-chunfeng.yun@mediatek.com> <20201216093012.24406-10-chunfeng.yun@mediatek.com> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20201216093012.24406-10-chunfeng.yun@mediatek.com> X-CRM114-Version: 20100106-BlameMichelson ( TRE 0.8.0 (BSD) ) MR-646709E3 X-CRM114-CacheID: sfid-20201221_142633_460314_A729C6BF X-CRM114-Status: GOOD ( 41.39 ) X-BeenThere: linux-arm-kernel@lists.infradead.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Chun-Kuang Hu , Min Guo , Philipp Zabel , devicetree@vger.kernel.org, David Airlie , Greg Kroah-Hartman , linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org, Kishon Vijay Abraham I , Serge Semin , Vinod Koul , linux-mediatek@lists.infradead.org, Daniel Vetter , netdev@vger.kernel.org, Matthias Brugger , Jakub Kicinski , Stanley Chu , "David S . Miller" , linux-arm-kernel@lists.infradead.org Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Sender: "linux-arm-kernel" Errors-To: linux-arm-kernel-bounces+linux-arm-kernel=archiver.kernel.org@lists.infradead.org On Wed, Dec 16, 2020 at 05:30:11PM +0800, Chunfeng Yun wrote: > Convert mediatek,mtu3.txt to YAML schema mediatek,mtu3.yaml > > Signed-off-by: Chunfeng Yun > --- > v4: > 1. refer to usb-drd.yaml insstead of usb/generic.txt > the following ones suggested by Rob: > 2. add the number of phys supported > 3. fix indentation of wakeup > 4. add examples for port and connector > > 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 | 278 ++++++++++++++++++ > 2 files changed, 278 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.txt b/Documentation/devicetree/bindings/usb/mediatek,mtu3.txt > deleted file mode 100644 > index a82ca438aec1..000000000000 > --- a/Documentation/devicetree/bindings/usb/mediatek,mtu3.txt > +++ /dev/null > @@ -1,108 +0,0 @@ > -The device node for Mediatek USB3.0 DRD controller > - > -Required properties: > - - compatible : should be "mediatek,-mtu3", "mediatek,mtu3", > - soc-model is the name of SoC, such as mt8173, mt2712 etc, > - when using "mediatek,mtu3" compatible string, you need SoC specific > - ones in addition, one of: > - - "mediatek,mt8173-mtu3" > - - reg : specifies physical base address and size of the registers > - - reg-names: should be "mac" for device IP and "ippc" for IP port control > - - interrupts : interrupt used by the device IP > - - power-domains : a phandle to USB power domain node to control USB's > - mtcmos > - - vusb33-supply : regulator of USB avdd3.3v > - - clocks : a list of phandle + clock-specifier pairs, one for each > - entry in clock-names > - - clock-names : must contain "sys_ck" for clock of controller, > - the following clocks are optional: > - "ref_ck", "mcu_ck" and "dma_ck"; > - - phys : see usb-hcd.yaml in the current directory > - - dr_mode : should be one of "host", "peripheral" or "otg", > - refer to usb/generic.txt > - > -Optional properties: > - - #address-cells, #size-cells : should be '2' if the device has sub-nodes > - with 'reg' property > - - ranges : allows valid 1:1 translation between child's address space and > - parent's address space > - - extcon : external connector for vbus and idpin changes detection, needed > - when supports dual-role mode. > - it's considered valid for compatibility reasons, not allowed for > - new bindings, and use "usb-role-switch" property instead. > - - vbus-supply : reference to the VBUS regulator, needed when supports > - dual-role mode. > - it's considered valid for compatibility reasons, not allowed for > - new bindings, and put into a usb-connector node. > - see connector/usb-connector.yaml. > - - pinctrl-names : a pinctrl state named "default" is optional, and need be > - defined if auto drd switch is enabled, that means the property dr_mode > - is set as "otg", and meanwhile the property "mediatek,enable-manual-drd" > - is not set. > - - pinctrl-0 : pin control group > - See: Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt > - > - - maximum-speed : valid arguments are "super-speed", "high-speed" and > - "full-speed"; refer to usb/generic.txt > - - usb-role-switch : use USB Role Switch to support dual-role switch, but > - not extcon; see usb/generic.txt. > - - enable-manual-drd : supports manual dual-role switch via debugfs; usually > - used when receptacle is TYPE-A and also wants to support dual-role > - mode. > - - wakeup-source: enable USB remote wakeup of host mode. > - - mediatek,syscon-wakeup : phandle to syscon used to access the register > - of the USB wakeup glue layer between SSUSB and SPM; it depends on > - "wakeup-source", and has two arguments: > - - the first one : register base address of the glue layer in syscon; > - - the second one : hardware version of the glue layer > - - 1 : used by mt8173 etc > - - 2 : used by mt2712 etc > - - mediatek,u3p-dis-msk : mask to disable u3ports, bit0 for u3port0, > - bit1 for u3port1, ... etc; > - > -additionally the properties from usb-hcd.yaml (in the current directory) are > -supported. > - > -Sub-nodes: > -The xhci should be added as subnode to mtu3 as shown in the following example > -if host mode is enabled. The DT binding details of xhci can be found in: > -Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt > - > -The port would be added as subnode if use "usb-role-switch" property. > - see graph.txt > - > -Example: > -ssusb: usb@11271000 { > - compatible = "mediatek,mt8173-mtu3"; > - reg = <0 0x11271000 0 0x3000>, > - <0 0x11280700 0 0x0100>; > - reg-names = "mac", "ippc"; > - interrupts = ; > - phys = <&phy_port0 PHY_TYPE_USB3>, > - <&phy_port1 PHY_TYPE_USB2>; > - power-domains = <&scpsys MT8173_POWER_DOMAIN_USB>; > - clocks = <&topckgen CLK_TOP_USB30_SEL>, <&clk26m>, > - <&pericfg CLK_PERI_USB0>, > - <&pericfg CLK_PERI_USB1>; > - clock-names = "sys_ck", "ref_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 = <2>; > - #size-cells = <2>; > - ranges; > - > - usb_host: xhci@11270000 { > - compatible = "mediatek,mt8173-xhci"; > - reg = <0 0x11270000 0 0x1000>; > - reg-names = "mac"; > - interrupts = ; > - 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>; > - }; > -}; > diff --git a/Documentation/devicetree/bindings/usb/mediatek,mtu3.yaml b/Documentation/devicetree/bindings/usb/mediatek,mtu3.yaml > new file mode 100644 > index 000000000000..e39850dff073 > --- /dev/null > +++ b/Documentation/devicetree/bindings/usb/mediatek,mtu3.yaml > @@ -0,0 +1,278 @@ > +# 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 > + > +allOf: > + - $ref: "usb-drd.yaml" > + > +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 Don't need maxItems here. > + 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: > + description: List of all the USB PHYs used > + minItems: 0 > + maxItems: 9 Need to define what each one is. > + > + vusb33-supply: > + description: Regulator of USB AVDD3.3v > + > + vbus-supply: > + 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: > + enum: [host, peripheral, otg] > + default: otg > + > + maximum-speed: > + 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. > + 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 > + > + 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: > + 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 > + > +additionalProperties: false > + > +examples: > + # Dual role switch by extcon > + - | > + #include > + #include > + #include > + #include > + #include > + > + usb@11271000 { > + compatible = "mediatek,mt8173-mtu3", "mediatek,mtu3"; > + reg = <0x11271000 0x3000>, <0x11280700 0x0100>; > + reg-names = "mac", "ippc"; > + interrupts = ; > + 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@11270000 { > + compatible = "mediatek,mt8173-xhci", "mediatek,mtk-xhci"; > + reg = <0x11270000 0x1000>; > + reg-names = "mac"; > + interrupts = ; > + 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>; > + }; > + }; > + > + # Enable/disable device by an input gpio for VBUS pin > + - | > + #include > + #include > + > + usb@112c1000 { > + compatible = "mediatek,mt2712-mtu3", "mediatek,mtu3"; > + reg = <0x112c1000 0x3000>, <0x112d0700 0x0100>; > + reg-names = "mac", "ippc"; > + interrupts = ; > + phys = <&u2port2 PHY_TYPE_USB2>; > + power-domains = <&scpsys MT2712_POWER_DOMAIN_USB2>; > + clocks = <&topckgen CLK_TOP_USB30_SEL>; > + clock-names = "sys_ck"; > + dr_mode = "peripheral"; > + usb-role-switch; > + > + connector { > + compatible = "gpio-usb-b-connector", "usb-b-connector"; > + type = "micro"; > + vbus-gpios = <&pio 13 GPIO_ACTIVE_HIGH>; > + }; > + }; > + > + # Dual role switch with type-c > + - | > + usb@11201000 { > + compatible ="mediatek,mt8183-mtu3", "mediatek,mtu3"; > + reg = <0x11201000 0x2e00>, <0x11203e00 0x0100>; > + reg-names = "mac", "ippc"; > + interrupts = ; > + phys = <&u2port0 PHY_TYPE_USB2>; > + clocks = <&clk26m>; > + clock-names = "sys_ck"; > + mediatek,syscon-wakeup = <&pericfg 0x400 1>; > + wakeup-source; > + dr_mode = "otg"; > + usb-role-switch; > + #address-cells = <1>; > + #size-cells = <1>; > + ranges; > + > + host: usb@11200000 { > + compatible = "mediatek,mt8183-xhci", "mediatek,mtk-xhci"; > + reg = <0x11200000 0x1000>; > + reg-names = "mac"; > + interrupts = ; > + clocks = <&clk26m>; > + clock-names = "sys_ck"; > + }; > + > + port { > + usb_role_sw: endpoint { > + remote-endpoint = <&hs_ep>; > + }; > + }; > + }; > + > +... > -- > 2.18.0 > _______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-14.0 required=3.0 tests=BAYES_00,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 3055CC433DB for ; Mon, 21 Dec 2020 19:26:35 +0000 (UTC) Received: from gabe.freedesktop.org (gabe.freedesktop.org [131.252.210.177]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id DFA9422B3B for ; Mon, 21 Dec 2020 19:26:34 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org DFA9422B3B Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org Authentication-Results: mail.kernel.org; spf=none smtp.mailfrom=dri-devel-bounces@lists.freedesktop.org Received: from gabe.freedesktop.org (localhost [127.0.0.1]) by gabe.freedesktop.org (Postfix) with ESMTP id 407246E4FF; Mon, 21 Dec 2020 19:26:34 +0000 (UTC) Received: from mail-oi1-f175.google.com (mail-oi1-f175.google.com [209.85.167.175]) by gabe.freedesktop.org (Postfix) with ESMTPS id 023DD6E4FF for ; Mon, 21 Dec 2020 19:26:32 +0000 (UTC) Received: by mail-oi1-f175.google.com with SMTP id w124so12376437oia.6 for ; Mon, 21 Dec 2020 11:26:32 -0800 (PST) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to; bh=vtdW1Gk+wgsPrzArM/JZVX511Uev3JxlRkyfJRLs8d4=; b=rnUhXkoW4/ZmvnMRjIiLSQ/MCIz6yscjrqW3fXg5aXbG1XYEuAtp9P9nZ97gaEh5a+ qPE8udAIzEwceUDUJEZ4RM5nuedfngad+cUCkMKLl1C2/SFPbLc3cznH9Rw3pzI1IAVc XA4gcnKNjZtgIqeiHNZ3FAnsor+6NZ8m/StEcIp/Uql6LUbXk41WTOnt+GFXVbLuU5Ws C9y0ysgEI3WwIpOzefqqru43C4a1O9ogEnn0QNOSIQzFjHi8OJDRA8GKrP4dI1lG4vsr 7E2+HXbab8aA4VTBLFUI5qhcEZ95hPwOVwDwgh/I3zcBRBrDY0/wkYAYx+2kp8jhiOWA Hz7Q== X-Gm-Message-State: AOAM532W5OUQ+cGVsw2aVo+XJqOLckI0LZK6JVpVR+3ZlzMm/I0pIHdD n3KlUEmeF2p6Nyt5jqQApKtUTHkOSw== X-Google-Smtp-Source: ABdhPJyT4ht8n63IxaDEo2ROCFrWiVpn1ol2Q50yOG+hthf0DVI3eKfWMFvySLHf/6hLCuosvG7utQ== X-Received: by 2002:aca:b707:: with SMTP id h7mr12335299oif.46.1608578792143; Mon, 21 Dec 2020 11:26:32 -0800 (PST) Received: from robh.at.kernel.org ([64.188.179.253]) by smtp.gmail.com with ESMTPSA id h7sm4021964otq.21.2020.12.21.11.26.28 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 21 Dec 2020 11:26:30 -0800 (PST) Received: (nullmailer pid 405604 invoked by uid 1000); Mon, 21 Dec 2020 19:26:28 -0000 Date: Mon, 21 Dec 2020 12:26:28 -0700 From: Rob Herring To: Chunfeng Yun Subject: Re: [PATCH v4 10/11] dt-bindings: usb: convert mediatek,mtu3.txt to YAML schema Message-ID: <20201221192628.GA401288@robh.at.kernel.org> References: <20201216093012.24406-1-chunfeng.yun@mediatek.com> <20201216093012.24406-10-chunfeng.yun@mediatek.com> MIME-Version: 1.0 Content-Disposition: inline In-Reply-To: <20201216093012.24406-10-chunfeng.yun@mediatek.com> X-BeenThere: dri-devel@lists.freedesktop.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Direct Rendering Infrastructure - Development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: Chun-Kuang Hu , Min Guo , devicetree@vger.kernel.org, David Airlie , Greg Kroah-Hartman , linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org, dri-devel@lists.freedesktop.org, Kishon Vijay Abraham I , Serge Semin , Vinod Koul , linux-mediatek@lists.infradead.org, netdev@vger.kernel.org, Matthias Brugger , Jakub Kicinski , Stanley Chu , "David S . Miller" , linux-arm-kernel@lists.infradead.org Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: dri-devel-bounces@lists.freedesktop.org Sender: "dri-devel" On Wed, Dec 16, 2020 at 05:30:11PM +0800, Chunfeng Yun wrote: > Convert mediatek,mtu3.txt to YAML schema mediatek,mtu3.yaml > > Signed-off-by: Chunfeng Yun > --- > v4: > 1. refer to usb-drd.yaml insstead of usb/generic.txt > the following ones suggested by Rob: > 2. add the number of phys supported > 3. fix indentation of wakeup > 4. add examples for port and connector > > 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 | 278 ++++++++++++++++++ > 2 files changed, 278 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.txt b/Documentation/devicetree/bindings/usb/mediatek,mtu3.txt > deleted file mode 100644 > index a82ca438aec1..000000000000 > --- a/Documentation/devicetree/bindings/usb/mediatek,mtu3.txt > +++ /dev/null > @@ -1,108 +0,0 @@ > -The device node for Mediatek USB3.0 DRD controller > - > -Required properties: > - - compatible : should be "mediatek,-mtu3", "mediatek,mtu3", > - soc-model is the name of SoC, such as mt8173, mt2712 etc, > - when using "mediatek,mtu3" compatible string, you need SoC specific > - ones in addition, one of: > - - "mediatek,mt8173-mtu3" > - - reg : specifies physical base address and size of the registers > - - reg-names: should be "mac" for device IP and "ippc" for IP port control > - - interrupts : interrupt used by the device IP > - - power-domains : a phandle to USB power domain node to control USB's > - mtcmos > - - vusb33-supply : regulator of USB avdd3.3v > - - clocks : a list of phandle + clock-specifier pairs, one for each > - entry in clock-names > - - clock-names : must contain "sys_ck" for clock of controller, > - the following clocks are optional: > - "ref_ck", "mcu_ck" and "dma_ck"; > - - phys : see usb-hcd.yaml in the current directory > - - dr_mode : should be one of "host", "peripheral" or "otg", > - refer to usb/generic.txt > - > -Optional properties: > - - #address-cells, #size-cells : should be '2' if the device has sub-nodes > - with 'reg' property > - - ranges : allows valid 1:1 translation between child's address space and > - parent's address space > - - extcon : external connector for vbus and idpin changes detection, needed > - when supports dual-role mode. > - it's considered valid for compatibility reasons, not allowed for > - new bindings, and use "usb-role-switch" property instead. > - - vbus-supply : reference to the VBUS regulator, needed when supports > - dual-role mode. > - it's considered valid for compatibility reasons, not allowed for > - new bindings, and put into a usb-connector node. > - see connector/usb-connector.yaml. > - - pinctrl-names : a pinctrl state named "default" is optional, and need be > - defined if auto drd switch is enabled, that means the property dr_mode > - is set as "otg", and meanwhile the property "mediatek,enable-manual-drd" > - is not set. > - - pinctrl-0 : pin control group > - See: Documentation/devicetree/bindings/pinctrl/pinctrl-bindings.txt > - > - - maximum-speed : valid arguments are "super-speed", "high-speed" and > - "full-speed"; refer to usb/generic.txt > - - usb-role-switch : use USB Role Switch to support dual-role switch, but > - not extcon; see usb/generic.txt. > - - enable-manual-drd : supports manual dual-role switch via debugfs; usually > - used when receptacle is TYPE-A and also wants to support dual-role > - mode. > - - wakeup-source: enable USB remote wakeup of host mode. > - - mediatek,syscon-wakeup : phandle to syscon used to access the register > - of the USB wakeup glue layer between SSUSB and SPM; it depends on > - "wakeup-source", and has two arguments: > - - the first one : register base address of the glue layer in syscon; > - - the second one : hardware version of the glue layer > - - 1 : used by mt8173 etc > - - 2 : used by mt2712 etc > - - mediatek,u3p-dis-msk : mask to disable u3ports, bit0 for u3port0, > - bit1 for u3port1, ... etc; > - > -additionally the properties from usb-hcd.yaml (in the current directory) are > -supported. > - > -Sub-nodes: > -The xhci should be added as subnode to mtu3 as shown in the following example > -if host mode is enabled. The DT binding details of xhci can be found in: > -Documentation/devicetree/bindings/usb/mediatek,mtk-xhci.txt > - > -The port would be added as subnode if use "usb-role-switch" property. > - see graph.txt > - > -Example: > -ssusb: usb@11271000 { > - compatible = "mediatek,mt8173-mtu3"; > - reg = <0 0x11271000 0 0x3000>, > - <0 0x11280700 0 0x0100>; > - reg-names = "mac", "ippc"; > - interrupts = ; > - phys = <&phy_port0 PHY_TYPE_USB3>, > - <&phy_port1 PHY_TYPE_USB2>; > - power-domains = <&scpsys MT8173_POWER_DOMAIN_USB>; > - clocks = <&topckgen CLK_TOP_USB30_SEL>, <&clk26m>, > - <&pericfg CLK_PERI_USB0>, > - <&pericfg CLK_PERI_USB1>; > - clock-names = "sys_ck", "ref_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 = <2>; > - #size-cells = <2>; > - ranges; > - > - usb_host: xhci@11270000 { > - compatible = "mediatek,mt8173-xhci"; > - reg = <0 0x11270000 0 0x1000>; > - reg-names = "mac"; > - interrupts = ; > - 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>; > - }; > -}; > diff --git a/Documentation/devicetree/bindings/usb/mediatek,mtu3.yaml b/Documentation/devicetree/bindings/usb/mediatek,mtu3.yaml > new file mode 100644 > index 000000000000..e39850dff073 > --- /dev/null > +++ b/Documentation/devicetree/bindings/usb/mediatek,mtu3.yaml > @@ -0,0 +1,278 @@ > +# 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 > + > +allOf: > + - $ref: "usb-drd.yaml" > + > +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 Don't need maxItems here. > + 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: > + description: List of all the USB PHYs used > + minItems: 0 > + maxItems: 9 Need to define what each one is. > + > + vusb33-supply: > + description: Regulator of USB AVDD3.3v > + > + vbus-supply: > + 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: > + enum: [host, peripheral, otg] > + default: otg > + > + maximum-speed: > + 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. > + 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 > + > + 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: > + 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 > + > +additionalProperties: false > + > +examples: > + # Dual role switch by extcon > + - | > + #include > + #include > + #include > + #include > + #include > + > + usb@11271000 { > + compatible = "mediatek,mt8173-mtu3", "mediatek,mtu3"; > + reg = <0x11271000 0x3000>, <0x11280700 0x0100>; > + reg-names = "mac", "ippc"; > + interrupts = ; > + 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@11270000 { > + compatible = "mediatek,mt8173-xhci", "mediatek,mtk-xhci"; > + reg = <0x11270000 0x1000>; > + reg-names = "mac"; > + interrupts = ; > + 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>; > + }; > + }; > + > + # Enable/disable device by an input gpio for VBUS pin > + - | > + #include > + #include > + > + usb@112c1000 { > + compatible = "mediatek,mt2712-mtu3", "mediatek,mtu3"; > + reg = <0x112c1000 0x3000>, <0x112d0700 0x0100>; > + reg-names = "mac", "ippc"; > + interrupts = ; > + phys = <&u2port2 PHY_TYPE_USB2>; > + power-domains = <&scpsys MT2712_POWER_DOMAIN_USB2>; > + clocks = <&topckgen CLK_TOP_USB30_SEL>; > + clock-names = "sys_ck"; > + dr_mode = "peripheral"; > + usb-role-switch; > + > + connector { > + compatible = "gpio-usb-b-connector", "usb-b-connector"; > + type = "micro"; > + vbus-gpios = <&pio 13 GPIO_ACTIVE_HIGH>; > + }; > + }; > + > + # Dual role switch with type-c > + - | > + usb@11201000 { > + compatible ="mediatek,mt8183-mtu3", "mediatek,mtu3"; > + reg = <0x11201000 0x2e00>, <0x11203e00 0x0100>; > + reg-names = "mac", "ippc"; > + interrupts = ; > + phys = <&u2port0 PHY_TYPE_USB2>; > + clocks = <&clk26m>; > + clock-names = "sys_ck"; > + mediatek,syscon-wakeup = <&pericfg 0x400 1>; > + wakeup-source; > + dr_mode = "otg"; > + usb-role-switch; > + #address-cells = <1>; > + #size-cells = <1>; > + ranges; > + > + host: usb@11200000 { > + compatible = "mediatek,mt8183-xhci", "mediatek,mtk-xhci"; > + reg = <0x11200000 0x1000>; > + reg-names = "mac"; > + interrupts = ; > + clocks = <&clk26m>; > + clock-names = "sys_ck"; > + }; > + > + port { > + usb_role_sw: endpoint { > + remote-endpoint = <&hs_ep>; > + }; > + }; > + }; > + > +... > -- > 2.18.0 > _______________________________________________ dri-devel mailing list dri-devel@lists.freedesktop.org https://lists.freedesktop.org/mailman/listinfo/dri-devel