include/vxworks.h

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