[PATCH 0/5] dt-bindings: arm: idle-states: Miscellaneous improvements

[PATCH 0/5] dt-bindings: arm: idle-states: Miscellaneous improvements

[Geert Uytterhoeven]

  - Replace abbreviations "eg" and "ie" by "e.g." resp. "i.e.",
  - Correct references to wake-up delay,
  - Correct "constraints guarantees" to "constraint guarantees",
  - Add punctuation marks to improve readability,
  - Move exit-latency-us explanation to exit-latency-us section.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
Split to ease review.
Feel free to squash into a single commit.

Geert Uytterhoeven (5):
  dt-bindings: arm: idle-states: Use "e.g." and "i.e." consistently
  dt-bindings: arm: idle-states: Correct references to wake-up delay
  dt-bindings: arm: idle-states: Correct "constraint guarantees"
  dt-bindings: arm: idle-states: Add punctuation to improve readability
  dt-bindings: arm: idle-states: Move exit-latency-us explanation

 .../devicetree/bindings/arm/idle-states.txt   | 32 +++++++++----------
 1 file changed, 16 insertions(+), 16 deletions(-)

-- 
2.17.1

Gr{oetje,eeting}s,

						Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
							    -- Linus Torvalds

[PATCH 1/5] dt-bindings: arm: idle-states: Use "e.g." and "i.e." consistently

[Geert Uytterhoeven]

Replace abbreviations "eg" and "ie" by "e.g." resp. "i.e." for
consistency.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
 .../devicetree/bindings/arm/idle-states.txt      | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/Documentation/devicetree/bindings/arm/idle-states.txt b/Documentation/devicetree/bindings/arm/idle-states.txt
index 2d325bed37e53c1c..610b16c28d99c3ef 100644
--- a/Documentation/devicetree/bindings/arm/idle-states.txt
+++ b/Documentation/devicetree/bindings/arm/idle-states.txt
@@ -28,7 +28,7 @@ PM implementation to put the processor in different idle states (which include
 states listed above; "off" state is not an idle state since it does not have
 wake-up capabilities, hence it is not considered in this document).
 
-Idle state parameters (eg entry latency) are platform specific and need to be
+Idle state parameters (e.g. entry latency) are platform specific and need to be
 characterized with bindings that provide the required information to OS PM
 code so that it can build the required tables and use them at runtime.
 
@@ -90,20 +90,20 @@ These timing parameters can be used by an OS in different circumstances.
 
 An idle CPU requires the expected min-residency time to select the most
 appropriate idle state based on the expected expiry time of the next IRQ
-(ie wake-up) that causes the CPU to return to the EXEC phase.
+(i.e. wake-up) that causes the CPU to return to the EXEC phase.
 
 An operating system scheduler may need to compute the shortest wake-up delay
 for CPUs in the system by detecting how long will it take to get a CPU out
-of an idle state, eg:
+of an idle state, e.g.:
 
 wakeup-delay = exit-latency + max(entry-latency - (now - entry-timestamp), 0)
 
 In other words, the scheduler can make its scheduling decision by selecting
-(eg waking-up) the CPU with the shortest wake-up latency.
+(e.g. waking-up) the CPU with the shortest wake-up latency.
 The wake-up latency must take into account the entry latency if that period
 has not expired. The abortable nature of the PREP period can be ignored
 if it cannot be relied upon (e.g. the PREP deadline may occur much sooner than
-the worst case since it depends on the CPU operating conditions, ie caches
+the worst case since it depends on the CPU operating conditions, i.e. caches
 state).
 
 An OS has to reliably probe the wakeup-latency since some devices can enforce
@@ -183,15 +183,15 @@ and IDLE2:
 		Graph 2: idle states min-residency example
 
 In graph 2 above, that takes into account idle states entry/exit energy
-costs, it is clear that if the idle state residency time (ie time till next
+costs, it is clear that if the idle state residency time (i.e. time till next
 wake-up IRQ) is less than IDLE2-min-residency, IDLE1 is the better idle state
 choice energywise.
 
 This is mainly down to the fact that IDLE1 entry/exit energy costs are lower
 than IDLE2.
 
-However, the lower power consumption (ie shallower energy curve slope) of idle
-state IDLE2 implies that after a suitable time, IDLE2 becomes more energy
+However, the lower power consumption (i.e. shallower energy curve slope) of
+idle state IDLE2 implies that after a suitable time, IDLE2 becomes more energy
 efficient.
 
 The time at which IDLE2 becomes more energy efficient than IDLE1 (and other
-- 
2.17.1

Re: [PATCH 1/5] dt-bindings: arm: idle-states: Use "e.g." and "i.e." consistently

[Rob Herring]

On Fri, 30 Aug 2019 17:02:58 +0200, Geert Uytterhoeven wrote:
> Replace abbreviations "eg" and "ie" by "e.g." resp. "i.e." for
> consistency.
> 
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> ---
>  .../devicetree/bindings/arm/idle-states.txt      | 16 ++++++++--------
>  1 file changed, 8 insertions(+), 8 deletions(-)
> 

Applied, thanks.

Rob

[PATCH 2/5] dt-bindings: arm: idle-states: Correct references to wake-up delay

[Geert Uytterhoeven]

The paragraph explains the use of wakup-delay, as defined above.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
 Documentation/devicetree/bindings/arm/idle-states.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/devicetree/bindings/arm/idle-states.txt b/Documentation/devicetree/bindings/arm/idle-states.txt
index 610b16c28d99c3ef..6e651b7e62c328be 100644
--- a/Documentation/devicetree/bindings/arm/idle-states.txt
+++ b/Documentation/devicetree/bindings/arm/idle-states.txt
@@ -99,8 +99,8 @@ of an idle state, e.g.:
 wakeup-delay = exit-latency + max(entry-latency - (now - entry-timestamp), 0)
 
 In other words, the scheduler can make its scheduling decision by selecting
-(e.g. waking-up) the CPU with the shortest wake-up latency.
-The wake-up latency must take into account the entry latency if that period
+(e.g. waking-up) the CPU with the shortest wake-up delay.
+The wake-up delay must take into account the entry latency if that period
 has not expired. The abortable nature of the PREP period can be ignored
 if it cannot be relied upon (e.g. the PREP deadline may occur much sooner than
 the worst case since it depends on the CPU operating conditions, i.e. caches
-- 
2.17.1

Re: [PATCH 2/5] dt-bindings: arm: idle-states: Correct references to wake-up delay

[Rob Herring]

On Fri, 30 Aug 2019 17:02:59 +0200, Geert Uytterhoeven wrote:
> The paragraph explains the use of wakup-delay, as defined above.
> 
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> ---
>  Documentation/devicetree/bindings/arm/idle-states.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 

Applied, thanks.

Rob

[PATCH 3/5] dt-bindings: arm: idle-states: Correct "constraint guarantees"

[Geert Uytterhoeven]

Correct "constraints guarantees" to "constraint guarantees".

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
 Documentation/devicetree/bindings/arm/idle-states.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/devicetree/bindings/arm/idle-states.txt b/Documentation/devicetree/bindings/arm/idle-states.txt
index 6e651b7e62c328be..4ef0de5c0c7f5990 100644
--- a/Documentation/devicetree/bindings/arm/idle-states.txt
+++ b/Documentation/devicetree/bindings/arm/idle-states.txt
@@ -107,7 +107,7 @@ the worst case since it depends on the CPU operating conditions, i.e. caches
 state).
 
 An OS has to reliably probe the wakeup-latency since some devices can enforce
-latency constraints guarantees to work properly, so the OS has to detect the
+latency constraint guarantees to work properly, so the OS has to detect the
 worst case wake-up latency it can incur if a CPU is allowed to enter an
 idle state, and possibly to prevent that to guarantee reliable device
 functioning.
-- 
2.17.1

Re: [PATCH 3/5] dt-bindings: arm: idle-states: Correct "constraint guarantees"

[Rob Herring]

On Fri, 30 Aug 2019 17:03:00 +0200, Geert Uytterhoeven wrote:
> Correct "constraints guarantees" to "constraint guarantees".
> 
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> ---
>  Documentation/devicetree/bindings/arm/idle-states.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 

Applied, thanks.

Rob

[PATCH 4/5] dt-bindings: arm: idle-states: Add punctuation to improve readability

[Geert Uytterhoeven]

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
 Documentation/devicetree/bindings/arm/idle-states.txt | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/devicetree/bindings/arm/idle-states.txt b/Documentation/devicetree/bindings/arm/idle-states.txt
index 4ef0de5c0c7f5990..eb9d725be7a93f4a 100644
--- a/Documentation/devicetree/bindings/arm/idle-states.txt
+++ b/Documentation/devicetree/bindings/arm/idle-states.txt
@@ -214,8 +214,8 @@ processor idle states, defined as device tree nodes, are listed.
 
 	Usage: Optional - On ARM systems, it is a container of processor idle
 			  states nodes. If the system does not provide CPU
-			  power management capabilities or the processor just
-			  supports idle_standby an idle-states node is not
+			  power management capabilities, or the processor just
+			  supports idle_standby, an idle-states node is not
 			  required.
 
 	Description: idle-states node is a container node, where its
@@ -342,8 +342,8 @@ follows:
 			    state.
 
 	In addition to the properties listed above, a state node may require
-	additional properties specifics to the entry-method defined in the
-	idle-states node, please refer to the entry-method bindings
+	additional properties specific to the entry-method defined in the
+	idle-states node. Please refer to the entry-method bindings
 	documentation for properties definitions.
 
 ===========================================
-- 
2.17.1

Re: [PATCH 4/5] dt-bindings: arm: idle-states: Add punctuation to improve readability

[Rob Herring]

On Fri, 30 Aug 2019 17:03:01 +0200, Geert Uytterhoeven wrote:
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> ---
>  Documentation/devicetree/bindings/arm/idle-states.txt | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 

Applied, thanks.

Rob

[PATCH 5/5] dt-bindings: arm: idle-states: Move exit-latency-us explanation

[Geert Uytterhoeven]

Move exit-latency-us explanation to exit-latency-us section.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
 Documentation/devicetree/bindings/arm/idle-states.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/devicetree/bindings/arm/idle-states.txt b/Documentation/devicetree/bindings/arm/idle-states.txt
index eb9d725be7a93f4a..771f5d20ae18768c 100644
--- a/Documentation/devicetree/bindings/arm/idle-states.txt
+++ b/Documentation/devicetree/bindings/arm/idle-states.txt
@@ -287,14 +287,14 @@ follows:
 		Value type: <prop-encoded-array>
 		Definition: u32 value representing worst case latency in
 			    microseconds required to enter the idle state.
-			    The exit-latency-us duration may be guaranteed
-			    only after entry-latency-us has passed.
 
 	- exit-latency-us
 		Usage: Required
 		Value type: <prop-encoded-array>
 		Definition: u32 value representing worst case latency
 			    in microseconds required to exit the idle state.
+			    The exit-latency-us duration may be guaranteed
+			    only after entry-latency-us has passed.
 
 	- min-residency-us
 		Usage: Required
-- 
2.17.1

Re: [PATCH 5/5] dt-bindings: arm: idle-states: Move exit-latency-us explanation

[Rob Herring]

On Fri, 30 Aug 2019 17:03:02 +0200, Geert Uytterhoeven wrote:
> Move exit-latency-us explanation to exit-latency-us section.
> 
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> ---
>  Documentation/devicetree/bindings/arm/idle-states.txt | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 

Applied, thanks.

Rob

Re: [PATCH 0/5] dt-bindings: arm: idle-states: Miscellaneous improvements

[Amit Kucheria]

On Fri, Aug 30, 2019 at 8:33 PM Geert Uytterhoeven
<geert+renesas@glider.be> wrote:
>
>   - Replace abbreviations "eg" and "ie" by "e.g." resp. "i.e.",
>   - Correct references to wake-up delay,
>   - Correct "constraints guarantees" to "constraint guarantees",
>   - Add punctuation marks to improve readability,
>   - Move exit-latency-us explanation to exit-latency-us section.
>
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>

This improves the readability of the doc. So for the series, feel free to add

Reviewed-by:  Amit Kucheria <amit.kucheria@linaro.org>

> ---
> Split to ease review.
> Feel free to squash into a single commit.
>
> Geert Uytterhoeven (5):
>   dt-bindings: arm: idle-states: Use "e.g." and "i.e." consistently
>   dt-bindings: arm: idle-states: Correct references to wake-up delay
>   dt-bindings: arm: idle-states: Correct "constraint guarantees"
>   dt-bindings: arm: idle-states: Add punctuation to improve readability
>   dt-bindings: arm: idle-states: Move exit-latency-us explanation
>
>  .../devicetree/bindings/arm/idle-states.txt   | 32 +++++++++----------
>  1 file changed, 16 insertions(+), 16 deletions(-)
>
> --
> 2.17.1
>
> Gr{oetje,eeting}s,
>
>                                                 Geert
>
> --
> Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org
>
> In personal conversations with technical people, I call myself a hacker. But
> when I'm talking to journalists I just say "programmer" or something like that.
>                                                             -- Linus Torvalds

Re: [PATCH 0/5] dt-bindings: arm: idle-states: Miscellaneous improvements

[Daniel Lezcano]

On 30/08/2019 17:02, Geert Uytterhoeven wrote:
>   - Replace abbreviations "eg" and "ie" by "e.g." resp. "i.e.",
>   - Correct references to wake-up delay,
>   - Correct "constraints guarantees" to "constraint guarantees",
>   - Add punctuation marks to improve readability,
>   - Move exit-latency-us explanation to exit-latency-us section.
> 
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>

Acked-by: Daniel Lezcano <daniel.lezcano@linaro.org>

> ---
> Split to ease review.
> Feel free to squash into a single commit.
> 
> Geert Uytterhoeven (5):
>   dt-bindings: arm: idle-states: Use "e.g." and "i.e." consistently
>   dt-bindings: arm: idle-states: Correct references to wake-up delay
>   dt-bindings: arm: idle-states: Correct "constraint guarantees"
>   dt-bindings: arm: idle-states: Add punctuation to improve readability
>   dt-bindings: arm: idle-states: Move exit-latency-us explanation
> 
>  .../devicetree/bindings/arm/idle-states.txt   | 32 +++++++++----------
>  1 file changed, 16 insertions(+), 16 deletions(-)
> 


-- 
 <http://www.linaro.org/> Linaro.org │ Open source software for ARM SoCs

Follow Linaro:  <http://www.facebook.com/pages/Linaro> Facebook |
<http://twitter.com/#!/linaroorg> Twitter |
<http://www.linaro.org/linaro-blog/> Blog