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