[PATCH] powercap: idle_inject: Fix the comment about play_idle

[PATCH] powercap: idle_inject: Fix the comment about play_idle

[Frank Lee]

From: Yangtao Li <tiny.windzz@gmail.com>

After commit 333cff6c963fbc ("powercap/drivers/idle_inject: Specify
idle state max latency"), we convert to use play_idle_precise() with
max allowed latency to specify the idle state.

Some function comments still use play_idle(), let's update it to
play_idle_precise().

Signed-off-by: Yangtao Li <tiny.windzz@gmail.com>
Signed-off-by: Frank Lee <frank@allwinnertech.com>
---
 drivers/powercap/idle_inject.c | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/drivers/powercap/idle_inject.c b/drivers/powercap/idle_inject.c
index c90f0990968b..597733ed86e9 100644
--- a/drivers/powercap/idle_inject.c
+++ b/drivers/powercap/idle_inject.c
@@ -19,8 +19,8 @@
  * The idle + run duration is specified via separate helpers and that allows
  * idle injection to be started.
  *
- * The idle injection kthreads will call play_idle() with the idle duration
- * specified as per the above.
+ * The idle injection kthreads will call play_idle_precise() with the idle
+ * duration and max allowed latency specified as per the above.
  *
  * After all of them have been woken up, a timer is set to start the next idle
  * injection cycle.
@@ -100,7 +100,7 @@ static void idle_inject_wakeup(struct idle_inject_device *ii_dev)
  *
  * This function is called when the idle injection timer expires.  It wakes up
  * idle injection tasks associated with the timer and they, in turn, invoke
- * play_idle() to inject a specified amount of CPU idle time.
+ * play_idle_precise() to inject a specified amount of CPU idle time.
  *
  * Return: HRTIMER_RESTART.
  */
@@ -124,8 +124,8 @@ static enum hrtimer_restart idle_inject_timer_fn(struct hrtimer *timer)
  * idle_inject_fn - idle injection work function
  * @cpu: the CPU owning the task
  *
- * This function calls play_idle() to inject a specified amount of CPU idle
- * time.
+ * This function calls play_idle_precise() to inject a specified amount of CPU
+ * idle time.
  */
 static void idle_inject_fn(unsigned int cpu)
 {
-- 
2.24.0

Re: [PATCH] powercap: idle_inject: Fix the comment about play_idle

[Rafael J. Wysocki]

On Sun, Jun 21, 2020 at 10:04 AM Frank Lee <frank@allwinnertech.com> wrote:
>
> From: Yangtao Li <tiny.windzz@gmail.com>
>
> After commit 333cff6c963fbc ("powercap/drivers/idle_inject: Specify
> idle state max latency"), we convert to use play_idle_precise() with
> max allowed latency to specify the idle state.
>
> Some function comments still use play_idle(), let's update it to
> play_idle_precise().
>
> Signed-off-by: Yangtao Li <tiny.windzz@gmail.com>
> Signed-off-by: Frank Lee <frank@allwinnertech.com>

Applied as 5.9 material under the "powercap: idle_inject: Replace
play_idle() with play_idle_precise() in comments" subject, thanks!

> ---
>  drivers/powercap/idle_inject.c | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/drivers/powercap/idle_inject.c b/drivers/powercap/idle_inject.c
> index c90f0990968b..597733ed86e9 100644
> --- a/drivers/powercap/idle_inject.c
> +++ b/drivers/powercap/idle_inject.c
> @@ -19,8 +19,8 @@
>   * The idle + run duration is specified via separate helpers and that allows
>   * idle injection to be started.
>   *
> - * The idle injection kthreads will call play_idle() with the idle duration
> - * specified as per the above.
> + * The idle injection kthreads will call play_idle_precise() with the idle
> + * duration and max allowed latency specified as per the above.
>   *
>   * After all of them have been woken up, a timer is set to start the next idle
>   * injection cycle.
> @@ -100,7 +100,7 @@ static void idle_inject_wakeup(struct idle_inject_device *ii_dev)
>   *
>   * This function is called when the idle injection timer expires.  It wakes up
>   * idle injection tasks associated with the timer and they, in turn, invoke
> - * play_idle() to inject a specified amount of CPU idle time.
> + * play_idle_precise() to inject a specified amount of CPU idle time.
>   *
>   * Return: HRTIMER_RESTART.
>   */
> @@ -124,8 +124,8 @@ static enum hrtimer_restart idle_inject_timer_fn(struct hrtimer *timer)
>   * idle_inject_fn - idle injection work function
>   * @cpu: the CPU owning the task
>   *
> - * This function calls play_idle() to inject a specified amount of CPU idle
> - * time.
> + * This function calls play_idle_precise() to inject a specified amount of CPU
> + * idle time.
>   */
>  static void idle_inject_fn(unsigned int cpu)
>  {
> --
> 2.24.0
>