Coredump pseudo-device

Interfaces for coredump pseudo-device. More...

Files
file	coredump.h
	Main header file for coredump pseudo-device driver API.

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...
struct	coredump_driver_api
	@driver_ops{Coredump pseudo-device} 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.
typedef void(*	coredump_device_dump_t) (const struct device *dev)
	@def_driverbackendgroup{Coredump pseudo-device,coredump_device_interface}
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

Interfaces for coredump pseudo-device.

Typedef Documentation

coredump_device_dump_t

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

#include <coredump.h>

@def_driverbackendgroup{Coredump pseudo-device,coredump_device_interface}

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 <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 <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 <coredump.h>

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

See coredump_device_unregister_memory() for argument description.

coredump_dump_callback_t

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

#include <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 <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 <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 <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