neorv32.h

Go to the documentation of this file.

// #################################################################################################
// # << NEORV32: neorv32.h - Main Core Library / HAL Include File >>                               #
// # ********************************************************************************************* #
// # BSD 3-Clause License                                                                          #
// #                                                                                               #
// # Copyright (c) 2024, Stephan Nolting. All rights reserved.                                     #
// #                                                                                               #
// # Redistribution and use in source and binary forms, with or without modification, are          #
// # permitted provided that the following conditions are met:                                     #
// #                                                                                               #
// # 1. Redistributions of source code must retain the above copyright notice, this list of        #
// #    conditions and the following disclaimer.                                                   #
// #                                                                                               #
// # 2. Redistributions in binary form must reproduce the above copyright notice, this list of     #
// #    conditions and the following disclaimer in the documentation and/or other materials        #
// #    provided with the distribution.                                                            #
// #                                                                                               #
// # 3. Neither the name of the copyright holder nor the names of its contributors may be used to  #
// #    endorse or promote products derived from this software without specific prior written      #
// #    permission.                                                                                #
// #                                                                                               #
// # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS   #
// # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF               #
// # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE    #
// # COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,     #
// # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE #
// # GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED    #
// # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING     #
// # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED  #
// # OF THE POSSIBILITY OF SUCH DAMAGE.                                                            #
// # ********************************************************************************************* #
// # The NEORV32 Processor - https://github.com/stnolting/neorv32              (c) Stephan Nolting #
// #################################################################################################
 
 
/**********************************************************************/
#ifndef neorv32_h
#define neorv32_h
 
#ifdef __cplusplus
extern "C" {
#endif
 
// Standard libraries
#include <stdint.h>
#include <inttypes.h>
#include <limits.h>
#include <unistd.h>
#include <stdlib.h>
 
 
/**********************************************************************/
enum NEORV32_CLOCK_PRSC_enum {
  CLK_PRSC_2    = 0, 
  CLK_PRSC_4    = 1, 
  CLK_PRSC_8    = 2, 
  CLK_PRSC_64   = 3, 
  CLK_PRSC_128  = 4, 
  CLK_PRSC_1024 = 5, 
  CLK_PRSC_2048 = 6, 
  CLK_PRSC_4096 = 7  
};
 
 
/**********************************************************************/
#define CFS_FIRQ_ENABLE        CSR_MIE_FIRQ1E    
#define CFS_FIRQ_PENDING       CSR_MIP_FIRQ1P    
#define CFS_RTE_ID             RTE_TRAP_FIRQ_1   
#define CFS_TRAP_CODE          TRAP_CODE_FIRQ_1  
#define UART0_RX_FIRQ_ENABLE   CSR_MIE_FIRQ2E    
#define UART0_RX_FIRQ_PENDING  CSR_MIP_FIRQ2P    
#define UART0_RX_RTE_ID        RTE_TRAP_FIRQ_2   
#define UART0_RX_TRAP_CODE     TRAP_CODE_FIRQ_2  
#define UART0_TX_FIRQ_ENABLE   CSR_MIE_FIRQ3E    
#define UART0_TX_FIRQ_PENDING  CSR_MIP_FIRQ3P    
#define UART0_TX_RTE_ID        RTE_TRAP_FIRQ_3   
#define UART0_TX_TRAP_CODE     TRAP_CODE_FIRQ_3  
#define UART1_RX_FIRQ_ENABLE   CSR_MIE_FIRQ4E    
#define UART1_RX_FIRQ_PENDING  CSR_MIP_FIRQ4P    
#define UART1_RX_RTE_ID        RTE_TRAP_FIRQ_4   
#define UART1_RX_TRAP_CODE     TRAP_CODE_FIRQ_4  
#define UART1_TX_FIRQ_ENABLE   CSR_MIE_FIRQ5E    
#define UART1_TX_FIRQ_PENDING  CSR_MIP_FIRQ5P    
#define UART1_TX_RTE_ID        RTE_TRAP_FIRQ_5   
#define UART1_TX_TRAP_CODE     TRAP_CODE_FIRQ_5  
#define SPI_FIRQ_ENABLE        CSR_MIE_FIRQ6E    
#define SPI_FIRQ_PENDING       CSR_MIP_FIRQ6P    
#define SPI_RTE_ID             RTE_TRAP_FIRQ_6   
#define SPI_TRAP_CODE          TRAP_CODE_FIRQ_6  
#define TWI_FIRQ_ENABLE        CSR_MIE_FIRQ7E    
#define TWI_FIRQ_PENDING       CSR_MIP_FIRQ7P    
#define TWI_RTE_ID             RTE_TRAP_FIRQ_7   
#define TWI_TRAP_CODE          TRAP_CODE_FIRQ_7  
#define XIRQ_FIRQ_ENABLE       CSR_MIE_FIRQ8E    
#define XIRQ_FIRQ_PENDING      CSR_MIP_FIRQ8P    
#define XIRQ_RTE_ID            RTE_TRAP_FIRQ_8   
#define XIRQ_TRAP_CODE         TRAP_CODE_FIRQ_8  
#define NEOLED_FIRQ_ENABLE     CSR_MIE_FIRQ9E    
#define NEOLED_FIRQ_PENDING    CSR_MIP_FIRQ9P    
#define NEOLED_RTE_ID          RTE_TRAP_FIRQ_9   
#define NEOLED_TRAP_CODE       TRAP_CODE_FIRQ_9  
#define DMA_FIRQ_ENABLE        CSR_MIE_FIRQ10E   
#define DMA_FIRQ_PENDING       CSR_MIP_FIRQ10P   
#define DMA_RTE_ID             RTE_TRAP_FIRQ_10  
#define DMA_TRAP_CODE          TRAP_CODE_FIRQ_10 
#define SDI_FIRQ_ENABLE        CSR_MIE_FIRQ11E   
#define SDI_FIRQ_PENDING       CSR_MIP_FIRQ11P   
#define SDI_RTE_ID             RTE_TRAP_FIRQ_11  
#define SDI_TRAP_CODE          TRAP_CODE_FIRQ_11 
#define GPTMR_FIRQ_ENABLE      CSR_MIE_FIRQ12E   
#define GPTMR_FIRQ_PENDING     CSR_MIP_FIRQ12P   
#define GPTMR_RTE_ID           RTE_TRAP_FIRQ_12  
#define GPTMR_TRAP_CODE        TRAP_CODE_FIRQ_12 
#define ONEWIRE_FIRQ_ENABLE    CSR_MIE_FIRQ13E   
#define ONEWIRE_FIRQ_PENDING   CSR_MIP_FIRQ13P   
#define ONEWIRE_RTE_ID         RTE_TRAP_FIRQ_13  
#define ONEWIRE_TRAP_CODE      TRAP_CODE_FIRQ_13 
#define SLINK_RX_FIRQ_ENABLE   CSR_MIE_FIRQ14E   
#define SLINK_RX_FIRQ_PENDING  CSR_MIP_FIRQ14P   
#define SLINK_RX_RTE_ID        RTE_TRAP_FIRQ_14  
#define SLINK_RX_TRAP_CODE     TRAP_CODE_FIRQ_14 
#define SLINK_TX_FIRQ_ENABLE   CSR_MIE_FIRQ15E   
#define SLINK_TX_FIRQ_PENDING  CSR_MIP_FIRQ15P   
#define SLINK_TX_RTE_ID        RTE_TRAP_FIRQ_15  
#define SLINK_TX_TRAP_CODE     TRAP_CODE_FIRQ_15 
/**********************************************************************/
#define XIP_MEM_BASE_ADDRESS    (0xE0000000U)
#define BOOTLOADER_BASE_ADDRESS (0xFFFFC000U)
#define IO_BASE_ADDRESS         (0xFFFFE000U)
/**********************************************************************/
#define NEORV32_CFS_BASE     (0xFFFFEB00U) 
#define NEORV32_SLINK_BASE   (0xFFFFEC00U) 
#define NEORV32_DMA_BASE     (0xFFFFED00U) 
#define NEORV32_CRC_BASE     (0xFFFFEE00U) 
#define NEORV32_XIP_BASE     (0xFFFFEF00U) 
#define NEORV32_PWM_BASE     (0xFFFFF000U) 
#define NEORV32_GPTMR_BASE   (0xFFFFF100U) 
#define NEORV32_ONEWIRE_BASE (0xFFFFF200U) 
#define NEORV32_XIRQ_BASE    (0xFFFFF300U) 
#define NEORV32_MTIME_BASE   (0xFFFFF400U) 
#define NEORV32_UART0_BASE   (0xFFFFF500U) 
#define NEORV32_UART1_BASE   (0xFFFFF600U) 
#define NEORV32_SDI_BASE     (0xFFFFF700U) 
#define NEORV32_SPI_BASE     (0xFFFFF800U) 
#define NEORV32_TWI_BASE     (0xFFFFF900U) 
#define NEORV32_TRNG_BASE    (0xFFFFFA00U) 
#define NEORV32_WDT_BASE     (0xFFFFFB00U) 
#define NEORV32_GPIO_BASE    (0xFFFFFC00U) 
#define NEORV32_NEOLED_BASE  (0xFFFFFD00U) 
#define NEORV32_SYSINFO_BASE (0xFFFFFE00U) 
#define NEORV32_DM_BASE      (0xFFFFFF00U) 
// ----------------------------------------------------------------------------
// Include all system header files
// ----------------------------------------------------------------------------
// intrinsics
#include "neorv32_intrinsics.h"
 
// cpu core
#include "neorv32_cpu.h"
#include "neorv32_cpu_amo.h"
#include "neorv32_cpu_csr.h"
#include "neorv32_cpu_cfu.h"
 
// NEORV32 runtime environment
#include "neorv32_rte.h"
 
// IO/peripheral devices
#include "neorv32_cfs.h"
#include "neorv32_crc.h"
#include "neorv32_dm.h"
#include "neorv32_dma.h"
#include "neorv32_gpio.h"
#include "neorv32_gptmr.h"
#include "neorv32_mtime.h"
#include "neorv32_neoled.h"
#include "neorv32_onewire.h"
#include "neorv32_pwm.h"
#include "neorv32_sdi.h"
#include "neorv32_slink.h"
#include "neorv32_spi.h"
#include "neorv32_sysinfo.h"
#include "neorv32_trng.h"
#include "neorv32_twi.h"
#include "neorv32_uart.h"
#include "neorv32_wdt.h"
#include "neorv32_xip.h"
#include "neorv32_xirq.h"
 
// backwards compatibility layer
#include "legacy.h"
 
#ifdef __cplusplus
}
#endif
 
#endif // neorv32_h