imx: Introduce CONFIG_SPL_FORCE_MMC_BOOT to force MMC boot on falcon mode
[oweals/u-boot.git] / arch / arm / mach-imx / spl.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Copyright (C) 2014 Gateworks Corporation
4  * Copyright (C) 2011-2012 Freescale Semiconductor, Inc.
5  *
6  * Author: Tim Harvey <tharvey@gateworks.com>
7  */
8
9 #include <common.h>
10 #include <asm/io.h>
11 #include <asm/arch/imx-regs.h>
12 #include <asm/arch/sys_proto.h>
13 #include <asm/spl.h>
14 #include <spl.h>
15 #include <asm/mach-imx/hab.h>
16 #include <asm/mach-imx/boot_mode.h>
17 #include <g_dnl.h>
18
19 DECLARE_GLOBAL_DATA_PTR;
20
21 #if defined(CONFIG_MX6)
22 /* determine boot device from SRC_SBMR1 (BOOT_CFG[4:1]) or SRC_GPR9 register */
23 u32 spl_boot_device(void)
24 {
25         unsigned int bmode = readl(&src_base->sbmr2);
26         u32 reg = imx6_src_get_boot_mode();
27         u32 mmc_index = ((reg >> 11) & 0x03);
28
29         /*
30          * Check for BMODE if serial downloader is enabled
31          * BOOT_MODE - see IMX6DQRM Table 8-1
32          */
33         if (((bmode >> 24) & 0x03) == 0x01) /* Serial Downloader */
34                 return BOOT_DEVICE_BOARD;
35
36         /*
37          * The above method does not detect that the boot ROM used
38          * serial downloader in case the boot ROM decided to use the
39          * serial downloader as a fall back (primary boot source failed).
40          *
41          * Infer that the boot ROM used the USB serial downloader by
42          * checking whether the USB PHY is currently active... This
43          * assumes that SPL did not (yet) initialize the USB PHY...
44          */
45         if (is_usbotg_phy_active())
46                 return BOOT_DEVICE_BOARD;
47
48         /* BOOT_CFG1[7:4] - see IMX6DQRM Table 8-8 */
49         switch ((reg & IMX6_BMODE_MASK) >> IMX6_BMODE_SHIFT) {
50          /* EIM: See 8.5.1, Table 8-9 */
51         case IMX6_BMODE_EMI:
52                 /* BOOT_CFG1[3]: NOR/OneNAND Selection */
53                 switch ((reg & IMX6_BMODE_EMI_MASK) >> IMX6_BMODE_EMI_SHIFT) {
54                 case IMX6_BMODE_ONENAND:
55                         return BOOT_DEVICE_ONENAND;
56                 case IMX6_BMODE_NOR:
57                         return BOOT_DEVICE_NOR;
58                 break;
59                 }
60         /* Reserved: Used to force Serial Downloader */
61         case IMX6_BMODE_RESERVED:
62                 return BOOT_DEVICE_BOARD;
63         /* SATA: See 8.5.4, Table 8-20 */
64 #if !defined(CONFIG_MX6UL) && !defined(CONFIG_MX6ULL)
65         case IMX6_BMODE_SATA:
66                 return BOOT_DEVICE_SATA;
67 #endif
68         /* Serial ROM: See 8.5.5.1, Table 8-22 */
69         case IMX6_BMODE_SERIAL_ROM:
70                 /* BOOT_CFG4[2:0] */
71                 switch ((reg & IMX6_BMODE_SERIAL_ROM_MASK) >>
72                         IMX6_BMODE_SERIAL_ROM_SHIFT) {
73                 case IMX6_BMODE_ECSPI1:
74                 case IMX6_BMODE_ECSPI2:
75                 case IMX6_BMODE_ECSPI3:
76                 case IMX6_BMODE_ECSPI4:
77                 case IMX6_BMODE_ECSPI5:
78                         return BOOT_DEVICE_SPI;
79                 case IMX6_BMODE_I2C1:
80                 case IMX6_BMODE_I2C2:
81                 case IMX6_BMODE_I2C3:
82                         return BOOT_DEVICE_I2C;
83                 }
84                 break;
85         /* SD/eSD: 8.5.3, Table 8-15  */
86         case IMX6_BMODE_SD:
87         case IMX6_BMODE_ESD:
88         case IMX6_BMODE_MMC:
89         case IMX6_BMODE_EMMC:
90                 if (mmc_index == 1)
91                         return BOOT_DEVICE_MMC2;
92                 else
93                         return BOOT_DEVICE_MMC1;
94         /* NAND Flash: 8.5.2, Table 8-10 */
95         case IMX6_BMODE_NAND_MIN ... IMX6_BMODE_NAND_MAX:
96                 return BOOT_DEVICE_NAND;
97         }
98         return BOOT_DEVICE_NONE;
99 }
100
101 #elif defined(CONFIG_MX7) || defined(CONFIG_IMX8M) || defined(CONFIG_IMX8)
102 /* Translate iMX7/i.MX8M boot device to the SPL boot device enumeration */
103 u32 spl_boot_device(void)
104 {
105 #if defined(CONFIG_MX7)
106         unsigned int bmode = readl(&src_base->sbmr2);
107
108         /*
109          * Check for BMODE if serial downloader is enabled
110          * BOOT_MODE - see IMX7DRM Table 6-24
111          */
112         if (((bmode >> 24) & 0x03) == 0x01) /* Serial Downloader */
113                 return BOOT_DEVICE_BOARD;
114
115         /*
116          * The above method does not detect that the boot ROM used
117          * serial downloader in case the boot ROM decided to use the
118          * serial downloader as a fall back (primary boot source failed).
119          *
120          * Infer that the boot ROM used the USB serial downloader by
121          * checking whether the USB PHY is currently active... This
122          * assumes that SPL did not (yet) initialize the USB PHY...
123          */
124         if (is_boot_from_usb())
125                 return BOOT_DEVICE_BOARD;
126 #endif
127
128         enum boot_device boot_device_spl = get_boot_device();
129
130         switch (boot_device_spl) {
131 #if defined(CONFIG_MX7)
132         case SD1_BOOT:
133         case MMC1_BOOT:
134         case SD2_BOOT:
135         case MMC2_BOOT:
136         case SD3_BOOT:
137         case MMC3_BOOT:
138                 return BOOT_DEVICE_MMC1;
139 #elif defined(CONFIG_IMX8)
140         case MMC1_BOOT:
141                 return BOOT_DEVICE_MMC1;
142         case SD2_BOOT:
143                 return BOOT_DEVICE_MMC2_2;
144         case SD3_BOOT:
145                 return BOOT_DEVICE_MMC1;
146         case FLEXSPI_BOOT:
147                 return BOOT_DEVICE_SPI;
148 #elif defined(CONFIG_IMX8M)
149         case SD1_BOOT:
150         case MMC1_BOOT:
151                 return BOOT_DEVICE_MMC1;
152         case SD2_BOOT:
153         case MMC2_BOOT:
154                 return BOOT_DEVICE_MMC2;
155 #endif
156         case NAND_BOOT:
157                 return BOOT_DEVICE_NAND;
158         case SPI_NOR_BOOT:
159                 return BOOT_DEVICE_SPI;
160         case USB_BOOT:
161                 return BOOT_DEVICE_USB;
162         default:
163                 return BOOT_DEVICE_NONE;
164         }
165 }
166 #endif /* CONFIG_MX7 || CONFIG_IMX8M || CONFIG_IMX8 */
167
168 #ifdef CONFIG_SPL_USB_GADGET
169 int g_dnl_bind_fixup(struct usb_device_descriptor *dev, const char *name)
170 {
171         put_unaligned(CONFIG_USB_GADGET_PRODUCT_NUM + 0xfff, &dev->idProduct);
172
173         return 0;
174 }
175 #endif
176
177 #if defined(CONFIG_SPL_MMC_SUPPORT)
178 /* called from spl_mmc to see type of boot mode for storage (RAW or FAT) */
179 u32 spl_boot_mode(const u32 boot_device)
180 {
181 /*
182  * When CONFIG_SPL_FORCE_MMC_BOOT is defined the 'boot_device' is used
183  * unconditionally to decide about device to use for booting.
184  * This is crucial for falcon boot mode, when board boots up (i.e. ROM
185  * loads SPL) from slow SPI-NOR memory and afterwards the SPL's 'falcon' boot
186  * mode is used to load Linux OS from eMMC partition.
187  */
188 #ifdef CONFIG_SPL_FORCE_MMC_BOOT
189         switch (boot_device) {
190 #else
191         switch (spl_boot_device()) {
192 #endif
193         /* for MMC return either RAW or FAT mode */
194         case BOOT_DEVICE_MMC1:
195         case BOOT_DEVICE_MMC2:
196         case BOOT_DEVICE_MMC2_2:
197 #if defined(CONFIG_SPL_FS_FAT)
198                 return MMCSD_MODE_FS;
199 #elif defined(CONFIG_SUPPORT_EMMC_BOOT)
200                 return MMCSD_MODE_EMMCBOOT;
201 #else
202                 return MMCSD_MODE_RAW;
203 #endif
204                 break;
205         default:
206                 puts("spl: ERROR:  unsupported device\n");
207                 hang();
208         }
209 }
210 #endif
211
212 #if defined(CONFIG_SECURE_BOOT)
213
214 /*
215  * +------------+  0x0 (DDR_UIMAGE_START) -
216  * |   Header   |                          |
217  * +------------+  0x40                    |
218  * |            |                          |
219  * |            |                          |
220  * |            |                          |
221  * |            |                          |
222  * | Image Data |                          |
223  * .            |                          |
224  * .            |                           > Stuff to be authenticated ----+
225  * .            |                          |                                |
226  * |            |                          |                                |
227  * |            |                          |                                |
228  * +------------+                          |                                |
229  * |            |                          |                                |
230  * | Fill Data  |                          |                                |
231  * |            |                          |                                |
232  * +------------+ Align to ALIGN_SIZE      |                                |
233  * |    IVT     |                          |                                |
234  * +------------+ + IVT_SIZE              -                                 |
235  * |            |                                                           |
236  * |  CSF DATA  | <---------------------------------------------------------+
237  * |            |
238  * +------------+
239  * |            |
240  * | Fill Data  |
241  * |            |
242  * +------------+ + CSF_PAD_SIZE
243  */
244
245 __weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
246 {
247         typedef void __noreturn (*image_entry_noargs_t)(void);
248         uint32_t offset;
249
250         image_entry_noargs_t image_entry =
251                 (image_entry_noargs_t)(unsigned long)spl_image->entry_point;
252
253         debug("image entry point: 0x%lX\n", spl_image->entry_point);
254
255         if (spl_image->flags & SPL_FIT_FOUND) {
256                 image_entry();
257         } else {
258                 /*
259                  * HAB looks for the CSF at the end of the authenticated
260                  * data therefore, we need to subtract the size of the
261                  * CSF from the actual filesize
262                  */
263                 offset = spl_image->size - CONFIG_CSF_SIZE;
264                 if (!imx_hab_authenticate_image(spl_image->load_addr,
265                                                 offset + IVT_SIZE +
266                                                 CSF_PAD_SIZE, offset)) {
267                         image_entry();
268                 } else {
269                         puts("spl: ERROR:  image authentication fail\n");
270                         hang();
271                 }
272         }
273 }
274
275 #if !defined(CONFIG_SPL_FIT_SIGNATURE)
276 ulong board_spl_fit_size_align(ulong size)
277 {
278         /*
279          * HAB authenticate_image requests the IVT offset is
280          * aligned to 0x1000
281          */
282
283         size = ALIGN(size, 0x1000);
284         size += CONFIG_CSF_SIZE;
285
286         return size;
287 }
288
289 void board_spl_fit_post_load(ulong load_addr, size_t length)
290 {
291         u32 offset = length - CONFIG_CSF_SIZE;
292
293         if (imx_hab_authenticate_image(load_addr,
294                                        offset + IVT_SIZE + CSF_PAD_SIZE,
295                                        offset)) {
296                 puts("spl: ERROR:  image authentication unsuccessful\n");
297                 hang();
298         }
299 }
300 #endif
301
302 #endif
303
304 #if defined(CONFIG_MX6) && defined(CONFIG_SPL_OS_BOOT)
305 int dram_init_banksize(void)
306 {
307         gd->bd->bi_dram[0].start = CONFIG_SYS_SDRAM_BASE;
308         gd->bd->bi_dram[0].size = imx_ddr_size();
309
310         return 0;
311 }
312 #endif