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