MdePkg/Acpi62: Add type 7 NFIT Platform Capabilities Structure support

[mirror_edk2.git] / OvmfPkg / OvmfXenElfHeaderGenerator.c

/** @file\r
  This program generates a hex array to be manually coppied into\r
  OvmfXen.fdf.\r
\r
  The purpose is for the flash device image to be recognize as an ELF.\r
\r
  Copyright (c) 2019, Citrix Systems, Inc.\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
**/\r
\r
#include "elf.h"\r
#include "fcntl.h"\r
#include "stdbool.h"\r
#include "stddef.h"\r
#include "stdio.h"\r
#include "stdlib.h"\r
\r
void\r
print_hdr (\r
  FILE    *file,\r
  void    *s,\r
  size_t  size,\r
  bool    end_delimiter\r
  )\r
{\r
  char  *c = s;\r
\r
  fprintf (file, "  ");\r
  while (size-- > 1) {\r
    fprintf (file, "0x%02hhx, ", *(c++));\r
  }\r
\r
  if (end_delimiter) {\r
    fprintf (file, "0x%02hhx,", *c);\r
  } else {\r
    fprintf (file, "0x%02hhx", *c);\r
  }\r
}\r
\r
/* Format for the XEN_ELFNOTE_PHYS32_ENTRY program segment */\r
#define XEN_ELFNOTE_PHYS32_ENTRY  18\r
typedef struct {\r
  uint32_t    name_size;\r
  uint32_t    desc_size;\r
  uint32_t    type;\r
  char        name[4];\r
  uint32_t    desc;\r
} xen_elfnote_phys32_entry;\r
\r
#define LICENSE_HDR  "\\r
## @file\r\n\\r
#  FDF include file that defines a PVH ELF header.\r\n\\r
#\r\n\\r
#  Copyright (c) 2022, Intel Corporation. All rights reserved.\r\n\\r
#\r\n\\r
#  SPDX-License-Identifier: BSD-2-Clause-Patent\r\n\\r
#\r\n\\r
##\r\n\\r
\r\n\\r
"\r
\r
int\r
main (\r
  int   argc,\r
  char  *argv[]\r
  )\r
{\r
  /* FW_SIZE */\r
  size_t  ovmf_blob_size = 0x00200000;\r
  /* Load OVMF at 1MB when running as PVH guest */\r
  uint32_t  ovmf_base_address = 0x00100000;\r
  uint32_t  ovmfxen_pvh_entry_point;\r
  size_t    offset_into_file = 0;\r
  char      *endptr, *str;\r
  long      param;\r
  FILE      *file = stdout;\r
\r
  /* Parse the size parameter */\r
  if (argc > 1) {\r
    str   = argv[1];\r
    param = strtol (str, &endptr, 10);\r
    if (endptr != str) {\r
      ovmf_blob_size = (size_t)param;\r
    }\r
  }\r
\r
  /* Parse the filepath parameter */\r
  if (argc > 2) {\r
    file = fopen (argv[2], "w");\r
    fprintf (file, LICENSE_HDR);\r
  }\r
\r
  /* Xen PVH entry point */\r
  ovmfxen_pvh_entry_point = ovmf_base_address + ovmf_blob_size - 0x30;\r
\r
  /* ELF file header */\r
 #ifdef PVH64\r
  Elf64_Ehdr  hdr = {\r
 #else\r
  Elf32_Ehdr  hdr = {\r
 #endif\r
    .e_ident   = ELFMAG,\r
    .e_type    = ET_EXEC,\r
    .e_machine = EM_386,\r
    .e_version = EV_CURRENT,\r
    .e_entry   = ovmfxen_pvh_entry_point,\r
    .e_flags   = R_386_NONE,\r
    .e_ehsize  = sizeof (hdr),\r
 #ifdef PVH64\r
    .e_phentsize = sizeof (Elf64_Phdr),\r
 #else\r
    .e_phentsize = sizeof (Elf32_Phdr),\r
 #endif\r
  };\r
\r
  offset_into_file += sizeof (hdr);\r
\r
 #ifdef PVH64\r
  hdr.e_ident[EI_CLASS] = ELFCLASS64;\r
 #else\r
  hdr.e_ident[EI_CLASS] = ELFCLASS32;\r
 #endif\r
  hdr.e_ident[EI_DATA]    = ELFDATA2LSB;\r
  hdr.e_ident[EI_VERSION] = EV_CURRENT;\r
  hdr.e_ident[EI_OSABI]   = ELFOSABI_LINUX;\r
  /* Placing program headers just after hdr */\r
  hdr.e_phoff = sizeof (hdr);\r
\r
  /* program header */\r
 #ifdef PVH64\r
  Elf64_Phdr  phdr_load = {\r
 #else\r
  Elf32_Phdr  phdr_load = {\r
 #endif\r
    .p_type   = PT_LOAD,\r
    .p_offset = 0, /* load everything */\r
    .p_paddr  = ovmf_base_address,\r
    .p_filesz = ovmf_blob_size,\r
    .p_memsz  = ovmf_blob_size,\r
    .p_flags  = PF_X | PF_W | PF_R,\r
 #ifdef PVH64\r
    .p_align  = 4,\r
 #else\r
    .p_align  = 0,\r
 #endif\r
  };\r
\r
  phdr_load.p_vaddr = phdr_load.p_paddr;\r
  hdr.e_phnum      += 1;\r
  offset_into_file += sizeof (phdr_load);\r
\r
  /* Xen ELF Note. */\r
\r
  xen_elfnote_phys32_entry  xen_elf_note = {\r
    .type      = XEN_ELFNOTE_PHYS32_ENTRY,\r
    .name      = "Xen",\r
    .desc      = ovmfxen_pvh_entry_point,\r
    .name_size =\r
      offsetof (xen_elfnote_phys32_entry, desc) -\r
      offsetof (xen_elfnote_phys32_entry, name),\r
    .desc_size =\r
      sizeof (xen_elfnote_phys32_entry) -\r
      offsetof (xen_elfnote_phys32_entry, desc),\r
  };\r
 #ifdef PVH64\r
  Elf64_Phdr  phdr_note = {\r
 #else\r
  Elf32_Phdr  phdr_note = {\r
 #endif\r
    .p_type   = PT_NOTE,\r
    .p_filesz = sizeof (xen_elf_note),\r
    .p_memsz  = sizeof (xen_elf_note),\r
    .p_flags  = PF_R,\r
 #ifdef PVH64\r
    .p_align  = 4,\r
 #else\r
    .p_align  = 0,\r
 #endif\r
  };\r
\r
  hdr.e_phnum       += 1;\r
  offset_into_file  += sizeof (phdr_note);\r
  phdr_note.p_offset = offset_into_file;\r
  phdr_note.p_paddr  = ovmf_base_address + phdr_note.p_offset;\r
  phdr_note.p_vaddr  = phdr_note.p_paddr;\r
\r
  /*\r
   * print elf header\r
   */\r
\r
  size_t  i;\r
  size_t  hdr_size  = sizeof (hdr);\r
  size_t  entry_off = offsetof (typeof(hdr), e_entry);\r
\r
  fprintf (file, "DATA = {\r\n");\r
\r
  fprintf (file, "  # ELF file header\r\n");\r
  print_hdr (file, &hdr, entry_off, true);\r
  fprintf (file, "\r\n");\r
  print_hdr (file, &hdr.e_entry, sizeof (hdr.e_entry), true);\r
  fprintf (file, " # hdr.e_entry\r\n");\r
  print_hdr (file, &hdr.e_entry + 1, hdr_size - entry_off - sizeof (hdr.e_entry), true);\r
\r
  fprintf (file, "\r\n\r\n  # ELF Program segment headers\r\n");\r
  fprintf (file, "  # - Load segment\r\n");\r
  for (i = 0; i < sizeof (phdr_load); i += 4) {\r
    print_hdr (file, ((char *)&phdr_load) + i, 4, true);\r
    fprintf (file, "\r\n");\r
  }\r
\r
  fprintf (file, "  # - ELFNOTE segment\r\n");\r
  for (i = 0; i < sizeof (phdr_note); i += 4) {\r
    print_hdr (file, ((char *)&phdr_note) + i, 4, true);\r
    fprintf (file, "\r\n");\r
  }\r
\r
  fprintf (file, "\r\n  # XEN_ELFNOTE_PHYS32_ENTRY\r\n");\r
  for (i = 0; i < sizeof (xen_elf_note); i += 4) {\r
    print_hdr (file, ((char *)&xen_elf_note) + i, 4, (sizeof (xen_elf_note) - i) > 4);\r
    fprintf (file, "\r\n");\r
  }\r
\r
  fprintf (file, "}\r\n");\r
\r
  return 0;\r
}\r