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