neorv32_tracebuf.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 - 2026 Stephan Nolting. All rights reserved.                  //
// Licensed under the BSD-3-Clause license, see LICENSE for details.                //
// SPDX-License-Identifier: BSD-3-Clause                                            //
// ================================================================================ //
 
#ifndef NEORV32_TRACEBUF_H
#define NEORV32_TRACEBUF_H
 
#include <neorv32.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_tracebuf_t;
 
#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  
};
/**********************************************************************/
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);
/**********************************************************************/
static inline void __attribute__ ((always_inline)) neorv32_tracebuf_start(void) {
  __MMREG32_BSET(NEORV32_TRACEBUF->CTRL, 1U << TRACEBUF_CTRL_START);
}
 
/**********************************************************************/
static inline void __attribute__ ((always_inline)) neorv32_tracebuf_stop(void) {
  __MMREG32_BSET(NEORV32_TRACEBUF->CTRL, 1U << TRACEBUF_CTRL_STOP);
}
 
#endif // NEORV32_TRACEBUF_H