Coredump pseudo-device Driver Backend API

Data Structures
struct	coredump_driver_api
	Driver Operations Coredump pseudo-device driver operations More...

Typedefs
typedef void(*	coredump_device_dump_t) (const struct device *dev)
	Add the device's data into the core dump being generated.
typedef bool(*	coredump_device_register_memory_t) (const struct device *dev, struct coredump_mem_region_node *region)
	Register a memory region to be stored in the core dump.
typedef bool(*	coredump_device_unregister_memory_t) (const struct device *dev, struct coredump_mem_region_node *region)
	Unregister a memory region from being stored in the core dump.
typedef bool(*	coredump_device_register_callback_t) (const struct device *dev, coredump_dump_callback_t callback)
	Register a callback to be invoked at dump time.

Detailed Description

This group contains the API type definitions, callback signatures, and other helpers required to implement a Coredump pseudo-device driver.

Typedef Documentation

coredump_device_dump_t

typedef void(* coredump_device_dump_t) (const struct device *dev)

#include <zephyr/drivers/coredump.h>

Add the device's data into the core dump being generated.

Called by the coredump subsystem at dump time so the device can copy the registered memory regions and callback data into the core dump.

coredump_device_register_callback_t

typedef bool(* coredump_device_register_callback_t) (const struct device *dev, coredump_dump_callback_t callback)

#include <zephyr/drivers/coredump.h>

Register a callback to be invoked at dump time.

See coredump_device_register_callback() for argument description.

coredump_device_register_memory_t

typedef bool(* coredump_device_register_memory_t) (const struct device *dev, struct coredump_mem_region_node *region)

#include <zephyr/drivers/coredump.h>

Register a memory region to be stored in the core dump.

See coredump_device_register_memory() for argument description.

coredump_device_unregister_memory_t

typedef bool(* coredump_device_unregister_memory_t) (const struct device *dev, struct coredump_mem_region_node *region)

#include <zephyr/drivers/coredump.h>

Unregister a memory region from being stored in the core dump.

See coredump_device_unregister_memory() for argument description.