spl: Always define preloader_console_init
[oweals/u-boot.git] / common / splash_source.c
index d1bb5a4baf3b3dbe247c790e9bdf2424fc606d15..2ff15208a70d77acc68e8cba33f1498a75e2f1be 100644 (file)
@@ -1,24 +1,30 @@
+// SPDX-License-Identifier: GPL-2.0+
 /*
  * (C) Copyright 2014 CompuLab, Ltd. <www.compulab.co.il>
  *
  * Authors: Igor Grinberg <grinberg@compulab.co.il>
- *
- * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #include <common.h>
-#include <nand.h>
+#include <bmp_layout.h>
+#include <command.h>
+#include <env.h>
 #include <errno.h>
-#include <splash.h>
-#include <spi_flash.h>
+#include <fs.h>
+#include <fdt_support.h>
+#include <image.h>
+#include <nand.h>
+#include <sata.h>
 #include <spi.h>
-#include <bmp_layout.h>
+#include <spi_flash.h>
+#include <splash.h>
+#include <usb.h>
 
 DECLARE_GLOBAL_DATA_PTR;
 
 #ifdef CONFIG_SPI_FLASH
 static struct spi_flash *sf;
-static int splash_sf_read(u32 bmp_load_addr, int offset, size_t read_size)
+static int splash_sf_read_raw(u32 bmp_load_addr, int offset, size_t read_size)
 {
        if (!sf) {
                sf = spi_flash_probe(CONFIG_SF_DEFAULT_BUS,
@@ -32,7 +38,7 @@ static int splash_sf_read(u32 bmp_load_addr, int offset, size_t read_size)
        return spi_flash_read(sf, offset, read_size, (void *)bmp_load_addr);
 }
 #else
-static int splash_sf_read(u32 bmp_load_addr, int offset, size_t read_size)
+static int splash_sf_read_raw(u32 bmp_load_addr, int offset, size_t read_size)
 {
        debug("%s: sf support not available\n", __func__);
        return -ENOSYS;
@@ -40,22 +46,23 @@ static int splash_sf_read(u32 bmp_load_addr, int offset, size_t read_size)
 #endif
 
 #ifdef CONFIG_CMD_NAND
-static int splash_nand_read(u32 bmp_load_addr, int offset, size_t read_size)
+static int splash_nand_read_raw(u32 bmp_load_addr, int offset, size_t read_size)
 {
-       return nand_read_skip_bad(&nand_info[nand_curr_device], offset,
+       struct mtd_info *mtd = get_nand_dev_by_index(nand_curr_device);
+       return nand_read_skip_bad(mtd, offset,
                                  &read_size, NULL,
-                                 nand_info[nand_curr_device].size,
+                                 mtd->size,
                                  (u_char *)bmp_load_addr);
 }
 #else
-static int splash_nand_read(u32 bmp_load_addr, int offset, size_t read_size)
+static int splash_nand_read_raw(u32 bmp_load_addr, int offset, size_t read_size)
 {
        debug("%s: nand support not available\n", __func__);
        return -ENOSYS;
 }
 #endif
 
-static int splash_storage_read(struct splash_location *location,
+static int splash_storage_read_raw(struct splash_location *location,
                               u32 bmp_load_addr, size_t read_size)
 {
        u32 offset;
@@ -66,9 +73,9 @@ static int splash_storage_read(struct splash_location *location,
        offset = location->offset;
        switch (location->storage) {
        case SPLASH_STORAGE_NAND:
-               return splash_nand_read(bmp_load_addr, offset, read_size);
+               return splash_nand_read_raw(bmp_load_addr, offset, read_size);
        case SPLASH_STORAGE_SF:
-               return splash_sf_read(bmp_load_addr, offset, read_size);
+               return splash_sf_read_raw(bmp_load_addr, offset, read_size);
        default:
                printf("Unknown splash location\n");
        }
@@ -85,7 +92,7 @@ static int splash_load_raw(struct splash_location *location, u32 bmp_load_addr)
        if (bmp_load_addr + bmp_header_size >= gd->start_addr_sp)
                goto splash_address_too_high;
 
-       res = splash_storage_read(location, bmp_load_addr, bmp_header_size);
+       res = splash_storage_read_raw(location, bmp_load_addr, bmp_header_size);
        if (res < 0)
                return res;
 
@@ -95,7 +102,7 @@ static int splash_load_raw(struct splash_location *location, u32 bmp_load_addr)
        if (bmp_load_addr + bmp_size >= gd->start_addr_sp)
                goto splash_address_too_high;
 
-       return splash_storage_read(location, bmp_load_addr, bmp_size);
+       return splash_storage_read_raw(location, bmp_load_addr, bmp_size);
 
 splash_address_too_high:
        printf("Error: splashimage address too high. Data overwrites U-Boot and/or placed beyond DRAM boundaries.\n");
@@ -103,6 +110,159 @@ splash_address_too_high:
        return -EFAULT;
 }
 
+static int splash_select_fs_dev(struct splash_location *location)
+{
+       int res;
+
+       switch (location->storage) {
+       case SPLASH_STORAGE_MMC:
+               res = fs_set_blk_dev("mmc", location->devpart, FS_TYPE_ANY);
+               break;
+       case SPLASH_STORAGE_USB:
+               res = fs_set_blk_dev("usb", location->devpart, FS_TYPE_ANY);
+               break;
+       case SPLASH_STORAGE_SATA:
+               res = fs_set_blk_dev("sata", location->devpart, FS_TYPE_ANY);
+               break;
+       case SPLASH_STORAGE_NAND:
+               if (location->ubivol != NULL)
+                       res = fs_set_blk_dev("ubi", NULL, FS_TYPE_UBIFS);
+               else
+                       res = -ENODEV;
+               break;
+       default:
+               printf("Error: unsupported location storage.\n");
+               return -ENODEV;
+       }
+
+       if (res)
+               printf("Error: could not access storage.\n");
+
+       return res;
+}
+
+#ifdef CONFIG_USB_STORAGE
+static int splash_init_usb(void)
+{
+       int err;
+
+       err = usb_init();
+       if (err)
+               return err;
+
+#ifndef CONFIG_DM_USB
+       err = usb_stor_scan(1) < 0 ? -ENODEV : 0;
+#endif
+
+       return err;
+}
+#else
+static inline int splash_init_usb(void)
+{
+       printf("Cannot load splash image: no USB support\n");
+       return -ENOSYS;
+}
+#endif
+
+#ifdef CONFIG_SATA
+static int splash_init_sata(void)
+{
+       return sata_probe(0);
+}
+#else
+static inline int splash_init_sata(void)
+{
+       printf("Cannot load splash image: no SATA support\n");
+       return -ENOSYS;
+}
+#endif
+
+#ifdef CONFIG_CMD_UBIFS
+static int splash_mount_ubifs(struct splash_location *location)
+{
+       int res;
+       char cmd[32];
+
+       sprintf(cmd, "ubi part %s", location->mtdpart);
+       res = run_command(cmd, 0);
+       if (res)
+               return res;
+
+       sprintf(cmd, "ubifsmount %s", location->ubivol);
+       res = run_command(cmd, 0);
+
+       return res;
+}
+
+static inline int splash_umount_ubifs(void)
+{
+       return run_command("ubifsumount", 0);
+}
+#else
+static inline int splash_mount_ubifs(struct splash_location *location)
+{
+       printf("Cannot load splash image: no UBIFS support\n");
+       return -ENOSYS;
+}
+
+static inline int splash_umount_ubifs(void)
+{
+       printf("Cannot unmount UBIFS: no UBIFS support\n");
+       return -ENOSYS;
+}
+#endif
+
+#define SPLASH_SOURCE_DEFAULT_FILE_NAME                "splash.bmp"
+
+static int splash_load_fs(struct splash_location *location, u32 bmp_load_addr)
+{
+       int res = 0;
+       loff_t bmp_size;
+       loff_t actread;
+       char *splash_file;
+
+       splash_file = env_get("splashfile");
+       if (!splash_file)
+               splash_file = SPLASH_SOURCE_DEFAULT_FILE_NAME;
+
+       if (location->storage == SPLASH_STORAGE_USB)
+               res = splash_init_usb();
+
+       if (location->storage == SPLASH_STORAGE_SATA)
+               res = splash_init_sata();
+
+       if (location->ubivol != NULL)
+               res = splash_mount_ubifs(location);
+
+       if (res)
+               return res;
+
+       res = splash_select_fs_dev(location);
+       if (res)
+               goto out;
+
+       res = fs_size(splash_file, &bmp_size);
+       if (res) {
+               printf("Error (%d): cannot determine file size\n", res);
+               goto out;
+       }
+
+       if (bmp_load_addr + bmp_size >= gd->start_addr_sp) {
+               printf("Error: splashimage address too high. Data overwrites U-Boot and/or placed beyond DRAM boundaries.\n");
+               res = -EFAULT;
+               goto out;
+       }
+
+       splash_select_fs_dev(location);
+       res = fs_read(splash_file, bmp_load_addr, 0, 0, &actread);
+
+out:
+       if (location->ubivol != NULL)
+               splash_umount_ubifs();
+
+       return res;
+}
+
 /**
  * select_splash_location - return the splash location based on board support
  *                         and env variable "splashsource".
@@ -127,7 +287,7 @@ static struct splash_location *select_splash_location(
        if (!locations || size == 0)
                return NULL;
 
-       env_splashsource = getenv("splashsource");
+       env_splashsource = env_get("splashsource");
        if (env_splashsource == NULL)
                return &locations[0];
 
@@ -140,6 +300,96 @@ static struct splash_location *select_splash_location(
        return NULL;
 }
 
+#ifdef CONFIG_FIT
+static int splash_load_fit(struct splash_location *location, u32 bmp_load_addr)
+{
+       int res;
+       int node_offset;
+       const char *splash_file;
+       const void *internal_splash_data;
+       size_t internal_splash_size;
+       int external_splash_addr;
+       int external_splash_size;
+       bool is_splash_external = false;
+       struct image_header *img_header;
+       const u32 *fit_header;
+       u32 fit_size;
+       const size_t header_size = sizeof(struct image_header);
+
+       /* Read in image header */
+       res = splash_storage_read_raw(location, bmp_load_addr, header_size);
+       if (res < 0)
+               return res;
+
+       img_header = (struct image_header *)bmp_load_addr;
+       if (image_get_magic(img_header) != FDT_MAGIC) {
+               printf("Could not find FDT magic\n");
+               return -EINVAL;
+       }
+
+       fit_size = fdt_totalsize(img_header);
+
+       /* Read in entire FIT */
+       fit_header = (const u32 *)(bmp_load_addr + header_size);
+       res = splash_storage_read_raw(location, (u32)fit_header, fit_size);
+       if (res < 0)
+               return res;
+
+       res = fit_check_format(fit_header);
+       if (!res) {
+               debug("Could not find valid FIT image\n");
+               return -EINVAL;
+       }
+
+       /* Get the splash image node */
+       splash_file = env_get("splashfile");
+       if (!splash_file)
+               splash_file = SPLASH_SOURCE_DEFAULT_FILE_NAME;
+
+       node_offset = fit_image_get_node(fit_header, splash_file);
+       if (node_offset < 0) {
+               debug("Could not find splash image '%s' in FIT\n",
+                     splash_file);
+               return -ENOENT;
+       }
+
+       /* Extract the splash data from FIT */
+       /* 1. Test if splash is in FIT internal data. */
+       if (!fit_image_get_data(fit_header, node_offset, &internal_splash_data, &internal_splash_size))
+               memmove((void *)bmp_load_addr, internal_splash_data, internal_splash_size);
+       /* 2. Test if splash is in FIT external data with fixed position. */
+       else if (!fit_image_get_data_position(fit_header, node_offset, &external_splash_addr))
+               is_splash_external = true;
+       /* 3. Test if splash is in FIT external data with offset. */
+       else if (!fit_image_get_data_offset(fit_header, node_offset, &external_splash_addr)) {
+               /* Align data offset to 4-byte boundary */
+               fit_size = ALIGN(fdt_totalsize(fit_header), 4);
+               /* External splash offset means the offset by end of FIT header */
+               external_splash_addr += location->offset + fit_size;
+               is_splash_external = true;
+       } else {
+               printf("Failed to get splash image from FIT\n");
+               return -ENODATA;
+       }
+
+       if (is_splash_external) {
+               res = fit_image_get_data_size(fit_header, node_offset, &external_splash_size);
+               if (res < 0) {
+                       printf("Failed to get size of splash image (err=%d)\n", res);
+                       return res;
+               }
+
+               /* Read in the splash data */
+               location->offset = external_splash_addr;
+               res = splash_storage_read_raw(location, bmp_load_addr, external_splash_size);
+               if (res < 0)
+                       return res;
+       }
+
+       return 0;
+}
+#endif /* CONFIG_FIT */
+
 /**
  * splash_source_load - load splash image from a supported location.
  *
@@ -158,7 +408,7 @@ int splash_source_load(struct splash_location *locations, uint size)
        char *env_splashimage_value;
        u32 bmp_load_addr;
 
-       env_splashimage_value = getenv("splashimage");
+       env_splashimage_value = env_get("splashimage");
        if (env_splashimage_value == NULL)
                return -ENOENT;
 
@@ -172,5 +422,13 @@ int splash_source_load(struct splash_location *locations, uint size)
        if (!splash_location)
                return -EINVAL;
 
-       return splash_load_raw(splash_location, bmp_load_addr);
+       if (splash_location->flags == SPLASH_STORAGE_RAW)
+               return splash_load_raw(splash_location, bmp_load_addr);
+       else if (splash_location->flags == SPLASH_STORAGE_FS)
+               return splash_load_fs(splash_location, bmp_load_addr);
+#ifdef CONFIG_FIT
+       else if (splash_location->flags == SPLASH_STORAGE_FIT)
+               return splash_load_fit(splash_location, bmp_load_addr);
+#endif
+       return -EINVAL;
 }