diff options
author | Boris Ostrovsky <boris.ostrovsky@oracle.com> | 2016-12-15 18:00:57 +0300 |
---|---|---|
committer | Thomas Gleixner <tglx@linutronix.de> | 2016-12-15 19:48:20 +0300 |
commit | 512f09801b356c54baef62543e51169f03b2e642 (patch) | |
tree | 4c3c9cb01ccdbaf8825145ca90bd4b5856fabe14 /kernel/cpu.c | |
parent | 9bf11ecce5a2758e5a097c2f3a13d08552d0d6f9 (diff) | |
download | linux-512f09801b356c54baef62543e51169f03b2e642.tar.xz |
cpu/hotplug: Clarify description of __cpuhp_setup_state() return value
When invoked with CPUHP_AP_ONLINE_DYN state __cpuhp_setup_state()
is expected to return positive value which is the hotplug state that
the routine assigns.
Signed-off-by: Boris Ostrovsky <boris.ostrovsky@oracle.com>
Cc: linux-pm@vger.kernel.org
Cc: viresh.kumar@linaro.org
Cc: bigeasy@linutronix.de
Cc: rjw@rjwysocki.net
Cc: xen-devel@lists.xenproject.org
Link: http://lkml.kernel.org/r/1481814058-4799-2-git-send-email-boris.ostrovsky@oracle.com
Signed-off-by: Thomas Gleixner <tglx@linutronix.de>
Diffstat (limited to 'kernel/cpu.c')
-rw-r--r-- | kernel/cpu.c | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/kernel/cpu.c b/kernel/cpu.c index 217fd2e7f435..5339aca811d2 100644 --- a/kernel/cpu.c +++ b/kernel/cpu.c @@ -1586,7 +1586,11 @@ EXPORT_SYMBOL_GPL(__cpuhp_state_add_instance); * @startup: startup callback function * @teardown: teardown callback function * - * Returns 0 if successful, otherwise a proper error code + * Returns: + * On success: + * Positive state number if @state is CPUHP_AP_ONLINE_DYN + * 0 for all other states + * On failure: proper (negative) error code */ int __cpuhp_setup_state(enum cpuhp_state state, const char *name, bool invoke, |