[PATCH V2] dt-bindings: arm: Explain capacities-dmips-mhz calculations in example

[PATCH V2] dt-bindings: arm: Explain capacities-dmips-mhz calculations in example

[Viresh Kumar]

The example contains two values for the capacity currently, 446 in text
and 578 in code. The numbers are all correct but can confuse some of the
readers. This patch tries to explain how the numbers are calculated to
avoid same confusion going forward.

Acked-by: Daniel Lezcano <daniel.lezcano@linaro.org>
Signed-off-by: Viresh Kumar <viresh.kumar@linaro.org>
---
V1->V2:
- The numbers weren't incorrect in the example, just that it needs a
  bit more explanation for some people.

 Documentation/devicetree/bindings/arm/cpu-capacity.txt | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/Documentation/devicetree/bindings/arm/cpu-capacity.txt b/Documentation/devicetree/bindings/arm/cpu-capacity.txt
index 9b5685a1d15d..84262cdb8d29 100644
--- a/Documentation/devicetree/bindings/arm/cpu-capacity.txt
+++ b/Documentation/devicetree/bindings/arm/cpu-capacity.txt
@@ -59,9 +59,11 @@ mhz values (normalized w.r.t. the highest value found while parsing the DT).
 ===========================================
 
 Example 1 (ARM 64-bit, 6-cpu system, two clusters):
-capacities-dmips-mhz are scaled w.r.t. 1024 (cpu@0 and cpu@1)
-supposing cluster0@max-freq=1100 and custer1@max-freq=850,
-final capacities are 1024 for cluster0 and 446 for cluster1
+The capacities-dmips-mhz or DMIPS/MHz values (scaled to 1024)
+are 1024 and 578 for cluster0 and cluster1. Further normalization
+is done by the operating system based on cluster0@max-freq=1100 and
+custer1@max-freq=850, final capacities are 1024 for cluster0 and
+446 for cluster1 (576*850/1100).
 
 cpus {
 	#address-cells = <2>;
-- 
2.19.1.568.g152ad8e3369a

Re: [PATCH V2] dt-bindings: arm: Explain capacities-dmips-mhz calculations in example

[Rob Herring]

On Mon, Oct 29, 2018 at 03:13:05PM +0530, Viresh Kumar wrote:
> The example contains two values for the capacity currently, 446 in text
> and 578 in code. The numbers are all correct but can confuse some of the
> readers. This patch tries to explain how the numbers are calculated to
> avoid same confusion going forward.
> 
> Acked-by: Daniel Lezcano <daniel.lezcano@linaro.org>
> Signed-off-by: Viresh Kumar <viresh.kumar@linaro.org>
> ---
> V1->V2:
> - The numbers weren't incorrect in the example, just that it needs a
>   bit more explanation for some people.
> 
>  Documentation/devicetree/bindings/arm/cpu-capacity.txt | 8 +++++---
>  1 file changed, 5 insertions(+), 3 deletions(-)

Applied.