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