aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/x86/boot.txt41
1 files changed, 41 insertions, 0 deletions
diff --git a/Documentation/x86/boot.txt b/Documentation/x86/boot.txt
index 7c3a8801b7ce..c6539a4278b6 100644
--- a/Documentation/x86/boot.txt
+++ b/Documentation/x86/boot.txt
@@ -54,6 +54,9 @@ Protocol 2.10: (Kernel 2.6.31) Added a protocol for relaxed alignment
54 beyond the kernel_alignment added, new init_size and 54 beyond the kernel_alignment added, new init_size and
55 pref_address fields. Added extended boot loader IDs. 55 pref_address fields. Added extended boot loader IDs.
56 56
57Protocol 2.11: (Kernel 3.6) Added a field for offset of EFI handover
58 protocol entry point.
59
57**** MEMORY LAYOUT 60**** MEMORY LAYOUT
58 61
59The traditional memory map for the kernel loader, used for Image or 62The traditional memory map for the kernel loader, used for Image or
@@ -189,6 +192,7 @@ Offset Proto Name Meaning
189 of struct setup_data 192 of struct setup_data
1900258/8 2.10+ pref_address Preferred loading address 1930258/8 2.10+ pref_address Preferred loading address
1910260/4 2.10+ init_size Linear memory required during initialization 1940260/4 2.10+ init_size Linear memory required during initialization
1950264/4 2.11+ handover_offset Offset of handover entry point
192 196
193(1) For backwards compatibility, if the setup_sects field contains 0, the 197(1) For backwards compatibility, if the setup_sects field contains 0, the
194 real value is 4. 198 real value is 4.
@@ -690,6 +694,16 @@ Offset/size: 0x260/4
690 else 694 else
691 runtime_start = pref_address 695 runtime_start = pref_address
692 696
697Field name: handover_offset
698Type: read
699Offset/size: 0x264/4
700
701 This field is the offset from the beginning of the kernel image to
702 the EFI handover protocol entry point. Boot loaders using the EFI
703 handover protocol to boot the kernel should jump to this offset.
704
705 See EFI HANDOVER PROTOCOL below for more details.
706
693 707
694**** THE IMAGE CHECKSUM 708**** THE IMAGE CHECKSUM
695 709
@@ -1010,3 +1024,30 @@ segment; __BOOS_CS must have execute/read permission, and __BOOT_DS
1010must have read/write permission; CS must be __BOOT_CS and DS, ES, SS 1024must have read/write permission; CS must be __BOOT_CS and DS, ES, SS
1011must be __BOOT_DS; interrupt must be disabled; %esi must hold the base 1025must be __BOOT_DS; interrupt must be disabled; %esi must hold the base
1012address of the struct boot_params; %ebp, %edi and %ebx must be zero. 1026address of the struct boot_params; %ebp, %edi and %ebx must be zero.
1027
1028**** EFI HANDOVER PROTOCOL
1029
1030This protocol allows boot loaders to defer initialisation to the EFI
1031boot stub. The boot loader is required to load the kernel/initrd(s)
1032from the boot media and jump to the EFI handover protocol entry point
1033which is hdr->handover_offset bytes from the beginning of
1034startup_{32,64}.
1035
1036The function prototype for the handover entry point looks like this,
1037
1038 efi_main(void *handle, efi_system_table_t *table, struct boot_params *bp)
1039
1040'handle' is the EFI image handle passed to the boot loader by the EFI
1041firmware, 'table' is the EFI system table - these are the first two
1042arguments of the "handoff state" as described in section 2.3 of the
1043UEFI specification. 'bp' is the boot loader-allocated boot params.
1044
1045The boot loader *must* fill out the following fields in bp,
1046
1047 o hdr.code32_start
1048 o hdr.cmd_line_ptr
1049 o hdr.cmdline_size
1050 o hdr.ramdisk_image (if applicable)
1051 o hdr.ramdisk_size (if applicable)
1052
1053All other fields should be zero.