* [PATCH] PM: domains: fix domain_governor kernel-doc warnings
@ 2023-12-05 22:58 Randy Dunlap
2023-12-07 12:45 ` Ulf Hansson
2023-12-13 10:33 ` Ulf Hansson
0 siblings, 2 replies; 3+ messages in thread
From: Randy Dunlap @ 2023-12-05 22:58 UTC (permalink / raw)
To: linux-kernel
Cc: Randy Dunlap, Rafael J. Wysocki, Pavel Machek, Kevin Hilman,
Ulf Hansson, Greg Kroah-Hartman, linux-pm
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 <rdunlap@infradead.org>
Cc: "Rafael J. Wysocki" <rafael@kernel.org>
Cc: Pavel Machek <pavel@ucw.cz>
Cc: Kevin Hilman <khilman@kernel.org>
Cc: Ulf Hansson <ulf.hansson@linaro.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: linux-pm@vger.kernel.org
---
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,
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] PM: domains: fix domain_governor kernel-doc warnings
2023-12-05 22:58 [PATCH] PM: domains: fix domain_governor kernel-doc warnings Randy Dunlap
@ 2023-12-07 12:45 ` Ulf Hansson
2023-12-13 10:33 ` Ulf Hansson
1 sibling, 0 replies; 3+ messages in thread
From: Ulf Hansson @ 2023-12-07 12:45 UTC (permalink / raw)
To: Randy Dunlap
Cc: linux-kernel, Rafael J. Wysocki, Pavel Machek, Kevin Hilman,
Greg Kroah-Hartman, linux-pm
On Tue, 5 Dec 2023 at 23:59, Randy Dunlap <rdunlap@infradead.org> 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 <rdunlap@infradead.org>
> Cc: "Rafael J. Wysocki" <rafael@kernel.org>
> Cc: Pavel Machek <pavel@ucw.cz>
> Cc: Kevin Hilman <khilman@kernel.org>
> Cc: Ulf Hansson <ulf.hansson@linaro.org>
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Cc: linux-pm@vger.kernel.org
Reviewed-by: Ulf Hansson <ulf.hansson@linaro.org>
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,
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] PM: domains: fix domain_governor kernel-doc warnings
2023-12-05 22:58 [PATCH] PM: domains: fix domain_governor kernel-doc warnings Randy Dunlap
2023-12-07 12:45 ` Ulf Hansson
@ 2023-12-13 10:33 ` Ulf Hansson
1 sibling, 0 replies; 3+ messages in thread
From: Ulf Hansson @ 2023-12-13 10:33 UTC (permalink / raw)
To: Randy Dunlap
Cc: linux-kernel, Rafael J. Wysocki, Pavel Machek, Kevin Hilman,
Greg Kroah-Hartman, linux-pm
On Tue, 5 Dec 2023 at 23:59, Randy Dunlap <rdunlap@infradead.org> 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 <rdunlap@infradead.org>
> Cc: "Rafael J. Wysocki" <rafael@kernel.org>
> Cc: Pavel Machek <pavel@ucw.cz>
> Cc: Kevin Hilman <khilman@kernel.org>
> Cc: Ulf Hansson <ulf.hansson@linaro.org>
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Cc: linux-pm@vger.kernel.org
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,
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2023-12-13 10:34 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-12-05 22:58 [PATCH] PM: domains: fix domain_governor kernel-doc warnings Randy Dunlap
2023-12-07 12:45 ` Ulf Hansson
2023-12-13 10:33 ` Ulf Hansson
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.