x86/Documentation: Update algo in init_size description of boot protocol

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:

43b1d3e68ee7 ("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 43b1d3e68ee7 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: 43b1d3e68ee7 ("kexec: Allocate kernel above bzImage's pref_address")
Fixes: d297366ba692 ("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

authored by Andy Shevchenko and committed by Ingo Molnar be4ca6c5 c809b0d0

Changed files
+13 -4
Documentation
arch
x86
+13 -4
Documentation/arch/x86/boot.rst
··· 896 896 897 897 The kernel runtime start address is determined by the following algorithm:: 898 898 899 - if (relocatable_kernel) 900 - runtime_start = align_up(load_address, kernel_alignment) 901 - else 902 - runtime_start = pref_address 899 + if (relocatable_kernel) { 900 + if (load_address < pref_address) 901 + load_address = pref_address; 902 + runtime_start = align_up(load_address, kernel_alignment); 903 + } else { 904 + runtime_start = pref_address; 905 + } 906 + 907 + Hence the necessary memory window location and size can be estimated by 908 + a boot loader as:: 909 + 910 + memory_window_start = runtime_start; 911 + memory_window_size = init_size; 903 912 904 913 ============ =============== 905 914 Field name: handover_offset