Coredump pseudo-device driver APIs

Coredump pseudo-device driver APIs. More...

Data Structures
struct	coredump_mem_region_node
	Structure describing a region in memory that may be stored in core dump at the time it is generated. More...

Typedefs
typedef void(*	coredump_dump_callback_t) (uintptr_t dump_area, size_t dump_area_size)
	Callback that occurs at dump time, data copied into dump_area will be included in the dump that is generated.

Functions
static bool	coredump_device_register_memory (const struct device *dev, struct coredump_mem_region_node *region)
	Register a region of memory to be stored in core dump at the time it is generated.
static bool	coredump_device_unregister_memory (const struct device *dev, struct coredump_mem_region_node *region)
	Unregister a region of memory to be stored in core dump at the time it is generated.
static bool	coredump_device_register_callback (const struct device *dev, coredump_dump_callback_t callback)
	Register a callback to be invoked at dump time.

Detailed Description

Coredump pseudo-device driver APIs.

Typedef Documentation

coredump_dump_callback_t

typedef void(* coredump_dump_callback_t) (uintptr_t dump_area, size_t dump_area_size)

#include </home/runner/work/zephyr/zephyr/zephyr/include/zephyr/drivers/coredump.h>

Callback that occurs at dump time, data copied into dump_area will be included in the dump that is generated.

Parameters

dump_area	Pointer to area to copy data into for inclusion in dump
dump_area_size	Size of available memory at dump_area

Function Documentation

coredump_device_register_callback()

bool coredump_device_register_callback ( const struct device * dev, coredump_dump_callback_t callback )

inlinestatic

#include </home/runner/work/zephyr/zephyr/zephyr/include/zephyr/drivers/coredump.h>

Register a callback to be invoked at dump time.

Parameters

dev	Pointer to the device structure for the driver instance.
callback	Callback to be invoked at dump time

Returns

true if registration succeeded

false if registration failed

coredump_device_register_memory()

bool coredump_device_register_memory ( const struct device * dev, struct coredump_mem_region_node * region )

inlinestatic

#include </home/runner/work/zephyr/zephyr/zephyr/include/zephyr/drivers/coredump.h>

Register a region of memory to be stored in core dump at the time it is generated.

Parameters

dev	Pointer to the device structure for the driver instance.
region	Struct describing memory to be collected

Returns

true if registration succeeded

false if registration failed

coredump_device_unregister_memory()

bool coredump_device_unregister_memory ( const struct device * dev, struct coredump_mem_region_node * region )

inlinestatic

#include </home/runner/work/zephyr/zephyr/zephyr/include/zephyr/drivers/coredump.h>

Unregister a region of memory to be stored in core dump at the time it is generated.

Parameters

dev	Pointer to the device structure for the driver instance.
region	Struct describing memory to be collected

Returns

true if unregistration succeeded

false if unregistration failed