[-next] PM: domains: fix some kernel-doc issues

Message ID 20210512072515.3820032-1-yangyingliang@huawei.com
State New
Headers show
Series
  • [-next] PM: domains: fix some kernel-doc issues
Related show

Commit Message

Yang Yingliang May 12, 2021, 7:25 a.m.
Fix the following make W=1 kernel build warnings:

  drivers/base/power/domain_governor.c:259: warning: Function parameter or member 'now' not described in '_default_power_down_ok'
  drivers/base/power/domain.c:581: warning: Function parameter or member 'depth' not described in 'genpd_power_off'
  drivers/base/power/domain.c:2520: warning: Function parameter or member 'np' not described in 'of_genpd_remove_last'
  drivers/base/power/domain.c:2520: warning: Excess function parameter 'provider' description in 'of_genpd_remove_last'

Signed-off-by: Yang Yingliang <yangyingliang@huawei.com>
---
 drivers/base/power/domain.c          | 3 ++-
 drivers/base/power/domain_governor.c | 1 +
 2 files changed, 3 insertions(+), 1 deletion(-)

Comments

Rafael J. Wysocki June 8, 2021, 12:57 p.m. | #1
On Wed, May 12, 2021 at 9:22 AM Yang Yingliang <yangyingliang@huawei.com> wrote:
>

> Fix the following make W=1 kernel build warnings:

>

>   drivers/base/power/domain_governor.c:259: warning: Function parameter or member 'now' not described in '_default_power_down_ok'

>   drivers/base/power/domain.c:581: warning: Function parameter or member 'depth' not described in 'genpd_power_off'

>   drivers/base/power/domain.c:2520: warning: Function parameter or member 'np' not described in 'of_genpd_remove_last'

>   drivers/base/power/domain.c:2520: warning: Excess function parameter 'provider' description in 'of_genpd_remove_last'

>

> Signed-off-by: Yang Yingliang <yangyingliang@huawei.com>

> ---

>  drivers/base/power/domain.c          | 3 ++-

>  drivers/base/power/domain_governor.c | 1 +

>  2 files changed, 3 insertions(+), 1 deletion(-)

>

> diff --git a/drivers/base/power/domain.c b/drivers/base/power/domain.c

> index b6a782c31613..5695a641efd3 100644

> --- a/drivers/base/power/domain.c

> +++ b/drivers/base/power/domain.c

> @@ -572,6 +572,7 @@ static void genpd_queue_power_off_work(struct generic_pm_domain *genpd)

>   * RPM status of the releated device is in an intermediate state, not yet turned

>   * into RPM_SUSPENDED. This means genpd_power_off() must allow one device to not

>   * be RPM_SUSPENDED, while it tries to power off the PM domain.

> + * @depth: nesting count for lockdep.

>   *

>   * If all of the @genpd's devices have been suspended and all of its subdomains

>   * have been powered down, remove power from @genpd.

> @@ -2505,7 +2506,7 @@ EXPORT_SYMBOL_GPL(of_genpd_remove_subdomain);

>

>  /**

>   * of_genpd_remove_last - Remove the last PM domain registered for a provider

> - * @provider: Pointer to device structure associated with provider

> + * @np: Pointer to device node associated with provider

>   *

>   * Find the last PM domain that was added by a particular provider and

>   * remove this PM domain from the list of PM domains. The provider is

> diff --git a/drivers/base/power/domain_governor.c b/drivers/base/power/domain_governor.c

> index c6c218758f0b..cd08c5885190 100644

> --- a/drivers/base/power/domain_governor.c

> +++ b/drivers/base/power/domain_governor.c

> @@ -252,6 +252,7 @@ static bool __default_power_down_ok(struct dev_pm_domain *pd,

>  /**

>   * _default_power_down_ok - Default generic PM domain power off governor routine.

>   * @pd: PM domain to check.

> + * @now: current ktime.

>   *

>   * This routine must be executed under the PM domain's lock.

>   */

> --


Applied as 5.14 material, thanks!

Patch

diff --git a/drivers/base/power/domain.c b/drivers/base/power/domain.c
index b6a782c31613..5695a641efd3 100644
--- a/drivers/base/power/domain.c
+++ b/drivers/base/power/domain.c
@@ -572,6 +572,7 @@  static void genpd_queue_power_off_work(struct generic_pm_domain *genpd)
  * RPM status of the releated device is in an intermediate state, not yet turned
  * into RPM_SUSPENDED. This means genpd_power_off() must allow one device to not
  * be RPM_SUSPENDED, while it tries to power off the PM domain.
+ * @depth: nesting count for lockdep.
  *
  * If all of the @genpd's devices have been suspended and all of its subdomains
  * have been powered down, remove power from @genpd.
@@ -2505,7 +2506,7 @@  EXPORT_SYMBOL_GPL(of_genpd_remove_subdomain);
 
 /**
  * of_genpd_remove_last - Remove the last PM domain registered for a provider
- * @provider: Pointer to device structure associated with provider
+ * @np: Pointer to device node associated with provider
  *
  * Find the last PM domain that was added by a particular provider and
  * remove this PM domain from the list of PM domains. The provider is
diff --git a/drivers/base/power/domain_governor.c b/drivers/base/power/domain_governor.c
index c6c218758f0b..cd08c5885190 100644
--- a/drivers/base/power/domain_governor.c
+++ b/drivers/base/power/domain_governor.c
@@ -252,6 +252,7 @@  static bool __default_power_down_ok(struct dev_pm_domain *pd,
 /**
  * _default_power_down_ok - Default generic PM domain power off governor routine.
  * @pd: PM domain to check.
+ * @now: current ktime.
  *
  * This routine must be executed under the PM domain's lock.
  */