Execution trace buffer (TRACEBUF) HW driver header file. More...

#include <neorv32.h>
#include <stdint.h>

Data Structures
struct	neorv32_tracebuf_t

Functions
static void	neorv32_tracebuf_start (void)

static void	neorv32_tracebuf_stop (void)

Prototypes
int	neorv32_tracebuf_available (void)

void	neorv32_tracebuf_enable (int hsel, uint32_t stop_addr)

void	neorv32_tracebuf_disable (void)

int	neorv32_tracebuf_get_buffer_depth (void)

int	neorv32_tracebuf_run (void)

void	neorv32_tracebuf_irq_ack (void)

int	neorv32_tracebuf_data_avail (void)

uint32_t	neorv32_tracebuf_data_get_src (void)

uint32_t	neorv32_tracebuf_data_get_dst (void)

IO Device: Execution trace buffer (TRACEBUF)
#define	NEORV32_TRACEBUF ((neorv32_tracebuf_t*) (NEORV32_TRACEBUF_BASE))

enum	NEORV32_TRACEBUF_CTRL_enum { TRACEBUF_CTRL_EN = 0 , TRACEBUF_CTRL_HSEL = 1 , TRACEBUF_CTRL_START = 2 , TRACEBUF_CTRL_STOP = 3 , TRACEBUF_CTRL_RUN = 4 , TRACEBUF_CTRL_AVAIL = 5 , TRACEBUF_CTRL_IRQ_CLR = 6 , TRACEBUF_CTRL_TBM_LSB = 7 , TRACEBUF_CTRL_TBM_MSB = 10 }

Detailed Description

Execution trace buffer (TRACEBUF) HW driver header file.

Macro Definition Documentation

◆ NEORV32_TRACEBUF

#define NEORV32_TRACEBUF ((neorv32_tracebuf_t*) (NEORV32_TRACEBUF_BASE))

TRACEBUF module hardware handle (#neorv32_tracer_t)

Enumeration Type Documentation

◆ NEORV32_TRACEBUF_CTRL_enum

enum NEORV32_TRACEBUF_CTRL_enum

TRACEBUF control register bits

Enumerator
TRACEBUF_CTRL_EN	TRACEBUF control register (0) (r/w): TRACEBUF enable, reset module when 0
TRACEBUF_CTRL_HSEL	TRACEBUF control register (1) (r/w): Hart select for tracing
TRACEBUF_CTRL_START	TRACEBUF control register (2) (r/w): Start tracing, flag always reads as zero
TRACEBUF_CTRL_STOP	TRACEBUF control register (3) (r/w): Manually stop tracing, flag always reads as zero
TRACEBUF_CTRL_RUN	TRACEBUF control register (4) (r/-): Tracing in progress when set
TRACEBUF_CTRL_AVAIL	TRACEBUF control register (5) (r/-): Trace data available when set
TRACEBUF_CTRL_IRQ_CLR	TRACEBUF control register (6) (r/w): Clear pending interrupt when writing 1
TRACEBUF_CTRL_TBM_LSB	TRACEBUF control register (7) (r/-): log2(trace buffer depth), LSB
TRACEBUF_CTRL_TBM_MSB	TRACEBUF control register(10) (r/-): log2(trace buffer depth), MSB

Function Documentation

◆ neorv32_tracebuf_available()

int neorv32_tracebuf_available ( void )

Check if TRACEBUF module was synthesized.

Returns: 0 if TRACER was not synthesized, non-zero if TRACER is available.

◆ neorv32_tracebuf_data_avail()

int neorv32_tracebuf_data_avail ( void )

Check if trace buffer data is available.

Returns: Non-zero if trace data available, zero if no trace data available.

◆ neorv32_tracebuf_data_get_dst()

uint32_t neorv32_tracebuf_data_get_dst ( void )

Get trace data: delta-destination. @important Use AFTER #neorv32_tracer_data_get_src().

Returns: 32-bit delta-destination address + trap-entry flag (in LSB).

◆ neorv32_tracebuf_data_get_src()

uint32_t neorv32_tracebuf_data_get_src ( void )

Get trace data: delta-source. @important Check if data is available before with #neorv32_tracer_data_avail().

Returns: 32-bit delta-source address + first-packet flag (in LSB).

◆ neorv32_tracebuf_disable()

void neorv32_tracebuf_disable ( void )

Reset and disable trace buffer.

◆ neorv32_tracebuf_enable()

void neorv32_tracebuf_enable	(	int	hsel,
		uint32_t	stop_addr
	)

Reset, enable and configure trace buffer.

Parameters

[in]	hsel	Hart ID of the CPU that is traced (0/1).
[in]	stop_addr	Stop tracing at this address. Use -1 to disable auto-stopping.

◆ neorv32_tracebuf_get_buffer_depth()

int neorv32_tracebuf_get_buffer_depth ( void )

Get trace buffer depth.

Returns: Trace buffer depth (number of entries)

◆ neorv32_tracebuf_irq_ack()

void neorv32_tracebuf_irq_ack ( void )

Acknowledge/clear pending trace buffer interrupt.

◆ neorv32_tracebuf_run()

int neorv32_tracebuf_run ( void )

Check if trace buffer is running.

Returns: Non-zero if tracing in progress, zero if tracing is stopped/halted.

◆ neorv32_tracebuf_start()

static void neorv32_tracebuf_start ( void )

inlinestatic

Start trace logging.

◆ neorv32_tracebuf_stop()

static void neorv32_tracebuf_stop ( void )