Commit 1d5c17e4 authored by Atish Patra's avatar Atish Patra Committed by Jonathan Corbet
Browse files

RISC-V: Typo fixes in image header and documentation. 



There are some typos in boot image header and riscv boot documentation.

Fix the typos.

Signed-off-by: default avatarAtish Patra <atish.patra@wdc.com>
Reviewed-by: default avatarPalmer Dabbelt <palmerdabbelt@google.com>
Link: https://lore.kernel.org/r/20191009010637.9955-1-atish.patra@wdc.com


Signed-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent eb431351

Documentation/riscv/boot-image-header.rst

+2 −2
Original line number Diff line number Diff line
@@ -22,7 +22,7 @@ The following 64-byte header is present in decompressed Linux kernel image:: 
	u64 res2 = 0;		  /* Reserved */

	u64 magic = 0x5643534952; /* Magic number, little endian, "RISCV" */

	u32 magic2 = 0x05435352;  /* Magic number 2, little endian, "RSC\x05" */

	u32 res4;		  /* Reserved for PE COFF offset */

	u32 res3;		  /* Reserved for PE COFF offset */



This header format is compliant with PE/COFF header and largely inspired from

ARM64 header. Thus, both ARM64 & RISC-V header can be combined into one common
@@ -34,7 +34,7 @@ Notes 
- This header can also be reused to support EFI stub for RISC-V in future. EFI

  specification needs PE/COFF image header in the beginning of the kernel image

  in order to load it as an EFI application. In order to support EFI stub,

  code0 should be replaced with "MZ" magic string and res5(at offset 0x3c) should

  code0 should be replaced with "MZ" magic string and res3(at offset 0x3c) should

  point to the rest of the PE/COFF header.



- version field indicate header version number

arch/riscv/include/asm/image.h

+2 −2
Original line number Diff line number Diff line
@@ -42,7 +42,7 @@ 
 * @res2:		reserved

 * @magic:		Magic number (RISC-V specific; deprecated)

 * @magic2:		Magic number 2 (to match the ARM64 'magic' field pos)

 * @res4:		reserved (will be used for PE COFF offset)

 * @res3:		reserved (will be used for PE COFF offset)

 *

 * The intention is for this header format to be shared between multiple

 * architectures to avoid a proliferation of image header formats.
@@ -59,7 +59,7 @@ struct riscv_image_header { 
	u64 res2;

	u64 magic;

	u32 magic2;

	u32 res4;

	u32 res3;

};

#endif /* __ASSEMBLY__ */

#endif /* _ASM_RISCV_IMAGE_H */

CRA Git | Maintained and supported by SUSTech CRA and CCSE