Re: [PATCH v3 07/15] dt-bindings: thermal: tsens: Convert over to a yaml schema

[Rob Herring <robh@kernel.org>]

On Wed, Sep 11, 2019 at 12:46:24PM +0530, Amit Kucheria wrote:
> Document interrupt support in the tsens driver by converting over to a
> YAML schema.
> 
> Suggested-by: Stephen Boyd <swboyd@chromium.org>
> Signed-off-by: Amit Kucheria <amit.kucheria@linaro.org>
> ---
>  .../bindings/thermal/qcom-tsens.txt           |  55 ------
>  .../bindings/thermal/qcom-tsens.yaml          | 174 ++++++++++++++++++
>  MAINTAINERS                                   |   1 +
>  3 files changed, 175 insertions(+), 55 deletions(-)
>  delete mode 100644 Documentation/devicetree/bindings/thermal/qcom-tsens.txt
>  create mode 100644 Documentation/devicetree/bindings/thermal/qcom-tsens.yaml


> diff --git a/Documentation/devicetree/bindings/thermal/qcom-tsens.yaml b/Documentation/devicetree/bindings/thermal/qcom-tsens.yaml
> new file mode 100644
> index 000000000000..6784766fe58f
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/thermal/qcom-tsens.yaml
> @@ -0,0 +1,174 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR MIT)
> +# Copyright 2019 Linaro Ltd.
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/thermal/qcom-tsens.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: QCOM SoC Temperature Sensor (TSENS)
> +
> +maintainers:
> +  - Amit Kucheria <amit.kucheria@linaro.org>
> +
> +description: |
> +  QCOM SoCs have TSENS IP to allow temperature measurement. There are currently
> +  three distinct major versions of the IP that is supported by a single driver.
> +  The IP versions are named v0.1, v1 and v2 in the driver, where v0.1 captures
> +  everything before v1 when there was no versioning information.
> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - description: v0.1 of TSENS
> +        items:
> +          - enum:
> +              - qcom,msm8916-tsens
> +              - qcom,msm8974-tsens
> +          - const: qcom,tsens-v0_1
> +
> +      - description: v1 of TSENS
> +        items:
> +          - enum:
> +              - qcom,qcs404-tsens
> +          - const: qcom,tsens-v1
> +
> +      - description: v2 of TSENS
> +        items:
> +          - enum:
> +              - qcom,msm8996-tsens
> +              - qcom,msm8998-tsens
> +              - qcom,sdm845-tsens
> +          - const: qcom,tsens-v2
> +
> +  reg:
> +    maxItems: 2
> +    items:
> +      - description: TM registers
> +      - description: SROT registers
> +
> +  nvmem-cells:
> +    minItems: 1
> +    maxItems: 2
> +    description:
> +      Reference to an nvmem node for the calibration data
> +
> +  nvmem-cells-names:

This is going to require 2 items, so you need an explicit minItems and 
maxItems.

> +    items:
> +      - enum:
> +        - caldata
> +        - calsel
> +
> +  "#qcom,sensors":
> +    allOf:
> +      - $ref: /schemas/types.yaml#/definitions/uint32
> +      - minimum: 1
> +      - maximum: 16
> +    description:
> +      Number of sensors enabled on this platform
> +
> +  "#thermal-sensor-cells":
> +    const: 1
> +    description:
> +      Number of cells required to uniquely identify the thermal sensors. Since
> +      we have multiple sensors this is set to 1
> +
> +allOf:
> +  - if:
> +      properties:
> +        compatible:
> +          contains:
> +            enum:
> +              - qcom,msm8916-tsens
> +              - qcom,msm8974-tsens
> +              - qcom,qcs404-tsens
> +              - qcom,tsens-v0_1
> +              - qcom,tsens-v1
> +    then:
> +      properties:
> +        interrupts:

> +          minItems: 1
> +          maxItems: 1

These can be implicit.

> +          items:
> +            - description: Combined interrupt if upper or lower threshold crossed
> +        interrupt-names:
> +          minItems: 1
> +          maxItems: 1

ditto.

> +          items:
> +            - const: uplow
> +
> +    else:
> +      properties:
> +        interrupts:
> +          minItems: 2
> +          maxItems: 2

ditto.

> +          items:
> +            - description: Combined interrupt if upper or lower threshold crossed
> +            - description: Interrupt if critical threshold crossed
> +        interrupt-names:
> +          minItems: 2
> +          maxItems: 2

ditto.

> +          items:
> +            - const: uplow
> +            - const: critical
> +
> +required:
> +  - compatible
> +  - reg
> +  - "#qcom,sensors"
> +  - interrupts
> +  - interrupt-names
> +  - "#thermal-sensor-cells"
> +
> +examples:
> +  - |
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +    // Example 1 (legacy: for pre v1 IP):
> +    tsens1: thermal-sensor@900000 {
> +           compatible = "qcom,msm8916-tsens", "qcom,tsens-v0_1";
> +           reg = <0x4a9000 0x1000>, /* TM */
> +                 <0x4a8000 0x1000>; /* SROT */
> +
> +           nvmem-cells = <&tsens_caldata>, <&tsens_calsel>;
> +           nvmem-cell-names = "caldata", "calsel";
> +
> +           interrupts = <GIC_SPI 184 IRQ_TYPE_LEVEL_HIGH>;
> +           interrupt-names = "uplow";
> +
> +           #qcom,sensors = <5>;
> +           #thermal-sensor-cells = <1>;
> +    };
> +
> +  - |
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +    // Example 2 (for any platform containing v1 of the TSENS IP):
> +    tsens2: thermal-sensor@4a9000 {
> +          compatible = "qcom,qcs404-tsens", "qcom,tsens-v1";
> +          reg = <0x004a9000 0x1000>, /* TM */
> +                <0x004a8000 0x1000>; /* SROT */
> +
> +          nvmem-cells = <&tsens_caldata>;
> +          nvmem-cell-names = "calib";
> +
> +          interrupts = <GIC_SPI 506 IRQ_TYPE_LEVEL_HIGH>;
> +          interrupt-names = "uplow";
> +
> +          #qcom,sensors = <10>;
> +          #thermal-sensor-cells = <1>;
> +    };
> +
> +  - |
> +    #include <dt-bindings/interrupt-controller/arm-gic.h>
> +    // Example 3 (for any platform containing v2 of the TSENS IP):
> +    tsens3: thermal-sensor@c263000 {
> +           compatible = "qcom,sdm845-tsens", "qcom,tsens-v2";
> +           reg = <0xc263000 0x1ff>,
> +                 <0xc222000 0x1ff>;
> +
> +           interrupts = <GIC_SPI 506 IRQ_TYPE_LEVEL_HIGH>,
> +                        <GIC_SPI 508 IRQ_TYPE_LEVEL_HIGH>;
> +           interrupt-names = "uplow", "critical";
> +
> +           #qcom,sensors = <13>;
> +           #thermal-sensor-cells = <1>;
> +    };
> +...
> diff --git a/MAINTAINERS b/MAINTAINERS
> index e7a47b5210fd..ff757a4a060c 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -13360,6 +13360,7 @@ L:	linux-pm@vger.kernel.org
>  L:	linux-arm-msm@vger.kernel.org
>  S:	Maintained
>  F:	drivers/thermal/qcom/
> +F:	Documentation/devicetree/bindings/thermal/qcom-tsens.yaml
>  
>  QUALCOMM VENUS VIDEO ACCELERATOR DRIVER
>  M:	Stanimir Varbanov <stanimir.varbanov@linaro.org>
> -- 
> 2.17.1
>