Re: [PATCH 1/2] dt-bindings: Introduce soc sleep stats bindings for Qualcomm SoCs

From: Stephen Boyd
Date: Thu Aug 08 2019 - 12:20:09 EST


Quoting Maulik Shah (2019-08-07 23:12:27)
> Add device binding documentation for Qualcomm Technology Inc's (QTI)
> SoC sleep stats driver. The driver is used for displaying SoC sleep
> statistic maintained by Always On Processor or Resource Power Manager.
>
> Cc: devicetree@xxxxxxxxxxxxxxx
> Signed-off-by: Mahesh Sivasubramanian <msivasub@xxxxxxxxxxxxxx>
> Signed-off-by: Lina Iyer <ilina@xxxxxxxxxxxxxx>
> Signed-off-by: Maulik Shah <mkshah@xxxxxxxxxxxxxx>

Your SoB chain is odd. The author is Mahesh? Otherwise, use the
Co-Developed-by tag.

> ---
> .../bindings/soc/qcom/soc-sleep-stats.txt | 36 +++++++++++++++++++
> 1 file changed, 36 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/soc/qcom/soc-sleep-stats.txt
>
> diff --git a/Documentation/devicetree/bindings/soc/qcom/soc-sleep-stats.txt b/Documentation/devicetree/bindings/soc/qcom/soc-sleep-stats.txt
> new file mode 100644
> index 000000000000..ee40687ded34
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/soc/qcom/soc-sleep-stats.txt
> @@ -0,0 +1,36 @@
> +* SoC Sleep Stats
> +
> +Always On Processor/Resource Power Manager maintains statistics of the SoC
> +sleep modes involving lowering or powering down of the backbone rails - Cx

What is a 'backbone' rail?

> +and Mx and the oscillator clock, XO.

Drop the comma? XO is the oscillator clock.

> +
> +Statistics includes SoC sleep mode type, number of times low power mode were
> +entered, time of last entry, time of last exit and accumulated sleep duration.
> +SoC Sleep Stats driver provides sysfs interface to display this information.

Can this document be YAML? Then it can be validated.

> +
> +PROPERTIES
> +
> +- compatible:
> + Usage: required
> + Value type: <string>
> + Definition: Should be "qcom,rpmh-sleep-stats" or "qcom,rpm-sleep-stats".
> +
> +- reg:
> + Usage: required
> + Value type: <prop-encoded-array>
> + Definition: The base address on the Always On Processor or Resource Power
> + Manager from where the stats are read.
> +
> +EXAMPLE 1:
> +
> + rpmh_sleep_stats: soc-sleep-stats@c3f0000 {
> + compatible = "qcom,rpmh-sleep-stats";
> + reg = <0 0xc3f0000 0 0x400>;

Is this memory region in DDR? Or some specific IMEM location? I wonder
if it would be better to just have a pointer from the RPM node to this
memory region and then populate some stats if so.

> + };
> +