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