xref: /openbmc/u-boot/include/vxworks.h (revision ecab65e4)
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * (C) Copyright 2008
4  * Niklaus Giger, niklaus.giger@member.fsf.org
5  */
6 
7 #ifndef _VXWORKS_H_
8 #define _VXWORKS_H_
9 
10 #include <efi_api.h>
11 
12 /*
13  * Physical address of memory base for VxWorks x86
14  * This is LOCAL_MEM_LOCAL_ADRS in the VxWorks kernel configuration.
15  */
16 #define VXWORKS_PHYS_MEM_BASE	0x100000
17 
18 /* x86 bootline offset relative to LOCAL_MEM_LOCAL_ADRS in VxWorks */
19 #define X86_BOOT_LINE_OFFSET	0x1200
20 
21 /*
22  * VxWorks x86 E820 related stuff
23  *
24  * VxWorks on x86 gets E820 information from pre-defined offset @
25  * 0x4a00 and 0x4000. At 0x4a00 it's an information table defined
26  * by VxWorks and the actual E820 table entries starts from 0x4000.
27  * As defined by the BIOS E820 spec, the maximum number of E820 table
28  * entries is 128 and each entry occupies 20 bytes, so it's 128 * 20
29  * = 2560 (0xa00) bytes in total. That's where VxWorks stores some
30  * information that is retrieved from the BIOS E820 call and saved
31  * later for sanity test during the kernel boot-up.
32  */
33 #define E820_DATA_OFFSET	0x4000
34 #define E820_INFO_OFFSET	0x4a00
35 
36 /* E820 info signatiure "SMAP" - System MAP */
37 #define E820_SIGNATURE	0x534d4150
38 
39 struct e820_info {
40 	u32 sign;	/* "SMAP" signature */
41 	u32 x0;		/* don't care, used by VxWorks */
42 	u32 x1;		/* don't care, used by VxWorks */
43 	u32 x2;		/* don't care, used by VxWorks */
44 	u32 addr;	/* last e820 table entry addr */
45 	u32 x3;		/* don't care, used by VxWorks */
46 	u32 entries;	/* e820 table entry count */
47 	u32 error;	/* must be zero */
48 };
49 
50 /*
51  * VxWorks bootloader stores its size at a pre-defined offset @ 0x5004.
52  * Later when VxWorks kernel boots up and system memory information is
53  * retrieved from the E820 table, the bootloader size will be subtracted
54  * from the total system memory size to calculate the size of available
55  * memory for the OS.
56  */
57 #define BOOT_IMAGE_SIZE_OFFSET	0x5004
58 
59 /*
60  * When booting from EFI BIOS, VxWorks bootloader stores the EFI GOP
61  * framebuffer info at a pre-defined offset @ 0x6100. When VxWorks kernel
62  * boots up, its EFI console driver tries to find such a block and if
63  * the signature matches, the framebuffer information will be used to
64  * initialize the driver.
65  *
66  * However it is not necessary to prepare an EFI environment for VxWorks's
67  * EFI console driver to function (eg: EFI loader in U-Boot). If U-Boot has
68  * already initialized the graphics card and set it to a VESA mode that is
69  * compatible with EFI GOP, we can simply prepare such a block for VxWorks.
70  */
71 #define EFI_GOP_INFO_OFFSET	0x6100
72 
73 /* EFI GOP info signatiure */
74 #define EFI_GOP_INFO_MAGIC	0xfeedface
75 
76 struct efi_gop_info {
77 	u32 magic;			/* signature */
78 	struct efi_gop_mode_info info;	/* EFI GOP mode info structure */
79 	phys_addr_t fb_base;		/* framebuffer base address */
80 	u32 fb_size;			/* framebuffer size */
81 };
82 
83 int do_bootvx(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
84 void boot_prep_vxworks(bootm_headers_t *images);
85 void boot_jump_vxworks(bootm_headers_t *images);
86 
87 #endif
88