common/spl/spl_spi.c

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