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