The NEORV32 RISC-V Processor

The NEORV32 Processor is a customizable microcontroller-like system on chip (SoC) built around the NEORV32 RISC-V CPU that is written in platform-independent VHDL. The processor is intended as auxiliary controller in larger SoC designs or as tiny and customized microcontroller that even fits into a Lattice iCE40 UltraPlus low-power & low-density FPGA. The project is intended to work out of the box and targets FPGA / RISC-V beginners as well as advanced users.

Special focus is paid on execution safety to provide defined and predictable behavior at any time. For example, the CPU ensures all memory accesses are properly acknowledged and all invalid/malformed instructions are always detected as such. Whenever an unexpected state occurs the application software is informed via precise and resumable hardware exceptions.

Key Features

• [x] all-in-one package: CPU + SoC + Software Framework + Tooling
• [x] completely described in behavioral, platform-independent VHDL - no primitives, macros, attributes, etc.
• [x] extensive CPU & SoC configuration options for adapting to application requirements
• [x] aims to be as small as possible while being as RISC-V-compliant as possible
• [x] FPGA friendly (e.g. all internal memories can be mapped to block RAM)
• [x] optimized for high clock frequencies to ease integration and timing closure
• [x] from zero to printf("hello world"); - completely open-source and documented

• [x] easy to use – intended to work out of the box

• :recycle: Looking for an all-Verilog version? Have a look at neorv32-verilog.

• :mag: Continuous integration to check for regressions (including RISC-V ISA compatibility check using RISCOF).

• :openfilefolder: Exemplary setups and community projects targeting various FPGA boards and toolchains to get started.

• :package: The entire processor is also available as Vivado IP Block.

• :kite: Support for FreeRTOS, Zephyr OS, MicroPython and LiteX SoC Builder Framework.

• :desktop_computer: Pre-configured Eclipse project for developing and debugging code using an IDE.

• :label: The project's change log is available in CHANGELOG.md.

• :rocket: Check out the quick links below and the User Guide to get started.

• :books: For detailed information see the online documentation.

Project Status

| Task / Subproject | Repository | CI Status | |:------------------|:-----------|:----------| | GitHub pages (docs) | neorv32 | | | Documentation build | neorv32 | | | Processor verification | neorv32 | | | RISCOF core verification | neorv32-riscof | | | FPGA implementations | neorv32-setups | | | All-Verilog version | neorv32-verilog | | | FreeRTOS port | neorv32-freertos | | | MicroPython port | neorv32-micropython | |

The processor passes the official RISC-V architecture tests to ensure compatibility with the RISC-V ISA specs., which is checked by the neorv32-riscof repository. It can successfully run any C program (for example from the sw/example folder) including CoreMark and FreeRTOS and can be synthesized for any target technology - tested on AMD, Intel, Lattice, Microchip, Gowin and Cologne Chip FPGAs. The conversion into a single, plain-Verilog module file is automatically checked by the neorv32-verilog repository.

Features

The NEORV32 Processor provides a full-featured microcontroller-like SoC build around the NEORV32 CPU. By using generics the design is highly configurable and allows a flexible customization to tailor the setup according to your needs. Note that all of the following SoC modules are entirely optional.

CPU Core

• 
• RISC-V 32-bit little-endian pipelined/multi-cycle modified Harvard architecture
• Single-core or SMP dual-core configuration (including low-latency inter-core communication)
• configurable instruction sets and extensions: \ RV32 I E M A C B U X Zaamo Zalrsc Zcb Zba Zbb Zbkb Zbkc Zbkx Zbs Zicntr Zicond Zicsr Zifencei Zihpm Zfinx Zkn Zknd Zkne Zknh Zkt Zks Zksed Zksh Zmmul Zxcfu Sdext Sdtrig Smpmp
• compatible to subsets of the RISC-V "Unprivileged ISA Specification" and "Privileged Architecture Specification"
• machine and user privilege modes
• implements all standard RISC-V exceptions and interrupts + 16 fast interrupt request channels as NEORV32-specific extension
• custom functions unit (CFU as Zxcfu ISA extension) for custom RISC-V instructions;
• intrinsic libraries for CPU extensions that are not yet supported by GCC

Memories

• processor-internal data and instruction memories (DMEM & IMEM) and caches (iCACHE & dCACHE)
• pre-installed bootloader (BOOTLDROM) with serial user interface; allows booting application code via UART, TWI or SPI flash or from an SD card

Timers and Counters

• core local interruptor (CLINT), RISC-V-compatible
• 32-bit general purpose timer (GPTMR)
• watchdog timer (WDT)

Input / Output

• standard serial interfaces: UART (2x), SPI (SPI host), SDI (SPI device), TWI (I²C host), TWD (I²C device), ONEWIRE (1-wire host)
• interrupt-capable general purpose IOs (GPIO) and PWM
• smart LED interface (NEOLED) to directly control NeoPixel(TM) LEDs

SoC Connectivity

• 32-bit external bus interface - Wishbone-compatible (XBUS); wrapper for AXI4 interfaces
• stream link interface with independent RX and TX channels - AXI4-Stream compatible (SLINK)

Advanced

• true-random number generator (TRNG) based on the neoTRNG
• custom functions subsystem (CFS) for custom tightly-coupled co-processors, accelerators or interfaces
• direct memory access controller (DMA) for CPU-independent data transfers and conversions

Debugging

• on-chip debugger (OCD) accessible via standard JTAG interface
• compatible to the "Minimal RISC-V Debug Specification Version 1.0"
• compatible with OpenOCD, GDB and Segger Embedded Studio
• RISC-V trigger module for hardware-assisted break- and watchpoints
• optional JTAG authentication module to implement custom security mechanisms
• execution trace buffer (TRACER)

FPGA Implementation Results

Implementation results for exemplary CPU configurations generated for an Intel Cyclone IV EP4CE22F17C6 FPGA using Intel Quartus Prime Lite 21.1 (no timing constrains, balanced optimization, fmax from _Slow 1200mV 0C Model).

| CPU Configuration (version 1.7.8.5) | LEs | FFs | Memory bits | DSPs | fmax | |:-----------------------|:----:|:----:|:----:|:-:|:-------:| | `rv32iZicsr| 1223 | 607 | 1024 | 0 | 130 MHz | |rv32iZicsrZicntr| 1578 | 773 | 1024 | 0 | 130 MHz | |rv32imcZicsrZicntr` | 2338 | 992 | 1024 | 0 | 130 MHz |

An incremental list of CPU extensions and processor modules can be found in the Data Sheet: FPGA Implementation Results.

Performance

The NEORV32 CPU is based on a two-stages pipelined/multi-cycle architecture (fetch and execute). The following table shows the performance results (scores and average CPI) for exemplary CPU configurations (no caches) executing 2000 iterations of the CoreMark CPU benchmark (using plain GCC10 rv32i built-in libraries only!).

| CPU Configuration (version 1.5.7.10) | CoreMark Score | |:---------------------------------------------------------|:-----:| | small (rv32i_Zicsr_Zifencei) | 33.89 | | medium (rv32imc_Zicsr_Zifencei) | 62.50 | | performance (rv32imc_Zicsr_Zifencei + perf. options) | 95.23 |

More information regarding the CPU performance can be found in the Data Sheet: CPU Performance. The CPU & SoC provide further "tuning" options to optimize the design for maximum performance, maximum clock speed, minimal area or minimal power consumption: User Guide: Application-Specific Processor Configuration

Getting Started

This overview provides some quick links to the most important sections of the online Data Sheet and the online User Guide.

:mag: NEORV32 Project - An Introduction

• Rationale - why? how come? what for?
• Key Features - what makes it special
• Structure - folders, RTL files and compile order
• File-List Files - to simplify HDL setup
• Metrics - FPGA implementation and performance evaluation

:desktop_computer: NEORV32 Processor - The SoC

• Top Entity - Signals - how to connect to the processor
• Top Entity - Generics - processor/CPU configuration options
• Address Space - memory layout and address mapping
• Boot Configuration - how to make the processor start executing
• SoC Modules - IO/peripheral modules and memories
• On-Chip Debugger - in-system debugging of the processor via JTAG

:abacus: NEORV32 CPU - The Core

• RISC-V Compatibility - what is compatible to the specs and what is not
• Architecture - a look under the hood
• Full Virtualization - execution safety
• ISA and Extensions - available (RISC-V) ISA extensions
• CSRs - control and status registers
• Traps - interrupts and exceptions

:floppy_disk: Software Framework - The Software Ecosystem

• Example Programs - examples how to use the processor's IO/peripheral modules
• Core Libraries - high-level functions for accessing the processor's peripherals
• Software Framework Documentation - doxygen-based
• Application Makefile - turning your application into an executable
• Bootloader - the build-in NEORV32 bootloader
• Image Generator - create (FPGA) memory initialization files from your application
• Semihosting - access files and system services on the host computer

:rocket: User Guide - Getting Started

• Toolchain Setup - install and set up the RISC-V GCC toolchain
• General Hardware Setup - set up a new NEORV32 FPGA project
• Adding Custom Hardware Modules - add your custom hardware
• Convert to Verilog - turn the NEORV32 into an all-Verilog design
• Package as Vivado IP block - turn the entire processor into an interactive AMD Vivado IP block
• Using Eclipse - use the Eclipse IDE for developing and debugging

:copyright: Legal

• Overview - license, disclaimer, limitation of liability for external links, proprietary notice, etc.
• Citing - citing information

This is an open-source project that is free of charge and provided under an permissive license.

:heart: A big shout-out to the community and all the contributors!