Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
x86/Documentation: Align Note Blocks style
The file collects pieces from different epochs and hence has unaligned
style of the Note Blocks (in terms of reStructuredText specification).
Align the style to be the same structured:
- start the text under 't' column from '.. note::' directive
- convert a couple of plain text notes to use '.. note::' directive
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Acked-by: Dave Hansen <dave.hansen@linux.intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20241128152546.2396782-3-andriy.shevchenko@linux.intel.com
authored by
Andy Shevchenko
and committed by
Jonathan Corbet
efba5970
f23d79d6
+21
-19
+21
-19
Documentation/arch/x86/boot.rst
+21
-19
Documentation/arch/x86/boot.rst
···
77
77
Protocol 2.15 (Kernel 5.5) Added the kernel_info and kernel_info.setup_type_max.
78
78
============= ============================================================
79
79
80
-
.. note::
80
+
.. note::
81
81
The protocol version number should be changed only if the setup header
82
82
is changed. There is no need to update the version number if boot_params
83
83
or kernel_info are changed. Additionally, it is recommended to use
···
229
229
=========== ======== ===================== ============================================
230
230
231
231
.. note::
232
-
(1) For backwards compatibility, if the setup_sects field contains 0, the
233
-
real value is 4.
232
+
(1) For backwards compatibility, if the setup_sects field contains 0,
233
+
the real value is 4.
234
234
235
-
(2) For boot protocol prior to 2.04, the upper two bytes of the syssize
236
-
field are unusable, which means the size of a bzImage kernel
237
-
cannot be determined.
235
+
(2) For boot protocol prior to 2.04, the upper two bytes of the syssize
236
+
field are unusable, which means the size of a bzImage kernel
237
+
cannot be determined.
238
238
239
-
(3) Ignored, but safe to set, for boot protocols 2.02-2.09.
239
+
(3) Ignored, but safe to set, for boot protocols 2.02-2.09.
240
240
241
241
If the "HdrS" (0x53726448) magic number is not found at offset 0x202,
242
242
the boot protocol version is "old". Loading an old kernel, the
···
265
265
nonstandard address should fill in the fields marked (reloc); other
266
266
boot loaders can ignore those fields.
267
267
268
-
The byte order of all fields is littleendian (this is x86, after all.)
268
+
The byte order of all fields is little endian (this is x86, after all.)
269
269
270
270
============ ===========
271
271
Field name: setup_sects
···
1206
1206
is_bzImage = (protocol >= 0x0200) && (loadflags & 0x01);
1207
1207
load_address = is_bzImage ? 0x100000 : 0x10000;
1208
1208
1209
-
Note that Image/zImage kernels can be up to 512K in size, and thus use
1210
-
the entire 0x10000-0x90000 range of memory. This means it is pretty
1211
-
much a requirement for these kernels to load the real-mode part at
1212
-
0x90000. bzImage kernels allow much more flexibility.
1209
+
.. note::
1210
+
Image/zImage kernels can be up to 512K in size, and thus use the entire
1211
+
0x10000-0x90000 range of memory. This means it is pretty much a
1212
+
requirement for these kernels to load the real-mode part at 0x90000.
1213
+
bzImage kernels allow much more flexibility.
1213
1214
1214
1215
Special Command Line Options
1215
1216
============================
···
1440
1439
1441
1440
All other fields should be zero.
1442
1441
1443
-
NOTE: The EFI Handover Protocol is deprecated in favour of the ordinary PE/COFF
1444
-
entry point, combined with the LINUX_EFI_INITRD_MEDIA_GUID based initrd
1445
-
loading protocol (refer to [0] for an example of the bootloader side of
1446
-
this), which removes the need for any knowledge on the part of the EFI
1447
-
bootloader regarding the internal representation of boot_params or any
1448
-
requirements/limitations regarding the placement of the command line
1449
-
and ramdisk in memory, or the placement of the kernel image itself.
1442
+
.. note::
1443
+
The EFI Handover Protocol is deprecated in favour of the ordinary PE/COFF
1444
+
entry point, combined with the LINUX_EFI_INITRD_MEDIA_GUID based initrd
1445
+
loading protocol (refer to [0] for an example of the bootloader side of
1446
+
this), which removes the need for any knowledge on the part of the EFI
1447
+
bootloader regarding the internal representation of boot_params or any
1448
+
requirements/limitations regarding the placement of the command line
1449
+
and ramdisk in memory, or the placement of the kernel image itself.
1450
1450
1451
1451
[0] https://github.com/u-boot/u-boot/commit/ec80b4735a593961fe701cc3a5d717d4739b0fd0