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