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