ecd_api.h File Reference

Go to the source code of this file.

Data Structures
struct	ecd_get_params_t

Macros
#define	ECD_MIN_BUFFER_SIZE   (32*1024*1024)
#define	ECD_SUCCESS   0
#define	ECD_ERR_INVALID_ARGUMENT   -1
#define	ECD_ERR_BUFFER_OVERRUN   -2
#define	ECD_ERR_ALLOCATION   -3

Enumerations
enum	ecd_fwState_t { ECD_FW_STATE_RUNNING, ECD_FW_STATE_UE, ECD_FW_STATE_FAILED }

Functions
int	ecd_GetCoreDumpData (void *dumpCtx, ecd_fwState_t fwState, ecd_get_params_t *params, void *dumpBuffer, int dumpBufferSize, int argc, char *argv[])
	Fetch coreDump data. More...
void	os_cfg_read8 (void *ctx, uint32_t offset, uint32_t *pdata)
void	os_cfg_read16 (void *ctx, uint32_t offset, uint32_t *pdata)
void	os_cfg_read32 (void *ctx, uint32_t offset, uint32_t *pdata)
void	os_cfg_write8 (void *ctx, uint32_t offset, uint32_t data)
void	os_cfg_write16 (void *ctx, uint32_t offset, uint32_t data)
void	os_cfg_write32 (void *ctx, uint32_t offset, uint32_t data)
void	os_bar_read8 (void *ctx, uint32_t bar, uint32_t offset, uint32_t *pdata)
void	os_bar_read16 (void *ctx, uint32_t bar, uint32_t offset, uint32_t *pdata)
void	os_bar_read32 (void *ctx, uint32_t bar, uint32_t offset, uint32_t *pdata)
void	os_bar_write8 (void *ctx, uint32_t bar, uint32_t offset, uint32_t data)
void	os_bar_write16 (void *ctx, uint32_t bar, uint32_t offset, uint32_t data)
void	os_bar_write32 (void *ctx, uint32_t bar, uint32_t offset, uint32_t data)
void *	os_malloc (void *ctx, uint32_t size)
void	os_free (void *ctx, void *ptr)
void	ecd_log (char *fmt,...)

Macro Details

#define ECD_ERR_ALLOCATION   -3

Definition at line 96 of file ecd_api.h.

#define ECD_ERR_BUFFER_OVERRUN   -2

Definition at line 95 of file ecd_api.h.

#define ECD_ERR_INVALID_ARGUMENT   -1

Definition at line 94 of file ecd_api.h.

#define ECD_MIN_BUFFER_SIZE   (32*1024*1024)

Definition at line 42 of file ecd_api.h.

#define ECD_SUCCESS   0

Definition at line 93 of file ecd_api.h.

Enumeration Details

enum ecd_fwState_t

Enumerator
ECD_FW_STATE_RUNNING
ECD_FW_STATE_UE
ECD_FW_STATE_FAILED

Definition at line 36 of file ecd_api.h.

Function Details

int ecd_GetCoreDumpData	(	void *	dumpCtx,
		ecd_fwState_t	fwState,
		ecd_get_params_t *	params,
		void *	dumpBuffer,
		int	dumpBufferSize,
		int	argc,
		char *	argv[]
	)

Fetch coreDump data.

This function is invoked by a user application to retrieve coreDump date.

Parameters

dumpCtx	The user supplied context pointer that is passed to the user supplied helper functions
fwState	The state of firmware
params	Informational parameters used to populate the coreDump image
dumpBuffer	coreDump data buffer populated by ecd_GetCoreDumpData()
dumpBufferLength	Length in bytes of the dumpBuffer (must be at least ECD_MIN_BUFFER_SIZE)
argc	Command line control parameter count
argv	Command line control parameters

argc/argv implement command line style arguments that control the library. Currently the following commands are supported:

"dead" Retrieve using a dead dump "live" Retrieve using a live dump "testtemplate" Retrieve using the test template "be3template" Retrieve using the BE3 template (default)

Returns

This function returns the size in bytes of the coreDump image data placed in dumpBuffer, or a negative error code.

void ecd_log	(	char *	fmt,
			...
	)

Definition at line 969 of file elxu_dump.c.

void os_bar_read16	(	void *	ctx,
		uint32_t	bar,
		uint32_t	offset,
		uint32_t *	pdata
	)

Definition at line 1203 of file elxu_dump.c.

void os_bar_read32	(	void *	ctx,
		uint32_t	bar,
		uint32_t	offset,
		uint32_t *	pdata
	)

Definition at line 1237 of file elxu_dump.c.

void os_bar_read8	(	void *	ctx,
		uint32_t	bar,
		uint32_t	offset,
		uint32_t *	pdata
	)

Definition at line 1169 of file elxu_dump.c.

void os_bar_write16	(	void *	ctx,
		uint32_t	bar,
		uint32_t	offset,
		uint32_t	data
	)

Definition at line 1302 of file elxu_dump.c.

void os_bar_write32	(	void *	ctx,
		uint32_t	bar,
		uint32_t	offset,
		uint32_t	data
	)

Definition at line 1333 of file elxu_dump.c.

void os_bar_write8	(	void *	ctx,
		uint32_t	bar,
		uint32_t	offset,
		uint32_t	data
	)

Definition at line 1271 of file elxu_dump.c.

void os_cfg_read16	(	void *	ctx,
		uint32_t	offset,
		uint32_t *	pdata
	)

Definition at line 1019 of file elxu_dump.c.

void os_cfg_read32	(	void *	ctx,
		uint32_t	offset,
		uint32_t *	pdata
	)

Definition at line 1050 of file elxu_dump.c.

void os_cfg_read8	(	void *	ctx,
		uint32_t	offset,
		uint32_t *	pdata
	)

Definition at line 989 of file elxu_dump.c.

void os_cfg_write16	(	void *	ctx,
		uint32_t	offset,
		uint32_t	data
	)

Definition at line 1112 of file elxu_dump.c.

void os_cfg_write32	(	void *	ctx,
		uint32_t	offset,
		uint32_t	data
	)

Definition at line 1140 of file elxu_dump.c.

void os_cfg_write8	(	void *	ctx,
		uint32_t	offset,
		uint32_t	data
	)

Definition at line 1083 of file elxu_dump.c.

void os_free	(	void *	ctx,
		void *	ptr
	)

Definition at line 1369 of file elxu_dump.c.

void* os_malloc	(	void *	ctx,
		uint32_t	size
	)

Definition at line 1365 of file elxu_dump.c.