From: Simon Glass <sjg@chromium.org>
Date: Sun, 25 Sep 2016 00:19:55 +0000 (-0600)
Subject: spl: Add function comments to spl_start_uboot()
X-Git-Tag: v2016.11-rc2~101
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=f59961e343cc591b99a78690eb01ec590e15baa7;p=u-boot

spl: Add function comments to spl_start_uboot()

Add some comments to describe this function.

Signed-off-by: Simon Glass <sjg@chromium.org>
Reviewed-by: Tom Rini <trini@konsulko.com>
---

diff --git a/include/spl.h b/include/spl.h
index 7fba485fea..16f1ef449c 100644
--- a/include/spl.h
+++ b/include/spl.h
@@ -110,7 +110,18 @@ int spl_board_ubi_load_image(u32 boot_device);
  */
 void __noreturn jump_to_image_linux(struct spl_image_info *spl_image,
 				    void *arg);
+
+/**
+ * spl_start_uboot() - Check if SPL should start the kernel or U-Boot
+ *
+ * This is called by the various SPL loaders to determine whether the board
+ * wants to load the kernel or U-Boot. This function should be provided by
+ * the board.
+ *
+ * @return 0 if SPL should start the kernel, 1 if U-Boot must be started
+ */
 int spl_start_uboot(void);
+
 void spl_display_print(void);
 
 /* NAND SPL functions */