neorv32_sysinfo.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_SYSINFO_H
#define NEORV32_SYSINFO_H
 
#include <neorv32.h>
#include <stdint.h>
 
/**********************************************************************/
typedef volatile struct __attribute__((packed,aligned(4))) {
        uint32_t CLK;   
  const uint32_t MISC;  
  const uint32_t SOC;   
  const uint32_t CACHE; 
} neorv32_sysinfo_t;
 
#define NEORV32_SYSINFO ((neorv32_sysinfo_t*) (NEORV32_SYSINFO_BASE))
 
enum NEORV32_SYSINFO_MISC_enum {
  SYSINFO_MISC_IMEM_LSB =  0, 
  SYSINFO_MISC_IMEM_MBS =  7, 
  SYSINFO_MISC_DMEM_LSB =  8, 
  SYSINFO_MISC_DMEM_MSB = 15, 
  SYSINFO_MISC_HART_LSB = 16, 
  SYSINFO_MISC_HART_MSB = 19, 
  SYSINFO_MISC_BOOT_LSB = 20, 
  SYSINFO_MISC_BOOT_MSB = 21, 
  SYSINFO_MISC_ITMO_LSB = 22, 
  SYSINFO_MISC_ITMO_MSB = 26, 
  SYSINFO_MISC_ETMO_LSB = 27, 
  SYSINFO_MISC_ETMO_MSB = 31  
};
 
enum NEORV32_SYSINFO_SOC_enum {
  SYSINFO_SOC_BOOTLOADER =  0, 
  SYSINFO_SOC_XBUS       =  1, 
  SYSINFO_SOC_IMEM       =  2, 
  SYSINFO_SOC_DMEM       =  3, 
  SYSINFO_SOC_OCD        =  4, 
  SYSINFO_SOC_ICACHE     =  5, 
  SYSINFO_SOC_DCACHE     =  6, 
//SYSINFO_SOC_reserved   =  7, /**< SYSINFO_SOC  (7) (r/-): reserved */
//SYSINFO_SOC_reserved   =  8, /**< SYSINFO_SOC  (8) (r/-): reserved */
//SYSINFO_SOC_reserved   =  9, /**< SYSINFO_SOC  (9) (r/-): reserved */
//SYSINFO_SOC_reserved   = 10, /**< SYSINFO_SOC (10) (r/-): reserved */
  SYSINFO_SOC_OCD_AUTH   = 11, 
  SYSINFO_SOC_IMEM_ROM   = 12, 
  SYSINFO_SOC_IO_TWD     = 13, 
  SYSINFO_SOC_IO_DMA     = 14, 
  SYSINFO_SOC_IO_GPIO    = 15, 
  SYSINFO_SOC_IO_CLINT   = 16, 
  SYSINFO_SOC_IO_UART0   = 17, 
  SYSINFO_SOC_IO_SPI     = 18, 
  SYSINFO_SOC_IO_TWI     = 19, 
  SYSINFO_SOC_IO_PWM     = 20, 
  SYSINFO_SOC_IO_WDT     = 21, 
  SYSINFO_SOC_IO_CFS     = 22, 
  SYSINFO_SOC_IO_TRNG    = 23, 
  SYSINFO_SOC_IO_SDI     = 24, 
  SYSINFO_SOC_IO_UART1   = 25, 
  SYSINFO_SOC_IO_NEOLED  = 26, 
  SYSINFO_SOC_IO_TRACER  = 27, 
  SYSINFO_SOC_IO_GPTMR   = 28, 
  SYSINFO_SOC_IO_SLINK   = 29, 
  SYSINFO_SOC_IO_ONEWIRE = 30, 
  SYSINFO_SOC_SIM        = 31  
};
 
 enum NEORV32_SYSINFO_CACHE_enum {
  SYSINFO_CACHE_BLOCK_SIZE_0   =  0, 
  SYSINFO_CACHE_BLOCK_SIZE_3   =  3, 
  SYSINFO_CACHE_I_NUM_BLOCKS_0 =  4, 
  SYSINFO_CACHE_I_NUM_BLOCKS_3 =  7, 
  SYSINFO_CACHE_D_NUM_BLOCKS_0 =  8, 
  SYSINFO_CACHE_D_NUM_BLOCKS_3 = 11, 
  SYSINFO_CACHE_UC_BEGIN_0     = 12, 
  SYSINFO_CACHE_UC_BEGIN_3     = 15, 
  SYSINFO_CACHE_BURSTS_EN      = 16  
};
/**********************************************************************/
inline uint32_t __attribute__ ((always_inline)) neorv32_sysinfo_is_sim(void) {
  return (uint32_t)(NEORV32_SYSINFO->SOC >> SYSINFO_SOC_SIM);
}
 
/**********************************************************************/
inline uint32_t __attribute__ ((always_inline)) neorv32_sysinfo_get_numcores(void) {
  return (uint32_t)((NEORV32_SYSINFO->MISC >> SYSINFO_MISC_HART_LSB) & 0x0fu);
}
 
/**********************************************************************/
inline uint32_t __attribute__ ((always_inline)) neorv32_sysinfo_get_imemsize(void) {
  uint32_t tmp = (NEORV32_SYSINFO->MISC >> SYSINFO_MISC_IMEM_LSB) & 0xffu;
  if (tmp) {
    return (uint32_t)(1u << tmp);
  }
  return 0;
}
 
/**********************************************************************/
inline uint32_t __attribute__ ((always_inline)) neorv32_sysinfo_get_dmemsize(void) {
  uint32_t tmp = (NEORV32_SYSINFO->MISC >> SYSINFO_MISC_DMEM_LSB) & 0xffu;
  if (tmp) {
    return (uint32_t)(1u << tmp);
  }
  return 0;
}
 
/**********************************************************************/
inline uint32_t __attribute__ ((always_inline)) neorv32_sysinfo_get_bootmode(void) {
  return (uint32_t)((NEORV32_SYSINFO->MISC >> SYSINFO_MISC_BOOT_LSB) & 0x03u);
}
 
/**********************************************************************/
inline uint32_t __attribute__ ((always_inline)) neorv32_sysinfo_get_intbustimeout(void) {
  uint32_t tmp = (NEORV32_SYSINFO->MISC >> SYSINFO_MISC_ITMO_LSB) & 0x1fu;
  if (tmp) {
    return (uint32_t)(1u << tmp);
  }
  return 0;
}
 
/**********************************************************************/
inline uint32_t __attribute__ ((always_inline)) neorv32_sysinfo_get_extbustimeout(void) {
  uint32_t tmp = (NEORV32_SYSINFO->MISC >> SYSINFO_MISC_ETMO_LSB) & 0x1fu;
  if (tmp) {
    return (uint32_t)(1u << tmp);
  }
  return 0;
}
 
/**********************************************************************/
inline uint32_t __attribute__ ((always_inline)) neorv32_sysinfo_get_clk(void) {
  return NEORV32_SYSINFO->CLK;
}
 
/**********************************************************************/
inline void __attribute__ ((always_inline)) neorv32_sysinfo_set_clk(uint32_t clock) {
  NEORV32_SYSINFO->CLK = clock;
}
 
#endif // NEORV32_SYSINFO_H