1.. _coredump_device_api:
2
3Coredump Device
4###############
5
6Overview
7********
8
9The coredump device is a pseudo-device driver with two types.A COREDUMP_TYPE_MEMCPY
10type exposes device tree bindings for memory address/size values to be included in
11any dump. And the driver exposes an API to add/remove dump memory regions at runtime.
12A COREDUMP_TYPE_CALLBACK device requires exactly one entry in the memory-regions
13array with a size of 0 and a desired size. The driver will statically allocate memory
14of the desired size and provide an API to register a callback function to fill that
15memory when a dump occurs.
16
17Configuration Options
18*********************
19
20Related configuration options:
21
22* :kconfig:option:`CONFIG_COREDUMP_DEVICE`
23
24API Reference
25*************
26
27.. doxygengroup:: coredump_device_interface
28