Documentation/powerpc: update fadump implementation details
authorSourabh Jain <sourabhjain@linux.ibm.com>
Mon, 22 Apr 2024 19:59:32 +0000 (01:29 +0530)
committerMichael Ellerman <mpe@ellerman.id.au>
Mon, 29 Apr 2024 13:51:15 +0000 (23:51 +1000)
commit57e6700145c5d1f49c52137e9163f73ec5441256
tree6a53b03bc285c455c2ccd6796ed3a7265be5019e
parentbc446c5acabadeb38b61b565535401c5dfdd1214
Documentation/powerpc: update fadump implementation details

The patch titled ("powerpc: make fadump resilient with memory add/remove
events") has made significant changes to the implementation of fadump,
particularly on elfcorehdr creation and fadump crash info header
structure. Therefore, updating the fadump implementation documentation
to reflect those changes.

Following updates are done to firmware assisted dump documentation:

1. The elfcorehdr is no longer stored after fadump HDR in the reserved
   dump area. Instead, the second kernel dynamically allocates memory
   for the elfcorehdr within the address range from 0 to the boot memory
   size. Therefore, update figures 1 and 2 of Memory Reservation during
   the first and second kernels to reflect this change.

2. A version field has been added to the fadump header to manage the
   future changes to fadump crash info header structure without changing
   the fadump header magic number in the future. Therefore, remove the
   corresponding TODO from the document.

Signed-off-by: Sourabh Jain <sourabhjain@linux.ibm.com>
Signed-off-by: Michael Ellerman <mpe@ellerman.id.au>
Link: https://msgid.link/20240422195932.1583833-4-sourabhjain@linux.ibm.com
Documentation/arch/powerpc/firmware-assisted-dump.rst