armv8: Support loading 32-bit OS in AArch32 execution state
[oweals/u-boot.git] / arch / arm / lib / bootm.c
1 /* Copyright (C) 2011
2  * Corscience GmbH & Co. KG - Simon Schwarz <schwarz@corscience.de>
3  *  - Added prep subcommand support
4  *  - Reorganized source - modeled after powerpc version
5  *
6  * (C) Copyright 2002
7  * Sysgo Real-Time Solutions, GmbH <www.elinos.com>
8  * Marius Groeger <mgroeger@sysgo.de>
9  *
10  * Copyright (C) 2001  Erik Mouw (J.A.K.Mouw@its.tudelft.nl)
11  *
12  * SPDX-License-Identifier:     GPL-2.0+
13  */
14
15 #include <common.h>
16 #include <command.h>
17 #include <image.h>
18 #include <u-boot/zlib.h>
19 #include <asm/byteorder.h>
20 #include <libfdt.h>
21 #include <mapmem.h>
22 #include <fdt_support.h>
23 #include <asm/bootm.h>
24 #include <asm/secure.h>
25 #include <linux/compiler.h>
26 #include <bootm.h>
27 #include <vxworks.h>
28
29 #ifdef CONFIG_ARMV7_NONSEC
30 #include <asm/armv7.h>
31 #endif
32
33 DECLARE_GLOBAL_DATA_PTR;
34
35 static struct tag *params;
36
37 static ulong get_sp(void)
38 {
39         ulong ret;
40
41         asm("mov %0, sp" : "=r"(ret) : );
42         return ret;
43 }
44
45 void arch_lmb_reserve(struct lmb *lmb)
46 {
47         ulong sp;
48
49         /*
50          * Booting a (Linux) kernel image
51          *
52          * Allocate space for command line and board info - the
53          * address should be as high as possible within the reach of
54          * the kernel (see CONFIG_SYS_BOOTMAPSZ settings), but in unused
55          * memory, which means far enough below the current stack
56          * pointer.
57          */
58         sp = get_sp();
59         debug("## Current stack ends at 0x%08lx ", sp);
60
61         /* adjust sp by 4K to be safe */
62         sp -= 4096;
63         lmb_reserve(lmb, sp,
64                     gd->bd->bi_dram[0].start + gd->bd->bi_dram[0].size - sp);
65 }
66
67 __weak void board_quiesce_devices(void)
68 {
69 }
70
71 /**
72  * announce_and_cleanup() - Print message and prepare for kernel boot
73  *
74  * @fake: non-zero to do everything except actually boot
75  */
76 static void announce_and_cleanup(int fake)
77 {
78         printf("\nStarting kernel ...%s\n\n", fake ?
79                 "(fake run for tracing)" : "");
80         bootstage_mark_name(BOOTSTAGE_ID_BOOTM_HANDOFF, "start_kernel");
81 #ifdef CONFIG_BOOTSTAGE_FDT
82         bootstage_fdt_add_report();
83 #endif
84 #ifdef CONFIG_BOOTSTAGE_REPORT
85         bootstage_report();
86 #endif
87
88 #ifdef CONFIG_USB_DEVICE
89         udc_disconnect();
90 #endif
91
92         board_quiesce_devices();
93
94         cleanup_before_linux();
95 }
96
97 static void setup_start_tag (bd_t *bd)
98 {
99         params = (struct tag *)bd->bi_boot_params;
100
101         params->hdr.tag = ATAG_CORE;
102         params->hdr.size = tag_size (tag_core);
103
104         params->u.core.flags = 0;
105         params->u.core.pagesize = 0;
106         params->u.core.rootdev = 0;
107
108         params = tag_next (params);
109 }
110
111 static void setup_memory_tags(bd_t *bd)
112 {
113         int i;
114
115         for (i = 0; i < CONFIG_NR_DRAM_BANKS; i++) {
116                 params->hdr.tag = ATAG_MEM;
117                 params->hdr.size = tag_size (tag_mem32);
118
119                 params->u.mem.start = bd->bi_dram[i].start;
120                 params->u.mem.size = bd->bi_dram[i].size;
121
122                 params = tag_next (params);
123         }
124 }
125
126 static void setup_commandline_tag(bd_t *bd, char *commandline)
127 {
128         char *p;
129
130         if (!commandline)
131                 return;
132
133         /* eat leading white space */
134         for (p = commandline; *p == ' '; p++);
135
136         /* skip non-existent command lines so the kernel will still
137          * use its default command line.
138          */
139         if (*p == '\0')
140                 return;
141
142         params->hdr.tag = ATAG_CMDLINE;
143         params->hdr.size =
144                 (sizeof (struct tag_header) + strlen (p) + 1 + 4) >> 2;
145
146         strcpy (params->u.cmdline.cmdline, p);
147
148         params = tag_next (params);
149 }
150
151 static void setup_initrd_tag(bd_t *bd, ulong initrd_start, ulong initrd_end)
152 {
153         /* an ATAG_INITRD node tells the kernel where the compressed
154          * ramdisk can be found. ATAG_RDIMG is a better name, actually.
155          */
156         params->hdr.tag = ATAG_INITRD2;
157         params->hdr.size = tag_size (tag_initrd);
158
159         params->u.initrd.start = initrd_start;
160         params->u.initrd.size = initrd_end - initrd_start;
161
162         params = tag_next (params);
163 }
164
165 static void setup_serial_tag(struct tag **tmp)
166 {
167         struct tag *params = *tmp;
168         struct tag_serialnr serialnr;
169
170         get_board_serial(&serialnr);
171         params->hdr.tag = ATAG_SERIAL;
172         params->hdr.size = tag_size (tag_serialnr);
173         params->u.serialnr.low = serialnr.low;
174         params->u.serialnr.high= serialnr.high;
175         params = tag_next (params);
176         *tmp = params;
177 }
178
179 static void setup_revision_tag(struct tag **in_params)
180 {
181         u32 rev = 0;
182
183         rev = get_board_rev();
184         params->hdr.tag = ATAG_REVISION;
185         params->hdr.size = tag_size (tag_revision);
186         params->u.revision.rev = rev;
187         params = tag_next (params);
188 }
189
190 static void setup_end_tag(bd_t *bd)
191 {
192         params->hdr.tag = ATAG_NONE;
193         params->hdr.size = 0;
194 }
195
196 __weak void setup_board_tags(struct tag **in_params) {}
197
198 #ifdef CONFIG_ARM64
199 static void do_nonsec_virt_switch(void)
200 {
201         smp_kick_all_cpus();
202         dcache_disable();       /* flush cache before swtiching to EL2 */
203 }
204 #endif
205
206 /* Subcommand: PREP */
207 static void boot_prep_linux(bootm_headers_t *images)
208 {
209         char *commandline = getenv("bootargs");
210
211         if (IMAGE_ENABLE_OF_LIBFDT && images->ft_len) {
212 #ifdef CONFIG_OF_LIBFDT
213                 debug("using: FDT\n");
214                 if (image_setup_linux(images)) {
215                         printf("FDT creation failed! hanging...");
216                         hang();
217                 }
218 #endif
219         } else if (BOOTM_ENABLE_TAGS) {
220                 debug("using: ATAGS\n");
221                 setup_start_tag(gd->bd);
222                 if (BOOTM_ENABLE_SERIAL_TAG)
223                         setup_serial_tag(&params);
224                 if (BOOTM_ENABLE_CMDLINE_TAG)
225                         setup_commandline_tag(gd->bd, commandline);
226                 if (BOOTM_ENABLE_REVISION_TAG)
227                         setup_revision_tag(&params);
228                 if (BOOTM_ENABLE_MEMORY_TAGS)
229                         setup_memory_tags(gd->bd);
230                 if (BOOTM_ENABLE_INITRD_TAG) {
231                         /*
232                          * In boot_ramdisk_high(), it may relocate ramdisk to
233                          * a specified location. And set images->initrd_start &
234                          * images->initrd_end to relocated ramdisk's start/end
235                          * addresses. So use them instead of images->rd_start &
236                          * images->rd_end when possible.
237                          */
238                         if (images->initrd_start && images->initrd_end) {
239                                 setup_initrd_tag(gd->bd, images->initrd_start,
240                                                  images->initrd_end);
241                         } else if (images->rd_start && images->rd_end) {
242                                 setup_initrd_tag(gd->bd, images->rd_start,
243                                                  images->rd_end);
244                         }
245                 }
246                 setup_board_tags(&params);
247                 setup_end_tag(gd->bd);
248         } else {
249                 printf("FDT and ATAGS support not compiled in - hanging\n");
250                 hang();
251         }
252 }
253
254 __weak bool armv7_boot_nonsec_default(void)
255 {
256 #ifdef CONFIG_ARMV7_BOOT_SEC_DEFAULT
257         return false;
258 #else
259         return true;
260 #endif
261 }
262
263 #ifdef CONFIG_ARMV7_NONSEC
264 bool armv7_boot_nonsec(void)
265 {
266         char *s = getenv("bootm_boot_mode");
267         bool nonsec = armv7_boot_nonsec_default();
268
269         if (s && !strcmp(s, "sec"))
270                 nonsec = false;
271
272         if (s && !strcmp(s, "nonsec"))
273                 nonsec = true;
274
275         return nonsec;
276 }
277 #endif
278
279 #ifdef CONFIG_ARM64
280 #ifdef CONFIG_ARMV8_SWITCH_TO_EL1
281 static void switch_to_el1(void)
282 {
283         if ((IH_ARCH_DEFAULT == IH_ARCH_ARM64) &&
284             (images.os.arch == IH_ARCH_ARM))
285                 armv8_switch_to_el1(0, (u64)gd->bd->bi_arch_number,
286                                     (u64)images.ft_addr,
287                                     (u64)images.ep,
288                                     ES_TO_AARCH32);
289         else
290                 armv8_switch_to_el1((u64)images.ft_addr, 0, 0,
291                                     images.ep,
292                                     ES_TO_AARCH64);
293 }
294 #endif
295 #endif
296
297 /* Subcommand: GO */
298 static void boot_jump_linux(bootm_headers_t *images, int flag)
299 {
300 #ifdef CONFIG_ARM64
301         void (*kernel_entry)(void *fdt_addr, void *res0, void *res1,
302                         void *res2);
303         int fake = (flag & BOOTM_STATE_OS_FAKE_GO);
304
305         kernel_entry = (void (*)(void *fdt_addr, void *res0, void *res1,
306                                 void *res2))images->ep;
307
308         debug("## Transferring control to Linux (at address %lx)...\n",
309                 (ulong) kernel_entry);
310         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
311
312         announce_and_cleanup(fake);
313
314         if (!fake) {
315                 do_nonsec_virt_switch();
316
317 #ifdef CONFIG_ARMV8_SWITCH_TO_EL1
318                 armv8_switch_to_el2((u64)images->ft_addr, 0, 0,
319                                     (u64)switch_to_el1, ES_TO_AARCH64);
320 #else
321                 if ((IH_ARCH_DEFAULT == IH_ARCH_ARM64) &&
322                     (images->os.arch == IH_ARCH_ARM))
323                         armv8_switch_to_el2(0, (u64)gd->bd->bi_arch_number,
324                                             (u64)images->ft_addr,
325                                             (u64)images->ep,
326                                             ES_TO_AARCH32);
327                 else
328                         armv8_switch_to_el2((u64)images->ft_addr, 0, 0,
329                                             images->ep,
330                                             ES_TO_AARCH64);
331 #endif
332         }
333 #else
334         unsigned long machid = gd->bd->bi_arch_number;
335         char *s;
336         void (*kernel_entry)(int zero, int arch, uint params);
337         unsigned long r2;
338         int fake = (flag & BOOTM_STATE_OS_FAKE_GO);
339
340         kernel_entry = (void (*)(int, int, uint))images->ep;
341
342         s = getenv("machid");
343         if (s) {
344                 if (strict_strtoul(s, 16, &machid) < 0) {
345                         debug("strict_strtoul failed!\n");
346                         return;
347                 }
348                 printf("Using machid 0x%lx from environment\n", machid);
349         }
350
351         debug("## Transferring control to Linux (at address %08lx)" \
352                 "...\n", (ulong) kernel_entry);
353         bootstage_mark(BOOTSTAGE_ID_RUN_OS);
354         announce_and_cleanup(fake);
355
356         if (IMAGE_ENABLE_OF_LIBFDT && images->ft_len)
357                 r2 = (unsigned long)images->ft_addr;
358         else
359                 r2 = gd->bd->bi_boot_params;
360
361         if (!fake) {
362 #ifdef CONFIG_ARMV7_NONSEC
363                 if (armv7_boot_nonsec()) {
364                         armv7_init_nonsec();
365                         secure_ram_addr(_do_nonsec_entry)(kernel_entry,
366                                                           0, machid, r2);
367                 } else
368 #endif
369                         kernel_entry(0, machid, r2);
370         }
371 #endif
372 }
373
374 /* Main Entry point for arm bootm implementation
375  *
376  * Modeled after the powerpc implementation
377  * DIFFERENCE: Instead of calling prep and go at the end
378  * they are called if subcommand is equal 0.
379  */
380 int do_bootm_linux(int flag, int argc, char * const argv[],
381                    bootm_headers_t *images)
382 {
383         /* No need for those on ARM */
384         if (flag & BOOTM_STATE_OS_BD_T || flag & BOOTM_STATE_OS_CMDLINE)
385                 return -1;
386
387         if (flag & BOOTM_STATE_OS_PREP) {
388                 boot_prep_linux(images);
389                 return 0;
390         }
391
392         if (flag & (BOOTM_STATE_OS_GO | BOOTM_STATE_OS_FAKE_GO)) {
393                 boot_jump_linux(images, flag);
394                 return 0;
395         }
396
397         boot_prep_linux(images);
398         boot_jump_linux(images, flag);
399         return 0;
400 }
401
402 #if defined(CONFIG_BOOTM_VXWORKS)
403 void boot_prep_vxworks(bootm_headers_t *images)
404 {
405 #if defined(CONFIG_OF_LIBFDT)
406         int off;
407
408         if (images->ft_addr) {
409                 off = fdt_path_offset(images->ft_addr, "/memory");
410                 if (off < 0) {
411 #ifdef CONFIG_ARCH_FIXUP_FDT
412                         if (arch_fixup_fdt(images->ft_addr))
413                                 puts("## WARNING: fixup memory failed!\n");
414 #endif
415                 }
416         }
417 #endif
418         cleanup_before_linux();
419 }
420 void boot_jump_vxworks(bootm_headers_t *images)
421 {
422         /* ARM VxWorks requires device tree physical address to be passed */
423         ((void (*)(void *))images->ep)(images->ft_addr);
424 }
425 #endif