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