git.gag.com Git - debian/elilo/blob - ia32/sysdeps.h

   1 /*
   2  *  Copyright (C) 2001-2003 Hewlett-Packard Co.
   3  *      Contributed by Stephane Eranian <eranian@hpl.hp.com>
   4  *      Contributed by Mike Johnston <johnston@intel.com>
   5  *      Contributed by Chris Ahna <christopher.j.ahna@intel.com>
   6  *
   7  * This file is part of the ELILO, the EFI Linux boot loader.
   8  *
   9  *  ELILO is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License as published by
  11  *  the Free Software Foundation; either version 2, or (at your option)
  12  *  any later version.
  13  *
  14  *  ELILO is distributed in the hope that it will be useful,
  15  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  *  GNU General Public License for more details.
  18  *
  19  *  You should have received a copy of the GNU General Public License
  20  *  along with ELILO; see the file COPYING.  If not, write to the Free
  21  *  Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  22  *  02111-1307, USA.
  23  *
  24  * Please check out the elilo.txt for complete documentation on how
  25  * to use this program.
  26  */
  27
  28 /*
  29  * This file is used to define all the IA32-specific data structures
  30  * and constant used by the generic ELILO
  31  */
  32 #ifndef __ELILO_SYSDEPS_IA32_H__
  33 #define __ELILO_SYSDEPS_IA32_H__
  34
  35 #define ELILO_ARCH      "IA-32" /* ASCII string */
  36 #define PADDR_MASK      0xfffffff
  37
  38 /* for now use library versions */
  39 #define Memset(a,v,n)   SetMem((a),(n),(v))
  40 #define Memcpy(a,b,n)   CopyMem((a),(b),(n))
  41
  42 /*
  43  * This version must match the one in the kernel.
  44  *
  45  * This table was put together using information from the
  46  * following Linux kernel source files:
  47  *   linux/include/tty.h
  48  *   linux/arch/i386/kernel/setup.c
  49  *   linux/arch/i386/boot/bootsect.S
  50  *   linux/arch/i386/boot/setup.S
  51  *   linux/arch/i386/boot/video.S
  52  *
  53  * New fields in this structure for EFI and ELILO are:
  54  *   efi_loader_sig
  55  *   efi_st_addr
  56  *
  57  * A new bit, LDRFLAG_BOOT_PARAM_RELOC, in the loader_flags
  58  * field is also defined in this file.
  59  */
  60
  61 #pragma pack(1)
  62
  63 /* Definitions for converting EFI memory map to E820 map for Linux
  64  * These definitions are from include/linux/asm-x86/e820.h
  65  * The structure ia32_boot_params below is updated to accommodate E820 map
  66  * EFI memory map is converted to E820 map in this structure and passed
  67  * to Linux. This way the OS does not need to do the conversion.
  68  */
  69
  70 #define E820_RAM        1
  71 #define E820_RESERVED   2
  72 #define E820_ACPI       3
  73 #define E820_NVS        4
  74 #define E820_MAX        128
  75
  76 struct e820entry {
  77         UINT64 addr;    /* start of memory segment */
  78         UINT64 size;    /* size of memory segment */
  79         UINT32 type;    /* type of memory segment */
  80 } __attribute__((packed));
  81
  82 typedef union ia32_boot_params {
  83         UINT8 raw[0x2000];
  84         struct {
  85 /* Cursor position before passing control to kernel. */
  86 /* 0x00 */      UINT8 orig_cursor_col;          /* LDR */
  87 /* 0x01 */      UINT8 orig_cursor_row;          /* LDR */
  88
  89 /* Available contiguous extended memory in KB. */
  90 /* 0x02 */      UINT16 ext_mem_k;               /* LDR */
  91
  92 /* Video page, mode and screen width before passing control to kernel. */
  93 /* 0x04 */      UINT16 orig_video_page;         /* LDR */
  94 /* 0x06 */      UINT8 orig_video_mode;          /* LDR */
  95 /* 0x07 */      UINT8 orig_video_cols;          /* LDR */
  96
  97 /* 0x08 */      UINT16 unused_1;                /* unused */
  98
  99 /* %%TBD */
 100 /* 0x0A */      UINT16 orig_ega_bx;             /* LDR */
 101
 102 /* 0x0C */      UINT16 unused_2;                /* unused */
 103
 104 /* Screen height before passing control to kernel. */
 105 /* 0x0E */      UINT8 orig_video_rows;          /* LDR */
 106
 107 /* %%TBD */
 108 /* 0x0F */      UINT8 is_vga;                   /* LDR */
 109 /* 0x10 */      UINT16 orig_video_points;       /* LDR */
 110
 111 /* %%TBD */
 112 /* 0x12 */      UINT16 lfb_width;               /* LDR */
 113 /* 0x14 */      UINT16 lfb_height;              /* LDR */
 114 /* 0x16 */      UINT16 lfb_depth;               /* LDR */
 115 /* 0x18 */      UINT32 lfb_base;                /* LDR */
 116 /* 0x1C */      UINT32 lfb_size;                /* LDR */
 117
 118 /* Offset of command line (from start of ia32_boot_param struct). */
 119 /* The command line magik number must be set for the kernel setup */
 120 /* code to use the command line offset. */
 121 /* 0x20 */      UINT16 cmdline_magik;           /* LDR */
 122 #define CMDLINE_MAGIK           0xA33F
 123 /* 0x22 */      UINT16 cmdline_offset;          /* LDR */
 124
 125 /* %%TBD */
 126 /* 0x24 */      UINT16 lfb_line_len;            /* LDR */
 127
 128 /* %%TBD */
 129 /* 0x26 */      UINT8 lfb_red_size;             /* LDR */
 130 /* 0x27 */      UINT8 lfb_red_pos;              /* LDR */
 131 /* 0x28 */      UINT8 lfb_green_size;           /* LDR */
 132 /* 0x29 */      UINT8 lfb_green_pos;            /* LDR */
 133 /* 0x2A */      UINT8 lfb_blue_size;            /* LDR */
 134 /* 0x2B */      UINT8 lfb_blue_pos;             /* LDR */
 135 /* 0x2C */      UINT8 lfb_rsvd_size;            /* LDR */
 136 /* 0x2D */      UINT8 lfb_rsvd_pos;             /* LDR */
 137
 138 /* %%TBD */
 139 /* 0x2E */      UINT16 vesa_seg;                /* LDR */
 140 /* 0x30 */      UINT16 vesa_off;                /* LDR */
 141
 142 /* %%TBD */
 143 /* 0x32 */      UINT16 lfb_pages;               /* LDR */
 144 /* 0x34 */      UINT8 lfb_reserved[0x0C];       /* reserved */
 145
 146 /* %%TBD */
 147 /* 0x40 */      UINT16 apm_bios_ver;            /* LDR */
 148 #define NO_APM_BIOS             0x0000
 149
 150 /* %%TBD */
 151 /* 0x42 */      UINT16 bios_code_seg;           /* LDR */
 152 /* 0x44 */      UINT32 bios_entry_point;        /* LDR */
 153 /* 0x48 */      UINT16 bios_code_seg16;         /* LDR */
 154 /* 0x4A */      UINT16 bios_data_seg;           /* LDR */
 155
 156 /* %%TBD */
 157 /* 0x4C */      UINT16 apm_bios_flags;          /* LDR */
 158 #define NO_32BIT_APM_MASK       0xFFFD
 159
 160 /* %%TBD */
 161 /* 0x4E */      UINT32 bios_code_len;           /* LDR */
 162 /* 0x52 */      UINT16 bios_data_len;           /* LDR */
 163
 164 /* 0x54 */      UINT8 unused_3[0x2C];           /* unused */
 165
 166 /* %%TBD */
 167 /* 0x80 */      UINT8 hd0_info[0x10];           /* LDR */
 168 /* 0x90 */      UINT8 hd1_info[0x10];           /* LDR */
 169
 170 /* %%TBD */
 171 /* 0xA0 */      UINT16 mca_info_len;            /* LDR */
 172 /* 0xA2 */      UINT8 mca_info_buf[0x10];       /* LDR */
 173
 174 /* 0xB2 */      UINT8 unused_4[0x10E];          /* unused */
 175
 176 /* EFI boot loader signature. */
 177 /* 0x1C0 */     UINT8 efi_loader_sig[4];        /* LDR */
 178 #define EFI_LOADER_SIG_IA32             "EL32"
 179
 180 /* Address of the EFI system table. */
 181 /* 0x1C4 */     UINT32 efi_sys_tbl;             /* LDR */
 182
 183 /* EFI memory descriptor size. */
 184 /* 0x1C8 */     UINT32 efi_mem_desc_size;       /* LDR */
 185
 186 /* EFI memory descriptor version. */
 187 /* 0x1CC */     UINT32 efi_mem_desc_ver;        /* LDR */
 188
 189 /* Address & size of EFI memory map. */
 190 /* 0x1D0 */     UINT32 efi_mem_map;             /* LDR */
 191 /* 0x1D4 */     UINT32 efi_mem_map_size;        /* LDR */
 192
 193 /* Address & size of loader. */
 194 /* 0x1D8 */     UINT32 loader_start;            /* LDR */
 195 /* 0x1DC */     UINT32 loader_size;             /* LDR */
 196
 197 /* Available contiguous extended memory in KB. */
 198 /* 0x1E0 */     UINT32 alt_mem_k;               /* LDR */
 199
 200 /* 0x1E4 */     UINT32 unused_51;               /* unused */
 201 /* 0x1E8 */     UINT8  e820_nrmap;
 202 /* 0x1E9 */     UINT32 unused_52[2];            /* unused */
 203
 204 /* Size of setup code in sectors (1 sector == 512 bytes). */
 205 /* 0x1F1 */     UINT8 setup_sectors;            /* BLD */
 206
 207 /* %%TBD */
 208 /* 0x1F2 */     UINT16 mount_root_rdonly;       /* BLD */
 209
 210 /* %%TBD */
 211 /* 0x1F4 */     UINT16 sys_size;                /* BLD */
 212
 213 /* %%TBD */
 214 /* 0x1F6 */     UINT16 swap_dev;                /* BLD */
 215
 216 /* %%TBD */
 217 /* 0x1F8 */     UINT16 ramdisk_flags;           /* BLD */
 218 #define RAMDISK_PROMPT          0x8000
 219 #define RAMDISK_LOAD            0x4000
 220
 221 /* %%TBD */
 222 /* 0x1FA */     UINT16 video_mode_flag;         /* BLD */
 223
 224 /* %%TBD */
 225 /* 0x1FC */     UINT16 orig_root_dev;           /* BLD */
 226
 227 /* 0x1FE */     UINT8 unused_6;                 /* unused */
 228
 229 /* %%TBD */
 230 /* 0x1FF */     UINT8 aux_dev_info;             /* LDR */
 231 #define NO_MOUSE                0x00
 232 #define FOUND_MOUSE             0xAA
 233
 234 /* Jump past setup data (not used in EFI). */
 235 /* 0x200 */     UINT16 jump;                    /* BLD */
 236
 237 /* Setup data signature. */
 238 /* 0x202 */     UINT8 setup_sig[4];             /* BLD */
 239 #define SETUP_SIG               "HdrS"
 240
 241 /* %%TBD */
 242 /* 0x206 */     UINT8 hdr_minor;                /* BLD */
 243 /* 0x207 */     UINT8 hdr_major;                /* BLD */
 244
 245 /* %%TBD */
 246 /* 0x208 */     UINT32 rm_switch;               /* LDD */
 247
 248 /* %%TBD */
 249 /* 0x20C */     UINT16 start_sys_seg;           /* BLD */
 250
 251 /* %%TBD */
 252 /* 0x20E */     UINT16 kernel_verstr_offset;    /* BLD */
 253
 254 /* Loader type & version. */
 255 /* 0x210 */     UINT8 loader_type;              /* LDR */
 256 #define LDRTYPE_ELILO                   0x50    /* 5?h == elilo */
 257                                                 /* ?0h == revision */
 258
 259 /* 0x211 */     UINT8 loader_flags;             /* BLD and LDR */
 260 #define LDRFLAG_CAN_USE_HEAP            0x80
 261 #define LDRFLAG_BOOT_PARAM_RELOC        0x40
 262
 263 /* %%TBD */
 264 /* 0x212 */     UINT16 setup_move_size;         /* BLD */
 265
 266 /* %%TBD */
 267 /* 0x214 */     UINT32 kernel_start;            /* LDR */
 268
 269 /* %%TBD */
 270 /* 0x218 */     UINT32 initrd_start;            /* LDR */
 271 /* 0x21C */     UINT32 initrd_size;             /* LDR */
 272
 273 /* %%TBD */
 274 /* 0x220 */     UINT32 bootsect_helper;         /* BLD */
 275
 276 /* %%TBD */
 277 /* 0x224 */     UINT16 heap_end_ptr;            /* LDR */
 278
 279 /* %%TBD */
 280 /* 0x226 */     UINT16 unused_7;                /* LDR */
 281
 282 /* 0x228 */     UINT32 cmdline_addr;            /* LDR */
 283 /* 0x22C */     UINT32 unused_8[41];
 284 /* 0x2D0 */     UINT8  e820_map[2560];
 285         } s;
 286 } boot_params_t;
 287 #pragma pack()
 288
 289 /*
 290  * The stuff below here is for jumping to the kernel.
 291  */
 292
 293 /*
 294  * Some macros to copy and set memory after EFI has been
 295  * stopped.
 296  */
 297
 298 #define MEMCPY(to, from, cnt) { \
 299         UINT8 *t = (UINT8 *)(to); \
 300         UINT8 *f = (UINT8 *)(from); \
 301         UINTN n = cnt; \
 302         if (t && f && n) { \
 303                 while (n--) { \
 304                         *t++ = *f++; \
 305                 } \
 306         } \
 307 }
 308
 309 #define MEMSET(ptr, size, val) { \
 310         UINT8 *p = (UINT8 *)(ptr); \
 311         UINTN n = (UINTN)(size); \
 312         UINT8 v = (UINT8)(val); \
 313         if (p && n) { \
 314                 while (n--) { \
 315                         *p++ = v; \
 316                 } \
 317         } \
 318 }
 319
 320 /*
 321  * Descriptor table pointer format.
 322  */
 323 #pragma pack(1)
 324 typedef struct {
 325         UINT16 limit;
 326         UINT32 base;
 327 } dt_addr_t;
 328 #pragma pack()
 329
 330 extern UINTN high_base_mem;
 331 extern UINTN high_ext_mem;
 332
 333 extern boot_params_t *param_start;
 334 extern UINTN param_size;
 335
 336 extern VOID *kernel_start;
 337 extern UINTN kernel_size;
 338
 339 extern VOID *initrd_start;
 340 extern UINTN initrd_size;
 341
 342 extern dt_addr_t gdt_addr;
 343 extern dt_addr_t idt_addr;
 344
 345 extern UINT16 init_gdt[];
 346 extern UINTN sizeof_init_gdt;
 347
 348 extern UINT8 rmswitch_image[];
 349 extern UINTN rmswitch_size;
 350
 351 extern INTN ia32_use_legacy_free_boot();
 352
 353 /*
 354  * How to jump to kernel code
 355  */
 356
 357 static inline void
 358 start_kernel(VOID *kentry, boot_params_t *bp)
 359 {
 360         /*
 361          * Disable interrupts.
 362          */
 363         asm volatile ( "cli" : : );
 364
 365         /*
 366          * Relocate initrd, if present.
 367          */
 368
 369         if (bp->s.initrd_start) {
 370                 MEMCPY(15 * 1024 * 1024, bp->s.initrd_start, bp->s.initrd_size);
 371                 bp->s.initrd_start = 15 * 1024 * 1024;
 372         }
 373         /*
 374          * Copy boot sector, setup data and command line
 375          * to final resting place.  We need to copy
 376          * BOOT_PARAM_MEMSIZE bytes.
 377          */
 378
 379         MEMCPY(high_base_mem, bp, 0x4000);
 380
 381         bp = (boot_params_t *)high_base_mem;
 382         bp->s.cmdline_addr = high_base_mem + bp->s.cmdline_offset;
 383
 384         /*
 385          * Initialize Linux GDT.
 386          */
 387
 388         MEMSET(gdt_addr.base, gdt_addr.limit, 0);
 389         MEMCPY(gdt_addr.base, init_gdt, sizeof_init_gdt);
 390
 391         if (! ia32_use_legacy_free_boot()) {
 392
 393                 /*
 394                  * Copy our real mode transition code to 0x7C00.
 395                  */
 396
 397                 MEMCPY(0x7C00, rmswitch_image, rmswitch_size);
 398
 399                 asm volatile ( "movl $0x7C00, %%ebx" : : );
 400                 asm volatile ( "jmp *%%ebx" : : );
 401         }
 402
 403         /*
 404          * Load descriptor table pointers.
 405          */
 406
 407         asm volatile ( "lidt %0" : : "m" (idt_addr) );
 408         asm volatile ( "lgdt %0" : : "m" (gdt_addr) );
 409
 410         /*
 411          * ebx := 0  (%%TBD - do not know why, yet)
 412          * ecx := kernel entry point
 413          * esi := address of boot sector and setup data
 414          */
 415
 416         asm volatile ( "movl %0, %%esi" : : "m" (high_base_mem) );
 417         asm volatile ( "movl %0, %%ecx" : : "m" (kentry) );
 418         asm volatile ( "xorl %%ebx, %%ebx" : : );
 419
 420         /*
 421          * Jump to kernel entry point.
 422          */
 423
 424         asm volatile ( "jmp *%%ecx" : : );
 425 }
 426
 427 typedef struct sys_img_options {
 428         UINT8 nothing_yet;
 429 } sys_img_options_t;
 430
 431 #endif /* __ELILO_SYSDEPS_IA32_H__ */