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