Re: [PATCH v3 2/5] dt-bindings: phy: qcom,qusb2: Convert QUSB2 phy bindings to yaml

From: Rob Herring
Date: Mon Jan 13 2020 - 16:22:04 EST


On Fri, Jan 10, 2020 at 05:48:16PM +0530, Sandeep Maheswaram wrote:
> Convert QUSB2 phy bindings to DT schema format using json-schema.
>
> Signed-off-by: Sandeep Maheswaram <sanm@xxxxxxxxxxxxxx>
> ---
> .../devicetree/bindings/phy/qcom,qusb2-phy.yaml | 152 +++++++++++++++++++++
> .../devicetree/bindings/phy/qcom-qusb2-phy.txt | 68 ---------
> 2 files changed, 152 insertions(+), 68 deletions(-)
> create mode 100644 Documentation/devicetree/bindings/phy/qcom,qusb2-phy.yaml
> delete mode 100644 Documentation/devicetree/bindings/phy/qcom-qusb2-phy.txt

Fails 'make dt_binding_check':

builds/robherring/linux-dt-review/Documentation/devicetree/bindings/phy/qcom,qusb2-phy.example.dt.yaml:
phy@88e2000: 'vdda-pll-supply' is a required property
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/phy/qcom,qusb2-phy.example.dt.yaml:
phy@88e2000: 'vdda-phy-dpdm-supply' is a required property

>
> diff --git a/Documentation/devicetree/bindings/phy/qcom,qusb2-phy.yaml b/Documentation/devicetree/bindings/phy/qcom,qusb2-phy.yaml
> new file mode 100644
> index 0000000..83cd01d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/phy/qcom,qusb2-phy.yaml
> @@ -0,0 +1,152 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +
> +%YAML 1.2
> +---
> +$id: "http://devicetree.org/schemas/phy/qcom,qusb2-phy.yaml#";
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#";
> +
> +title: Qualcomm QUSB2 phy controller
> +
> +maintainers:
> + - Manu Gautam <mgautam@xxxxxxxxxxxxxx>
> +
> +description:
> + QUSB2 controller supports LS/FS/HS usb connectivity on Qualcomm chipsets.
> +
> +properties:
> + compatible:
> + anyOf:

anyOf is usually wrong. Use 'oneOf'.

> + - items:
> + - const: qcom,msm8996-qusb2-phy
> + - items:
> + - const: qcom,msm8998-qusb2-phy
> + - items:
> + - const: qcom,sc7180-qusb2-phy
> + - items:
> + - const: qcom,sdm845-qusb2-phy

These 4 can be a single enum. However, you should drop sc7180 and
sdm845. Those should match below. (Or drop the below. Just pick which
way and fixup any dts files that don't conform.)

> + - items:
> + - enum:
> + - qcom,sc7180-qusb2-phy
> + - qcom,sdm845-qusb2-phy
> + - const: qcom,qusb2-v2-phy
> +
> + reg:
> + maxItems: 1
> +
> + "#phy-cells":
> + const: 0
> +
> + clocks:
> + minItems: 2
> + items:
> + - description: phy config clock
> + - description: 19.2 MHz ref clk
> + - description: phy interface clock (Optional)
> +
> + clock-names:
> + minItems: 2
> + items:
> + - const: cfg_ahb
> + - const: ref
> + - const: iface
> +
> + vdda-pll-supply:
> + description:
> + Phandle to 1.8V regulator supply to PHY refclk pll block.
> +
> + vdda-phy-dpdm-supply:
> + description:
> + Phandle to 3.1V regulator supply to Dp/Dm port signals.
> +
> + resets:
> + maxItems: 1
> +
> + nvmem-cells:
> + maxItems: 1
> + description:
> + Phandle to nvmem cell that contains 'HS Tx trim'
> + tuning parameter value for qusb2 phy.
> +
> + qcom,tcsr-syscon:
> + description:
> + Phandle to TCSR syscon register region.
> + $ref: /schemas/types.yaml#/definitions/cell

s/cell/phandle/

> +
> + qcom,imp-res-offset-value:
> + description:
> + It is a 6 bit value that specifies offset to be
> + added to PHY refgen RESCODE via IMP_CTRL1 register. It is a PHY
> + tuning parameter that may vary for different boards of same SOC.
> + This property is applicable to only QUSB2 v2 PHY.
> + allOf:
> + - $ref: /schemas/types.yaml#/definitions/uint32
> + - minimum: 0
> + maximum: 63
> + default: 0
> +
> + qcom,hstx-trim-value:
> + description:
> + It is a 4 bit value that specifies tuning for HSTX
> + output current.
> + Possible range is - 15mA to 24mA (stepsize of 600 uA).
> + See dt-bindings/phy/phy-qcom-qusb2.h for applicable values.
> + This property is applicable to only QUSB2 v2 PHY.
> + allOf:
> + - $ref: /schemas/types.yaml#/definitions/uint32
> + - minimum: 0
> + maximum: 15
> + default: 3
> +
> + qcom,preemphasis-level:
> + description:
> + It is a 2 bit value that specifies pre-emphasis level.
> + Possible range is 0 to 15% (stepsize of 5%).
> + See dt-bindings/phy/phy-qcom-qusb2.h for applicable values.
> + This property is applicable to only QUSB2 v2 PHY.
> + allOf:
> + - $ref: /schemas/types.yaml#/definitions/uint32
> + - minimum: 0
> + maximum: 3
> + default: 2
> +
> + qcom,preemphasis-width:
> + description:
> + It is a 1 bit value that specifies how long the HSTX
> + pre-emphasis (specified using qcom,preemphasis-level) must be in
> + effect. Duration could be half-bit of full-bit.
> + See dt-bindings/phy/phy-qcom-qusb2.h for applicable values.
> + This property is applicable to only QUSB2 v2 PHY.
> + allOf:
> + - $ref: /schemas/types.yaml#/definitions/uint32
> + - minimum: 0
> + maximum: 1
> + default: 0
> +
> +required:
> + - compatible
> + - reg
> + - "#phy-cells"
> + - clocks
> + - clock-names
> + - vdda-pll-supply
> + - vdda-phy-dpdm-supply
> + - resets
> +
> +
> +examples:
> + - |
> + #include <dt-bindings/clock/qcom,gcc-sdm845.h>
> + #include <dt-bindings/clock/qcom,rpmh.h>
> + usb_1_hsphy: phy@88e2000 {
> + compatible = "qcom,sdm845-qusb2-phy";
> + reg = <0 0x088e2000 0 0x400>;
> + #phy-cells = <0>;
> +
> + clocks = <&gcc GCC_USB_PHY_CFG_AHB2PHY_CLK>,
> + <&rpmhcc RPMH_CXO_CLK>;
> + clock-names = "cfg_ahb", "ref";
> +
> + resets = <&gcc GCC_QUSB2PHY_PRIM_BCR>;
> +
> + nvmem-cells = <&qusb2p_hstx_trim>;
> + };
> diff --git a/Documentation/devicetree/bindings/phy/qcom-qusb2-phy.txt b/Documentation/devicetree/bindings/phy/qcom-qusb2-phy.txt
> deleted file mode 100644
> index fe29f9e..0000000
> --- a/Documentation/devicetree/bindings/phy/qcom-qusb2-phy.txt
> +++ /dev/null
> @@ -1,68 +0,0 @@
> -Qualcomm QUSB2 phy controller
> -=============================
> -
> -QUSB2 controller supports LS/FS/HS usb connectivity on Qualcomm chipsets.
> -
> -Required properties:
> - - compatible: compatible list, contains
> - "qcom,msm8996-qusb2-phy" for 14nm PHY on msm8996,
> - "qcom,msm8998-qusb2-phy" for 10nm PHY on msm8998,
> - "qcom,sdm845-qusb2-phy" for 10nm PHY on sdm845.
> -
> - - reg: offset and length of the PHY register set.
> - - #phy-cells: must be 0.
> -
> - - clocks: a list of phandles and clock-specifier pairs,
> - one for each entry in clock-names.
> - - clock-names: must be "cfg_ahb" for phy config clock,
> - "ref" for 19.2 MHz ref clk,
> - "iface" for phy interface clock (Optional).
> -
> - - vdda-pll-supply: Phandle to 1.8V regulator supply to PHY refclk pll block.
> - - vdda-phy-dpdm-supply: Phandle to 3.1V regulator supply to Dp/Dm port signals.
> -
> - - resets: Phandle to reset to phy block.
> -
> -Optional properties:
> - - nvmem-cells: Phandle to nvmem cell that contains 'HS Tx trim'
> - tuning parameter value for qusb2 phy.
> -
> - - qcom,tcsr-syscon: Phandle to TCSR syscon register region.
> - - qcom,imp-res-offset-value: It is a 6 bit value that specifies offset to be
> - added to PHY refgen RESCODE via IMP_CTRL1 register. It is a PHY
> - tuning parameter that may vary for different boards of same SOC.
> - This property is applicable to only QUSB2 v2 PHY (sdm845).
> - - qcom,hstx-trim-value: It is a 4 bit value that specifies tuning for HSTX
> - output current.
> - Possible range is - 15mA to 24mA (stepsize of 600 uA).
> - See dt-bindings/phy/phy-qcom-qusb2.h for applicable values.
> - This property is applicable to only QUSB2 v2 PHY (sdm845).
> - Default value is 22.2mA for sdm845.
> - - qcom,preemphasis-level: It is a 2 bit value that specifies pre-emphasis level.
> - Possible range is 0 to 15% (stepsize of 5%).
> - See dt-bindings/phy/phy-qcom-qusb2.h for applicable values.
> - This property is applicable to only QUSB2 v2 PHY (sdm845).
> - Default value is 10% for sdm845.
> -- qcom,preemphasis-width: It is a 1 bit value that specifies how long the HSTX
> - pre-emphasis (specified using qcom,preemphasis-level) must be in
> - effect. Duration could be half-bit of full-bit.
> - See dt-bindings/phy/phy-qcom-qusb2.h for applicable values.
> - This property is applicable to only QUSB2 v2 PHY (sdm845).
> - Default value is full-bit width for sdm845.
> -
> -Example:
> - hsusb_phy: phy@7411000 {
> - compatible = "qcom,msm8996-qusb2-phy";
> - reg = <0x7411000 0x180>;
> - #phy-cells = <0>;
> -
> - clocks = <&gcc GCC_USB_PHY_CFG_AHB2PHY_CLK>,
> - <&gcc GCC_RX1_USB2_CLKREF_CLK>,
> - clock-names = "cfg_ahb", "ref";
> -
> - vdda-pll-supply = <&pm8994_l12>;
> - vdda-phy-dpdm-supply = <&pm8994_l24>;
> -
> - resets = <&gcc GCC_QUSB2PHY_PRIM_BCR>;
> - nvmem-cells = <&qusb2p_hstx_trim>;
> - };
> --
> QUALCOMM INDIA, on behalf of Qualcomm Innovation Center, Inc. is a member
> of Code Aurora Forum, hosted by The Linux Foundation
>