Documentation/i386/boot.txt

   1                      THE LINUX/I386 BOOT PROTOCOL
   2                      ----------------------------
   3
   4                     H. Peter Anvin <hpa@zytor.com>
   5                         Last update 2007-05-23
   6
   7 On the i386 platform, the Linux kernel uses a rather complicated boot
   8 convention.  This has evolved partially due to historical aspects, as
   9 well as the desire in the early days to have the kernel itself be a
  10 bootable image, the complicated PC memory model and due to changed
  11 expectations in the PC industry caused by the effective demise of
  12 real-mode DOS as a mainstream operating system.
  13
  14 Currently, the following versions of the Linux/i386 boot protocol exist.
  15
  16 Old kernels:    zImage/Image support only.  Some very early kernels
  17                 may not even support a command line.
  18
  19 Protocol 2.00:  (Kernel 1.3.73) Added bzImage and initrd support, as
  20                 well as a formalized way to communicate between the
  21                 boot loader and the kernel.  setup.S made relocatable,
  22                 although the traditional setup area still assumed
  23                 writable.
  24
  25 Protocol 2.01:  (Kernel 1.3.76) Added a heap overrun warning.
  26
  27 Protocol 2.02:  (Kernel 2.4.0-test3-pre3) New command line protocol.
  28                 Lower the conventional memory ceiling.  No overwrite
  29                 of the traditional setup area, thus making booting
  30                 safe for systems which use the EBDA from SMM or 32-bit
  31                 BIOS entry points.  zImage deprecated but still
  32                 supported.
  33
  34 Protocol 2.03:  (Kernel 2.4.18-pre1) Explicitly makes the highest possible
  35                 initrd address available to the bootloader.
  36
  37 Protocol 2.04:  (Kernel 2.6.14) Extend the syssize field to four bytes.
  38
  39 Protocol 2.05:  (Kernel 2.6.20) Make protected mode kernel relocatable.
  40                 Introduce relocatable_kernel and kernel_alignment fields.
  41
  42 Protocol 2.06:  (Kernel 2.6.22) Added a field that contains the size of
  43                 the boot command line
  44
  45
  46 **** MEMORY LAYOUT
  47
  48 The traditional memory map for the kernel loader, used for Image or
  49 zImage kernels, typically looks like:
  50
  51         |                        |
  52 0A0000  +------------------------+
  53         |  Reserved for BIOS     |      Do not use.  Reserved for BIOS EBDA.
  54 09A000  +------------------------+
  55         |  Command line          |
  56         |  Stack/heap            |      For use by the kernel real-mode code.
  57 098000  +------------------------+
  58         |  Kernel setup          |      The kernel real-mode code.
  59 090200  +------------------------+
  60         |  Kernel boot sector    |      The kernel legacy boot sector.
  61 090000  +------------------------+
  62         |  Protected-mode kernel |      The bulk of the kernel image.
  63 010000  +------------------------+
  64         |  Boot loader           |      <- Boot sector entry point 0000:7C00
  65 001000  +------------------------+
  66         |  Reserved for MBR/BIOS |
  67 000800  +------------------------+
  68         |  Typically used by MBR |
  69 000600  +------------------------+
  70         |  BIOS use only         |
  71 000000  +------------------------+
  72
  73
  74 When using bzImage, the protected-mode kernel was relocated to
  75 0x100000 ("high memory"), and the kernel real-mode block (boot sector,
  76 setup, and stack/heap) was made relocatable to any address between
  77 0x10000 and end of low memory. Unfortunately, in protocols 2.00 and
  78 2.01 the 0x90000+ memory range is still used internally by the kernel;
  79 the 2.02 protocol resolves that problem.
  80
  81 It is desirable to keep the "memory ceiling" -- the highest point in
  82 low memory touched by the boot loader -- as low as possible, since
  83 some newer BIOSes have begun to allocate some rather large amounts of
  84 memory, called the Extended BIOS Data Area, near the top of low
  85 memory.  The boot loader should use the "INT 12h" BIOS call to verify
  86 how much low memory is available.
  87
  88 Unfortunately, if INT 12h reports that the amount of memory is too
  89 low, there is usually nothing the boot loader can do but to report an
  90 error to the user.  The boot loader should therefore be designed to
  91 take up as little space in low memory as it reasonably can.  For
  92 zImage or old bzImage kernels, which need data written into the
  93 0x90000 segment, the boot loader should make sure not to use memory
  94 above the 0x9A000 point; too many BIOSes will break above that point.
  95
  96 For a modern bzImage kernel with boot protocol version >= 2.02, a
  97 memory layout like the following is suggested:
  98
  99         ~                        ~
 100         |  Protected-mode kernel |
 101 100000  +------------------------+
 102         |  I/O memory hole       |
 103 0A0000  +------------------------+
 104         |  Reserved for BIOS     |      Leave as much as possible unused
 105         ~                        ~
 106         |  Command line          |      (Can also be below the X+10000 mark)
 107 X+10000 +------------------------+
 108         |  Stack/heap            |      For use by the kernel real-mode code.
 109 X+08000 +------------------------+
 110         |  Kernel setup          |      The kernel real-mode code.
 111         |  Kernel boot sector    |      The kernel legacy boot sector.
 112 X       +------------------------+
 113         |  Boot loader           |      <- Boot sector entry point 0000:7C00
 114 001000  +------------------------+
 115         |  Reserved for MBR/BIOS |
 116 000800  +------------------------+
 117         |  Typically used by MBR |
 118 000600  +------------------------+
 119         |  BIOS use only         |
 120 000000  +------------------------+
 121
 122 ... where the address X is as low as the design of the boot loader
 123 permits.
 124
 125
 126 **** THE REAL-MODE KERNEL HEADER
 127
 128 In the following text, and anywhere in the kernel boot sequence, "a
 129 sector" refers to 512 bytes.  It is independent of the actual sector
 130 size of the underlying medium.
 131
 132 The first step in loading a Linux kernel should be to load the
 133 real-mode code (boot sector and setup code) and then examine the
 134 following header at offset 0x01f1.  The real-mode code can total up to
 135 32K, although the boot loader may choose to load only the first two
 136 sectors (1K) and then examine the bootup sector size.
 137
 138 The header looks like:
 139
 140 Offset  Proto   Name            Meaning
 141 /Size
 142
 143 01F1/1  ALL(1   setup_sects     The size of the setup in sectors
 144 01F2/2  ALL     root_flags      If set, the root is mounted readonly
 145 01F4/4  2.04+(2 syssize         The size of the 32-bit code in 16-byte paras
 146 01F8/2  ALL     ram_size        DO NOT USE - for bootsect.S use only
 147 01FA/2  ALL     vid_mode        Video mode control
 148 01FC/2  ALL     root_dev        Default root device number
 149 01FE/2  ALL     boot_flag       0xAA55 magic number
 150 0200/2  2.00+   jump            Jump instruction
 151 0202/4  2.00+   header          Magic signature "HdrS"
 152 0206/2  2.00+   version         Boot protocol version supported
 153 0208/4  2.00+   realmode_swtch  Boot loader hook (see below)
 154 020C/2  2.00+   start_sys       The load-low segment (0x1000) (obsolete)
 155 020E/2  2.00+   kernel_version  Pointer to kernel version string
 156 0210/1  2.00+   type_of_loader  Boot loader identifier
 157 0211/1  2.00+   loadflags       Boot protocol option flags
 158 0212/2  2.00+   setup_move_size Move to high memory size (used with hooks)
 159 0214/4  2.00+   code32_start    Boot loader hook (see below)
 160 0218/4  2.00+   ramdisk_image   initrd load address (set by boot loader)
 161 021C/4  2.00+   ramdisk_size    initrd size (set by boot loader)
 162 0220/4  2.00+   bootsect_kludge DO NOT USE - for bootsect.S use only
 163 0224/2  2.01+   heap_end_ptr    Free memory after setup end
 164 0226/2  N/A     pad1            Unused
 165 0228/4  2.02+   cmd_line_ptr    32-bit pointer to the kernel command line
 166 022C/4  2.03+   initrd_addr_max Highest legal initrd address
 167 0230/4  2.05+   kernel_alignment Physical addr alignment required for kernel
 168 0234/1  2.05+   relocatable_kernel Whether kernel is relocatable or not
 169 0235/3  N/A     pad2            Unused
 170 0238/4  2.06+   cmdline_size    Maximum size of the kernel command line
 171 023C/4  2.07+   hardware_subarch Hardware subarchitecture
 172 0240/8  2.07+   hardware_subarch_data Subarchitecture-specific data
 173 0248/4  2.08+   payload_offset  Offset of kernel payload
 174 024C/4  2.08+   payload_length  Length of kernel payload
 175
 176 (1) For backwards compatibility, if the setup_sects field contains 0, the
 177     real value is 4.
 178
 179 (2) For boot protocol prior to 2.04, the upper two bytes of the syssize
 180     field are unusable, which means the size of a bzImage kernel
 181     cannot be determined.
 182
 183 If the "HdrS" (0x53726448) magic number is not found at offset 0x202,
 184 the boot protocol version is "old".  Loading an old kernel, the
 185 following parameters should be assumed:
 186
 187         Image type = zImage
 188         initrd not supported
 189         Real-mode kernel must be located at 0x90000.
 190
 191 Otherwise, the "version" field contains the protocol version,
 192 e.g. protocol version 2.01 will contain 0x0201 in this field.  When
 193 setting fields in the header, you must make sure only to set fields
 194 supported by the protocol version in use.
 195
 196
 197 **** DETAILS OF HEADER FIELDS
 198
 199 For each field, some are information from the kernel to the bootloader
 200 ("read"), some are expected to be filled out by the bootloader
 201 ("write"), and some are expected to be read and modified by the
 202 bootloader ("modify").
 203
 204 All general purpose boot loaders should write the fields marked
 205 (obligatory).  Boot loaders who want to load the kernel at a
 206 nonstandard address should fill in the fields marked (reloc); other
 207 boot loaders can ignore those fields.
 208
 209 The byte order of all fields is littleendian (this is x86, after all.)
 210
 211 Field name:     setup_sects
 212 Type:           read
 213 Offset/size:    0x1f1/1
 214 Protocol:       ALL
 215
 216   The size of the setup code in 512-byte sectors.  If this field is
 217   0, the real value is 4.  The real-mode code consists of the boot
 218   sector (always one 512-byte sector) plus the setup code.
 219
 220 Field name:      root_flags
 221 Type:            modify (optional)
 222 Offset/size:     0x1f2/2
 223 Protocol:        ALL
 224
 225   If this field is nonzero, the root defaults to readonly.  The use of
 226   this field is deprecated; use the "ro" or "rw" options on the
 227   command line instead.
 228
 229 Field name:     syssize
 230 Type:           read
 231 Offset/size:    0x1f4/4 (protocol 2.04+) 0x1f4/2 (protocol ALL)
 232 Protocol:       2.04+
 233
 234   The size of the protected-mode code in units of 16-byte paragraphs.
 235   For protocol versions older than 2.04 this field is only two bytes
 236   wide, and therefore cannot be trusted for the size of a kernel if
 237   the LOAD_HIGH flag is set.
 238
 239 Field name:     ram_size
 240 Type:           kernel internal
 241 Offset/size:    0x1f8/2
 242 Protocol:       ALL
 243
 244   This field is obsolete.
 245
 246 Field name:     vid_mode
 247 Type:           modify (obligatory)
 248 Offset/size:    0x1fa/2
 249
 250   Please see the section on SPECIAL COMMAND LINE OPTIONS.
 251
 252 Field name:     root_dev
 253 Type:           modify (optional)
 254 Offset/size:    0x1fc/2
 255 Protocol:       ALL
 256
 257   The default root device device number.  The use of this field is
 258   deprecated, use the "root=" option on the command line instead.
 259
 260 Field name:     boot_flag
 261 Type:           read
 262 Offset/size:    0x1fe/2
 263 Protocol:       ALL
 264
 265   Contains 0xAA55.  This is the closest thing old Linux kernels have
 266   to a magic number.
 267
 268 Field name:     jump
 269 Type:           read
 270 Offset/size:    0x200/2
 271 Protocol:       2.00+
 272
 273   Contains an x86 jump instruction, 0xEB followed by a signed offset
 274   relative to byte 0x202.  This can be used to determine the size of
 275   the header.
 276
 277 Field name:     header
 278 Type:           read
 279 Offset/size:    0x202/4
 280 Protocol:       2.00+
 281
 282   Contains the magic number "HdrS" (0x53726448).
 283
 284 Field name:     version
 285 Type:           read
 286 Offset/size:    0x206/2
 287 Protocol:       2.00+
 288
 289   Contains the boot protocol version, in (major << 8)+minor format,
 290   e.g. 0x0204 for version 2.04, and 0x0a11 for a hypothetical version
 291   10.17.
 292
 293 Field name:     readmode_swtch
 294 Type:           modify (optional)
 295 Offset/size:    0x208/4
 296 Protocol:       2.00+
 297
 298   Boot loader hook (see ADVANCED BOOT LOADER HOOKS below.)
 299
 300 Field name:     start_sys
 301 Type:           read
 302 Offset/size:    0x20c/4
 303 Protocol:       2.00+
 304
 305   The load low segment (0x1000).  Obsolete.
 306
 307 Field name:     kernel_version
 308 Type:           read
 309 Offset/size:    0x20e/2
 310 Protocol:       2.00+
 311
 312   If set to a nonzero value, contains a pointer to a NUL-terminated
 313   human-readable kernel version number string, less 0x200.  This can
 314   be used to display the kernel version to the user.  This value
 315   should be less than (0x200*setup_sects).
 316
 317   For example, if this value is set to 0x1c00, the kernel version
 318   number string can be found at offset 0x1e00 in the kernel file.
 319   This is a valid value if and only if the "setup_sects" field
 320   contains the value 15 or higher, as:
 321
 322         0x1c00  < 15*0x200 (= 0x1e00) but
 323         0x1c00 >= 14*0x200 (= 0x1c00)
 324
 325         0x1c00 >> 9 = 14, so the minimum value for setup_secs is 15.
 326
 327 Field name:     type_of_loader
 328 Type:           write (obligatory)
 329 Offset/size:    0x210/1
 330 Protocol:       2.00+
 331
 332   If your boot loader has an assigned id (see table below), enter
 333   0xTV here, where T is an identifier for the boot loader and V is
 334   a version number.  Otherwise, enter 0xFF here.
 335
 336   Assigned boot loader ids:
 337         0  LILO                 (0x00 reserved for pre-2.00 bootloader)
 338         1  Loadlin
 339         2  bootsect-loader      (0x20, all other values reserved)
 340         3  SYSLINUX
 341         4  EtherBoot
 342         5  ELILO
 343         7  GRuB
 344         8  U-BOOT
 345         9  Xen
 346         A  Gujin
 347         B  Qemu
 348
 349   Please contact <hpa@zytor.com> if you need a bootloader ID
 350   value assigned.
 351
 352 Field name:     loadflags
 353 Type:           modify (obligatory)
 354 Offset/size:    0x211/1
 355 Protocol:       2.00+
 356
 357   This field is a bitmask.
 358
 359   Bit 0 (read): LOADED_HIGH
 360         - If 0, the protected-mode code is loaded at 0x10000.
 361         - If 1, the protected-mode code is loaded at 0x100000.
 362
 363   Bit 6 (write): KEEP_SEGMENTS
 364         Protocol: 2.07+
 365         - if 0, reload the segment registers in the 32bit entry point.
 366         - if 1, do not reload the segment registers in the 32bit entry point.
 367                 Assume that %cs %ds %ss %es are all set to flat segments with
 368                 a base of 0 (or the equivalent for their environment).
 369
 370   Bit 7 (write): CAN_USE_HEAP
 371         Set this bit to 1 to indicate that the value entered in the
 372         heap_end_ptr is valid.  If this field is clear, some setup code
 373         functionality will be disabled.
 374
 375 Field name:     setup_move_size
 376 Type:           modify (obligatory)
 377 Offset/size:    0x212/2
 378 Protocol:       2.00-2.01
 379
 380   When using protocol 2.00 or 2.01, if the real mode kernel is not
 381   loaded at 0x90000, it gets moved there later in the loading
 382   sequence.  Fill in this field if you want additional data (such as
 383   the kernel command line) moved in addition to the real-mode kernel
 384   itself.
 385
 386   The unit is bytes starting with the beginning of the boot sector.
 387
 388   This field is can be ignored when the protocol is 2.02 or higher, or
 389   if the real-mode code is loaded at 0x90000.
 390
 391 Field name:     code32_start
 392 Type:           modify (optional, reloc)
 393 Offset/size:    0x214/4
 394 Protocol:       2.00+
 395
 396   The address to jump to in protected mode.  This defaults to the load
 397   address of the kernel, and can be used by the boot loader to
 398   determine the proper load address.
 399
 400   This field can be modified for two purposes:
 401
 402   1. as a boot loader hook (see ADVANCED BOOT LOADER HOOKS below.)
 403
 404   2. if a bootloader which does not install a hook loads a
 405      relocatable kernel at a nonstandard address it will have to modify
 406      this field to point to the load address.
 407
 408 Field name:     ramdisk_image
 409 Type:           write (obligatory)
 410 Offset/size:    0x218/4
 411 Protocol:       2.00+
 412
 413   The 32-bit linear address of the initial ramdisk or ramfs.  Leave at
 414   zero if there is no initial ramdisk/ramfs.
 415
 416 Field name:     ramdisk_size
 417 Type:           write (obligatory)
 418 Offset/size:    0x21c/4
 419 Protocol:       2.00+
 420
 421   Size of the initial ramdisk or ramfs.  Leave at zero if there is no
 422   initial ramdisk/ramfs.
 423
 424 Field name:     bootsect_kludge
 425 Type:           kernel internal
 426 Offset/size:    0x220/4
 427 Protocol:       2.00+
 428
 429   This field is obsolete.
 430
 431 Field name:     heap_end_ptr
 432 Type:           write (obligatory)
 433 Offset/size:    0x224/2
 434 Protocol:       2.01+
 435
 436   Set this field to the offset (from the beginning of the real-mode
 437   code) of the end of the setup stack/heap, minus 0x0200.
 438
 439 Field name:     cmd_line_ptr
 440 Type:           write (obligatory)
 441 Offset/size:    0x228/4
 442 Protocol:       2.02+
 443
 444   Set this field to the linear address of the kernel command line.
 445   The kernel command line can be located anywhere between the end of
 446   the setup heap and 0xA0000; it does not have to be located in the
 447   same 64K segment as the real-mode code itself.
 448
 449   Fill in this field even if your boot loader does not support a
 450   command line, in which case you can point this to an empty string
 451   (or better yet, to the string "auto".)  If this field is left at
 452   zero, the kernel will assume that your boot loader does not support
 453   the 2.02+ protocol.
 454
 455 Field name:     initrd_addr_max
 456 Type:           read
 457 Offset/size:    0x22c/4
 458 Protocol:       2.03+
 459
 460   The maximum address that may be occupied by the initial
 461   ramdisk/ramfs contents.  For boot protocols 2.02 or earlier, this
 462   field is not present, and the maximum address is 0x37FFFFFF.  (This
 463   address is defined as the address of the highest safe byte, so if
 464   your ramdisk is exactly 131072 bytes long and this field is
 465   0x37FFFFFF, you can start your ramdisk at 0x37FE0000.)
 466
 467 Field name:     kernel_alignment
 468 Type:           read (reloc)
 469 Offset/size:    0x230/4
 470 Protocol:       2.05+
 471
 472   Alignment unit required by the kernel (if relocatable_kernel is true.)
 473
 474 Field name:     relocatable_kernel
 475 Type:           read (reloc)
 476 Offset/size:    0x234/1
 477 Protocol:       2.05+
 478
 479   If this field is nonzero, the protected-mode part of the kernel can
 480   be loaded at any address that satisfies the kernel_alignment field.
 481   After loading, the boot loader must set the code32_start field to
 482   point to the loaded code, or to a boot loader hook.
 483
 484 Field name:     cmdline_size
 485 Type:           read
 486 Offset/size:    0x238/4
 487 Protocol:       2.06+
 488
 489   The maximum size of the command line without the terminating
 490   zero. This means that the command line can contain at most
 491   cmdline_size characters. With protocol version 2.05 and earlier, the
 492   maximum size was 255.
 493
 494 Field name:     hardware_subarch
 495 Type:           write
 496 Offset/size:    0x23c/4
 497 Protocol:       2.07+
 498
 499   In a paravirtualized environment the hardware low level architectural
 500   pieces such as interrupt handling, page table handling, and
 501   accessing process control registers needs to be done differently.
 502
 503   This field allows the bootloader to inform the kernel we are in one
 504   one of those environments.
 505
 506   0x00000000    The default x86/PC environment
 507   0x00000001    lguest
 508   0x00000002    Xen
 509
 510 Field name:     hardware_subarch_data
 511 Type:           write
 512 Offset/size:    0x240/8
 513 Protocol:       2.07+
 514
 515   A pointer to data that is specific to hardware subarch
 516
 517 Field name:     payload_offset
 518 Type:           read
 519 Offset/size:    0x248/4
 520 Protocol:       2.08+
 521
 522   If non-zero then this field contains the offset from the end of the
 523   real-mode code to the payload.
 524
 525   The payload may be compressed. The format of both the compressed and
 526   uncompressed data should be determined using the standard magic
 527   numbers. Currently only gzip compressed ELF is used.
 528
 529 Field name:     payload_length
 530 Type:           read
 531 Offset/size:    0x24c/4
 532 Protocol:       2.08+
 533
 534   The length of the payload.
 535
 536 **** THE IMAGE CHECKSUM
 537
 538 From boot protocol version 2.08 onwards the CRC-32 is calculated over
 539 the entire file using the characteristic polynomial 0x04C11DB7 and an
 540 initial remainder of 0xffffffff.  The checksum is appended to the
 541 file; therefore the CRC of the file up to the limit specified in the
 542 syssize field of the header is always 0.
 543
 544 **** THE KERNEL COMMAND LINE
 545
 546 The kernel command line has become an important way for the boot
 547 loader to communicate with the kernel.  Some of its options are also
 548 relevant to the boot loader itself, see "special command line options"
 549 below.
 550
 551 The kernel command line is a null-terminated string. The maximum
 552 length can be retrieved from the field cmdline_size.  Before protocol
 553 version 2.06, the maximum was 255 characters.  A string that is too
 554 long will be automatically truncated by the kernel.
 555
 556 If the boot protocol version is 2.02 or later, the address of the
 557 kernel command line is given by the header field cmd_line_ptr (see
 558 above.)  This address can be anywhere between the end of the setup
 559 heap and 0xA0000.
 560
 561 If the protocol version is *not* 2.02 or higher, the kernel
 562 command line is entered using the following protocol:
 563
 564         At offset 0x0020 (word), "cmd_line_magic", enter the magic
 565         number 0xA33F.
 566
 567         At offset 0x0022 (word), "cmd_line_offset", enter the offset
 568         of the kernel command line (relative to the start of the
 569         real-mode kernel).
 570
 571         The kernel command line *must* be within the memory region
 572         covered by setup_move_size, so you may need to adjust this
 573         field.
 574
 575
 576 **** MEMORY LAYOUT OF THE REAL-MODE CODE
 577
 578 The real-mode code requires a stack/heap to be set up, as well as
 579 memory allocated for the kernel command line.  This needs to be done
 580 in the real-mode accessible memory in bottom megabyte.
 581
 582 It should be noted that modern machines often have a sizable Extended
 583 BIOS Data Area (EBDA).  As a result, it is advisable to use as little
 584 of the low megabyte as possible.
 585
 586 Unfortunately, under the following circumstances the 0x90000 memory
 587 segment has to be used:
 588
 589         - When loading a zImage kernel ((loadflags & 0x01) == 0).
 590         - When loading a 2.01 or earlier boot protocol kernel.
 591
 592           -> For the 2.00 and 2.01 boot protocols, the real-mode code
 593              can be loaded at another address, but it is internally
 594              relocated to 0x90000.  For the "old" protocol, the
 595              real-mode code must be loaded at 0x90000.
 596
 597 When loading at 0x90000, avoid using memory above 0x9a000.
 598
 599 For boot protocol 2.02 or higher, the command line does not have to be
 600 located in the same 64K segment as the real-mode setup code; it is
 601 thus permitted to give the stack/heap the full 64K segment and locate
 602 the command line above it.
 603
 604 The kernel command line should not be located below the real-mode
 605 code, nor should it be located in high memory.
 606
 607
 608 **** SAMPLE BOOT CONFIGURATION
 609
 610 As a sample configuration, assume the following layout of the real
 611 mode segment:
 612
 613     When loading below 0x90000, use the entire segment:
 614
 615         0x0000-0x7fff   Real mode kernel
 616         0x8000-0xdfff   Stack and heap
 617         0xe000-0xffff   Kernel command line
 618
 619     When loading at 0x90000 OR the protocol version is 2.01 or earlier:
 620
 621         0x0000-0x7fff   Real mode kernel
 622         0x8000-0x97ff   Stack and heap
 623         0x9800-0x9fff   Kernel command line
 624
 625 Such a boot loader should enter the following fields in the header:
 626
 627         unsigned long base_ptr; /* base address for real-mode segment */
 628
 629         if ( setup_sects == 0 ) {
 630                 setup_sects = 4;
 631         }
 632
 633         if ( protocol >= 0x0200 ) {
 634                 type_of_loader = <type code>;
 635                 if ( loading_initrd ) {
 636                         ramdisk_image = <initrd_address>;
 637                         ramdisk_size = <initrd_size>;
 638                 }
 639
 640                 if ( protocol >= 0x0202 && loadflags & 0x01 )
 641                         heap_end = 0xe000;
 642                 else
 643                         heap_end = 0x9800;
 644
 645                 if ( protocol >= 0x0201 ) {
 646                         heap_end_ptr = heap_end - 0x200;
 647                         loadflags |= 0x80; /* CAN_USE_HEAP */
 648                 }
 649
 650                 if ( protocol >= 0x0202 ) {
 651                         cmd_line_ptr = base_ptr + heap_end;
 652                         strcpy(cmd_line_ptr, cmdline);
 653                 } else {
 654                         cmd_line_magic  = 0xA33F;
 655                         cmd_line_offset = heap_end;
 656                         setup_move_size = heap_end + strlen(cmdline)+1;
 657                         strcpy(base_ptr+cmd_line_offset, cmdline);
 658                 }
 659         } else {
 660                 /* Very old kernel */
 661
 662                 heap_end = 0x9800;
 663
 664                 cmd_line_magic  = 0xA33F;
 665                 cmd_line_offset = heap_end;
 666
 667                 /* A very old kernel MUST have its real-mode code
 668                    loaded at 0x90000 */
 669
 670                 if ( base_ptr != 0x90000 ) {
 671                         /* Copy the real-mode kernel */
 672                         memcpy(0x90000, base_ptr, (setup_sects+1)*512);
 673                         base_ptr = 0x90000;              /* Relocated */
 674                 }
 675
 676                 strcpy(0x90000+cmd_line_offset, cmdline);
 677
 678                 /* It is recommended to clear memory up to the 32K mark */
 679                 memset(0x90000 + (setup_sects+1)*512, 0,
 680                        (64-(setup_sects+1))*512);
 681         }
 682
 683
 684 **** LOADING THE REST OF THE KERNEL
 685
 686 The 32-bit (non-real-mode) kernel starts at offset (setup_sects+1)*512
 687 in the kernel file (again, if setup_sects == 0 the real value is 4.)
 688 It should be loaded at address 0x10000 for Image/zImage kernels and
 689 0x100000 for bzImage kernels.
 690
 691 The kernel is a bzImage kernel if the protocol >= 2.00 and the 0x01
 692 bit (LOAD_HIGH) in the loadflags field is set:
 693
 694         is_bzImage = (protocol >= 0x0200) && (loadflags & 0x01);
 695         load_address = is_bzImage ? 0x100000 : 0x10000;
 696
 697 Note that Image/zImage kernels can be up to 512K in size, and thus use
 698 the entire 0x10000-0x90000 range of memory.  This means it is pretty
 699 much a requirement for these kernels to load the real-mode part at
 700 0x90000.  bzImage kernels allow much more flexibility.
 701
 702
 703 **** SPECIAL COMMAND LINE OPTIONS
 704
 705 If the command line provided by the boot loader is entered by the
 706 user, the user may expect the following command line options to work.
 707 They should normally not be deleted from the kernel command line even
 708 though not all of them are actually meaningful to the kernel.  Boot
 709 loader authors who need additional command line options for the boot
 710 loader itself should get them registered in
 711 Documentation/kernel-parameters.txt to make sure they will not
 712 conflict with actual kernel options now or in the future.
 713
 714   vga=<mode>
 715         <mode> here is either an integer (in C notation, either
 716         decimal, octal, or hexadecimal) or one of the strings
 717         "normal" (meaning 0xFFFF), "ext" (meaning 0xFFFE) or "ask"
 718         (meaning 0xFFFD).  This value should be entered into the
 719         vid_mode field, as it is used by the kernel before the command
 720         line is parsed.
 721
 722   mem=<size>
 723         <size> is an integer in C notation optionally followed by
 724         (case insensitive) K, M, G, T, P or E (meaning << 10, << 20,
 725         << 30, << 40, << 50 or << 60).  This specifies the end of
 726         memory to the kernel. This affects the possible placement of
 727         an initrd, since an initrd should be placed near end of
 728         memory.  Note that this is an option to *both* the kernel and
 729         the bootloader!
 730
 731   initrd=<file>
 732         An initrd should be loaded.  The meaning of <file> is
 733         obviously bootloader-dependent, and some boot loaders
 734         (e.g. LILO) do not have such a command.
 735
 736 In addition, some boot loaders add the following options to the
 737 user-specified command line:
 738
 739   BOOT_IMAGE=<file>
 740         The boot image which was loaded.  Again, the meaning of <file>
 741         is obviously bootloader-dependent.
 742
 743   auto
 744         The kernel was booted without explicit user intervention.
 745
 746 If these options are added by the boot loader, it is highly
 747 recommended that they are located *first*, before the user-specified
 748 or configuration-specified command line.  Otherwise, "init=/bin/sh"
 749 gets confused by the "auto" option.
 750
 751
 752 **** RUNNING THE KERNEL
 753
 754 The kernel is started by jumping to the kernel entry point, which is
 755 located at *segment* offset 0x20 from the start of the real mode
 756 kernel.  This means that if you loaded your real-mode kernel code at
 757 0x90000, the kernel entry point is 9020:0000.
 758
 759 At entry, ds = es = ss should point to the start of the real-mode
 760 kernel code (0x9000 if the code is loaded at 0x90000), sp should be
 761 set up properly, normally pointing to the top of the heap, and
 762 interrupts should be disabled.  Furthermore, to guard against bugs in
 763 the kernel, it is recommended that the boot loader sets fs = gs = ds =
 764 es = ss.
 765
 766 In our example from above, we would do:
 767
 768         /* Note: in the case of the "old" kernel protocol, base_ptr must
 769            be == 0x90000 at this point; see the previous sample code */
 770
 771         seg = base_ptr >> 4;
 772
 773         cli();  /* Enter with interrupts disabled! */
 774
 775         /* Set up the real-mode kernel stack */
 776         _SS = seg;
 777         _SP = heap_end;
 778
 779         _DS = _ES = _FS = _GS = seg;
 780         jmp_far(seg+0x20, 0);   /* Run the kernel */
 781
 782 If your boot sector accesses a floppy drive, it is recommended to
 783 switch off the floppy motor before running the kernel, since the
 784 kernel boot leaves interrupts off and thus the motor will not be
 785 switched off, especially if the loaded kernel has the floppy driver as
 786 a demand-loaded module!
 787
 788
 789 **** ADVANCED BOOT LOADER HOOKS
 790
 791 If the boot loader runs in a particularly hostile environment (such as
 792 LOADLIN, which runs under DOS) it may be impossible to follow the
 793 standard memory location requirements.  Such a boot loader may use the
 794 following hooks that, if set, are invoked by the kernel at the
 795 appropriate time.  The use of these hooks should probably be
 796 considered an absolutely last resort!
 797
 798 IMPORTANT: All the hooks are required to preserve %esp, %ebp, %esi and
 799 %edi across invocation.
 800
 801   realmode_swtch:
 802         A 16-bit real mode far subroutine invoked immediately before
 803         entering protected mode.  The default routine disables NMI, so
 804         your routine should probably do so, too.
 805
 806   code32_start:
 807         A 32-bit flat-mode routine *jumped* to immediately after the
 808         transition to protected mode, but before the kernel is
 809         uncompressed.  No segments, except CS, are guaranteed to be
 810         set up (current kernels do, but older ones do not); you should
 811         set them up to BOOT_DS (0x18) yourself.
 812
 813         After completing your hook, you should jump to the address
 814         that was in this field before your boot loader overwrote it
 815         (relocated, if appropriate.)
 816
 817
 818 **** 32-bit BOOT PROTOCOL
 819
 820 For machine with some new BIOS other than legacy BIOS, such as EFI,
 821 LinuxBIOS, etc, and kexec, the 16-bit real mode setup code in kernel
 822 based on legacy BIOS can not be used, so a 32-bit boot protocol needs
 823 to be defined.
 824
 825 In 32-bit boot protocol, the first step in loading a Linux kernel
 826 should be to setup the boot parameters (struct boot_params,
 827 traditionally known as "zero page"). The memory for struct boot_params
 828 should be allocated and initialized to all zero. Then the setup header
 829 from offset 0x01f1 of kernel image on should be loaded into struct
 830 boot_params and examined. The end of setup header can be calculated as
 831 follow:
 832
 833         0x0202 + byte value at offset 0x0201
 834
 835 In addition to read/modify/write the setup header of the struct
 836 boot_params as that of 16-bit boot protocol, the boot loader should
 837 also fill the additional fields of the struct boot_params as that
 838 described in zero-page.txt.
 839
 840 After setupping the struct boot_params, the boot loader can load the
 841 32/64-bit kernel in the same way as that of 16-bit boot protocol.
 842
 843 In 32-bit boot protocol, the kernel is started by jumping to the
 844 32-bit kernel entry point, which is the start address of loaded
 845 32/64-bit kernel.
 846
 847 At entry, the CPU must be in 32-bit protected mode with paging
 848 disabled; a GDT must be loaded with the descriptors for selectors
 849 __BOOT_CS(0x10) and __BOOT_DS(0x18); both descriptors must be 4G flat
 850 segment; __BOOS_CS must have execute/read permission, and __BOOT_DS
 851 must have read/write permission; CS must be __BOOT_CS and DS, ES, SS
 852 must be __BOOT_DS; interrupt must be disabled; %esi must hold the base
 853 address of the struct boot_params; %ebp, %edi and %ebx must be zero.