Update smp_call_function* comments
PATCH 1/1 Update smp_call_function* comments
Update documentation for i386 smp_call_function* functions.
As reported by Randy Dunlap <[email protected]>
[ I've posted this before but it seems to have been lost along the way. ]
Signed-off-by Jeremy Fitzhardinge <[email protected]>
Cc Randy Dunlap <[email protected]>
--- arch/i386/kernel/smp.c | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-)
===================================================================
arch/i386/kernel/smp.c +16 -11
@@ -570,8 +570,10 @@ static int __smp_call_function_mask(cpum* @info: An arbitrary pointer to pass to the function. * @wait: If true, wait (atomically) until function has completed on other CPUs. * -* Returns 0 on success, else a negative status code. Does not return until -* remote CPUs are nearly ready to execute <<func>> or are or have finished. +* Returns 0 on success, else a negative status code. +* +* If @wait is true, then returns once @func has returned; otherwise +* it returns just before the target cpu calls @func. * * You must not call this function with disabled interrupts or from a * hardware interrupt handler or from a bottom half handler.
@@ -593,11 +595,13 @@ int smp_call_function_mask(cpumask_t mas* smp_call_function(): Run a function on all other CPUs. * @func: The function to run. This must be fast and non-blocking. * @info: An arbitrary pointer to pass to the function. -* @nonatomic: currently unused. +* @nonatomic: Unused. * @wait: If true, wait (atomically) until function has completed on other CPUs. * -* Returns 0 on success, else a negative status code. Does not return until -* remote CPUs are nearly ready to execute <<func>> or are or have executed. +* Returns 0 on success, else a negative status code. +* +* If @wait is true, then returns once @func has returned; otherwise +* it returns just before the target cpu calls @func. * * You must not call this function with disabled interrupts or from a * hardware interrupt handler or from a bottom half handler.
@@ -609,17 +613,18 @@ int smp_call_function(void (*func) (void }EXPORT_SYMBOL (smp_call_function); -/* +/** * smp_call_function_single - Run a function on another CPU +* @cpu: The target CPU. Cannot be the calling CPU. * @func: The function to run. This must be fast and non-blocking. * @info: An arbitrary pointer to pass to the function. -* @nonatomic: Currently unused. +* @nonatomic: Unused. * @wait: If true, wait until function has completed on other CPUs. * -* Retrurns 0 on success, else a negative status code. -* -* Does not return until the remote CPU is nearly ready to execute <func> -* or is or has executed. +* Returns 0 on success, else a negative status code. +* +* If @wait is true, then returns once @func has returned; otherwise +* it returns just before the target cpu calls @func. */ int smp_call_function_single (int cpu,void (*func) (void *info),void *info,int nonatomic,int wait)