1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Early boot support code for BootX bootloader
5 * Copyright (C) 2005 Ben. Herrenschmidt (benh@kernel.crashing.org)
8 #include <linux/kernel.h>
9 #include <linux/string.h>
10 #include <linux/init.h>
11 #include <generated/utsrelease.h>
12 #include <asm/sections.h>
15 #include <asm/bootx.h>
16 #include <asm/btext.h>
18 #include <asm/setup.h>
24 #define DBG(fmt...) do { bootx_printf(fmt); } while(0)
26 #define DBG(fmt...) do { } while(0)
29 extern void __start(unsigned long r3
, unsigned long r4
, unsigned long r5
);
31 static unsigned long __initdata bootx_dt_strbase
;
32 static unsigned long __initdata bootx_dt_strend
;
33 static unsigned long __initdata bootx_node_chosen
;
34 static boot_infos_t
* __initdata bootx_info
;
35 static char __initdata bootx_disp_path
[256];
37 /* Is boot-info compatible ? */
38 #define BOOT_INFO_IS_COMPATIBLE(bi) \
39 ((bi)->compatible_version <= BOOT_INFO_VERSION)
40 #define BOOT_INFO_IS_V2_COMPATIBLE(bi) ((bi)->version >= 2)
41 #define BOOT_INFO_IS_V4_COMPATIBLE(bi) ((bi)->version >= 4)
43 #ifdef CONFIG_BOOTX_TEXT
44 static void __init
bootx_printf(const char *format
, ...)
46 const char *p
, *q
, *s
;
50 va_start(args
, format
);
51 for (p
= format
; *p
!= 0; p
= q
) {
52 for (q
= p
; *q
!= 0 && *q
!= '\n' && *q
!= '%'; ++q
)
55 btext_drawtext(p
, q
- p
);
61 btext_drawstring("\r\n");
71 s
= va_arg(args
, const char *);
78 v
= va_arg(args
, unsigned long);
85 #else /* CONFIG_BOOTX_TEXT */
86 static void __init
bootx_printf(const char *format
, ...) {}
87 #endif /* CONFIG_BOOTX_TEXT */
89 static void * __init
bootx_early_getprop(unsigned long base
,
93 struct bootx_dt_node
*np
= (struct bootx_dt_node
*)(base
+ node
);
94 u32
*ppp
= &np
->properties
;
97 struct bootx_dt_prop
*pp
=
98 (struct bootx_dt_prop
*)(base
+ *ppp
);
100 if (strcmp((char *)((unsigned long)pp
->name
+ base
),
102 return (void *)((unsigned long)pp
->value
+ base
);
109 #define dt_push_token(token, mem) \
111 *(mem) = ALIGN(*(mem),4); \
112 *((u32 *)*(mem)) = token; \
116 static unsigned long __init
bootx_dt_find_string(char *str
)
120 s
= os
= (char *)bootx_dt_strbase
;
122 while (s
< (char *)bootx_dt_strend
) {
123 if (strcmp(s
, str
) == 0)
130 static void __init
bootx_dt_add_prop(char *name
, void *data
, int size
,
131 unsigned long *mem_end
)
133 unsigned long soff
= bootx_dt_find_string(name
);
137 bootx_printf("WARNING: Can't find string index for <%s>\n",
141 if (size
> 0x20000) {
142 bootx_printf("WARNING: ignoring large property ");
143 bootx_printf("%s length 0x%x\n", name
, size
);
146 dt_push_token(OF_DT_PROP
, mem_end
);
147 dt_push_token(size
, mem_end
);
148 dt_push_token(soff
, mem_end
);
150 /* push property content */
152 memcpy((void *)*mem_end
, data
, size
);
153 *mem_end
= ALIGN(*mem_end
+ size
, 4);
157 static void __init
bootx_add_chosen_props(unsigned long base
,
158 unsigned long *mem_end
)
162 bootx_dt_add_prop("linux,bootx", NULL
, 0, mem_end
);
164 if (bootx_info
->kernelParamsOffset
) {
165 char *args
= (char *)((unsigned long)bootx_info
) +
166 bootx_info
->kernelParamsOffset
;
167 bootx_dt_add_prop("bootargs", args
, strlen(args
) + 1, mem_end
);
169 if (bootx_info
->ramDisk
) {
170 val
= ((unsigned long)bootx_info
) + bootx_info
->ramDisk
;
171 bootx_dt_add_prop("linux,initrd-start", &val
, 4, mem_end
);
172 val
+= bootx_info
->ramDiskSize
;
173 bootx_dt_add_prop("linux,initrd-end", &val
, 4, mem_end
);
175 if (strlen(bootx_disp_path
))
176 bootx_dt_add_prop("linux,stdout-path", bootx_disp_path
,
177 strlen(bootx_disp_path
) + 1, mem_end
);
180 static void __init
bootx_add_display_props(unsigned long base
,
181 unsigned long *mem_end
,
184 boot_infos_t
*bi
= bootx_info
;
188 bootx_dt_add_prop("linux,boot-display", NULL
, 0, mem_end
);
189 bootx_dt_add_prop("linux,opened", NULL
, 0, mem_end
);
191 bootx_dt_add_prop("linux,bootx-noscreen", NULL
, 0, mem_end
);
193 tmp
= bi
->dispDeviceDepth
;
194 bootx_dt_add_prop("linux,bootx-depth", &tmp
, 4, mem_end
);
195 tmp
= bi
->dispDeviceRect
[2] - bi
->dispDeviceRect
[0];
196 bootx_dt_add_prop("linux,bootx-width", &tmp
, 4, mem_end
);
197 tmp
= bi
->dispDeviceRect
[3] - bi
->dispDeviceRect
[1];
198 bootx_dt_add_prop("linux,bootx-height", &tmp
, 4, mem_end
);
199 tmp
= bi
->dispDeviceRowBytes
;
200 bootx_dt_add_prop("linux,bootx-linebytes", &tmp
, 4, mem_end
);
201 tmp
= (u32
)bi
->dispDeviceBase
;
203 tmp
= (u32
)bi
->logicalDisplayBase
;
204 tmp
+= bi
->dispDeviceRect
[1] * bi
->dispDeviceRowBytes
;
205 tmp
+= bi
->dispDeviceRect
[0] * ((bi
->dispDeviceDepth
+ 7) / 8);
206 bootx_dt_add_prop("linux,bootx-addr", &tmp
, 4, mem_end
);
209 static void __init
bootx_dt_add_string(char *s
, unsigned long *mem_end
)
211 unsigned int l
= strlen(s
) + 1;
212 memcpy((void *)*mem_end
, s
, l
);
213 bootx_dt_strend
= *mem_end
= *mem_end
+ l
;
216 static void __init
bootx_scan_dt_build_strings(unsigned long base
,
218 unsigned long *mem_end
)
220 struct bootx_dt_node
*np
= (struct bootx_dt_node
*)(base
+ node
);
221 u32
*cpp
, *ppp
= &np
->properties
;
225 /* Keep refs to known nodes */
226 namep
= np
->full_name
? (char *)(base
+ np
->full_name
) : NULL
;
228 bootx_printf("Node without a full name !\n");
231 DBG("* strings: %s\n", namep
);
233 if (!strcmp(namep
, "/chosen")) {
234 DBG(" detected /chosen ! adding properties names !\n");
235 bootx_dt_add_string("linux,bootx", mem_end
);
236 bootx_dt_add_string("linux,stdout-path", mem_end
);
237 bootx_dt_add_string("linux,initrd-start", mem_end
);
238 bootx_dt_add_string("linux,initrd-end", mem_end
);
239 bootx_dt_add_string("bootargs", mem_end
);
240 bootx_node_chosen
= node
;
242 if (node
== bootx_info
->dispDeviceRegEntryOffset
) {
243 DBG(" detected display ! adding properties names !\n");
244 bootx_dt_add_string("linux,boot-display", mem_end
);
245 bootx_dt_add_string("linux,opened", mem_end
);
246 strlcpy(bootx_disp_path
, namep
, sizeof(bootx_disp_path
));
249 /* get and store all property names */
251 struct bootx_dt_prop
*pp
=
252 (struct bootx_dt_prop
*)(base
+ *ppp
);
254 namep
= pp
->name
? (char *)(base
+ pp
->name
) : NULL
;
255 if (namep
== NULL
|| strcmp(namep
, "name") == 0)
257 /* get/create string entry */
258 soff
= bootx_dt_find_string(namep
);
260 bootx_dt_add_string(namep
, mem_end
);
265 /* do all our children */
268 np
= (struct bootx_dt_node
*)(base
+ *cpp
);
269 bootx_scan_dt_build_strings(base
, *cpp
, mem_end
);
274 static void __init
bootx_scan_dt_build_struct(unsigned long base
,
276 unsigned long *mem_end
)
278 struct bootx_dt_node
*np
= (struct bootx_dt_node
*)(base
+ node
);
279 u32
*cpp
, *ppp
= &np
->properties
;
280 char *namep
, *p
, *ep
, *lp
;
283 dt_push_token(OF_DT_BEGIN_NODE
, mem_end
);
285 /* get the node's full name */
286 namep
= np
->full_name
? (char *)(base
+ np
->full_name
) : NULL
;
291 DBG("* struct: %s\n", namep
);
293 /* Fixup an Apple bug where they have bogus \0 chars in the
294 * middle of the path in some properties, and extract
295 * the unit name (everything after the last '/').
297 memcpy((void *)*mem_end
, namep
, l
+ 1);
298 namep
= (char *)*mem_end
;
299 for (lp
= p
= namep
, ep
= namep
+ l
; p
< ep
; p
++) {
306 *mem_end
= ALIGN((unsigned long)lp
+ 1, 4);
308 /* get and store all properties */
310 struct bootx_dt_prop
*pp
=
311 (struct bootx_dt_prop
*)(base
+ *ppp
);
313 namep
= pp
->name
? (char *)(base
+ pp
->name
) : NULL
;
315 if (namep
== NULL
|| !strcmp(namep
, "name"))
317 /* Skip "bootargs" in /chosen too as we replace it */
318 if (node
== bootx_node_chosen
&& !strcmp(namep
, "bootargs"))
321 /* push property head */
322 bootx_dt_add_prop(namep
,
323 pp
->value
? (void *)(base
+ pp
->value
): NULL
,
324 pp
->length
, mem_end
);
329 if (node
== bootx_node_chosen
) {
330 bootx_add_chosen_props(base
, mem_end
);
331 if (bootx_info
->dispDeviceRegEntryOffset
== 0)
332 bootx_add_display_props(base
, mem_end
, 0);
334 else if (node
== bootx_info
->dispDeviceRegEntryOffset
)
335 bootx_add_display_props(base
, mem_end
, 1);
337 /* do all our children */
340 np
= (struct bootx_dt_node
*)(base
+ *cpp
);
341 bootx_scan_dt_build_struct(base
, *cpp
, mem_end
);
345 dt_push_token(OF_DT_END_NODE
, mem_end
);
348 static unsigned long __init
bootx_flatten_dt(unsigned long start
)
350 boot_infos_t
*bi
= bootx_info
;
351 unsigned long mem_start
, mem_end
;
352 struct boot_param_header
*hdr
;
356 /* Start using memory after the big blob passed by BootX, get
357 * some space for the header
359 mem_start
= mem_end
= ALIGN(((unsigned long)bi
) + start
, 4);
360 DBG("Boot params header at: %x\n", mem_start
);
361 hdr
= (struct boot_param_header
*)mem_start
;
362 mem_end
+= sizeof(struct boot_param_header
);
363 rsvmap
= (u64
*)(ALIGN(mem_end
, 8));
364 hdr
->off_mem_rsvmap
= ((unsigned long)rsvmap
) - mem_start
;
365 mem_end
= ((unsigned long)rsvmap
) + 8 * sizeof(u64
);
367 /* Get base of tree */
368 base
= ((unsigned long)bi
) + bi
->deviceTreeOffset
;
370 /* Build string array */
371 DBG("Building string array at: %x\n", mem_end
);
372 DBG("Device Tree Base=%x\n", base
);
373 bootx_dt_strbase
= mem_end
;
375 bootx_dt_strend
= mem_end
;
376 bootx_scan_dt_build_strings(base
, 4, &mem_end
);
377 /* Add some strings */
378 bootx_dt_add_string("linux,bootx-noscreen", &mem_end
);
379 bootx_dt_add_string("linux,bootx-depth", &mem_end
);
380 bootx_dt_add_string("linux,bootx-width", &mem_end
);
381 bootx_dt_add_string("linux,bootx-height", &mem_end
);
382 bootx_dt_add_string("linux,bootx-linebytes", &mem_end
);
383 bootx_dt_add_string("linux,bootx-addr", &mem_end
);
384 /* Wrap up strings */
385 hdr
->off_dt_strings
= bootx_dt_strbase
- mem_start
;
386 hdr
->dt_strings_size
= bootx_dt_strend
- bootx_dt_strbase
;
388 /* Build structure */
389 mem_end
= ALIGN(mem_end
, 16);
390 DBG("Building device tree structure at: %x\n", mem_end
);
391 hdr
->off_dt_struct
= mem_end
- mem_start
;
392 bootx_scan_dt_build_struct(base
, 4, &mem_end
);
393 dt_push_token(OF_DT_END
, &mem_end
);
396 hdr
->boot_cpuid_phys
= 0;
397 hdr
->magic
= OF_DT_HEADER
;
398 hdr
->totalsize
= mem_end
- mem_start
;
399 hdr
->version
= OF_DT_VERSION
;
400 /* Version 16 is not backward compatible */
401 hdr
->last_comp_version
= 0x10;
403 /* Reserve the whole thing and copy the reserve map in, we
404 * also bump mem_reserve_cnt to cause further reservations to
405 * fail since it's too late.
407 mem_end
= ALIGN(mem_end
, PAGE_SIZE
);
408 DBG("End of boot params: %x\n", mem_end
);
409 rsvmap
[0] = mem_start
;
411 if (bootx_info
->ramDisk
) {
412 rsvmap
[2] = ((unsigned long)bootx_info
) + bootx_info
->ramDisk
;
413 rsvmap
[3] = rsvmap
[2] + bootx_info
->ramDiskSize
;
421 return (unsigned long)hdr
;
425 #ifdef CONFIG_BOOTX_TEXT
426 static void __init
btext_welcome(boot_infos_t
*bi
)
431 bootx_printf("Welcome to Linux, kernel " UTS_RELEASE
"\n");
432 bootx_printf("\nlinked at : 0x%x", KERNELBASE
);
433 bootx_printf("\nframe buffer at : 0x%x", bi
->dispDeviceBase
);
434 bootx_printf(" (phys), 0x%x", bi
->logicalDisplayBase
);
435 bootx_printf(" (log)");
436 bootx_printf("\nklimit : 0x%x",(unsigned long)klimit
);
437 bootx_printf("\nboot_info at : 0x%x", bi
);
438 __asm__
__volatile__ ("mfmsr %0" : "=r" (flags
));
439 bootx_printf("\nMSR : 0x%x", flags
);
440 __asm__
__volatile__ ("mfspr %0, 287" : "=r" (pvr
));
441 bootx_printf("\nPVR : 0x%x", pvr
);
444 __asm__
__volatile__ ("mfspr %0, 1008" : "=r" (flags
));
445 bootx_printf("\nHID0 : 0x%x", flags
);
447 if (pvr
== 8 || pvr
== 12 || pvr
== 0x800c) {
448 __asm__
__volatile__ ("mfspr %0, 1019" : "=r" (flags
));
449 bootx_printf("\nICTC : 0x%x", flags
);
452 bootx_printf("\n\n");
453 bootx_printf("bi->deviceTreeOffset : 0x%x\n",
454 bi
->deviceTreeOffset
);
455 bootx_printf("bi->deviceTreeSize : 0x%x\n",
458 bootx_printf("\n\n");
460 #endif /* CONFIG_BOOTX_TEXT */
462 void __init
bootx_init(unsigned long r3
, unsigned long r4
)
464 boot_infos_t
*bi
= (boot_infos_t
*) r4
;
469 unsigned long offset
= reloc_offset();
475 /* We haven't cleared any bss at this point, make sure
476 * what we need is initialized
478 bootx_dt_strbase
= bootx_dt_strend
= 0;
479 bootx_node_chosen
= 0;
480 bootx_disp_path
[0] = 0;
482 if (!BOOT_INFO_IS_V2_COMPATIBLE(bi
))
483 bi
->logicalDisplayBase
= bi
->dispDeviceBase
;
485 /* Fixup depth 16 -> 15 as that's what MacOS calls 16bpp */
486 if (bi
->dispDeviceDepth
== 16)
487 bi
->dispDeviceDepth
= 15;
490 #ifdef CONFIG_BOOTX_TEXT
491 ptr
= (unsigned long)bi
->logicalDisplayBase
;
492 ptr
+= bi
->dispDeviceRect
[1] * bi
->dispDeviceRowBytes
;
493 ptr
+= bi
->dispDeviceRect
[0] * ((bi
->dispDeviceDepth
+ 7) / 8);
494 btext_setup_display(bi
->dispDeviceRect
[2] - bi
->dispDeviceRect
[0],
495 bi
->dispDeviceRect
[3] - bi
->dispDeviceRect
[1],
496 bi
->dispDeviceDepth
, bi
->dispDeviceRowBytes
,
497 (unsigned long)bi
->logicalDisplayBase
);
500 #endif /* CONFIG_BOOTX_TEXT */
503 * Test if boot-info is compatible. Done only in config
504 * CONFIG_BOOTX_TEXT since there is nothing much we can do
505 * with an incompatible version, except display a message
506 * and eventually hang the processor...
508 * I'll try to keep enough of boot-info compatible in the
509 * future to always allow display of this message;
511 if (!BOOT_INFO_IS_COMPATIBLE(bi
)) {
512 bootx_printf(" !!! WARNING - Incompatible version"
513 " of BootX !!!\n\n\n");
517 if (bi
->architecture
!= BOOT_ARCH_PCI
) {
518 bootx_printf(" !!! WARNING - Unsupported machine"
519 " architecture !\n");
524 #ifdef CONFIG_BOOTX_TEXT
528 /* New BootX enters kernel with MMU off, i/os are not allowed
529 * here. This hack will have been done by the boostrap anyway.
531 if (bi
->version
< 4) {
533 * XXX If this is an iMac, turn off the USB controller.
535 model
= (char *) bootx_early_getprop(r4
+ bi
->deviceTreeOffset
,
538 && (strcmp(model
, "iMac,1") == 0
539 || strcmp(model
, "PowerMac1,1") == 0)) {
540 bootx_printf("iMac,1 detected, shutting down USB\n");
541 out_le32((unsigned __iomem
*)0x80880008, 1); /* XXX */
545 /* Get a pointer that points above the device tree, args, ramdisk,
546 * etc... to use for generating the flattened tree
548 if (bi
->version
< 5) {
549 space
= bi
->deviceTreeOffset
+ bi
->deviceTreeSize
;
550 if (bi
->ramDisk
>= space
)
551 space
= bi
->ramDisk
+ bi
->ramDiskSize
;
553 space
= bi
->totalParamsSize
;
555 bootx_printf("Total space used by parameters & ramdisk: 0x%x\n", space
);
557 /* New BootX will have flushed all TLBs and enters kernel with
558 * MMU switched OFF, so this should not be useful anymore.
560 if (bi
->version
< 4) {
561 unsigned long x __maybe_unused
;
563 bootx_printf("Touching pages...\n");
566 * Touch each page to make sure the PTEs for them
567 * are in the hash table - the aim is to try to avoid
568 * getting DSI exceptions while copying the kernel image.
570 for (ptr
= ((unsigned long) &_stext
) & PAGE_MASK
;
571 ptr
< (unsigned long)bi
+ space
; ptr
+= PAGE_SIZE
)
572 x
= *(volatile unsigned long *)ptr
;
575 /* Ok, now we need to generate a flattened device-tree to pass
578 bootx_printf("Preparing boot params...\n");
580 hdr
= bootx_flatten_dt(space
);
582 #ifdef CONFIG_BOOTX_TEXT
584 bootx_printf("Preparing BAT...\n");
593 __start(hdr
, KERNELBASE
+ offset
, 0);