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