x86: Add return-value comment to cpu_jump_to_64bit()
authorSimon Glass <sjg@chromium.org>
Sun, 19 Mar 2023 19:30:07 +0000 (08:30 +1300)
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>
Sat, 25 Mar 2023 10:07:21 +0000 (11:07 +0100)
This does not mention what it returns. Add the missing documentation.

Signed-off-by: Simon Glass <sjg@chromium.org>
arch/x86/include/asm/cpu.h

index 3346012..073f80b 100644 (file)
@@ -262,6 +262,7 @@ void cpu_call32(ulong code_seg32, ulong target, ulong table);
  *
  * @setup_base:        Pointer to the setup.bin information for the kernel
  * @target:    Pointer to the start of the kernel image
+ * Return: -EFAULT if the kernel returned; otherwise does not return
  */
 int cpu_jump_to_64bit(ulong setup_base, ulong target);