Coredump APIs

Coredump APIs. More...

Functions
void	coredump (unsigned int reason, const z_arch_esf_t *esf, struct k_thread *thread)
	Perform coredump. More...
void	coredump_memory_dump (uintptr_t start_addr, uintptr_t end_addr)
	Dump memory region. More...
void	coredump_buffer_output (uint8_t *buf, size_t buflen)
	Output the buffer via coredump. More...
int	coredump_query (enum coredump_query_id query_id, void *arg)
	Perform query on coredump subsystem. More...
int	coredump_cmd (enum coredump_cmd_id query_id, void *arg)
	Perform command on coredump subsystem. More...

Detailed Description

Coredump APIs.

Function Documentation

coredump()

void coredump	(	unsigned int	reason,
		const z_arch_esf_t *	esf,
		struct k_thread *	thread
	)

#include <include/zephyr/debug/coredump.h>

Perform coredump.

Normally, this is called inside z_fatal_error() to generate coredump when a fatal error is encountered. This can also be called on demand whenever a coredump is desired.

Parameters

reason	Reason for the fatal error
esf	Exception context
thread	Thread information to dump

coredump_buffer_output()

int coredump_buffer_output	(	uint8_t *	buf,
		size_t	buflen
	)

#include <include/zephyr/debug/coredump.h>

Output the buffer via coredump.

This outputs the buffer of byte array to the coredump backend. For example, this can be called to output the coredump section containing registers, or a section for memory dump.

Parameters

buf	Buffer to be send to coredump output
buflen	Buffer length

coredump_cmd()

int coredump_cmd	(	enum coredump_cmd_id	cmd_id,
		void *	arg
	)

#include <include/zephyr/debug/coredump.h>

Perform command on coredump subsystem.

Perform certain on coredump subsystem, for example, output the stored coredump via logging.

Parameters

[in]	cmd_id	Command ID
[in,out]	arg	Pointer to argument for exchanging information

Returns

Depends on the command

coredump_memory_dump()

void coredump_memory_dump	(	uintptr_t	start_addr,
		uintptr_t	end_addr
	)

#include <include/zephyr/debug/coredump.h>

Dump memory region.

Parameters

start_addr	Start address of memory region to be dumped
end_addr	End address of memory region to be dumped

coredump_query()

int coredump_query	(	enum coredump_query_id	query_id,
		void *	arg
	)

#include <include/zephyr/debug/coredump.h>

Perform query on coredump subsystem.

Query the coredump subsystem for information, for example, if there is an error.

Parameters

[in]	query_id	Query ID
[in,out]	arg	Pointer to argument for exchanging information

Returns

Depends on the query