neorv32_tracer.h

Go to the documentation of this file.

// ================================================================================ //
// The NEORV32 RISC-V Processor - https://github.com/stnolting/neorv32              //
// Copyright (c) NEORV32 contributors.                                              //
// Copyright (c) 2020 - 2025 Stephan Nolting. All rights reserved.                  //
// Licensed under the BSD-3-Clause license, see LICENSE for details.                //
// SPDX-License-Identifier: BSD-3-Clause                                            //
// ================================================================================ //

 
#ifndef NEORV32_TRACER_H
#define NEORV32_TRACER_H
 
#include <stdint.h>
 
 
/**********************************************************************/
typedef volatile struct __attribute__((packed,aligned(4))) {
  uint32_t       CTRL;      
  uint32_t       STOP_ADDR; 
  const uint32_t DELTA_SRC; 
  const uint32_t DELTA_DST; 
} neorv32_tracer_t;

#define NEORV32_TRACER ((neorv32_tracer_t*) (NEORV32_TRACER_BASE))

enum NEORV32_TRACER_CTRL_enum {
  TRACER_CTRL_EN      =  0, 
  TRACER_CTRL_HSEL    =  1, 
  TRACER_CTRL_START   =  2, 
  TRACER_CTRL_STOP    =  3, 
  TRACER_CTRL_RUN     =  4, 
  TRACER_CTRL_AVAIL   =  5, 
  TRACER_CTRL_IRQ_CLR =  6, 
  TRACER_CTRL_TBM_LSB =  7, 
  TRACER_CTRL_TBM_MSB = 10  
};

 
 
/**********************************************************************/
int      neorv32_tracer_available(void);
void     neorv32_tracer_enable(int hsel, uint32_t stop_addr);
void     neorv32_tracer_disable(void);
int      neorv32_tracer_get_buffer_depth(void);
int      neorv32_tracer_run(void);
void     neorv32_tracer_irq_ack(void);
int      neorv32_tracer_data_avail(void);
uint32_t neorv32_tracer_data_get_src(void);
uint32_t neorv32_tracer_data_get_dst(void);
 
 
/**********************************************************************/
inline void __attribute__ ((always_inline)) neorv32_tracer_start(void) {
  NEORV32_TRACER->CTRL |= (1 << TRACER_CTRL_START);
}
 
/**********************************************************************/
inline void __attribute__ ((always_inline)) neorv32_tracer_stop(void) {
  NEORV32_TRACER->CTRL |= (1 << TRACER_CTRL_STOP);
}
 
#endif // NEORV32_TRACER_H