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