diff options
| author | Simon Glass <sjg@chromium.org> | 2020-07-17 08:48:30 -0600 |
|---|---|---|
| committer | Bin Meng <bmeng.cn@gmail.com> | 2020-07-20 09:46:48 +0800 |
| commit | c6efee503103f0e210cdd82653aca6c10814198d (patch) | |
| tree | 8ee0f0e8899f5857b31d240aa67ab1cad8035e3d /arch/x86/include/asm/mp.h | |
| parent | f91f5ab6f0fe2c33b2dd9aa078a87c09eb792a4c (diff) | |
x86: mp: Add more comments to the module
Add a description of how this module works and also some missing function
comments.
Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Wolfgang Wallner <wolfgang.wallner@br-automation.com>
Reviewed-by: Bin Meng <bmeng.cn@gmail.com>
Diffstat (limited to 'arch/x86/include/asm/mp.h')
| -rw-r--r-- | arch/x86/include/asm/mp.h | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/arch/x86/include/asm/mp.h b/arch/x86/include/asm/mp.h index ff49004222a..5f9b8c65643 100644 --- a/arch/x86/include/asm/mp.h +++ b/arch/x86/include/asm/mp.h @@ -36,6 +36,14 @@ typedef int (*mp_callback_t)(struct udevice *cpu, void *arg); * * Note that ap_call() and bsp_call() can be NULL. In the NULL case the * callback will just not be called. + * + * @barrier: Ensures that the BSP and AP don't run the flight record at the same + * time + * @cpus_entered: Counts the number of APs that have run this record + * @ap_call: Function for the APs to call + * @ap_arg: Argument to pass to @ap_call + * @bsp_call: Function for the BSP to call + * @bsp_arg: Argument to pass to @bsp_call */ struct mp_flight_record { atomic_t barrier; @@ -83,7 +91,11 @@ struct mp_flight_record { */ int mp_init(void); -/* Set up additional CPUs */ +/** + * x86_mp_init() - Set up additional CPUs + * + * @returns < 0 on error, 0 on success. + */ int x86_mp_init(void); /** |