ocs_ddumplib.c File Reference

#include "ocs.h"
#include "ocs_ddump.h"

Go to the source code of this file.

Detailed Description

General diagnostics dump API

Definition in file ocs_ddumplib.c.

Macros
#define	OCS_NEWLINE_MOD   8
#define	OCS_NEWLINE_MOD   8

Functions
void	ocs_ddump_startfile (ocs_textbuf_t *textbuf)
	Generate driver dump start of file information. More...
void	ocs_ddump_endfile (ocs_textbuf_t *textbuf)
	Generate driver dump end of file information. More...
void	ocs_ddump_section (ocs_textbuf_t *textbuf, const char *name, uint32_t instance)
	Generate driver dump section start data. More...
void	ocs_ddump_endsection (ocs_textbuf_t *textbuf, const char *name, uint32_t instance)
	Generate driver dump section end data. More...
void	ocs_ddump_value (ocs_textbuf_t *textbuf, const char *name, const char *fmt,...)
	Generate driver dump data for a given value. More...
void	ocs_ddump_buffer (ocs_textbuf_t *textbuf, const char *name, uint32_t instance, void *buffer, uint32_t size)
	Generate driver dump data for an arbitrary buffer of DWORDS. More...
void	ocs_ddump_queue_entries (ocs_textbuf_t *textbuf, void *q_addr, uint32_t size, uint32_t length, int32_t index, uint32_t qentries)
	Generate driver dump for queue. More...

Macro Details

#define OCS_NEWLINE_MOD   8

#define OCS_NEWLINE_MOD   8

Function Details

void ocs_ddump_buffer	(	ocs_textbuf_t *	textbuf,
		const char *	name,
		uint32_t	instance,
		void *	buffer,
		uint32_t	size
	)

Generate driver dump data for an arbitrary buffer of DWORDS.

A status value is added to textbuf

Parameters

textbuf	pointer to text buffer
name	name of status variable
instance	instance number of this section
buffer	buffer to print
size	size of buffer in bytes

Returns

none

Definition at line 154 of file ocs_ddumplib.c.

void ocs_ddump_endfile

(

ocs_textbuf_t *

textbuf

)

Generate driver dump end of file information.

The end of file information is added to 'textbuf'

Parameters

textbuf

pointer to driver dump text buffer

Returns

none

Definition at line 73 of file ocs_ddumplib.c.

void ocs_ddump_endsection	(	ocs_textbuf_t *	textbuf,
		const char *	name,
		uint32_t	instance
	)

Generate driver dump section end data.

The driver section end information is added to textbuf

Parameters

textbuf	pointer to text buffer
name	name of section
instance	instance number of this section

Returns

none

Definition at line 108 of file ocs_ddumplib.c.

void ocs_ddump_queue_entries	(	ocs_textbuf_t *	textbuf,
		void *	q_addr,
		uint32_t	size,
		uint32_t	length,
		int32_t	index,
		uint32_t	qentries
	)

Generate driver dump for queue.

Add queue elements to text buffer

Parameters

textbuf	pointer to driver dump text buffer
q_addr	address of start of queue
size	size of each queue entry
length	number of queue entries in the queue
index	current index of queue
qentries	number of most recent queue entries to dump

Returns

none

Definition at line 196 of file ocs_ddumplib.c.

void ocs_ddump_section	(	ocs_textbuf_t *	textbuf,
		const char *	name,
		uint32_t	instance
	)

Generate driver dump section start data.

The driver section start information is added to textbuf

Parameters

textbuf	pointer to text buffer
name	name of section
instance	instance number of this section

Returns

none

Definition at line 90 of file ocs_ddumplib.c.

void ocs_ddump_startfile

(

ocs_textbuf_t *

textbuf

)

Generate driver dump start of file information.

The start of file information is added to 'textbuf'

Parameters

textbuf

pointer to driver dump text buffer

Returns

none

Definition at line 53 of file ocs_ddumplib.c.

void ocs_ddump_value	(	ocs_textbuf_t *	textbuf,
		const char *	name,
		const char *	fmt,
			...
	)

Generate driver dump data for a given value.

A value is added to textbuf

Parameters

textbuf	pointer to text buffer
name	name of variable
fmt	snprintf format specifier

Returns

none

Definition at line 126 of file ocs_ddumplib.c.