xref: /openbmc/u-boot/arch/arm/lib/bootm.c (revision 4611d5ba)
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 <linux/compiler.h>
24 
25 #if defined(CONFIG_ARMV7_NONSEC) || defined(CONFIG_ARMV7_VIRT)
26 #include <asm/armv7.h>
27 #endif
28 
29 DECLARE_GLOBAL_DATA_PTR;
30 
31 static struct tag *params;
32 
33 static ulong get_sp(void)
34 {
35 	ulong ret;
36 
37 	asm("mov %0, sp" : "=r"(ret) : );
38 	return ret;
39 }
40 
41 void arch_lmb_reserve(struct lmb *lmb)
42 {
43 	ulong sp;
44 
45 	/*
46 	 * Booting a (Linux) kernel image
47 	 *
48 	 * Allocate space for command line and board info - the
49 	 * address should be as high as possible within the reach of
50 	 * the kernel (see CONFIG_SYS_BOOTMAPSZ settings), but in unused
51 	 * memory, which means far enough below the current stack
52 	 * pointer.
53 	 */
54 	sp = get_sp();
55 	debug("## Current stack ends at 0x%08lx ", sp);
56 
57 	/* adjust sp by 4K to be safe */
58 	sp -= 4096;
59 	lmb_reserve(lmb, sp,
60 		    gd->bd->bi_dram[0].start + gd->bd->bi_dram[0].size - sp);
61 }
62 
63 /**
64  * announce_and_cleanup() - Print message and prepare for kernel boot
65  *
66  * @fake: non-zero to do everything except actually boot
67  */
68 static void announce_and_cleanup(int fake)
69 {
70 	printf("\nStarting kernel ...%s\n\n", fake ?
71 		"(fake run for tracing)" : "");
72 	bootstage_mark_name(BOOTSTAGE_ID_BOOTM_HANDOFF, "start_kernel");
73 #ifdef CONFIG_BOOTSTAGE_FDT
74 	if (flag == BOOTM_STATE_OS_FAKE_GO)
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 static void do_nonsec_virt_switch(void)
189 {
190 #if defined(CONFIG_ARMV7_NONSEC) || defined(CONFIG_ARMV7_VIRT)
191 	if (armv7_switch_nonsec() == 0)
192 #ifdef CONFIG_ARMV7_VIRT
193 		if (armv7_switch_hyp() == 0)
194 			debug("entered HYP mode\n");
195 #else
196 		debug("entered non-secure state\n");
197 #endif
198 #endif
199 }
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 	do_nonsec_virt_switch();
238 }
239 
240 /* Subcommand: GO */
241 static void boot_jump_linux(bootm_headers_t *images, int flag)
242 {
243 	unsigned long machid = gd->bd->bi_arch_number;
244 	char *s;
245 	void (*kernel_entry)(int zero, int arch, uint params);
246 	unsigned long r2;
247 	int fake = (flag & BOOTM_STATE_OS_FAKE_GO);
248 
249 	kernel_entry = (void (*)(int, int, uint))images->ep;
250 
251 	s = getenv("machid");
252 	if (s) {
253 		strict_strtoul(s, 16, &machid);
254 		printf("Using machid 0x%lx from environment\n", machid);
255 	}
256 
257 	debug("## Transferring control to Linux (at address %08lx)" \
258 		"...\n", (ulong) kernel_entry);
259 	bootstage_mark(BOOTSTAGE_ID_RUN_OS);
260 	announce_and_cleanup(fake);
261 
262 	if (IMAGE_ENABLE_OF_LIBFDT && images->ft_len)
263 		r2 = (unsigned long)images->ft_addr;
264 	else
265 		r2 = gd->bd->bi_boot_params;
266 
267 	if (!fake)
268 		kernel_entry(0, machid, r2);
269 }
270 
271 /* Main Entry point for arm bootm implementation
272  *
273  * Modeled after the powerpc implementation
274  * DIFFERENCE: Instead of calling prep and go at the end
275  * they are called if subcommand is equal 0.
276  */
277 int do_bootm_linux(int flag, int argc, char *argv[], bootm_headers_t *images)
278 {
279 	/* No need for those on ARM */
280 	if (flag & BOOTM_STATE_OS_BD_T || flag & BOOTM_STATE_OS_CMDLINE)
281 		return -1;
282 
283 	if (flag & BOOTM_STATE_OS_PREP) {
284 		boot_prep_linux(images);
285 		return 0;
286 	}
287 
288 	if (flag & (BOOTM_STATE_OS_GO | BOOTM_STATE_OS_FAKE_GO)) {
289 		boot_jump_linux(images, flag);
290 		return 0;
291 	}
292 
293 	boot_prep_linux(images);
294 	boot_jump_linux(images, flag);
295 	return 0;
296 }
297 
298 #ifdef CONFIG_CMD_BOOTZ
299 
300 struct zimage_header {
301 	uint32_t	code[9];
302 	uint32_t	zi_magic;
303 	uint32_t	zi_start;
304 	uint32_t	zi_end;
305 };
306 
307 #define	LINUX_ARM_ZIMAGE_MAGIC	0x016f2818
308 
309 int bootz_setup(ulong image, ulong *start, ulong *end)
310 {
311 	struct zimage_header *zi;
312 
313 	zi = (struct zimage_header *)map_sysmem(image, 0);
314 	if (zi->zi_magic != LINUX_ARM_ZIMAGE_MAGIC) {
315 		puts("Bad Linux ARM zImage magic!\n");
316 		return 1;
317 	}
318 
319 	*start = zi->zi_start;
320 	*end = zi->zi_end;
321 
322 	printf("Kernel image @ %#08lx [ %#08lx - %#08lx ]\n", image, *start,
323 	      *end);
324 
325 	return 0;
326 }
327 
328 #endif	/* CONFIG_CMD_BOOTZ */
329