ocs_ddump.h File Reference

#include "ocs_textbuf.h"

Go to the source code of this file.

Macros
#define	OCS_DDUMP_FLAGS_WQES   (1U << 0)
#define	OCS_DDUMP_FLAGS_CQES   (1U << 1)
#define	OCS_DDUMP_FLAGS_MQES   (1U << 2)
#define	OCS_DDUMP_FLAGS_RQES   (1U << 3)
#define	OCS_DDUMP_FLAGS_EQES   (1U << 4)
#define	OCS_DDUMP_FLAGS_DEFAULT

Functions
int	ocs_ddump (ocs_t *ocs, ocs_textbuf_t *textbuf, uint32_t flags, uint32_t qentries)
	Initiate ddump. More...
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...
	__attribute__ ((format(printf, 3, 4))) extern void ocs_ddump_value(ocs_textbuf_t *textbuf
const char const char 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...
int32_t	ocs_save_ddump (ocs_t *ocs, uint32_t flags, uint32_t qentries)
	Capture and save ddump. More...
int32_t	ocs_get_saved_ddump (ocs_t *ocs, ocs_textbuf_t *textbuf)
int32_t	ocs_save_ddump_all (uint32_t flags, uint32_t qentries, uint32_t alloc_flag)
	Capture and save ddump for all OCS instances. More...
int32_t	ocs_adapter_ddump_clear_and_save (ocs_t *ocs, uint8_t bus, uint8_t dev, uint32_t flags, uint32_t qentries, uint32_t alloc_flag)
	Clear the previously saved ddump, and collect the ddump for all OCS instances of the adapter. More...
int32_t	ocs_clear_saved_ddump (ocs_t *ocs)
	Clear saved ddump. 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...

Variables
const char *	name
const char const char *	fmt

Macro Details

#define OCS_DDUMP_FLAGS_CQES   (1U << 1)

Definition at line 39 of file ocs_ddump.h.

#define OCS_DDUMP_FLAGS_DEFAULT

Value:

(OCS_DDUMP_FLAGS_WQES | OCS_DDUMP_FLAGS_CQES | \
				 OCS_DDUMP_FLAGS_MQES | OCS_DDUMP_FLAGS_RQES | \
				 OCS_DDUMP_FLAGS_EQES)

Definition at line 43 of file ocs_ddump.h.

#define OCS_DDUMP_FLAGS_EQES   (1U << 4)

Definition at line 42 of file ocs_ddump.h.

#define OCS_DDUMP_FLAGS_MQES   (1U << 2)

Definition at line 40 of file ocs_ddump.h.

#define OCS_DDUMP_FLAGS_RQES   (1U << 3)

Definition at line 41 of file ocs_ddump.h.

#define OCS_DDUMP_FLAGS_WQES   (1U << 0)

Definition at line 38 of file ocs_ddump.h.

Function Details

__attribute__

(

(format(printf, 3, 4))

)

int32_t ocs_adapter_ddump_clear_and_save	(	ocs_t *	ocs,
		uint8_t	bus,
		uint8_t	dev,
		uint32_t	flags,
		uint32_t	qentries,
		uint32_t	alloc_flag
	)

Clear the previously saved ddump, and collect the ddump for all OCS instances of the adapter.

Definition at line 881 of file ocs_ddump.c.

int32_t ocs_clear_saved_ddump

(

ocs_t *

ocs

)

Clear saved ddump.

Clears saved ddump to make room for next one.

Parameters

ocs	pointer to device context

Returns

0 if ddump was cleared; > 0 no saved ddump found

Definition at line 937 of file ocs_ddump.c.

int ocs_ddump	(	ocs_t *	ocs,
		ocs_textbuf_t *	textbuf,
		uint32_t	flags,
		uint32_t	qentries
	)

Initiate ddump.

Traverses the ocs/domain/port/node/io data structures to generate a driver dump.

Parameters

ocs	pointer to device context
textbuf	pointer to text buffer
flags	ddump flags
qentries	number of queue entries to dump

Returns

Returns 0 on success, or a negative value on failure.

Definition at line 656 of file ocs_ddump.c.

const char const char 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.

int32_t ocs_get_saved_ddump	(	ocs_t *	ocs,
		ocs_textbuf_t *	textbuf
	)

int32_t ocs_save_ddump	(	ocs_t *	ocs,
		uint32_t	flags,
		uint32_t	qentries
	)

Capture and save ddump.

Captures and saves a ddump to the ocs_t structure to save the current state. The goal of this function is to save a ddump as soon as an issue is encountered. The saved ddump will be kept until the user reads it.

Parameters

ocs	pointer to device context
flags	ddump flags
qentries	number of queue entries to dump

Returns

0 if ddump was saved; > 0 of one already exists; < 0 error

Definition at line 820 of file ocs_ddump.c.

int32_t ocs_save_ddump_all	(	uint32_t	flags,
		uint32_t	qentries,
		uint32_t	alloc_flag
	)

Capture and save ddump for all OCS instances.

Calls ocs_save_ddump() for each OCS instance.

Parameters

flags	ddump flags
qentries	number of queue entries to dump
alloc_flag	allocate dump buffer if not already allocated

Returns

0 if ddump was saved; > 0 of one already exists; < 0 error

Definition at line 852 of file ocs_ddump.c.

Variable Details

const char const char * fmt

Definition at line 54 of file ocs_ddump.h.

const char* name

Definition at line 54 of file ocs_ddump.h.