Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <94ab770b-8a8a-4299-a54e-2ff77afb9e04@arm.com>
Date:   Tue, 12 Jul 2022 13:54:37 +0100
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (Windows NT 10.0; rv:91.0) Gecko/20100101
 Thunderbird/91.11.0
Subject: Re: [PATCH 4/4] dt-binding:perf: Add Amlogic DDR PMU
Content-Language: en-GB
To:     Jiucheng Xu <jiucheng.xu@amlogic.com>,
        linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org,
        linux-amlogic@lists.infradead.org, devicetree@vger.kernel.org
Cc:     Rob Herring <robh+dt@kernel.org>,
        Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>,
        Will Deacon <will@kernel.org>,
        Mark Rutland <mark.rutland@arm.com>,
        Neil Armstrong <narmstrong@baylibre.com>,
        Kevin Hilman <khilman@baylibre.com>,
        Jerome Brunet <jbrunet@baylibre.com>,
        Martin Blumenstingl <martin.blumenstingl@googlemail.com>,
        Chris Healy <cphealy@gmail.com>
References: <20220712063641.2790997-1-jiucheng.xu@amlogic.com>
 <20220712063641.2790997-4-jiucheng.xu@amlogic.com>
From:   Robin Murphy <robin.murphy@arm.com>
In-Reply-To: <20220712063641.2790997-4-jiucheng.xu@amlogic.com>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 7bit
Precedence: bulk

On 2022-07-12 07:36, Jiucheng Xu wrote:
> Add binding documentation for the Amlogic G12 series DDR
> performance monitor unit.
> 
> Signed-off-by: Jiucheng Xu <jiucheng.xu@amlogic.com>
> ---
>   .../devicetree/bindings/perf/aml-ddr-pmu.yaml | 51 +++++++++++++++++++
>   MAINTAINERS                                   |  1 +
>   2 files changed, 52 insertions(+)
>   create mode 100644 Documentation/devicetree/bindings/perf/aml-ddr-pmu.yaml
> 
> diff --git a/Documentation/devicetree/bindings/perf/aml-ddr-pmu.yaml b/Documentation/devicetree/bindings/perf/aml-ddr-pmu.yaml
> new file mode 100644
> index 000000000000..c586b4ab4009
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/perf/aml-ddr-pmu.yaml
> @@ -0,0 +1,51 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/perf/aml-ddr-pmu.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Amlogic G12 DDR performance monitor
> +
> +maintainers:
> +  - Jiucheng Xu <jiucheng.xu@amlogic.com>
> +
> +properties:
> +  compatible:
> +    oneOf:
> +      - enum:
> +          - aml,g12-ddr-pmu
> +      - items:
> +          - enum:
> +              - aml,g12-ddr-pmu
> +          - const: aml,g12-ddr-pmu

Judging by what the driver actually implements, this should probably be:

   compatible:
     items:
       - enum:
         - amlogic,g12a-ddr-pmu
         - amlogic,g12b-ddr-pmu
         - amlogic,sm1-ddr-pmu
       - const: amlogic,g12-ddr-pmu

There doesn't seem much point in allowing only the common compatible 
without a SoC-specific identifier. Note also that "aml," is not the 
documented vendor prefix.

> +
> +  reg:
> +    maxItems: 2
> +
> +  interrupts:
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - model

Remove this, and use the compatible strings properly as above.

> +  - dmc_nr
> +  - chann_nr

I suspect those could probably be inferred from the correct compatible 
string, but if not (i.e. within one SoC you have multiple PMUs 
supporting the same events but with different numbers of usable 
channels), then document what exactly they mean.

> +  - reg
> +  - interrupts
> +  - interrupt-names

As mentioned in the driver review, if you really want to use a named 
interrupt (which should usually be unnecessary when there's only one), 
it has to be a defined name. DT is not a mechanism for overriding what 
Linux shows in /proc/interrupts.

Thanks,
Robin.

> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +          ddr_pmu: ddr_pmu {
> +                  compatible = "amlogic,g12-ddr-pmu";
> +                  model = "g12a";
> +                  dmc_nr = <1>;
> +                  chann_nr = <4>;
> +                  reg = <0x0 0xff638000 0x0 0x100
> +                         0x0 0xff638c00 0x0 0x100>;
> +                  interrupts = <GIC_SPI 52 IRQ_TYPE_EDGE_RISING>;
> +                  interrupt-names = "ddr_pmu";
> +          };
> +    };
> diff --git a/MAINTAINERS b/MAINTAINERS
> index fd2a56a339b4..ac0a1df4622d 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -1055,6 +1055,7 @@ M:	Jiucheng Xu <jiucheng.xu@amlogic.com>
>   S:	Supported
>   W:	http://www.amlogic.com
>   F:	Documentation/admin-guide/perf/aml-ddr-pmu.rst
> +F:	Documentation/devicetree/bindings/perf/aml-ddr-pmu.yaml
>   F:	drivers/perf/amlogic/
>   F:	include/soc/amlogic/
>