include/grub/i386/pc/memory.h

   1 /* memory.h - describe the memory map */
   2 /*
   3  *  GRUB  --  GRand Unified Bootloader
   4  *  Copyright (C) 2002,2007,2008  Free Software Foundation, Inc.
   5  *
   6  *  GRUB is free software: you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation, either version 3 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  GRUB is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with GRUB.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef GRUB_MEMORY_MACHINE_HEADER
  21 #define GRUB_MEMORY_MACHINE_HEADER      1
  22
  23 #include <grub/symbol.h>
  24 #include <grub/machine/machine.h>
  25 #ifndef ASM_FILE
  26 #include <grub/types.h>
  27 #include <grub/err.h>
  28 #include <grub/memory.h>
  29 #endif
  30
  31 /* The scratch buffer used in real mode code.  */
  32 #define GRUB_MEMORY_MACHINE_SCRATCH_ADDR        0x68000
  33 #define GRUB_MEMORY_MACHINE_SCRATCH_SEG (GRUB_MEMORY_MACHINE_SCRATCH_ADDR >> 4)
  34 #define GRUB_MEMORY_MACHINE_SCRATCH_SIZE        0x10000
  35
  36 /* The real mode stack.  */
  37 #define GRUB_MEMORY_MACHINE_REAL_STACK  (0x2000 - 0x10)
  38
  39 /* The size of the protect mode stack.  */
  40 #define GRUB_MEMORY_MACHINE_PROT_STACK_SIZE     0x8000
  41
  42 /* The upper memory area (starting at 640 kiB).  */
  43 #define GRUB_MEMORY_MACHINE_UPPER               0xa0000
  44
  45 /* The protected mode stack.  */
  46 #define GRUB_MEMORY_MACHINE_PROT_STACK  \
  47         (GRUB_MEMORY_MACHINE_SCRATCH_ADDR + GRUB_MEMORY_MACHINE_SCRATCH_SIZE \
  48          + GRUB_MEMORY_MACHINE_PROT_STACK_SIZE - 0x10)
  49
  50 /* The memory area where GRUB uses its own purpose. This part is not added
  51    into free memory for dynamic allocations.  */
  52 #define GRUB_MEMORY_MACHINE_RESERVED_START      \
  53         GRUB_MEMORY_MACHINE_SCRATCH_ADDR
  54 #define GRUB_MEMORY_MACHINE_RESERVED_END        \
  55         (GRUB_MEMORY_MACHINE_PROT_STACK + 0x10)
  56
  57 /* The area where GRUB is decompressed at early startup.  */
  58 #define GRUB_MEMORY_MACHINE_DECOMPRESSION_ADDR  0x100000
  59
  60 /* The address of a partition table passed to another boot loader.  */
  61 #define GRUB_MEMORY_MACHINE_PART_TABLE_ADDR     0x7be
  62
  63 /* The address where another boot loader is loaded.  */
  64 #define GRUB_MEMORY_MACHINE_BOOT_LOADER_ADDR    0x7c00
  65
  66 /* The flag for protected mode.  */
  67 #define GRUB_MEMORY_MACHINE_CR0_PE_ON           0x1
  68
  69 /* The code segment of the protected mode.  */
  70 #define GRUB_MEMORY_MACHINE_PROT_MODE_CSEG      0x8
  71
  72 /* The data segment of the protected mode.  */
  73 #define GRUB_MEMORY_MACHINE_PROT_MODE_DSEG      0x10
  74
  75 /* The code segment of the pseudo real mode.  */
  76 #define GRUB_MEMORY_MACHINE_PSEUDO_REAL_CSEG    0x18
  77
  78 /* The data segment of the pseudo real mode.  */
  79 #define GRUB_MEMORY_MACHINE_PSEUDO_REAL_DSEG    0x20
  80
  81 #define GRUB_MEMORY_MACHINE_BIOS_DATA_AREA_ADDR 0x400
  82
  83 #ifndef ASM_FILE
  84
  85 /* See http://heim.ifi.uio.no/~stanisls/helppc/bios_data_area.html for a
  86    description of the BIOS Data Area layout.  */
  87 struct grub_machine_bios_data_area
  88 {
  89   grub_uint8_t unused1[0x17];
  90   grub_uint8_t keyboard_flag_lower; /* 0x17 */
  91   grub_uint8_t unused2[0xf0 - 0x18];
  92 };
  93
  94 struct grub_machine_mmap_entry
  95 {
  96   grub_uint32_t size;
  97   grub_uint64_t addr;
  98   grub_uint64_t len;
  99 #define GRUB_MACHINE_MEMORY_AVAILABLE   1
 100 #define GRUB_MACHINE_MEMORY_RESERVED    2
 101 #define GRUB_MACHINE_MEMORY_ACPI        3
 102 #define GRUB_MACHINE_MEMORY_NVS         4
 103 #define GRUB_MACHINE_MEMORY_MAX_TYPE    4
 104   /* This one is special: it's used internally but is never reported
 105      by firmware. */
 106 #define GRUB_MACHINE_MEMORY_HOLE        5
 107
 108   grub_uint32_t type;
 109 } __attribute__((packed));
 110
 111 grub_err_t EXPORT_FUNC(grub_machine_mmap_iterate)
 112      (int NESTED_FUNC_ATTR (*hook) (grub_uint64_t, grub_uint64_t, grub_uint32_t));
 113
 114 grub_uint64_t grub_mmap_get_post64 (void);
 115 grub_uint64_t grub_mmap_get_upper (void);
 116 grub_uint64_t grub_mmap_get_lower (void);
 117
 118 #define GRUB_MMAP_MALLOC_LOW 1
 119
 120 #ifdef GRUB_MACHINE_PCBIOS
 121 grub_err_t grub_machine_mmap_register (grub_uint64_t start, grub_uint64_t size,
 122                                        int type, int handle);
 123 grub_err_t grub_machine_mmap_unregister (int handle);
 124 #else
 125 static inline grub_err_t
 126 grub_machine_mmap_register (grub_uint64_t start __attribute__ ((unused)),
 127                             grub_uint64_t size __attribute__ ((unused)),
 128                             int type __attribute__ ((unused)),
 129                             int handle __attribute__ ((unused)))
 130 {
 131   return GRUB_ERR_NONE;
 132 }
 133 static inline grub_err_t
 134 grub_machine_mmap_unregister (int handle  __attribute__ ((unused)))
 135 {
 136   return GRUB_ERR_NONE;
 137 }
 138 #endif
 139
 140 #endif
 141
 142 #endif /* ! GRUB_MEMORY_MACHINE_HEADER */