xref: /openbmc/u-boot/arch/arm/lib/bootm.c (revision 95390360121451337738f73ed2f75f8dfbdce831)
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 	armv8_switch_to_el2();
204 #ifdef CONFIG_ARMV8_SWITCH_TO_EL1
205 	armv8_switch_to_el1();
206 #endif
207 }
208 #endif
209 
210 /* Subcommand: PREP */
211 static void boot_prep_linux(bootm_headers_t *images)
212 {
213 	char *commandline = getenv("bootargs");
214 
215 	if (IMAGE_ENABLE_OF_LIBFDT && images->ft_len) {
216 #ifdef CONFIG_OF_LIBFDT
217 		debug("using: FDT\n");
218 		if (image_setup_linux(images)) {
219 			printf("FDT creation failed! hanging...");
220 			hang();
221 		}
222 #endif
223 	} else if (BOOTM_ENABLE_TAGS) {
224 		debug("using: ATAGS\n");
225 		setup_start_tag(gd->bd);
226 		if (BOOTM_ENABLE_SERIAL_TAG)
227 			setup_serial_tag(&params);
228 		if (BOOTM_ENABLE_CMDLINE_TAG)
229 			setup_commandline_tag(gd->bd, commandline);
230 		if (BOOTM_ENABLE_REVISION_TAG)
231 			setup_revision_tag(&params);
232 		if (BOOTM_ENABLE_MEMORY_TAGS)
233 			setup_memory_tags(gd->bd);
234 		if (BOOTM_ENABLE_INITRD_TAG) {
235 			/*
236 			 * In boot_ramdisk_high(), it may relocate ramdisk to
237 			 * a specified location. And set images->initrd_start &
238 			 * images->initrd_end to relocated ramdisk's start/end
239 			 * addresses. So use them instead of images->rd_start &
240 			 * images->rd_end when possible.
241 			 */
242 			if (images->initrd_start && images->initrd_end) {
243 				setup_initrd_tag(gd->bd, images->initrd_start,
244 						 images->initrd_end);
245 			} else if (images->rd_start && images->rd_end) {
246 				setup_initrd_tag(gd->bd, images->rd_start,
247 						 images->rd_end);
248 			}
249 		}
250 		setup_board_tags(&params);
251 		setup_end_tag(gd->bd);
252 	} else {
253 		printf("FDT and ATAGS support not compiled in - hanging\n");
254 		hang();
255 	}
256 }
257 
258 __weak bool armv7_boot_nonsec_default(void)
259 {
260 #ifdef CONFIG_ARMV7_BOOT_SEC_DEFAULT
261 	return false;
262 #else
263 	return true;
264 #endif
265 }
266 
267 #ifdef CONFIG_ARMV7_NONSEC
268 bool armv7_boot_nonsec(void)
269 {
270 	char *s = getenv("bootm_boot_mode");
271 	bool nonsec = armv7_boot_nonsec_default();
272 
273 	if (s && !strcmp(s, "sec"))
274 		nonsec = false;
275 
276 	if (s && !strcmp(s, "nonsec"))
277 		nonsec = true;
278 
279 	return nonsec;
280 }
281 #endif
282 
283 /* Subcommand: GO */
284 static void boot_jump_linux(bootm_headers_t *images, int flag)
285 {
286 #ifdef CONFIG_ARM64
287 	void (*kernel_entry)(void *fdt_addr, void *res0, void *res1,
288 			void *res2);
289 	int fake = (flag & BOOTM_STATE_OS_FAKE_GO);
290 
291 	kernel_entry = (void (*)(void *fdt_addr, void *res0, void *res1,
292 				void *res2))images->ep;
293 
294 	debug("## Transferring control to Linux (at address %lx)...\n",
295 		(ulong) kernel_entry);
296 	bootstage_mark(BOOTSTAGE_ID_RUN_OS);
297 
298 	announce_and_cleanup(fake);
299 
300 	if (!fake) {
301 		do_nonsec_virt_switch();
302 		kernel_entry(images->ft_addr, NULL, NULL, NULL);
303 	}
304 #else
305 	unsigned long machid = gd->bd->bi_arch_number;
306 	char *s;
307 	void (*kernel_entry)(int zero, int arch, uint params);
308 	unsigned long r2;
309 	int fake = (flag & BOOTM_STATE_OS_FAKE_GO);
310 
311 	kernel_entry = (void (*)(int, int, uint))images->ep;
312 
313 	s = getenv("machid");
314 	if (s) {
315 		if (strict_strtoul(s, 16, &machid) < 0) {
316 			debug("strict_strtoul failed!\n");
317 			return;
318 		}
319 		printf("Using machid 0x%lx from environment\n", machid);
320 	}
321 
322 	debug("## Transferring control to Linux (at address %08lx)" \
323 		"...\n", (ulong) kernel_entry);
324 	bootstage_mark(BOOTSTAGE_ID_RUN_OS);
325 	announce_and_cleanup(fake);
326 
327 	if (IMAGE_ENABLE_OF_LIBFDT && images->ft_len)
328 		r2 = (unsigned long)images->ft_addr;
329 	else
330 		r2 = gd->bd->bi_boot_params;
331 
332 	if (!fake) {
333 #ifdef CONFIG_ARMV7_NONSEC
334 		if (armv7_boot_nonsec()) {
335 			armv7_init_nonsec();
336 			secure_ram_addr(_do_nonsec_entry)(kernel_entry,
337 							  0, machid, r2);
338 		} else
339 #endif
340 			kernel_entry(0, machid, r2);
341 	}
342 #endif
343 }
344 
345 /* Main Entry point for arm bootm implementation
346  *
347  * Modeled after the powerpc implementation
348  * DIFFERENCE: Instead of calling prep and go at the end
349  * they are called if subcommand is equal 0.
350  */
351 int do_bootm_linux(int flag, int argc, char * const argv[],
352 		   bootm_headers_t *images)
353 {
354 	/* No need for those on ARM */
355 	if (flag & BOOTM_STATE_OS_BD_T || flag & BOOTM_STATE_OS_CMDLINE)
356 		return -1;
357 
358 	if (flag & BOOTM_STATE_OS_PREP) {
359 		boot_prep_linux(images);
360 		return 0;
361 	}
362 
363 	if (flag & (BOOTM_STATE_OS_GO | BOOTM_STATE_OS_FAKE_GO)) {
364 		boot_jump_linux(images, flag);
365 		return 0;
366 	}
367 
368 	boot_prep_linux(images);
369 	boot_jump_linux(images, flag);
370 	return 0;
371 }
372 
373 #if defined(CONFIG_BOOTM_VXWORKS)
374 void boot_prep_vxworks(bootm_headers_t *images)
375 {
376 #if defined(CONFIG_OF_LIBFDT)
377 	int off;
378 
379 	if (images->ft_addr) {
380 		off = fdt_path_offset(images->ft_addr, "/memory");
381 		if (off < 0) {
382 #ifdef CONFIG_ARCH_FIXUP_FDT
383 			if (arch_fixup_fdt(images->ft_addr))
384 				puts("## WARNING: fixup memory failed!\n");
385 #endif
386 		}
387 	}
388 #endif
389 	cleanup_before_linux();
390 }
391 void boot_jump_vxworks(bootm_headers_t *images)
392 {
393 	/* ARM VxWorks requires device tree physical address to be passed */
394 	((void (*)(void *))images->ep)(images->ft_addr);
395 }
396 #endif
397