linux/Documentation/arch
Andy Shevchenko 0c92af9ead x86/Documentation: Update algo in init_size description of boot protocol
[ Upstream commit be4ca6c53e ]

The init_size description of boot protocol has an example of the runtime
start address for the compressed bzImage. For non-relocatable kernel
it relies on the pref_address value (if not 0), but for relocatable case
only pays respect to the load_addres and kernel_alignment, and it is
inaccurate for the latter. Boot loader must consider the pref_address
as the Linux kernel relocates to it before being decompressed as nicely
described in this commit message a year ago:

  43b1d3e68e ("kexec: Allocate kernel above bzImage's pref_address")

Due to this documentation inaccuracy some of the bootloaders (*) made a
mistake in the calculations and if kernel image is big enough, this may
lead to unbootable configurations.

*)
  In particular, kexec-tools missed that and resently got a couple of
  changes which will be part of v2.0.30 release. For the record,
  commit 43b1d3e68e only fixed the kernel kexec implementation and
  also missed to update the init_size description.

While at it, make an example C-like looking as it's done elsewhere in
the document and fix indentation as presribed by the reStructuredText
specifications, so the syntax highliting will work properly.

Fixes: 43b1d3e68e ("kexec: Allocate kernel above bzImage's pref_address")
Fixes: d297366ba6 ("x86: document new bzImage fields")
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
Signed-off-by: Ingo Molnar <mingo@kernel.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Cc: "H. Peter Anvin" <hpa@zytor.com>
Link: https://lore.kernel.org/r/20241125105005.1616154-1-andriy.shevchenko@linux.intel.com
Signed-off-by: Sasha Levin <sashal@kernel.org>
History 2024-12-05 14:03:07 +01:00
..
arc docs: kernel_feat.py: fix potential command injection 2024-01-11 09:21:01 -07:00
arm move asm/unaligned.h to linux/unaligned.h 2024-10-02 17:23:23 -04:00
arm64 arm64: Subscribe Microsoft Azure Cobalt 100 to erratum 3194386 2024-10-04 12:38:03 +01:00
loongarch Docs/LoongArch: Add advanced extended IRQ model description 2024-09-24 15:32:20 +08:00
m68k Docs: typos/spelling 2024-05-02 10:02:29 -06:00
mips docs: kernel_feat.py: fix potential command injection 2024-01-11 09:21:01 -07:00
nios2 docs: kernel_feat.py: fix potential command injection 2024-01-11 09:21:01 -07:00
openrisc docs: kernel_feat.py: fix potential command injection 2024-01-11 09:21:01 -07:00
parisc docs: kernel_feat.py: fix potential command injection 2024-01-11 09:21:01 -07:00
powerpc Documentation: Fix spelling mistakes 2024-09-05 14:35:45 -06:00
riscv Another relatively mundane cycle for docs: 2024-09-17 16:44:08 +02:00
s390 s390/vfio-ap: Driver feature advertisement 2024-09-23 17:57:04 +02:00
sh docs: kernel_feat.py: fix potential command injection 2024-01-11 09:21:01 -07:00
sparc Docs: typos/spelling 2024-05-02 10:02:29 -06:00
x86 x86/Documentation: Update algo in init_size description of boot protocol 2024-12-05 14:03:07 +01:00
xtensa docs: kernel_feat.py: fix potential command injection 2024-01-11 09:21:01 -07:00
index.rst The number of commits for documentation is not huge this time around, but 2023-11-01 17:11:41 -10:00