GRUB2/MOD_SRC/grub-2.04/include/grub/kernel.h

   1 /*
   2  *  GRUB  --  GRand Unified Bootloader
   3  *  Copyright (C) 2002,2005,2006,2007,2008,2009  Free Software Foundation, Inc.
   4  *
   5  *  GRUB is free software: you can redistribute it and/or modify
   6  *  it under the terms of the GNU General Public License as published by
   7  *  the Free Software Foundation, either version 3 of the License, or
   8  *  (at your option) any later version.
   9  *
  10  *  GRUB is distributed in the hope that it will be useful,
  11  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  *  GNU General Public License for more details.
  14  *
  15  *  You should have received a copy of the GNU General Public License
  16  *  along with GRUB.  If not, see <http://www.gnu.org/licenses/>.
  17  */
  18
  19 #ifndef GRUB_KERNEL_HEADER
  20 #define GRUB_KERNEL_HEADER      1
  21
  22 #include <grub/types.h>
  23 #include <grub/symbol.h>
  24
  25 enum
  26 {
  27   OBJ_TYPE_ELF,
  28   OBJ_TYPE_MEMDISK,
  29   OBJ_TYPE_CONFIG,
  30   OBJ_TYPE_PREFIX,
  31   OBJ_TYPE_PUBKEY,
  32   OBJ_TYPE_DTB
  33 };
  34
  35 /* The module header.  */
  36 struct grub_module_header
  37 {
  38   /* The type of object.  */
  39   grub_uint32_t type;
  40   /* The size of object (including this header).  */
  41   grub_uint32_t size;
  42 };
  43
  44 /* "gmim" (GRUB Module Info Magic).  */
  45 #define GRUB_MODULE_MAGIC 0x676d696d
  46
  47 struct grub_module_info32
  48 {
  49   /* Magic number so we know we have modules present.  */
  50   grub_uint32_t magic;
  51   /* The offset of the modules.  */
  52   grub_uint32_t offset;
  53   /* The size of all modules plus this header.  */
  54   grub_uint32_t size;
  55 };
  56
  57 struct grub_module_info64
  58 {
  59   /* Magic number so we know we have modules present.  */
  60   grub_uint32_t magic;
  61   grub_uint32_t padding;
  62   /* The offset of the modules.  */
  63   grub_uint64_t offset;
  64   /* The size of all modules plus this header.  */
  65   grub_uint64_t size;
  66 };
  67
  68 #ifndef GRUB_UTIL
  69 /* Space isn't reusable on some platforms.  */
  70 /* On Qemu the preload space is readonly.  */
  71 /* On emu there is no preload space.  */
  72 /* On ieee1275 our code assumes that heap is p=v which isn't guaranteed for module space.  */
  73 #if defined (GRUB_MACHINE_QEMU) || defined (GRUB_MACHINE_EMU) \
  74   || defined (GRUB_MACHINE_EFI) \
  75   || (defined (GRUB_MACHINE_IEEE1275) && !defined (__sparc__))
  76 #define GRUB_KERNEL_PRELOAD_SPACE_REUSABLE 0
  77 #endif
  78
  79 #if defined (GRUB_MACHINE_PCBIOS) || defined (GRUB_MACHINE_COREBOOT) \
  80   || defined (GRUB_MACHINE_MULTIBOOT) || defined (GRUB_MACHINE_MIPS_QEMU_MIPS) \
  81   || defined (GRUB_MACHINE_MIPS_LOONGSON) || defined (GRUB_MACHINE_ARC) \
  82   || (defined (__sparc__) && defined (GRUB_MACHINE_IEEE1275)) \
  83   || defined (GRUB_MACHINE_UBOOT) || defined (GRUB_MACHINE_XEN) \
  84   || defined(GRUB_MACHINE_XEN_PVH)
  85 /* FIXME: stack is between 2 heap regions. Move it.  */
  86 #define GRUB_KERNEL_PRELOAD_SPACE_REUSABLE 1
  87 #endif
  88
  89 #ifndef GRUB_KERNEL_PRELOAD_SPACE_REUSABLE
  90 #error "Please check if preload space is reusable on this platform!"
  91 #endif
  92
  93 #if GRUB_TARGET_SIZEOF_VOID_P == 8
  94 #define grub_module_info grub_module_info64
  95 #else
  96 #define grub_module_info grub_module_info32
  97 #endif
  98
  99 extern grub_addr_t EXPORT_VAR (grub_modbase);
 100
 101 void EXPORT_FUNC(ventoy_env_hook_root)(int hook);
 102
 103 #define FOR_MODULES(var)  for (\
 104   var = (grub_modbase && ((((struct grub_module_info *) grub_modbase)->magic) == GRUB_MODULE_MAGIC)) ? (struct grub_module_header *) \
 105     (grub_modbase + (((struct grub_module_info *) grub_modbase)->offset)) : 0;\
 106   var && (grub_addr_t) var \
 107     < (grub_modbase + (((struct grub_module_info *) grub_modbase)->size));    \
 108   var = (struct grub_module_header *)                                   \
 109     (((grub_uint32_t *) var) + ((((struct grub_module_header *) var)->size + sizeof (grub_addr_t) - 1) / sizeof (grub_addr_t)) * (sizeof (grub_addr_t) / sizeof (grub_uint32_t))))
 110
 111 grub_addr_t grub_modules_get_end (void);
 112
 113 #endif
 114
 115 /* The start point of the C code.  */
 116 void grub_main (void) __attribute__ ((noreturn));
 117
 118 /* The machine-specific initialization. This must initialize memory.  */
 119 void grub_machine_init (void);
 120
 121 /* The machine-specific finalization.  */
 122 void EXPORT_FUNC(grub_machine_fini) (int flags);
 123
 124 /* The machine-specific prefix initialization.  */
 125 void
 126 grub_machine_get_bootlocation (char **device, char **path);
 127
 128 /* Register all the exported symbols. This is automatically generated.  */
 129 void grub_register_exported_symbols (void);
 130
 131 extern void (*EXPORT_VAR(grub_net_poll_cards_idle)) (void);
 132
 133 #endif /* ! GRUB_KERNEL_HEADER */