xref: /openbmc/u-boot/include/vxworks.h (revision 7ebfb3780cbb608baaffbf6835b642484fa02ba3)
1*83d290c5STom Rini /* SPDX-License-Identifier: GPL-2.0+ */
2e9084b23SNiklaus Giger /*
3e9084b23SNiklaus Giger  * (C) Copyright 2008
4e9084b23SNiklaus Giger  * Niklaus Giger, niklaus.giger@member.fsf.org
5e9084b23SNiklaus Giger  */
6e9084b23SNiklaus Giger 
7e9084b23SNiklaus Giger #ifndef _VXWORKS_H_
8e9084b23SNiklaus Giger #define _VXWORKS_H_
9e9084b23SNiklaus Giger 
10447ae4f7SBin Meng #include <efi_api.h>
11447ae4f7SBin Meng 
12b90ff0fdSBin Meng /*
132902be86SBin Meng  * Physical address of memory base for VxWorks x86
142902be86SBin Meng  * This is LOCAL_MEM_LOCAL_ADRS in the VxWorks kernel configuration.
152902be86SBin Meng  */
162902be86SBin Meng #define VXWORKS_PHYS_MEM_BASE	0x100000
172902be86SBin Meng 
1879c584e5SBin Meng /* x86 bootline offset relative to LOCAL_MEM_LOCAL_ADRS in VxWorks */
1979c584e5SBin Meng #define X86_BOOT_LINE_OFFSET	0x1200
2079c584e5SBin Meng 
212902be86SBin Meng /*
22b90ff0fdSBin Meng  * VxWorks x86 E820 related stuff
23b90ff0fdSBin Meng  *
242902be86SBin Meng  * VxWorks on x86 gets E820 information from pre-defined offset @
25b90ff0fdSBin Meng  * 0x4a00 and 0x4000. At 0x4a00 it's an information table defined
26b90ff0fdSBin Meng  * by VxWorks and the actual E820 table entries starts from 0x4000.
27b90ff0fdSBin Meng  * As defined by the BIOS E820 spec, the maximum number of E820 table
28b90ff0fdSBin Meng  * entries is 128 and each entry occupies 20 bytes, so it's 128 * 20
29b90ff0fdSBin Meng  * = 2560 (0xa00) bytes in total. That's where VxWorks stores some
30b90ff0fdSBin Meng  * information that is retrieved from the BIOS E820 call and saved
31b90ff0fdSBin Meng  * later for sanity test during the kernel boot-up.
32b90ff0fdSBin Meng  */
332902be86SBin Meng #define E820_DATA_OFFSET	0x4000
342902be86SBin Meng #define E820_INFO_OFFSET	0x4a00
35b90ff0fdSBin Meng 
36b90ff0fdSBin Meng /* E820 info signatiure "SMAP" - System MAP */
37b90ff0fdSBin Meng #define E820_SIGNATURE	0x534d4150
38b90ff0fdSBin Meng 
39fa5e91f7SBin Meng struct e820_info {
40b90ff0fdSBin Meng 	u32 sign;	/* "SMAP" signature */
41b90ff0fdSBin Meng 	u32 x0;		/* don't care, used by VxWorks */
42b90ff0fdSBin Meng 	u32 x1;		/* don't care, used by VxWorks */
43b90ff0fdSBin Meng 	u32 x2;		/* don't care, used by VxWorks */
44b90ff0fdSBin Meng 	u32 addr;	/* last e820 table entry addr */
45b90ff0fdSBin Meng 	u32 x3;		/* don't care, used by VxWorks */
46b90ff0fdSBin Meng 	u32 entries;	/* e820 table entry count */
47b90ff0fdSBin Meng 	u32 error;	/* must be zero */
48b90ff0fdSBin Meng };
49b90ff0fdSBin Meng 
501351700cSBin Meng /*
511351700cSBin Meng  * VxWorks bootloader stores its size at a pre-defined offset @ 0x5004.
521351700cSBin Meng  * Later when VxWorks kernel boots up and system memory information is
531351700cSBin Meng  * retrieved from the E820 table, the bootloader size will be subtracted
541351700cSBin Meng  * from the total system memory size to calculate the size of available
551351700cSBin Meng  * memory for the OS.
561351700cSBin Meng  */
571351700cSBin Meng #define BOOT_IMAGE_SIZE_OFFSET	0x5004
581351700cSBin Meng 
59447ae4f7SBin Meng /*
60447ae4f7SBin Meng  * When booting from EFI BIOS, VxWorks bootloader stores the EFI GOP
61447ae4f7SBin Meng  * framebuffer info at a pre-defined offset @ 0x6100. When VxWorks kernel
62447ae4f7SBin Meng  * boots up, its EFI console driver tries to find such a block and if
63447ae4f7SBin Meng  * the signature matches, the framebuffer information will be used to
64447ae4f7SBin Meng  * initialize the driver.
65447ae4f7SBin Meng  *
66447ae4f7SBin Meng  * However it is not necessary to prepare an EFI environment for VxWorks's
67447ae4f7SBin Meng  * EFI console driver to function (eg: EFI loader in U-Boot). If U-Boot has
68447ae4f7SBin Meng  * already initialized the graphics card and set it to a VESA mode that is
69447ae4f7SBin Meng  * compatible with EFI GOP, we can simply prepare such a block for VxWorks.
70447ae4f7SBin Meng  */
71447ae4f7SBin Meng #define EFI_GOP_INFO_OFFSET	0x6100
72447ae4f7SBin Meng 
73447ae4f7SBin Meng /* EFI GOP info signatiure */
74447ae4f7SBin Meng #define EFI_GOP_INFO_MAGIC	0xfeedface
75447ae4f7SBin Meng 
76447ae4f7SBin Meng struct efi_gop_info {
77447ae4f7SBin Meng 	u32 magic;			/* signature */
78447ae4f7SBin Meng 	struct efi_gop_mode_info info;	/* EFI GOP mode info structure */
79447ae4f7SBin Meng 	phys_addr_t fb_base;		/* framebuffer base address */
80447ae4f7SBin Meng 	u32 fb_size;			/* framebuffer size */
81447ae4f7SBin Meng };
82447ae4f7SBin Meng 
8354841ab5SWolfgang Denk int do_bootvx(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]);
84871a57bbSMiao Yan void boot_prep_vxworks(bootm_headers_t *images);
85871a57bbSMiao Yan void boot_jump_vxworks(bootm_headers_t *images);
86e9084b23SNiklaus Giger 
87e9084b23SNiklaus Giger #endif
88