summaryrefslogtreecommitdiff
path: root/kernel
diff options
context:
space:
mode:
authorRafael J. Wysocki <rafael.j.wysocki@intel.com>2025-09-09 13:44:14 +0200
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2025-10-15 12:00:02 +0200
commit372a5b01da506433a8b39b02fcdc6446f29cc1a2 (patch)
treed8b1b1520bb3c710a210dbed1f61cb72208f1a6c /kernel
parent76e53c74f1168ed2bf3f7c2f2b24ad566a262c72 (diff)
downloadlinux-372a5b01da506433a8b39b02fcdc6446f29cc1a2.tar.gz
linux-372a5b01da506433a8b39b02fcdc6446f29cc1a2.tar.bz2
linux-372a5b01da506433a8b39b02fcdc6446f29cc1a2.zip
smp: Fix up and expand the smp_call_function_many() kerneldoc
[ Upstream commit ccf09357ffef2ab472369ab9cdf470c9bc9b821a ] The smp_call_function_many() kerneldoc comment got out of sync with the function definition (bool parameter "wait" is incorrectly described as a bitmask in it), so fix it up by copying the "wait" description from the smp_call_function() kerneldoc and add information regarding the handling of the local CPU to it. Fixes: 49b3bd213a9f ("smp: Fix all kernel-doc warnings") Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com> Signed-off-by: Thomas Gleixner <tglx@linutronix.de> Signed-off-by: Sasha Levin <sashal@kernel.org>
Diffstat (limited to 'kernel')
-rw-r--r--kernel/smp.c11
1 files changed, 5 insertions, 6 deletions
diff --git a/kernel/smp.c b/kernel/smp.c
index f25e20617b7e..fa6faf50fb43 100644
--- a/kernel/smp.c
+++ b/kernel/smp.c
@@ -891,16 +891,15 @@ static void smp_call_function_many_cond(const struct cpumask *mask,
* @mask: The set of cpus to run on (only runs on online subset).
* @func: The function to run. This must be fast and non-blocking.
* @info: An arbitrary pointer to pass to the function.
- * @wait: Bitmask that controls the operation. If %SCF_WAIT is set, wait
- * (atomically) until function has completed on other CPUs. If
- * %SCF_RUN_LOCAL is set, the function will also be run locally
- * if the local CPU is set in the @cpumask.
- *
- * If @wait is true, then returns once @func has returned.
+ * @wait: If true, wait (atomically) until function has completed
+ * on other CPUs.
*
* You must not call this function with disabled interrupts or from a
* hardware interrupt handler or from a bottom half handler. Preemption
* must be disabled when calling this function.
+ *
+ * @func is not called on the local CPU even if @mask contains it. Consider
+ * using on_each_cpu_cond_mask() instead if this is not desirable.
*/
void smp_call_function_many(const struct cpumask *mask,
smp_call_func_t func, void *info, bool wait)