summaryrefslogtreecommitdiffstats
path: root/Documentation
diff options
context:
space:
mode:
authorMasami Hiramatsu <mhiramat@kernel.org>2020-11-20 11:29:22 +0900
committerSteven Rostedt (VMware) <rostedt@goodmis.org>2020-11-30 23:22:11 -0500
commit05227490c5f0f1bbd3693a7a70b3fb5b09d2a996 (patch)
tree7ac9d5918f9cb46fa9283a2ec91e7cb2719bd63f /Documentation
parente86843580d1bb1ce12544bca3115cf11d51603ff (diff)
downloadlinux-stable-05227490c5f0f1bbd3693a7a70b3fb5b09d2a996.tar.gz
linux-stable-05227490c5f0f1bbd3693a7a70b3fb5b09d2a996.tar.bz2
linux-stable-05227490c5f0f1bbd3693a7a70b3fb5b09d2a996.zip
docs: bootconfig: Add the endianness of fields
Add a description about the endianness of the size and the checksum fields. Those must be stored as le32 instead of u32. This will allow us to apply bootconfig to the cross build initrd without caring the endianness. Link: https://lkml.kernel.org/r/160583936246.547349.10964204130590955409.stgit@devnote2 Reported-by: Steven Rostedt <rostedt@goodmis.org> Suggested-by: Linus Torvalds <torvalds@linux-foundation.org> Signed-off-by: Masami Hiramatsu <mhiramat@kernel.org> Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/admin-guide/bootconfig.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/admin-guide/bootconfig.rst b/Documentation/admin-guide/bootconfig.rst
index 363599683784..9b90efcc3a35 100644
--- a/Documentation/admin-guide/bootconfig.rst
+++ b/Documentation/admin-guide/bootconfig.rst
@@ -140,7 +140,9 @@ Since the boot configuration file is loaded with initrd, it will be added
to the end of the initrd (initramfs) image file with padding, size,
checksum and 12-byte magic word as below.
-[initrd][bootconfig][padding][size(u32)][checksum(u32)][#BOOTCONFIG\n]
+[initrd][bootconfig][padding][size(le32)][checksum(le32)][#BOOTCONFIG\n]
+
+The size and checksum fields are unsigned 32bit little endian value.
When the boot configuration is added to the initrd image, the total
file size is aligned to 4 bytes. To fill the gap, null characters