Debug APIs

Detailed Description

APIs for debug operations on the host.

Defines
#define	VX_PRINT(zone, message, ...)   do { tivx_print_global(((vx_enum)zone), "[%s:%u] " message, __FUNCTION__, __LINE__, ## __VA_ARGS__); } while (1 == 0)
	Utility macro to print debug information if specified zone is globally set.
#define	VX_PRINT_GRAPH(zone, graph, message, ...)   do { tivx_print_object(((vx_enum)zone), tivxGetGraphDebugZonemask(graph), "[ %s ] " message, tivxGetGraphName(graph), ## __VA_ARGS__); } while (1 == 0)
	Utility macro to print debug information if specified zone is set on a given graph object.
#define	VX_PRINT_NODE(zone, node, message, ...)   do { tivx_print_object(((vx_enum)zone), tivxGetNodeDebugZonemask(node), "[ %s ] " message, tivxGetNodeName(node), ## __VA_ARGS__); } while (1 == 0)
	Utility macro to print debug information if specified zone is set on a given node object.
#define	VX_PRINT_KERNEL(zone, kernel, message, ...)   do { tivx_print_object(((vx_enum)zone), tivxGetTargetKernelInstanceDebugZonemask(kernel), "[%s:%u] " message, __FUNCTION__, __LINE__, ## __VA_ARGS__); } while (1 == 0)
	Utility macro to print debug information if specified zone is set on a given target kernel instance.

Enumerations
enum	tivx_debug_zone_e {   VX_ZONE_ERROR = 0,   VX_ZONE_WARNING = 1,   VX_ZONE_INFO = 2,   VX_ZONE_MAX = 3 }
	These are the bit flags for debugging. More...

Functions
vx_uint32	ownGetGlobalZonemask (void)
	Internal function - returns the global debug zone bitmask.
vx_char *	tivx_find_zone_name (vx_enum zone)
	Returns the name of an enumerated debug zone. More...
void	tivx_print_global (vx_enum zone, const char *format,...)
	Internal printing function for the global debug zone bitmask. More...
void	tivx_print_object (vx_enum zone, vx_uint32 debug_zonemask, const char *format,...)
	Internal printing function for a framework object with a set debug zone bitmask. More...
void	tivx_set_debug_zone (vx_enum zone)
	Sets a zone bit in the debug mask. More...
void	tivx_clr_debug_zone (vx_enum zone)
	Clears the zone bit in the mask. More...
vx_bool	tivx_is_zone_enabled (vx_enum zone)
	Returns true or false if the zone bit is set or cleared. More...
vx_uint32	tivxGetNodeDebugZonemask (vx_node node)
	Returns the debug zonemask value of a node. More...
vx_uint32	tivxGetGraphDebugZonemask (vx_graph graph)
	Returns the debug zonemask value of a graph. More...
vx_status	tivxSetGraphDebugZone (vx_graph graph, vx_uint32 debug_zone, vx_bool enable)
	Sets or clears a given debug zone for a graph. More...
vx_status	tivxSetNodeDebugZone (vx_node node, vx_uint32 debug_zone, vx_bool enable)
	Sets or clears a given debug zone for a node. More...
const char *	tivxGetNodeName (vx_node node)
	Returns the name of a node object. More...
const char *	tivxGetGraphName (vx_graph graph)
	Returns the name of a graph object. More...

Enumeration Type Documentation

tivx_debug_zone_e

enum tivx_debug_zone_e

These are the bit flags for debugging.

Enumerator
VX_ZONE_ERROR	Used for error prints
VX_ZONE_WARNING	Used for prints that report possible issues
VX_ZONE_INFO	Used for debug processing/tracking prints
VX_ZONE_MAX	Used to indicate the upper bound of zone enumerations

Definition at line 87 of file include/TI/tivx_debug.h.

Function Documentation

tivx_find_zone_name()

vx_char* tivx_find_zone_name

(

vx_enum

zone

)

Returns the name of an enumerated debug zone.

Parameters

[in]

zone

The debug zone from tivx_debug_zone_e.

tivx_print_global()

void tivx_print_global	(	vx_enum	zone,
		const char *	format,
			...
	)

Internal printing function for the global debug zone bitmask.

Parameters

[in]	zone	The debug zone from tivx_debug_zone_e required to print the given message.
[in]	format	The format string to print.
[in]	...	The variable list of arguments.

tivx_print_object()

void tivx_print_object	(	vx_enum	zone,
		vx_uint32	debug_zonemask,
		const char *	format,
			...
	)

Internal printing function for a framework object with a set debug zone bitmask.

Parameters

[in]	zone	The debug zone from tivx_debug_zone_e required to print the given message.
[in]	debug_zonemask	The debug zone bitmask of a framework object
[in]	format	The format string to print.
[in]	...	The variable list of arguments.

tivx_set_debug_zone()

void tivx_set_debug_zone

(

vx_enum

zone

)

Sets a zone bit in the debug mask.

Parameters

[in]

zone

The debug zone from tivx_debug_zone_e.

tivx_clr_debug_zone()

void tivx_clr_debug_zone

(

vx_enum

zone

)

Clears the zone bit in the mask.

Parameters

[in]

zone

The debug zone from tivx_debug_zone_e.

tivx_is_zone_enabled()

vx_bool tivx_is_zone_enabled

(

vx_enum

zone

)

Returns true or false if the zone bit is set or cleared.

Parameters

[in]

zone

The debug zone from tivx_debug_zone_e.

tivxGetNodeDebugZonemask()

vx_uint32 tivxGetNodeDebugZonemask

(

vx_node

node

)

Returns the debug zonemask value of a node.

Parameters

[in]

node

A given vx_node object.

tivxGetGraphDebugZonemask()

vx_uint32 tivxGetGraphDebugZonemask

(

vx_graph

graph

)

Returns the debug zonemask value of a graph.

Parameters

[in]

graph

A given vx_graph object.

tivxSetGraphDebugZone()

vx_status tivxSetGraphDebugZone	(	vx_graph	graph,
		vx_uint32	debug_zone,
		vx_bool	enable
	)

Sets or clears a given debug zone for a graph.

Parameters

[in]	graph	Graph reference
[in]	debug_zone	Given debug zone enumeration
[in]	enable	Flag to indicate if zone should be enabled or disabled

tivxSetNodeDebugZone()

vx_status tivxSetNodeDebugZone	(	vx_node	node,
		vx_uint32	debug_zone,
		vx_bool	enable
	)

Sets or clears a given debug zone for a node.

Parameters

[in]	node	Node reference
[in]	debug_zone	Given debug zone enumeration
[in]	enable	Flag to indicate if zone should be enabled or disabled

tivxGetNodeName()

const char* tivxGetNodeName

(

vx_node

node

)

Returns the name of a node object.

Parameters

[in]

node

A given vx_node object.

tivxGetGraphName()

const char* tivxGetGraphName

(

vx_graph

graph

)

Returns the name of a graph object.

Parameters

[in]

graph

A given vx_graph object.