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