Real-time Trace APIs

Detailed Description

APIs for real-time event trace operations on the target.

Functions
void	tivxLogRtTraceKernelInstanceExeStart (tivx_target_kernel_instance kernel, uint16_t event_index)
	Log trace on target kernel instance execute start. More...
void	tivxLogRtTraceKernelInstanceExeEnd (tivx_target_kernel_instance kernel, uint16_t event_index)
	Log trace on target kernel instance execute end. More...
void	tivxLogRtTraceKernelInstanceExeStartTimestamp (tivx_target_kernel_instance kernel, uint16_t event_index, uint64_t timestamp)
	Log trace on target kernel instance execute start with timestamp given externally. More...
void	tivxLogRtTraceKernelInstanceExeEndTimestamp (tivx_target_kernel_instance kernel, uint16_t event_index, uint64_t timestamp)
	Log trace on target kernel instance execute end with timestamp given externally. More...

Function Documentation

tivxLogRtTraceKernelInstanceExeStart()

void tivxLogRtTraceKernelInstanceExeStart	(	tivx_target_kernel_instance	kernel,
		uint16_t	event_index
	)

Log trace on target kernel instance execute start.

• This API is intended to be called from within a target-side callback of a user kernel (process callback, for example).

Parameters

[in]	kernel	The target kernel instance object from the argument list of the target side callback
[in]	event_index	Event index to trigger the start trace for

tivxLogRtTraceKernelInstanceExeEnd()

void tivxLogRtTraceKernelInstanceExeEnd	(	tivx_target_kernel_instance	kernel,
		uint16_t	event_index
	)

Log trace on target kernel instance execute end.

• This API is intended to be called from within a target-side callback of a user kernel (process callback, for example).

Parameters

[in]	kernel	The target kernel instance object from the argument list of the target side callback
[in]	event_index	Event index to trigger the end trace for

tivxLogRtTraceKernelInstanceExeStartTimestamp()

void tivxLogRtTraceKernelInstanceExeStartTimestamp	(	tivx_target_kernel_instance	kernel,
		uint16_t	event_index,
		uint64_t	timestamp
	)

Log trace on target kernel instance execute start with timestamp given externally.

• This API is intended to be called from within a target-side callback of a user kernel (process callback, for example).
• This was added to accommodate timestamps obtained from within an interrupt context. The trace API can not be called from within an interrupt context due to locks, so instead, a timestamp can be obtained from within the interrupt ISR, and later assigned to the logger via this API.

Parameters

[in]	kernel	The target kernel instance object from the argument list of the target side callback
[in]	event_index	Event index to trigger the end trace for
[in]	timestamp	Timestamp to assign to the event

tivxLogRtTraceKernelInstanceExeEndTimestamp()

void tivxLogRtTraceKernelInstanceExeEndTimestamp	(	tivx_target_kernel_instance	kernel,
		uint16_t	event_index,
		uint64_t	timestamp
	)

Log trace on target kernel instance execute end with timestamp given externally.

• This API is intended to be called from within a target-side callback of a user kernel (process callback, for example).
• This was added to accommodate timestamps obtained from within an interrupt context. The trace API can not be called from within an interrupt context due to locks, so instead, a timestamp can be obtained from within the interrupt ISR, and later assigned to the logger via this API.

Parameters

[in]	kernel	The target kernel instance object from the argument list of the target side callback
[in]	event_index	Event index to trigger the end trace for
[in]	timestamp	Timestamp to assign to the event