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 - 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_sysinfo_h
#define neorv32_sysinfo_h
 
#include <stdint.h>
 
/**********************************************************************/
typedef volatile struct __attribute__((packed,aligned(4))) {
        uint32_t CLK;     
  const uint8_t  MISC[4]; 
  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 = 0, 
  SYSINFO_MISC_DMEM = 1, 
  SYSINFO_MISC_HART = 2, 
  SYSINFO_MISC_BOOT = 3  
};

enum NEORV32_SYSINFO_SOC_enum {
  SYSINFO_SOC_BOOTLOADER   =  0, 
  SYSINFO_SOC_XBUS         =  1, 
  SYSINFO_SOC_MEM_INT_IMEM =  2, 
  SYSINFO_SOC_MEM_INT_DMEM =  3, 
  SYSINFO_SOC_OCD          =  4, 
  SYSINFO_SOC_ICACHE       =  5, 
  SYSINFO_SOC_DCACHE       =  6, 
 
  SYSINFO_SOC_XBUS_CACHE   =  8, 
  SYSINFO_SOC_XIP          =  9, 
  SYSINFO_SOC_XIP_CACHE    = 10, 
  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_GPTMR     = 28, 
  SYSINFO_SOC_IO_SLINK     = 29, 
  SYSINFO_SOC_IO_ONEWIRE   = 30, 
  SYSINFO_SOC_IO_CRC       = 31  
};

 enum NEORV32_SYSINFO_CACHE_enum {
  SYSINFO_CACHE_INST_BLOCK_SIZE_0 =  0, 
  SYSINFO_CACHE_INST_BLOCK_SIZE_3 =  3, 
  SYSINFO_CACHE_INST_NUM_BLOCKS_0 =  4, 
  SYSINFO_CACHE_INST_NUM_BLOCKS_3 =  7, 
 
  SYSINFO_CACHE_DATA_BLOCK_SIZE_0 =  8, 
  SYSINFO_CACHE_DATA_BLOCK_SIZE_3 = 11, 
  SYSINFO_CACHE_DATA_NUM_BLOCKS_0 = 12, 
  SYSINFO_CACHE_DATA_NUM_BLOCKS_3 = 15, 
 
  SYSINFO_CACHE_XIP_BLOCK_SIZE_0  = 16, 
  SYSINFO_CACHE_XIP_BLOCK_SIZE_3  = 19, 
  SYSINFO_CACHE_XIP_NUM_BLOCKS_0  = 20, 
  SYSINFO_CACHE_XIP_NUM_BLOCKS_3  = 23, 
 
  SYSINFO_CACHE_XBUS_BLOCK_SIZE_0 = 24, 
  SYSINFO_CACHE_XBUS_BLOCK_SIZE_3 = 27, 
  SYSINFO_CACHE_XBUS_NUM_BLOCKS_0 = 28, 
  SYSINFO_CACHE_XBUS_NUM_BLOCKS_3 = 31  
};

 
/**********************************************************************/
inline uint32_t __attribute__ ((always_inline)) neorv32_sysinfo_get_numcores(void) {
  return (uint32_t)(NEORV32_SYSINFO->MISC[SYSINFO_MISC_HART]);
}
 
/**********************************************************************/
inline uint32_t __attribute__ ((always_inline)) neorv32_sysinfo_get_imemsize(void) {
  return (uint32_t)(1 << NEORV32_SYSINFO->MISC[SYSINFO_MISC_IMEM]);
}
 
/**********************************************************************/
inline uint32_t __attribute__ ((always_inline)) neorv32_sysinfo_get_dmemsize(void) {
  return (uint32_t)(1 << NEORV32_SYSINFO->MISC[SYSINFO_MISC_DMEM]);
}
 
/**********************************************************************/
inline uint32_t __attribute__ ((always_inline)) neorv32_sysinfo_get_bootmode(void) {
  return (uint32_t)(NEORV32_SYSINFO->MISC[SYSINFO_MISC_BOOT]);
}
 
/**********************************************************************/
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