doc: services: debug: coredump: add flash partition

Add flash partition guide to coredump documentation. Signed-off-by: Lucas Tamborrino <lucas.tamborrino@espressif.com>
Willmish · Jun 21, 2023 · 9ae80aa · 9ae80aa
1 parent d8332d1
commit 9ae80aa
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/doc/services/debugging/coredump.rst b/doc/services/debugging/coredump.rst
@@ -18,6 +18,8 @@ Configure this module using the following options.
 Here are the options to enable output backends for core dump:
 
 * ``DEBUG_COREDUMP_BACKEND_LOGGING``: use log module for core dump output.
+* ``DEBUG_COREDUMP_BACKEND_FLASH_PARTITION``: use flash partition for core
+  dump output.
 * ``DEBUG_COREDUMP_BACKEND_NULL``: fallback core dump backend if other
   backends cannot be enabled. All output is sent to null.
 
@@ -62,6 +64,20 @@ This usually involves the following steps:
    ``ZEPHYR_TOOLCHAIN_VARIANT=zephyr`` should use the debugger in the
    ``xtensa-intel_apl_adsp`` toolchain of the SDK.
 
+5. When ``DEBUG_COREDUMP_BACKEND_FLASH_PARTITION`` is enabled the core dump
+   data is stored in the flash partition. The flash partition must be defined
+   in the device tree:
+
+	.. code-block:: devicetree
+
+		&flash0 {
+			partitions {
+				coredump_partition: partition@255000 {
+					label = "coredump-partition";
+					reg = <0x255000 DT_SIZE_K(4)>;
+				};
+		};
+
 Example
 -------