2023-12-05 22:59:11

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH] PM: domains: fix domain_governor kernel-doc warnings

Fix kernel-doc warnings found when using "W=1".

domain_governor.c:54: warning: No description found for return value of 'default_suspend_ok'
domain_governor.c:266: warning: No description found for return value of '_default_power_down_ok'
domain_governor.c:412: warning: cannot understand function prototype: 'struct dev_power_governor pm_domain_always_on_gov = '

Signed-off-by: Randy Dunlap <[email protected]>
Cc: "Rafael J. Wysocki" <[email protected]>
Cc: Pavel Machek <[email protected]>
Cc: Kevin Hilman <[email protected]>
Cc: Ulf Hansson <[email protected]>
Cc: Greg Kroah-Hartman <[email protected]>
Cc: [email protected]
---
drivers/base/power/domain_governor.c | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)

diff -- a/drivers/base/power/domain_governor.c b/drivers/base/power/domain_governor.c
--- a/drivers/base/power/domain_governor.c
+++ b/drivers/base/power/domain_governor.c
@@ -49,6 +49,8 @@ static int dev_update_qos_constraint(str
/**
* default_suspend_ok - Default PM domain governor routine to suspend devices.
* @dev: Device to check.
+ *
+ * Returns: true if OK to suspend, false if not OK to suspend
*/
static bool default_suspend_ok(struct device *dev)
{
@@ -261,6 +263,8 @@ static bool __default_power_down_ok(stru
* @now: current ktime.
*
* This routine must be executed under the PM domain's lock.
+ *
+ * Returns: true if OK to power down, false if not OK to power down
*/
static bool _default_power_down_ok(struct dev_pm_domain *pd, ktime_t now)
{
@@ -406,8 +410,8 @@ struct dev_power_governor simple_qos_gov
.power_down_ok = default_power_down_ok,
};

-/**
- * pm_genpd_gov_always_on - A governor implementing an always-on policy
+/*
+ * pm_domain_always_on_gov - A governor implementing an always-on policy
*/
struct dev_power_governor pm_domain_always_on_gov = {
.suspend_ok = default_suspend_ok,


2023-12-07 12:46:43

by Ulf Hansson

[permalink] [raw]
Subject: Re: [PATCH] PM: domains: fix domain_governor kernel-doc warnings

On Tue, 5 Dec 2023 at 23:59, Randy Dunlap <[email protected]> wrote:
>
> Fix kernel-doc warnings found when using "W=1".
>
> domain_governor.c:54: warning: No description found for return value of 'default_suspend_ok'
> domain_governor.c:266: warning: No description found for return value of '_default_power_down_ok'
> domain_governor.c:412: warning: cannot understand function prototype: 'struct dev_power_governor pm_domain_always_on_gov = '
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: "Rafael J. Wysocki" <[email protected]>
> Cc: Pavel Machek <[email protected]>
> Cc: Kevin Hilman <[email protected]>
> Cc: Ulf Hansson <[email protected]>
> Cc: Greg Kroah-Hartman <[email protected]>
> Cc: [email protected]

Reviewed-by: Ulf Hansson <[email protected]>

Kind regards
Uffe

> ---
> drivers/base/power/domain_governor.c | 8 ++++++--
> 1 file changed, 6 insertions(+), 2 deletions(-)
>
> diff -- a/drivers/base/power/domain_governor.c b/drivers/base/power/domain_governor.c
> --- a/drivers/base/power/domain_governor.c
> +++ b/drivers/base/power/domain_governor.c
> @@ -49,6 +49,8 @@ static int dev_update_qos_constraint(str
> /**
> * default_suspend_ok - Default PM domain governor routine to suspend devices.
> * @dev: Device to check.
> + *
> + * Returns: true if OK to suspend, false if not OK to suspend
> */
> static bool default_suspend_ok(struct device *dev)
> {
> @@ -261,6 +263,8 @@ static bool __default_power_down_ok(stru
> * @now: current ktime.
> *
> * This routine must be executed under the PM domain's lock.
> + *
> + * Returns: true if OK to power down, false if not OK to power down
> */
> static bool _default_power_down_ok(struct dev_pm_domain *pd, ktime_t now)
> {
> @@ -406,8 +410,8 @@ struct dev_power_governor simple_qos_gov
> .power_down_ok = default_power_down_ok,
> };
>
> -/**
> - * pm_genpd_gov_always_on - A governor implementing an always-on policy
> +/*
> + * pm_domain_always_on_gov - A governor implementing an always-on policy
> */
> struct dev_power_governor pm_domain_always_on_gov = {
> .suspend_ok = default_suspend_ok,

2023-12-13 10:34:27

by Ulf Hansson

[permalink] [raw]
Subject: Re: [PATCH] PM: domains: fix domain_governor kernel-doc warnings

On Tue, 5 Dec 2023 at 23:59, Randy Dunlap <[email protected]> wrote:
>
> Fix kernel-doc warnings found when using "W=1".
>
> domain_governor.c:54: warning: No description found for return value of 'default_suspend_ok'
> domain_governor.c:266: warning: No description found for return value of '_default_power_down_ok'
> domain_governor.c:412: warning: cannot understand function prototype: 'struct dev_power_governor pm_domain_always_on_gov = '
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: "Rafael J. Wysocki" <[email protected]>
> Cc: Pavel Machek <[email protected]>
> Cc: Kevin Hilman <[email protected]>
> Cc: Ulf Hansson <[email protected]>
> Cc: Greg Kroah-Hartman <[email protected]>
> Cc: [email protected]

Applied for next, thanks!

Kind regards
Uffe


> ---
> drivers/base/power/domain_governor.c | 8 ++++++--
> 1 file changed, 6 insertions(+), 2 deletions(-)
>
> diff -- a/drivers/base/power/domain_governor.c b/drivers/base/power/domain_governor.c
> --- a/drivers/base/power/domain_governor.c
> +++ b/drivers/base/power/domain_governor.c
> @@ -49,6 +49,8 @@ static int dev_update_qos_constraint(str
> /**
> * default_suspend_ok - Default PM domain governor routine to suspend devices.
> * @dev: Device to check.
> + *
> + * Returns: true if OK to suspend, false if not OK to suspend
> */
> static bool default_suspend_ok(struct device *dev)
> {
> @@ -261,6 +263,8 @@ static bool __default_power_down_ok(stru
> * @now: current ktime.
> *
> * This routine must be executed under the PM domain's lock.
> + *
> + * Returns: true if OK to power down, false if not OK to power down
> */
> static bool _default_power_down_ok(struct dev_pm_domain *pd, ktime_t now)
> {
> @@ -406,8 +410,8 @@ struct dev_power_governor simple_qos_gov
> .power_down_ok = default_power_down_ok,
> };
>
> -/**
> - * pm_genpd_gov_always_on - A governor implementing an always-on policy
> +/*
> + * pm_domain_always_on_gov - A governor implementing an always-on policy
> */
> struct dev_power_governor pm_domain_always_on_gov = {
> .suspend_ok = default_suspend_ok,