RE: [PATCH 1/6] dt-bindings: usb: ci-hdrc-usb2: convert to yaml
From: Peng Fan <peng.fan@nxp.com>
Date: 2022-10-12 10:57:44
Also in:
linux-devicetree, linux-usb, lkml
Subject: Re: [PATCH 1/6] dt-bindings: usb: ci-hdrc-usb2: convert to yaml On Mon, Oct 10, 2022 at 06:18:11PM +0800, Peng Fan (OSS) wrote:quoted
From: Peng Fan <peng.fan@nxp.com> Convert the binding to yaml formats/yaml/DT schema/quoted
Signed-off-by: Peng Fan <peng.fan@nxp.com> --- .../devicetree/bindings/usb/ci-hdrc-usb2.txt | 158 --------- .../devicetree/bindings/usb/ci-hdrc-usb2.yaml | 306 ++++++++++++++++++ 2 files changed, 306 insertions(+), 158 deletions(-) delete mode 100644 Documentation/devicetree/bindings/usb/ci-hdrc-usb2.txt create mode 100644 Documentation/devicetree/bindings/usb/ci-hdrc-usb2.yamlquoted
diff --git a/Documentation/devicetree/bindings/usb/ci-hdrc-usb2.yamlb/Documentation/devicetree/bindings/usb/ci-hdrc-usb2.yaml new file mode 100644 index 000000000000..1c10691c45f2--- /dev/null +++ b/Documentation/devicetree/bindings/usb/ci-hdrc-usb2.yaml@@ -0,0 +1,306 @@ +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause) %YAML 1.2 +--- +$id:+https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdeviquoted
+cetree.org%2Fschemas%2Fusb%2Fci-hdrc-usb2.yaml%23&data=05%7C01%7Cquoted
+peng.fan%40nxp.com%7Cfc258d6827034e160b4908daaab8b693%7C686ea 1d3bc2b4quoted
+c6fa92cd99c5c301635%7C0%7C0%7C638010007567431723%7CUnknown% 7CTWFpbGZsquoted
+b3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6 Mn0%3quoted
+D%7C3000%7C%7C%7C&sdata=g%2FCjkGDjScTAOc1PQg1BI9GjC%2Fg XRK5DuyHcTquoted
+NjLCZQ%3D&reserved=0 +$schema:+https://eur01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fdeviquoted
+cetree.org%2Fmeta-schemas%2Fcore.yaml%23&data=05%7C01%7Cpeng.fan%quoted
+40nxp.com%7Cfc258d6827034e160b4908daaab8b693%7C686ea1d3bc2b4c 6fa92cd9quoted
+9c5c301635%7C0%7C0%7C638010007567431723%7CUnknown%7CTWFpb GZsb3d8eyJWIquoted
+joiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7 C3000%quoted
+7C%7C%7C&sdata=s61yrkTxGglHJ7d9oL8WGD7fQYMeDDnZHi21c6Wg %2B6k%3D&aquoted
+mp;reserved=0 + +title: USB2 ChipIdea USB controller for ci13xxx Binding + +maintainers: + - Greg Kroah-Hartman [off-list ref] + +properties: + compatible: + oneOf: + - enum: + - chipidea,usb2 + - lsi,zevio-usb + - nvidia,tegra20-udc + - nvidia,tegra30-udc + - nvidia,tegra114-udc + - nvidia,tegra124-udc + - qcom,ci-hdrc + - items: + - enum: + - fsl,imx23-usb + - fsl,imx25-usb + - fsl,imx28-usb + - fsl,imx6q-usb + - fsl,imx6sl-usb + - fsl,imx6sx-usb + - fsl,imx6ul-usb + - fsl,imx7d-usb + - const: fsl,imx27-usb + - items: + - const: fsl,imx7ulp-usb + - const: fsl,imx6ul-usb + - items: + - const: lsi,zevio-usb + - items: + - const: xlnx,zynq-usb-2.20a + - const: chipidea,usb2 + reg: + maxItems: 1 + + interrupts: + maxItems: 1 + + clocks: + maxItems: 2 + + itc-setting: + description: + interrupt threshold control register control, the setting should be + aligned with ITC bits at register USBCMD. + $ref: /schemas/types.yaml#/definitions/uint32 + + ahb-burst-config: + description: + it is vendor dependent, the required value should be aligned with + AHBBRST at SBUSCFG, the range is from 0x0 to 0x7. This property is + used to change AHB burst configuration, check the chipidea spec for + meaning of each value. If this property is not existed, it will use + the reset value. + $ref: /schemas/types.yaml#/definitions/uint32 + minimum: 0x0 + maximum: 0x7 + + tx-burst-size-dword: + description: + it is vendor dependent, the tx burst size in dword (4 bytes), This + register represents the maximum length of a the burst in 32-bit + words while moving data from system memory to the USB bus, thevaluequoted
+ of this property will only take effect if property "ahb-burst-config" + is set to 0, if this property is missing the reset default of the + hardware implementation will be used. + $ref: /schemas/types.yaml#/definitions/uint32 + + rx-burst-size-dword: + description: + it is vendor dependent, the rx burst size in dword (4 bytes), This + register represents the maximum length of a the burst in 32-bit words + while moving data from the USB bus to system memory, the value of + this property will only take effect if property "ahb-burst-config" + is set to 0, if this property is missing the reset default of the + hardware implementation will be used. + $ref: /schemas/types.yaml#/definitions/uint32 + + extcon: + description: | + Phandles to external connector devices. First phandle should point + to external connector, which provide "USB" cable events, the second + should point to external connector device, which provide "USB-HOST" + cable events. If one of the external connector devices is not + required, empty <0> phandle should be specified. + + phy-clkgate-delay-us: + description: | + The delay time (us) between putting the PHY into low power modeandquoted
+ gating the PHY clock. + + non-zero-ttctrl-ttha: + description: | + After setting this property, the value of register ttctrl.ttha + will be 0x7f; if not, the value will be 0x0, this is the default + value. It needs to be very carefully for setting this property, it + is recommended that consult with your IC engineer before setting + this value. On the most of chipidea platforms, the "usage_tt" flag + at RTL is 0, so this property only affects siTD. + + If this property is not set, the max packet size is 1023 bytes, and + if the total of packet size for pervious transactions are more than + 256 bytes, it can't accept any transactions within this frame. The + use case is single transaction, but higher frame rate. + + If this property is set, the max packet size is 188 bytes, it can + handle more transactions than above case, it can accept transactions + until it considers the left room size within frame is less than 188 + bytes, software needs to make sure it does not send more than 90% + maximum_periodic_data_per_frame. The use case is multiple + transactions, but less frame rate. + + mux-controls: + description: | + The mux control for toggling host/device output of this controller. + It's expected that a mux state of 0 indicates device mode and a mux + state of 1 indicates host mode. + + mux-control-names: + description: Shall be "usb_switch" if mux-controls is specified. + + pinctrl-names: + description: | + Names for optional pin modes in "default", "host", "device". + In case of HSIC-mode, "idle" and "active" pin modes are mandatory. + In this case, the "idle" state needs to pull down the data and + strobe pin and the "active" state needs to pull up the strobe pin. + + pinctrl-0: + maxItems: 1 + + pinctrl-1: + maxItems: 1 + + phys: + maxItems: 1 + + phy-names: + const: usb-phy + + vbus-supply: + description: reference to the VBUS regulator. + +required: + - compatible + - reg + - interrupts + +allOf: + - $ref: usb-drd.yaml# + - $ref: usb-hcd.yaml# + - if: + properties: + mux-controls: + true + then: + properties: + mux-control-names: + const: usb_switch + - if: + properties: + phy_type: + const: hsic + + required: + - phy_type + then: + properties: + pinctrl-names: + items: + - const: idle + - const: active + else: + properties: + pinctrl-names: + oneOf: + - items: + - const: default + - enum: + - host + - device + - items: + - const: default + - if: + properties: + compatible: + enum: + - fsl,imx23-usb + - fsl,imx25-usb + - fsl,imx27-usb + - fsl,imx28-usb + - fsl,imx6q-usb + - fsl,imx6sl-usb + - fsl,imx6sx-usb + - fsl,imx6ul-usb + - fsl,imx7d-usb + - fsl,imx7ulp-usb + then: + properties: + fsl,usbmisc: + description: + Phandler of non-core register device, with one argument that + indicate usb controller indextype ref? Don't define properties within if/then/else. Define at top level and then restrict presence in the if/then schema.quoted
+ + disable-over-current: + description: disable over current detect + + over-current-active-low: + description: over current signal polarity is active low + + over-current-active-high: + description: | + Over current signal polarity is active high. It's recommended to + specify the over current polarity. + + power-active-high: + description: power signal polarity is active high + + external-vbus-divider: + description: enables off-chip resistor divider for Vbus + + samsung,picophy-pre-emp-curr-control: + description: | + HS Transmitter Pre-Emphasis Current Control. This signal controls + the amount of current sourced to the USB_OTG*_DP andUSB_OTG*_DNquoted
+ pins after a J-to-K or K-to-J transition. The range is from 0x0 to + 0x3, the default value is 0x1. Details can refer toTXPREEMPAMPTUNE0quoted
+ bits of USBNC_n_PHY_CFG1. + $ref: /schemas/types.yaml#/definitions/uint32 + minimum: 0x0 + maximum: 0x3 + + samsung,picophy-dc-vol-level-adjust: + description: | + HS DC Voltage Level Adjustment. Adjust the high-speed transmitterDCquoted
+ level voltage. The range is from 0x0 to 0xf, the default value is + 0x3. Details can refer to TXVREFTUNE0 bits of USBNC_n_PHY_CFG1. + $ref: /schemas/types.yaml#/definitions/uint32 + minimum: 0x0 + maximum: 0xf + +additionalProperties: trueCannot be true.quoted
+ +examples: + - | + #include <dt-bindings/interrupt-controller/arm-gic.h> + #include <dt-bindings/clock/berlin2.h> + + usb@f7ed0000 { + compatible = "chipidea,usb2";Doesn't match documentation. You should know by now to test your bindings.
I am not very clear on this. Could you please share more info? Thanks, Peng.
quoted
+ reg = <0xf7ed0000 0x10000>; + interrupts = <GIC_SPI 11 IRQ_TYPE_LEVEL_HIGH>; + clocks = <&chip CLKID_USB0>; + phys = <&usb_phy0>; + phy-names = "usb-phy"; + vbus-supply = <®_usb0_vbus>; + itc-setting = <0x4>; /* 4 micro-frames */ + /* Incremental burst of unspecified length */ + ahb-burst-config = <0x0>; + tx-burst-size-dword = <0x10>; /* 64 bytes */ + rx-burst-size-dword = <0x10>; + extcon = <0>, <&usb_id>; + phy-clkgate-delay-us = <400>; + mux-controls = <&usb_switch>; + mux-control-names = "usb_switch"; + }; + + # Example for HSIC: + - | + #include <dt-bindings/interrupt-controller/arm-gic.h> + #include <dt-bindings/clock/imx6qdl-clock.h> + + usb@2184400 { + compatible = "fsl,imx6q-usb", "fsl,imx27-usb"; + reg = <0x02184400 0x200>; + interrupts = <0 41 IRQ_TYPE_LEVEL_HIGH>; + clocks = <&clks IMX6QDL_CLK_USBOH3>; + fsl,usbphy = <&usbphynop1>; + fsl,usbmisc = <&usbmisc 2>; + phy_type = "hsic"; + dr_mode = "host"; + ahb-burst-config = <0x0>; + tx-burst-size-dword = <0x10>; + rx-burst-size-dword = <0x10>; + pinctrl-names = "idle", "active"; + pinctrl-0 = <&pinctrl_usbh2_idle>; + pinctrl-1 = <&pinctrl_usbh2_active>; + #address-cells = <1>; + #size-cells = <0>; + + usbnet: ethernet@1 { + compatible = "usb424,9730"; + reg = <1>; + }; + }; + +... -- 2.37.1
_______________________________________________ linux-arm-kernel mailing list linux-arm-kernel@lists.infradead.org http://lists.infradead.org/mailman/listinfo/linux-arm-kernel