[PATCH v4 01/19] docs: thermal: convert cpu-idle-cooling.rst to ReST

From: Mauro Carvalho Chehab
Date: Thu Apr 30 2020 - 12:18:49 EST


Despite being named with .rst extension, this file doesn't
match the ReST standard. It actually causes a crash at
Sphinx:

Sphinx parallel build error:
docutils.utils.SystemMessage: /devel/v4l/docs/Documentation/driver-api/thermal/cpu-idle-cooling.rst:69: (SEVERE/4) Unexpected section title.

Add needed markups for it to be properly parsed.

While here, add it to the thermal index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
---
.../driver-api/thermal/cpu-idle-cooling.rst | 18 ++++++++++++------
Documentation/driver-api/thermal/index.rst | 1 +
2 files changed, 13 insertions(+), 6 deletions(-)

diff --git a/Documentation/driver-api/thermal/cpu-idle-cooling.rst b/Documentation/driver-api/thermal/cpu-idle-cooling.rst
index a1c3edecae00..b5a4544af004 100644
--- a/Documentation/driver-api/thermal/cpu-idle-cooling.rst
+++ b/Documentation/driver-api/thermal/cpu-idle-cooling.rst
@@ -1,3 +1,9 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+================
+CPU Idle Cooling
+================
+

Situation:
----------
@@ -45,7 +51,7 @@ idle state target residency, we lead to dropping the static and the
dynamic leakage for this period (modulo the energy needed to enter
this state). So the sustainable power with idle cycles has a linear
relation with the OPPâs sustainable power and can be computed with a
-coefficient similar to:
+coefficient similar to::

Power(IdleCycle) = Coef x Power(OPP)

@@ -136,7 +142,7 @@ Power considerations
--------------------

When we reach the thermal trip point, we have to sustain a specified
-power for a specific temperature but at this time we consume:
+power for a specific temperature but at this time we consume::

Power = Capacitance x Voltage^2 x Frequency x Utilisation

@@ -145,7 +151,7 @@ wrong in the system setup). The âCapacitanceâ and âUtilisationâ are a
fixed value, âVoltageâ and the âFrequencyâ are fixed artificially
because we donât want to change the OPP. We can group the
âCapacitanceâ and the âUtilisationâ into a single term which is the
-âDynamic Power Coefficient (Cdyn)â Simplifying the above, we have:
+âDynamic Power Coefficient (Cdyn)â Simplifying the above, we have::

Pdyn = Cdyn x Voltage^2 x Frequency

@@ -154,7 +160,7 @@ in order to target the sustainable power defined in the device
tree. So with the idle injection mechanism, we want an average power
(Ptarget) resulting in an amount of time running at full power on a
specific OPP and idle another amount of time. That could be put in a
-equation:
+equation::

P(opp)target = ((Trunning x (P(opp)running) + (Tidle x P(opp)idle)) /
(Trunning + Tidle)
@@ -165,7 +171,7 @@ equation:

At this point if we know the running period for the CPU, that gives us
the idle injection we need. Alternatively if we have the idle
-injection duration, we can compute the running duration with:
+injection duration, we can compute the running duration with::

Trunning = Tidle / ((P(opp)running / P(opp)target) - 1)

@@ -188,7 +194,7 @@ However, in this demonstration we ignore three aspects:
target residency, otherwise we end up consuming more energy and
potentially invert the mitigation effect

-So the final equation is:
+So the final equation is::

Trunning = (Tidle - Twakeup ) x
(((P(opp)dyn + P(opp)static ) - P(opp)target) / P(opp)target )
diff --git a/Documentation/driver-api/thermal/index.rst b/Documentation/driver-api/thermal/index.rst
index 5ba61d19c6ae..4cb0b9b6bfb8 100644
--- a/Documentation/driver-api/thermal/index.rst
+++ b/Documentation/driver-api/thermal/index.rst
@@ -8,6 +8,7 @@ Thermal
:maxdepth: 1

cpu-cooling-api
+ cpu-idle-cooling
sysfs-api
power_allocator

--
2.25.4