Message ID | 20190808061228.16573-2-mkshah@codeaurora.org (mailing list archive) |
---|---|
State | New, archived |
Headers | show |
Series | Introduce SoC sleep stats driver | expand |
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@vger.kernel.org > Signed-off-by: Mahesh Sivasubramanian <msivasub@codeaurora.org> > Signed-off-by: Lina Iyer <ilina@codeaurora.org> > Signed-off-by: Maulik Shah <mkshah@codeaurora.org> 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. > + }; > +
On 8/8/2019 9:50 PM, Stephen Boyd wrote: > 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@vger.kernel.org >> Signed-off-by: Mahesh Sivasubramanian <msivasub@codeaurora.org> >> Signed-off-by: Lina Iyer <ilina@codeaurora.org> >> Signed-off-by: Maulik Shah <mkshah@codeaurora.org> > Your SoB chain is odd. The author is Mahesh? Otherwise, use the > Co-Developed-by tag. corrected in v2. >> --- >> .../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? done. > >> +and Mx and the oscillator clock, XO. > Drop the comma? XO is the oscillator clock. done. > >> + >> +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. converted to YAML in v2. > >> + >> +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. Not a DDR. > >> + }; >> +
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 +and Mx and the oscillator clock, XO. + +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. + +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>; + }; + +EXAMPLE 2: + + rpm_sleep_stats: soc-sleep-stats@4690000 { + compatible = "qcom,rpm-sleep-stats"; + reg = <0 0x04690000 0 0x400>; + };