[v10,1/5] dt-bindings: Introduce SoC sleep stats bindings

Commit Message

Maulik Shah Oct. 5, 2021, 9:11 a.m. UTC

From: Mahesh Sivasubramanian <[e-mail]>

Add device binding documentation for Qualcomm Technologies, Inc. (QTI)
SoC sleep stats driver. The driver is used for displaying SoC sleep
statistic maintained by Always On Processor or Resource Power Manager.

Cc: [e-mail]
Signed-off-by: Mahesh Sivasubramanian <[e-mail]>
Signed-off-by: Lina Iyer <[e-mail]>
Signed-off-by: Maulik Shah <[e-mail]>
Reviewed-by: Rob Herring <[e-mail]>
Reviewed-by: Bjorn Andersson <[e-mail]>
Reviewed-by: Stephen Boyd <[e-mail]>
---
 .../bindings/soc/qcom/soc-sleep-stats.yaml         | 47 ++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/soc/qcom/soc-sleep-stats.yaml

Comments

Rob Herring Oct. 5, 2021, 12:26 p.m. UTC | #1

On Tue, 05 Oct 2021 14:41:01 +0530, Maulik Shah wrote:
> From: Mahesh Sivasubramanian <[e-mail]>
> 
> Add device binding documentation for Qualcomm Technologies, Inc. (QTI)
> SoC sleep stats driver. The driver is used for displaying SoC sleep
> statistic maintained by Always On Processor or Resource Power Manager.
> 
> Cc: [e-mail]
> Signed-off-by: Mahesh Sivasubramanian <[e-mail]>
> Signed-off-by: Lina Iyer <[e-mail]>
> Signed-off-by: Maulik Shah <[e-mail]>
> Reviewed-by: Rob Herring <[e-mail]>
> Reviewed-by: Bjorn Andersson <[e-mail]>
> Reviewed-by: Stephen Boyd <[e-mail]>
> ---
>  .../bindings/soc/qcom/soc-sleep-stats.yaml         | 47 ++++++++++++++++++++++
>  1 file changed, 47 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/soc/qcom/soc-sleep-stats.yaml
> 

My bot found errors running 'make DT_CHECKER_FLAGS=-m dt_binding_check'
on your patch (DT_CHECKER_FLAGS is new in v5.13):

yamllint warnings/errors:

dtschema/dtc warnings/errors:
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/soc/qcom/soc-sleep-stats.example.dt.yaml: memory@c3f0000: 'device_type' is a required property
	From schema: /usr/local/lib/python3.8/dist-packages/dtschema/schemas/memory.yaml
/builds/robherring/linux-dt-review/Documentation/devicetree/bindings/soc/qcom/soc-sleep-stats.example.dt.yaml: memory@4690000: 'device_type' is a required property
	From schema: /usr/local/lib/python3.8/dist-packages/dtschema/schemas/memory.yaml

doc reference errors (make refcheckdocs):

See https://patchwork.ozlabs.org/patch/1536587

This check can fail if there are any dependencies. The base for a patch
series is generally the most recent rc1.

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure 'yamllint' is installed and dt-schema is up to
date:

pip3 install dtschema --upgrade

Please check and re-submit.

Bjorn Andersson Oct. 5, 2021, 4:01 p.m. UTC | #2

On Tue 05 Oct 02:11 PDT 2021, Maulik Shah wrote:

> From: Mahesh Sivasubramanian <[e-mail]>
> 
> Add device binding documentation for Qualcomm Technologies, Inc. (QTI)
> SoC sleep stats driver. The driver is used for displaying SoC sleep
> statistic maintained by Always On Processor or Resource Power Manager.
> 
> Cc: [e-mail]
> Signed-off-by: Mahesh Sivasubramanian <[e-mail]>
> Signed-off-by: Lina Iyer <[e-mail]>
> Signed-off-by: Maulik Shah <[e-mail]>
> Reviewed-by: Rob Herring <[e-mail]>
> Reviewed-by: Bjorn Andersson <[e-mail]>
> Reviewed-by: Stephen Boyd <[e-mail]>
> ---
>  .../bindings/soc/qcom/soc-sleep-stats.yaml         | 47 ++++++++++++++++++++++
>  1 file changed, 47 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/soc/qcom/soc-sleep-stats.yaml
> 
> diff --git a/Documentation/devicetree/bindings/soc/qcom/soc-sleep-stats.yaml b/Documentation/devicetree/bindings/soc/qcom/soc-sleep-stats.yaml
> new file mode 100644
> index 0000000..e50be2d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/soc/qcom/soc-sleep-stats.yaml
> @@ -0,0 +1,47 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/soc/qcom/soc-sleep-stats.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Qualcomm Technologies, Inc. (QTI) SoC sleep stats bindings
> +
> +maintainers:
> +  - Maulik Shah <[e-mail]>
> +
> +description:
> +  Always On Processor/Resource Power Manager maintains statistics of the SoC
> +  sleep modes involving powering down of the rails and 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.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - qcom,rpmh-sleep-stats
> +      - qcom,rpm-sleep-stats
> +
> +  reg:
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +examples:
> +  # Example of rpmh sleep stats
> +  - |
> +    memory@c3f0000 {

As noted by Rob's bot, "memory" is reserved to describe system ram. I
think we can call this "sram@" instead.

Regards,
Bjorn

> +      compatible = "qcom,rpmh-sleep-stats";
> +      reg = <0x0c3f0000 0x400>;
> +    };
> +  # Example of rpm sleep stats
> +  - |
> +    memory@4690000 {
> +      compatible = "qcom,rpm-sleep-stats";
> +      reg = <0x04690000 0x400>;
> +    };
> +...
> -- 
> QUALCOMM INDIA, on behalf of Qualcomm Innovation Center, Inc. is a member
> of Code Aurora Forum, hosted by The Linux Foundation
>

Maulik Shah Oct. 6, 2021, 3:14 p.m. UTC | #3

Hi,

On 10/5/2021 9:31 PM, Bjorn Andersson wrote:
> On Tue 05 Oct 02:11 PDT 2021, Maulik Shah wrote:
> 
>> From: Mahesh Sivasubramanian <[e-mail]>
>>
>> Add device binding documentation for Qualcomm Technologies, Inc. (QTI)
>> SoC sleep stats driver. The driver is used for displaying SoC sleep
>> statistic maintained by Always On Processor or Resource Power Manager.
>>
>> Cc: [e-mail]
>> Signed-off-by: Mahesh Sivasubramanian <[e-mail]>
>> Signed-off-by: Lina Iyer <[e-mail]>
>> Signed-off-by: Maulik Shah <[e-mail]>
>> Reviewed-by: Rob Herring <[e-mail]>
>> Reviewed-by: Bjorn Andersson <[e-mail]>
>> Reviewed-by: Stephen Boyd <[e-mail]>
>> ---
>>   .../bindings/soc/qcom/soc-sleep-stats.yaml         | 47 ++++++++++++++++++++++
>>   1 file changed, 47 insertions(+)
>>   create mode 100644 Documentation/devicetree/bindings/soc/qcom/soc-sleep-stats.yaml
>>
>> diff --git a/Documentation/devicetree/bindings/soc/qcom/soc-sleep-stats.yaml b/Documentation/devicetree/bindings/soc/qcom/soc-sleep-stats.yaml
>> new file mode 100644
>> index 0000000..e50be2d
>> --- /dev/null
>> +++ b/Documentation/devicetree/bindings/soc/qcom/soc-sleep-stats.yaml
>> @@ -0,0 +1,47 @@
>> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> +%YAML 1.2
>> +---
>> +$id: http://devicetree.org/schemas/soc/qcom/soc-sleep-stats.yaml#
>> +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> +
>> +title: Qualcomm Technologies, Inc. (QTI) SoC sleep stats bindings
>> +
>> +maintainers:
>> +  - Maulik Shah <[e-mail]>
>> +
>> +description:
>> +  Always On Processor/Resource Power Manager maintains statistics of the SoC
>> +  sleep modes involving powering down of the rails and 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.
>> +
>> +properties:
>> +  compatible:
>> +    enum:
>> +      - qcom,rpmh-sleep-stats
>> +      - qcom,rpm-sleep-stats
>> +
>> +  reg:
>> +    maxItems: 1
>> +
>> +required:
>> +  - compatible
>> +  - reg
>> +
>> +additionalProperties: false
>> +
>> +examples:
>> +  # Example of rpmh sleep stats
>> +  - |
>> +    memory@c3f0000 {
> 
> As noted by Rob's bot, "memory" is reserved to describe system ram. I
> think we can call this "sram@" instead.
> 
> Regards,
> Bjorn

Updated in v11 to use sram.

Thanks,
Maulik

> 
>> +      compatible = "qcom,rpmh-sleep-stats";
>> +      reg = <0x0c3f0000 0x400>;
>> +    };
>> +  # Example of rpm sleep stats
>> +  - |
>> +    memory@4690000 {
>> +      compatible = "qcom,rpm-sleep-stats";
>> +      reg = <0x04690000 0x400>;
>> +    };
>> +...
>> -- 
>> QUALCOMM INDIA, on behalf of Qualcomm Innovation Center, Inc. is a member
>> of Code Aurora Forum, hosted by The Linux Foundation
>>

Patch

diff --git a/Documentation/devicetree/bindings/soc/qcom/soc-sleep-stats.yaml b/Documentation/devicetree/bindings/soc/qcom/soc-sleep-stats.yaml
new file mode 100644
index 0000000..e50be2d
--- /dev/null
+++ b/Documentation/devicetree/bindings/soc/qcom/soc-sleep-stats.yaml
@@ -0,0 +1,47 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/soc/qcom/soc-sleep-stats.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Qualcomm Technologies, Inc. (QTI) SoC sleep stats bindings
+
+maintainers:
+  - Maulik Shah <[e-mail]>
+
+description:
+  Always On Processor/Resource Power Manager maintains statistics of the SoC
+  sleep modes involving powering down of the rails and 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.
+
+properties:
+  compatible:
+    enum:
+      - qcom,rpmh-sleep-stats
+      - qcom,rpm-sleep-stats
+
+  reg:
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  # Example of rpmh sleep stats
+  - |
+    memory@c3f0000 {
+      compatible = "qcom,rpmh-sleep-stats";
+      reg = <0x0c3f0000 0x400>;
+    };
+  # Example of rpm sleep stats
+  - |
+    memory@4690000 {
+      compatible = "qcom,rpm-sleep-stats";
+      reg = <0x04690000 0x400>;
+    };
+...