diff options
| author | Changbin Du <changbin.du@gmail.com> | 2019-05-08 11:21:22 -0400 |
|---|---|---|
| committer | Jonathan Corbet <corbet@lwn.net> | 2019-05-08 16:34:10 -0400 |
| commit | 0c2d3639a81b1033f3cb5d3c5ae4d9e7e1313cc4 (patch) | |
| tree | d83cc1b80c88d738aeeef5e388e6b804c16c373a /Documentation/x86 | |
| parent | 4b1357600200cd2b56ecc6fb452d50d4079b42ed (diff) | |
Documentation: x86: convert zero-page.txt to reST
This converts the plain text documentation to reStructuredText format and
add it to Sphinx TOC tree. No essential content change.
Signed-off-by: Changbin Du <changbin.du@gmail.com>
Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/x86')
| -rw-r--r-- | Documentation/x86/index.rst | 1 | ||||
| -rw-r--r-- | Documentation/x86/zero-page.rst | 45 | ||||
| -rw-r--r-- | Documentation/x86/zero-page.txt | 40 |
3 files changed, 46 insertions, 40 deletions
diff --git a/Documentation/x86/index.rst b/Documentation/x86/index.rst index d9ccc0f39279..e43aa9b31976 100644 --- a/Documentation/x86/index.rst +++ b/Documentation/x86/index.rst | |||
| @@ -14,3 +14,4 @@ x86-specific Documentation | |||
| 14 | kernel-stacks | 14 | kernel-stacks |
| 15 | entry_64 | 15 | entry_64 |
| 16 | earlyprintk | 16 | earlyprintk |
| 17 | zero-page | ||
diff --git a/Documentation/x86/zero-page.rst b/Documentation/x86/zero-page.rst new file mode 100644 index 000000000000..f088f5881666 --- /dev/null +++ b/Documentation/x86/zero-page.rst | |||
| @@ -0,0 +1,45 @@ | |||
| 1 | .. SPDX-License-Identifier: GPL-2.0 | ||
| 2 | |||
| 3 | ========= | ||
| 4 | Zero Page | ||
| 5 | ========= | ||
| 6 | The additional fields in struct boot_params as a part of 32-bit boot | ||
| 7 | protocol of kernel. These should be filled by bootloader or 16-bit | ||
| 8 | real-mode setup code of the kernel. References/settings to it mainly | ||
| 9 | are in:: | ||
| 10 | |||
| 11 | arch/x86/include/uapi/asm/bootparam.h | ||
| 12 | |||
| 13 | =========== ===== ======================= ================================================= | ||
| 14 | Offset/Size Proto Name Meaning | ||
| 15 | |||
| 16 | 000/040 ALL screen_info Text mode or frame buffer information | ||
| 17 | (struct screen_info) | ||
| 18 | 040/014 ALL apm_bios_info APM BIOS information (struct apm_bios_info) | ||
| 19 | 058/008 ALL tboot_addr Physical address of tboot shared page | ||
| 20 | 060/010 ALL ist_info Intel SpeedStep (IST) BIOS support information | ||
| 21 | (struct ist_info) | ||
| 22 | 080/010 ALL hd0_info hd0 disk parameter, OBSOLETE!! | ||
| 23 | 090/010 ALL hd1_info hd1 disk parameter, OBSOLETE!! | ||
| 24 | 0A0/010 ALL sys_desc_table System description table (struct sys_desc_table), | ||
| 25 | OBSOLETE!! | ||
| 26 | 0B0/010 ALL olpc_ofw_header OLPC's OpenFirmware CIF and friends | ||
| 27 | 0C0/004 ALL ext_ramdisk_image ramdisk_image high 32bits | ||
| 28 | 0C4/004 ALL ext_ramdisk_size ramdisk_size high 32bits | ||
| 29 | 0C8/004 ALL ext_cmd_line_ptr cmd_line_ptr high 32bits | ||
| 30 | 140/080 ALL edid_info Video mode setup (struct edid_info) | ||
| 31 | 1C0/020 ALL efi_info EFI 32 information (struct efi_info) | ||
| 32 | 1E0/004 ALL alt_mem_k Alternative mem check, in KB | ||
| 33 | 1E4/004 ALL scratch Scratch field for the kernel setup code | ||
| 34 | 1E8/001 ALL e820_entries Number of entries in e820_table (below) | ||
| 35 | 1E9/001 ALL eddbuf_entries Number of entries in eddbuf (below) | ||
| 36 | 1EA/001 ALL edd_mbr_sig_buf_entries Number of entries in edd_mbr_sig_buffer | ||
| 37 | (below) | ||
| 38 | 1EB/001 ALL kbd_status Numlock is enabled | ||
| 39 | 1EC/001 ALL secure_boot Secure boot is enabled in the firmware | ||
| 40 | 1EF/001 ALL sentinel Used to detect broken bootloaders | ||
| 41 | 290/040 ALL edd_mbr_sig_buffer EDD MBR signatures | ||
| 42 | 2D0/A00 ALL e820_table E820 memory map table | ||
| 43 | (array of struct e820_entry) | ||
| 44 | D00/1EC ALL eddbuf EDD data (array of struct edd_info) | ||
| 45 | =========== ===== ======================= ================================================= | ||
diff --git a/Documentation/x86/zero-page.txt b/Documentation/x86/zero-page.txt deleted file mode 100644 index 68aed077f7b6..000000000000 --- a/Documentation/x86/zero-page.txt +++ /dev/null | |||
| @@ -1,40 +0,0 @@ | |||
| 1 | The additional fields in struct boot_params as a part of 32-bit boot | ||
| 2 | protocol of kernel. These should be filled by bootloader or 16-bit | ||
| 3 | real-mode setup code of the kernel. References/settings to it mainly | ||
| 4 | are in: | ||
| 5 | |||
| 6 | arch/x86/include/uapi/asm/bootparam.h | ||
| 7 | |||
| 8 | |||
| 9 | Offset Proto Name Meaning | ||
| 10 | /Size | ||
| 11 | |||
| 12 | 000/040 ALL screen_info Text mode or frame buffer information | ||
| 13 | (struct screen_info) | ||
| 14 | 040/014 ALL apm_bios_info APM BIOS information (struct apm_bios_info) | ||
| 15 | 058/008 ALL tboot_addr Physical address of tboot shared page | ||
| 16 | 060/010 ALL ist_info Intel SpeedStep (IST) BIOS support information | ||
| 17 | (struct ist_info) | ||
| 18 | 080/010 ALL hd0_info hd0 disk parameter, OBSOLETE!! | ||
| 19 | 090/010 ALL hd1_info hd1 disk parameter, OBSOLETE!! | ||
| 20 | 0A0/010 ALL sys_desc_table System description table (struct sys_desc_table), | ||
| 21 | OBSOLETE!! | ||
| 22 | 0B0/010 ALL olpc_ofw_header OLPC's OpenFirmware CIF and friends | ||
| 23 | 0C0/004 ALL ext_ramdisk_image ramdisk_image high 32bits | ||
| 24 | 0C4/004 ALL ext_ramdisk_size ramdisk_size high 32bits | ||
| 25 | 0C8/004 ALL ext_cmd_line_ptr cmd_line_ptr high 32bits | ||
| 26 | 140/080 ALL edid_info Video mode setup (struct edid_info) | ||
| 27 | 1C0/020 ALL efi_info EFI 32 information (struct efi_info) | ||
| 28 | 1E0/004 ALL alt_mem_k Alternative mem check, in KB | ||
| 29 | 1E4/004 ALL scratch Scratch field for the kernel setup code | ||
| 30 | 1E8/001 ALL e820_entries Number of entries in e820_table (below) | ||
| 31 | 1E9/001 ALL eddbuf_entries Number of entries in eddbuf (below) | ||
| 32 | 1EA/001 ALL edd_mbr_sig_buf_entries Number of entries in edd_mbr_sig_buffer | ||
| 33 | (below) | ||
| 34 | 1EB/001 ALL kbd_status Numlock is enabled | ||
| 35 | 1EC/001 ALL secure_boot Secure boot is enabled in the firmware | ||
| 36 | 1EF/001 ALL sentinel Used to detect broken bootloaders | ||
| 37 | 290/040 ALL edd_mbr_sig_buffer EDD MBR signatures | ||
| 38 | 2D0/A00 ALL e820_table E820 memory map table | ||
| 39 | (array of struct e820_entry) | ||
| 40 | D00/1EC ALL eddbuf EDD data (array of struct edd_info) | ||
