LXR uboot/common/spl/spl

   1// SPDX-License-Identifier: GPL-2.0+
   2/*
   3 * Copyright (C) 2011 OMICRON electronics GmbH
   4 *
   5 * based on drivers/mtd/nand/raw/nand_spl_load.c
   6 *
   7 * Copyright (C) 2011
   8 * Heiko Schocher, DENX Software Engineering, hs@denx.de.
   9 */
  10
  11#include <common.h>
  12#include <image.h>
  13#include <log.h>
  14#include <spi.h>
  15#include <spi_flash.h>
  16#include <errno.h>
  17#include <spl.h>
  18
  19DECLARE_GLOBAL_DATA_PTR;
  20
  21#ifdef CONFIG_SPL_OS_BOOT
  22/*
  23 * Load the kernel, check for a valid header we can parse, and if found load
  24 * the kernel and then device tree.
  25 */
  26static int spi_load_image_os(struct spl_image_info *spl_image,
  27                             struct spi_flash *flash,
  28                             struct image_header *header)
  29{
  30        int err;
  31
  32        /* Read for a header, parse or error out. */
  33        spi_flash_read(flash, CONFIG_SYS_SPI_KERNEL_OFFS, sizeof(*header),
  34                       (void *)header);
  35
  36        if (image_get_magic(header) != IH_MAGIC)
  37                return -1;
  38
  39        err = spl_parse_image_header(spl_image, header);
  40        if (err)
  41                return err;
  42
  43        spi_flash_read(flash, CONFIG_SYS_SPI_KERNEL_OFFS,
  44                       spl_image->size, (void *)spl_image->load_addr);
  45
  46        /* Read device tree. */
  47        spi_flash_read(flash, CONFIG_SYS_SPI_ARGS_OFFS,
  48                       CONFIG_SYS_SPI_ARGS_SIZE,
  49                       (void *)CONFIG_SYS_SPL_ARGS_ADDR);
  50
  51        return 0;
  52}
  53#endif
  54
  55static ulong spl_spi_fit_read(struct spl_load_info *load, ulong sector,
  56                              ulong count, void *buf)
  57{
  58        struct spi_flash *flash = load->dev;
  59        ulong ret;
  60
  61        ret = spi_flash_read(flash, sector, count, buf);
  62        if (!ret)
  63                return count;
  64        else
  65                return 0;
  66}
  67
  68unsigned int __weak spl_spi_get_uboot_offs(struct spi_flash *flash)
  69{
  70        return CONFIG_SYS_SPI_U_BOOT_OFFS;
  71}
  72
  73/*
  74 * The main entry for SPI booting. It's necessary that SDRAM is already
  75 * configured and available since this code loads the main U-Boot image
  76 * from SPI into SDRAM and starts it from there.
  77 */
  78static int spl_spi_load_image(struct spl_image_info *spl_image,
  79                              struct spl_boot_device *bootdev)
  80{
  81        int err = 0;
  82        unsigned int payload_offs;
  83        struct spi_flash *flash;
  84        struct image_header *header;
  85
  86        /*
  87         * Load U-Boot image from SPI flash into RAM
  88         * In DM mode: defaults speed and mode will be
  89         * taken from DT when available
  90         */
  91
  92        flash = spi_flash_probe(CONFIG_SF_DEFAULT_BUS,
  93                                CONFIG_SF_DEFAULT_CS,
  94                                CONFIG_SF_DEFAULT_SPEED,
  95                                CONFIG_SF_DEFAULT_MODE);
  96        if (!flash) {
  97                puts("SPI probe failed.\n");
  98                return -ENODEV;
  99        }
 100
 101        payload_offs = spl_spi_get_uboot_offs(flash);
 102
 103        header = spl_get_load_buffer(-sizeof(*header), sizeof(*header));
 104
 105#if CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)
 106        payload_offs = fdtdec_get_config_int(gd->fdt_blob,
 107                                             "u-boot,spl-payload-offset",
 108                                             payload_offs);
 109#endif
 110
 111#ifdef CONFIG_SPL_OS_BOOT
 112        if (spl_start_uboot() || spi_load_image_os(spl_image, flash, header))
 113#endif
 114        {
 115                /* Load u-boot, mkimage header is 64 bytes. */
 116                err = spi_flash_read(flash, payload_offs, sizeof(*header),
 117                                     (void *)header);
 118                if (err) {
 119                        debug("%s: Failed to read from SPI flash (err=%d)\n",
 120                              __func__, err);
 121                        return err;
 122                }
 123
 124                if (IS_ENABLED(CONFIG_SPL_LOAD_FIT_FULL) &&
 125                    image_get_magic(header) == FDT_MAGIC) {
 126                        err = spi_flash_read(flash, payload_offs,
 127                                             roundup(fdt_totalsize(header), 4),
 128                                             (void *)CONFIG_SYS_LOAD_ADDR);
 129                        if (err)
 130                                return err;
 131                        err = spl_parse_image_header(spl_image,
 132                                        (struct image_header *)CONFIG_SYS_LOAD_ADDR);
 133                } else if (IS_ENABLED(CONFIG_SPL_LOAD_FIT) &&
 134                           image_get_magic(header) == FDT_MAGIC) {
 135                        struct spl_load_info load;
 136
 137                        debug("Found FIT\n");
 138                        load.dev = flash;
 139                        load.priv = NULL;
 140                        load.filename = NULL;
 141                        load.bl_len = 1;
 142                        load.read = spl_spi_fit_read;
 143                        err = spl_load_simple_fit(spl_image, &load,
 144                                                  payload_offs,
 145                                                  header);
 146                } else if (IS_ENABLED(CONFIG_SPL_LOAD_IMX_CONTAINER)) {
 147                        struct spl_load_info load;
 148
 149                        load.dev = flash;
 150                        load.priv = NULL;
 151                        load.filename = NULL;
 152                        load.bl_len = 1;
 153                        load.read = spl_spi_fit_read;
 154
 155                        err = spl_load_imx_container(spl_image, &load,
 156                                                     payload_offs);
 157                } else {
 158                        err = spl_parse_image_header(spl_image, header);
 159                        if (err)
 160                                return err;
 161                        err = spi_flash_read(flash, payload_offs,
 162                                             spl_image->size,
 163                                             (void *)spl_image->load_addr);
 164                }
 165        }
 166
 167        return err;
 168}
 169/* Use priorty 1 so that boards can override this */
 170SPL_LOAD_IMAGE_METHOD("SPI", 1, BOOT_DEVICE_SPI, spl_spi_load_image);
 171