coredump.h

Go to the documentation of this file.

/*
 * Copyright Meta Platforms, Inc. and its affiliates.
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef INCLUDE_ZEPHYR_DRIVERS_COREDUMP_H_
#define INCLUDE_ZEPHYR_DRIVERS_COREDUMP_H_
 
#include <zephyr/device.h>
#include <zephyr/sys/slist.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct coredump_mem_region_node {
        sys_snode_t node;
 
        uintptr_t start;
 
        size_t size;
};
 
typedef void (*coredump_dump_callback_t)(uintptr_t dump_area, size_t dump_area_size);
 
/*
 * Type definition of coredump API function for adding specified
 * data into coredump
 */
typedef void (*coredump_device_dump_t)(const struct device *dev);
 
/*
 * Type definition of coredump API function for registering a memory
 * region
 */
typedef bool (*coredump_device_register_memory_t)(const struct device *dev,
        struct coredump_mem_region_node *region);
 
/*
 * Type definition of coredump API function for unregistering a memory
 * region
 */
typedef bool (*coredump_device_unregister_memory_t)(const struct device *dev,
        struct coredump_mem_region_node *region);
 
/*
 * Type definition of coredump API function for registering a dump
 * callback
 */
typedef bool (*coredump_device_register_callback_t)(const struct device *dev,
        coredump_dump_callback_t callback);
 
/*
 * API which a coredump pseudo-device driver should expose
 */
__subsystem struct coredump_driver_api {
        coredump_device_dump_t              dump;
        coredump_device_register_memory_t   register_memory;
        coredump_device_unregister_memory_t unregister_memory;
        coredump_device_register_callback_t register_callback;
};
 
static inline bool coredump_device_register_memory(const struct device *dev,
        struct coredump_mem_region_node *region)
{
        const struct coredump_driver_api *api =
                (const struct coredump_driver_api *)dev->api;
 
        return api->register_memory(dev, region);
}
 
static inline bool coredump_device_unregister_memory(const struct device *dev,
        struct coredump_mem_region_node *region)
{
        const struct coredump_driver_api *api =
                (const struct coredump_driver_api *)dev->api;
 
        return api->unregister_memory(dev, region);
}
 
static inline bool coredump_device_register_callback(const struct device *dev,
        coredump_dump_callback_t callback)
{
        const struct coredump_driver_api *api =
                (const struct coredump_driver_api *)dev->api;
 
        return api->register_callback(dev, callback);
}
 
#ifdef __cplusplus
}
#endif
 
#endif /* INCLUDE_ZEPHYR_DRIVERS_COREDUMP_H_ */