Merge branch 'master' of git://git.denx.de/u-boot-spi
[platform/kernel/u-boot.git] / common / spl / spl.c
index 1566acd..35120b6 100644 (file)
@@ -1,15 +1,16 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  * (C) Copyright 2010
  * Texas Instruments, <www.ti.com>
  *
  * Aneesh V <aneesh@ti.com>
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #include <common.h>
+#include <bloblist.h>
 #include <binman_sym.h>
 #include <dm.h>
+#include <handoff.h>
 #include <spl.h>
 #include <asm/u-boot.h>
 #include <nand.h>
@@ -20,6 +21,7 @@
 #include <dm/root.h>
 #include <linux/compiler.h>
 #include <fdt_support.h>
+#include <bootcount.h>
 
 DECLARE_GLOBAL_DATA_PTR;
 
@@ -34,7 +36,7 @@ DECLARE_GLOBAL_DATA_PTR;
 u32 *boot_params_ptr = NULL;
 
 /* See spl.h for information about this */
-binman_sym_declare(ulong, u_boot_any, pos);
+binman_sym_declare(ulong, u_boot_any, image_pos);
 
 /* Define board data structure */
 static bd_t bdata __attribute__ ((section(".data")));
@@ -44,6 +46,14 @@ static bd_t bdata __attribute__ ((section(".data")));
  */
 __weak void show_boot_progress(int val) {}
 
+#if defined(CONFIG_SPL_OS_BOOT) || CONFIG_IS_ENABLED(HANDOFF)
+/* weak, default platform-specific function to initialize dram banks */
+__weak int dram_init_banksize(void)
+{
+       return 0;
+}
+#endif
+
 /*
  * Default function to determine if u-boot or the OS should
  * be started. This implementation always returns 1.
@@ -57,19 +67,12 @@ __weak void show_boot_progress(int val) {}
 #ifdef CONFIG_SPL_OS_BOOT
 __weak int spl_start_uboot(void)
 {
-       puts("SPL: Please implement spl_start_uboot() for your board\n");
-       puts("SPL: Direct Linux boot not active!\n");
+       puts(SPL_TPL_PROMPT
+            "Please implement spl_start_uboot() for your board\n");
+       puts(SPL_TPL_PROMPT "Direct Linux boot not active!\n");
        return 1;
 }
 
-/* weak default platform specific function to initialize
- * dram banks
- */
-__weak int dram_init_banksize(void)
-{
-       return 0;
-}
-
 /*
  * Weak default function for arch specific zImage check. Return zero
  * and fill start and end address if image is recognized.
@@ -80,6 +83,11 @@ int __weak bootz_setup(ulong image, ulong *start, ulong *end)
 }
 #endif
 
+/* Weak default function for arch/board-specific fixups to the spl_image_info */
+void __weak spl_perform_fixups(struct spl_image_info *spl_image)
+{
+}
+
 void spl_fixup_fdt(void)
 {
 #if defined(CONFIG_SPL_OF_LIBFDT) && defined(CONFIG_SYS_SPL_ARGS_ADDR)
@@ -95,13 +103,13 @@ void spl_fixup_fdt(void)
        /* fixup the memory dt node */
        err = fdt_shrink_to_minimum(fdt_blob, 0);
        if (err == 0) {
-               printf("spl: fdt_shrink_to_minimum err - %d\n", err);
+               printf(SPL_TPL_PROMPT "fdt_shrink_to_minimum err - %d\n", err);
                return;
        }
 
        err = arch_fixup_fdt(fdt_blob);
        if (err) {
-               printf("spl: arch_fixup_fdt err - %d\n", err);
+               printf(SPL_TPL_PROMPT "arch_fixup_fdt err - %d\n", err);
                return;
        }
 #endif
@@ -122,13 +130,24 @@ __weak void spl_board_prepare_for_boot(void)
        /* Nothing to do! */
 }
 
+__weak struct image_header *spl_get_load_buffer(ssize_t offset, size_t size)
+{
+       return (struct image_header *)(CONFIG_SYS_TEXT_BASE + offset);
+}
+
 void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
 {
-       ulong u_boot_pos = binman_sym(ulong, u_boot_any, pos);
+       ulong u_boot_pos = binman_sym(ulong, u_boot_any, image_pos);
 
        spl_image->size = CONFIG_SYS_MONITOR_LEN;
-       if (u_boot_pos != BINMAN_SYM_MISSING) {
-               /* biman does not support separate entry addresses at present */
+
+       /*
+        * Binman error cases: address of the end of the previous region or the
+        * start of the image's entry area (usually 0) if there is no previous
+        * region.
+        */
+       if (u_boot_pos && u_boot_pos != BINMAN_SYM_MISSING) {
+               /* Binman does not support separated entry addresses */
                spl_image->entry_point = u_boot_pos;
                spl_image->load_addr = u_boot_pos;
        } else {
@@ -139,9 +158,83 @@ void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
        spl_image->name = "U-Boot";
 }
 
+#ifdef CONFIG_SPL_LOAD_FIT_FULL
+/* Parse and load full fitImage in SPL */
+static int spl_load_fit_image(struct spl_image_info *spl_image,
+                             const struct image_header *header)
+{
+       bootm_headers_t images;
+       const char *fit_uname_config = NULL;
+       const char *fit_uname_fdt = FIT_FDT_PROP;
+       const char *uname;
+       ulong fw_data = 0, dt_data = 0, img_data = 0;
+       ulong fw_len = 0, dt_len = 0, img_len = 0;
+       int idx, conf_noffset;
+       int ret;
+
+#ifdef CONFIG_SPL_FIT_SIGNATURE
+       images.verify = 1;
+#endif
+       ret = fit_image_load(&images, (ulong)header,
+                            NULL, &fit_uname_config,
+                            IH_ARCH_DEFAULT, IH_TYPE_STANDALONE, -1,
+                            FIT_LOAD_REQUIRED, &fw_data, &fw_len);
+       if (ret < 0)
+               return ret;
+
+       spl_image->size = fw_len;
+       spl_image->entry_point = fw_data;
+       spl_image->load_addr = fw_data;
+       spl_image->os = IH_OS_U_BOOT;
+       spl_image->name = "U-Boot";
+
+       debug(SPL_TPL_PROMPT "payload image: %32s load addr: 0x%lx size: %d\n",
+             spl_image->name, spl_image->load_addr, spl_image->size);
+
+#ifdef CONFIG_SPL_FIT_SIGNATURE
+       images.verify = 1;
+#endif
+       fit_image_load(&images, (ulong)header,
+                      &fit_uname_fdt, &fit_uname_config,
+                      IH_ARCH_DEFAULT, IH_TYPE_FLATDT, -1,
+                      FIT_LOAD_OPTIONAL, &dt_data, &dt_len);
+
+       conf_noffset = fit_conf_get_node((const void *)header,
+                                        fit_uname_config);
+       if (conf_noffset <= 0)
+               return 0;
+
+       for (idx = 0;
+            uname = fdt_stringlist_get((const void *)header, conf_noffset,
+                                       FIT_LOADABLE_PROP, idx,
+                               NULL), uname;
+            idx++)
+       {
+#ifdef CONFIG_SPL_FIT_SIGNATURE
+               images.verify = 1;
+#endif
+               ret = fit_image_load(&images, (ulong)header,
+                                    &uname, &fit_uname_config,
+                                    IH_ARCH_DEFAULT, IH_TYPE_LOADABLE, -1,
+                                    FIT_LOAD_OPTIONAL_NON_ZERO,
+                                    &img_data, &img_len);
+               if (ret < 0)
+                       return ret;
+       }
+
+       return 0;
+}
+#endif
+
 int spl_parse_image_header(struct spl_image_info *spl_image,
                           const struct image_header *header)
 {
+#ifdef CONFIG_SPL_LOAD_FIT_FULL
+       int ret = spl_load_fit_image(spl_image, header);
+
+       if (!ret)
+               return ret;
+#endif
        if (image_get_magic(header) == IH_MAGIC) {
 #ifdef CONFIG_SPL_LEGACY_IMAGE_SUPPORT
                u32 header_size = sizeof(struct image_header);
@@ -165,9 +258,9 @@ int spl_parse_image_header(struct spl_image_info *spl_image,
                }
                spl_image->os = image_get_os(header);
                spl_image->name = image_get_name(header);
-               debug("spl: payload image: %.*s load addr: 0x%lx size: %d\n",
-                       IH_NMLEN, spl_image->name,
-                       spl_image->load_addr, spl_image->size);
+               debug(SPL_TPL_PROMPT
+                     "payload image: %32s load addr: 0x%lx size: %d\n",
+                     spl_image->name, spl_image->load_addr, spl_image->size);
 #else
                /* LEGACY image not supported */
                debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
@@ -195,7 +288,8 @@ int spl_parse_image_header(struct spl_image_info *spl_image,
                        spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
                        spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
                        spl_image->size = end - start;
-                       debug("spl: payload zImage, load addr: 0x%lx size: %d\n",
+                       debug(SPL_TPL_PROMPT
+                             "payload zImage, load addr: 0x%lx size: %d\n",
                              spl_image->load_addr, spl_image->size);
                        return 0;
                }
@@ -223,16 +317,52 @@ __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
        image_entry_noargs_t image_entry =
                (image_entry_noargs_t)spl_image->entry_point;
 
-       debug("image entry point: 0x%lX\n", spl_image->entry_point);
+       debug("image entry point: 0x%lx\n", spl_image->entry_point);
        image_entry();
 }
 
+#if CONFIG_IS_ENABLED(HANDOFF)
+/**
+ * Set up the SPL hand-off information
+ *
+ * This is initially empty (zero) but can be written by
+ */
+static int setup_spl_handoff(void)
+{
+       struct spl_handoff *ho;
+
+       ho = bloblist_ensure(BLOBLISTT_SPL_HANDOFF, sizeof(struct spl_handoff));
+       if (!ho)
+               return -ENOENT;
+
+       return 0;
+}
+
+static int write_spl_handoff(void)
+{
+       struct spl_handoff *ho;
+
+       ho = bloblist_find(BLOBLISTT_SPL_HANDOFF, sizeof(struct spl_handoff));
+       if (!ho)
+               return -ENOENT;
+       handoff_save_dram(ho);
+#ifdef CONFIG_SANDBOX
+       ho->arch.magic = TEST_HANDOFF_MAGIC;
+#endif
+       debug(SPL_TPL_PROMPT "Wrote SPL handoff\n");
+
+       return 0;
+}
+#else
+static inline int setup_spl_handoff(void) { return 0; }
+static inline int write_spl_handoff(void) { return 0; }
+
+#endif /* HANDOFF */
+
 static int spl_common_init(bool setup_malloc)
 {
        int ret;
 
-       debug("spl_early_init()\n");
-
 #if CONFIG_VAL(SYS_MALLOC_F_LEN)
        if (setup_malloc) {
 #ifdef CONFIG_MALLOC_F_ADDR
@@ -249,6 +379,30 @@ static int spl_common_init(bool setup_malloc)
                return ret;
        }
        bootstage_mark_name(BOOTSTAGE_ID_START_SPL, "spl");
+#if CONFIG_IS_ENABLED(LOG)
+       ret = log_init();
+       if (ret) {
+               debug("%s: Failed to set up logging\n", __func__);
+               return ret;
+       }
+#endif
+       if (CONFIG_IS_ENABLED(BLOBLIST)) {
+               ret = bloblist_init();
+               if (ret) {
+                       debug("%s: Failed to set up bloblist: ret=%d\n",
+                             __func__, ret);
+                       return ret;
+               }
+       }
+       if (CONFIG_IS_ENABLED(HANDOFF)) {
+               int ret;
+
+               ret = setup_spl_handoff();
+               if (ret) {
+                       puts(SPL_TPL_PROMPT "Cannot set up SPL handoff\n");
+                       hang();
+               }
+       }
        if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
                ret = fdtdec_setup();
                if (ret) {
@@ -272,6 +426,10 @@ static int spl_common_init(bool setup_malloc)
 
 void spl_set_bd(void)
 {
+       /*
+        * NOTE: On some platforms (e.g. x86) bdata may be in flash and not
+        * writeable.
+        */
        if (!gd->bd)
                gd->bd = &bdata;
 }
@@ -280,6 +438,8 @@ int spl_early_init(void)
 {
        int ret;
 
+       debug("%s\n", __func__);
+
        ret = spl_common_init(true);
        if (ret)
                return ret;
@@ -294,6 +454,8 @@ int spl_init(void)
        bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
                        IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
 
+       debug("%s\n", __func__);
+
        if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
                ret = spl_common_init(setup_malloc);
                if (ret)
@@ -362,10 +524,12 @@ static int boot_from_devices(struct spl_image_info *spl_image,
                if (loader)
                        printf("Trying to boot from %s\n", loader->name);
                else
-                       puts("SPL: Unsupported Boot Device!\n");
+                       puts(SPL_TPL_PROMPT "Unsupported Boot Device!\n");
 #endif
-               if (loader && !spl_load_image(spl_image, loader))
+               if (loader && !spl_load_image(spl_image, loader)) {
+                       spl_image->boot_device = spl_boot_list[i];
                        return 0;
+               }
        }
 
        return -ENODEV;
@@ -381,15 +545,12 @@ void board_init_r(gd_t *dummy1, ulong dummy2)
                BOOT_DEVICE_NONE,
        };
        struct spl_image_info spl_image;
+       int ret;
 
-       debug(">>spl:board_init_r()\n");
+       debug(">>" SPL_TPL_PROMPT "board_init_r()\n");
 
        spl_set_bd();
 
-#ifdef CONFIG_SPL_OS_BOOT
-       dram_init_banksize();
-#endif
-
 #if defined(CONFIG_SYS_SPL_MALLOC_START)
        mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
                        CONFIG_SYS_SPL_MALLOC_SIZE);
@@ -411,18 +572,38 @@ void board_init_r(gd_t *dummy1, ulong dummy2)
        spl_board_init();
 #endif
 
+       if (IS_ENABLED(CONFIG_SPL_OS_BOOT) || CONFIG_IS_ENABLED(HANDOFF))
+               dram_init_banksize();
+
+       bootcount_inc();
+
        memset(&spl_image, '\0', sizeof(spl_image));
 #ifdef CONFIG_SYS_SPL_ARGS_ADDR
        spl_image.arg = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
 #endif
+       spl_image.boot_device = BOOT_DEVICE_NONE;
        board_boot_order(spl_boot_list);
 
        if (boot_from_devices(&spl_image, spl_boot_list,
                              ARRAY_SIZE(spl_boot_list))) {
-               puts("SPL: failed to boot from all boot devices\n");
+               puts(SPL_TPL_PROMPT "failed to boot from all boot devices\n");
                hang();
        }
 
+       spl_perform_fixups(&spl_image);
+       if (CONFIG_IS_ENABLED(HANDOFF)) {
+               ret = write_spl_handoff();
+               if (ret)
+                       printf(SPL_TPL_PROMPT
+                              "SPL hand-off write failed (err=%d)\n", ret);
+       }
+       if (CONFIG_IS_ENABLED(BLOBLIST)) {
+               ret = bloblist_finish();
+               if (ret)
+                       printf("Warning: Failed to finish bloblist (ret=%d)\n",
+                              ret);
+       }
+
 #ifdef CONFIG_CPU_V7M
        spl_image.entry_point |= 0x1;
 #endif
@@ -436,6 +617,13 @@ void board_init_r(gd_t *dummy1, ulong dummy2)
                spl_invoke_atf(&spl_image);
                break;
 #endif
+#if CONFIG_IS_ENABLED(OPTEE)
+       case IH_OS_TEE:
+               debug("Jumping to U-Boot via OP-TEE\n");
+               spl_optee_entry(NULL, NULL, spl_image.fdt_addr,
+                               (void *)spl_image.entry_point);
+               break;
+#endif
 #ifdef CONFIG_SPL_OS_BOOT
        case IH_OS_LINUX:
                debug("Jumping to Linux\n");
@@ -447,12 +635,10 @@ void board_init_r(gd_t *dummy1, ulong dummy2)
                debug("Unsupported OS image.. Jumping nevertheless..\n");
        }
 #if CONFIG_VAL(SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
-       debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
+       debug("SPL malloc() used 0x%lx bytes (%ld KB)\n", gd->malloc_ptr,
              gd->malloc_ptr / 1024);
 #endif
 #ifdef CONFIG_BOOTSTAGE_STASH
-       int ret;
-
        bootstage_mark_name(BOOTSTAGE_ID_END_SPL, "end_spl");
        ret = bootstage_stash((void *)CONFIG_BOOTSTAGE_STASH_ADDR,
                              CONFIG_BOOTSTAGE_STASH_SIZE);
@@ -465,6 +651,7 @@ void board_init_r(gd_t *dummy1, ulong dummy2)
        jump_to_image_no_args(&spl_image);
 }
 
+#ifdef CONFIG_SPL_SERIAL_SUPPORT
 /*
  * This requires UART clocks to be enabled.  In order for this to work the
  * caller must ensure that the gd pointer is valid.
@@ -477,12 +664,15 @@ void preloader_console_init(void)
 
        gd->have_console = 1;
 
-       puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
-                       U_BOOT_TIME ")\n");
+#if CONFIG_IS_ENABLED(BANNER_PRINT)
+       puts("\nU-Boot " SPL_TPL_NAME " " PLAIN_VERSION " (" U_BOOT_DATE " - "
+            U_BOOT_TIME " " U_BOOT_TZ ")\n");
+#endif
 #ifdef CONFIG_SPL_DISPLAY_PRINT
        spl_display_print();
 #endif
 }
+#endif
 
 /**
  * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution