The NEORV32 RISC-V Processor

1. Overview
   • Key Features
   • Status
2. Features
3. FPGA Implementation Results
4. Performance
5. Software Framework & Tooling
6. Getting Started :rocket:

1. Overview

The NEORV32 Processor is a customizable microcontroller-like system on chip (SoC) written in platform-independent VHDL that is based on the NEORV32 RISC-V CPU. The project is intended as auxiliary processor in larger SoC designs or as ready-to-go stand-alone custom microcontroller that even fits into a Lattice iCE40 UltraPlus 5k low-power & low-density FPGA running at 24+ MHz.

Special focus is paid on execution safety to provide defined and predictable behavior at any time. Therefore, the CPU ensures that all memory access are acknowledged and no invalid/malformed instructions are executed. Whenever an unexpected situation occurs the application code is informed via precise and resumable hardware exceptions.

:interrobang: Want to know more? Check out the project's rationale.

:books: For detailed information take a look at the NEORV32 online documentation. The latest PDF versions can be found here.

:label: The project's change log is available in CHANGELOG.md. To see the changes between official releases visit the project's release page.

:package: Exemplary setups targeting various FPGA boards and toolchains to get you started. Also check out the list of community projects there.

:heavy_check_mark: Automatic check for RISC-V specification compliance.

:kite: Support for Zephyr & FreeRTOS operating systems and LiteX SoC Builder Framework.

:bulb: Feel free to open a new issue or start a new discussion if you have questions, comments, ideas or if something is not working as expected. Or have a chat on our gitter channel. See how to contribute.

:rocket: Check out the quick links below or directly jump to the User Guide to get started setting up your NEORV32 setup!

Key Features

• [x] all-in-one package: CPU + SoC + Software Framework & Tooling
• [x] completely described in behavioral, platform-independent VHDL - no platform-specific primitives, macros, attributes, etc.
• [x] extensive configuration options for adapting the processor to the requirements of the application
• [x] highly extensible hardware - on CPU, processor and system level
• [x] aims to be as small as possible while being as RISC-V-compliant as possible - with a reasonable area-vs-performance trade-off
• [x] FPGA friendly (e.g. all internal memories can be mapped to block RAM - including the register file)
• [x] optimized for high clock frequencies to ease timing closure and integration
• [x] from zero to "hello world!" - completely open source and documented
• [x] easy to use even for FPGA / RISC-V starters – intended to work out of the box

Status

The NEORV32 is fully operational. The processor passes the official RISC-V architecture tests, which is checked by the neorv32-verif 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 Intel, Xilinx and Lattice FPGAs.

[back to top]

2. 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

• 32-bit little-endian RISC-V single-core, pipelined/multi-cycle modified Harvard architecture
• configurable ISA extensions:
  RV32 [I/ E] [B] [C] [M] [U] [X] [Zfinx] [Zicsr] [Zicntr] [Zihpm] [Zifencei] [Zmmul] [Zxcfu] [PMP] [DEBUG]
• compatible to subsets of the RISC-V Unprivileged ISA Specification (pdf) and Privileged Architecture Specification (pdf).
• machine and user privilege modes
• implements all standard RISC-V exceptions and interrupts (including MTI, MEI & MSI)
• 16 fast interrupt request channels as NEORV32-specific extension

Memory

• processor-internal data and instruction memories (DMEM / IMEM) & cache (iCACHE)
• pre-installed bootloader (BOOTLDROM) with serial user interface; allows booting application code via UART or from external SPI flash

Timers

• 64-bit machine system timer (MTIME), RISC-V spec. compatible
• 32-bit general purpose timer (GPTMR)
• watchdog timer (WDT)

Input / Output

• standard serial interfaces (UART, SPI, TWI)
• general purpose IOs (GPIO) and PWM
• smart LED interface (NEOLED) to directly control NeoPixel(TM) LEDs

SoC Connectivity

• 32-bit external bus interface - Wishbone b4 compatible (WISHBONE); wrappers for AXI4-Lite and Avalon-MM host interfaces
• 32-bit stream link interface with up to 8 independent RX and TX channels (SLINK) - AXI4-Stream compatible
• external interrupts controller with up to 32 channels (XIRQ)

Advanced

• true random number generator (TRNG) based on the neoTRNG
• execute-in-place module (XIP) to execute code directly from SPI flash
• custom functions subsystem (CFS) for custom tightly-coupled co-processors, accelerators or interfaces
• custom functions unit (CFU) for up to 1024 custom RISC-V instructions

Debugging

• on-chip debugger (OCD) accessible via standard JTAG interface
• compliant to the "Minimal RISC-V Debug Specification Version 0.13.2"
• compatible with OpenOCD + gdb and Segger Embedded Studio

:warning: The B, Zfinx and Zmmul RISC-V ISA extensions are frozen and officially ratified but there is no upstream gcc support yet (will be available with GCC12). To circumvent this, the NEORV32 software framework provides intrinsic libraries for the B and Zfinx extensions.

[back to top]

3. 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, f_max from Slow 1200mV 0C Model).

:bulb: An incremental list of the CPU extensions and the Processor modules found in the Data Sheet: FPGA Implementation Results.

:bulb: The neorv32-setups repository provides exemplary FPGA setups targeting various FPGA boards and toolchains.

[back to top]

4. Performance

The NEORV32 CPU is based on a two-stages pipeline architecture (fetch and execute). The average CPI (cycles per instruction) depends on the instruction mix of a specific applications and also on the available CPU extensions.

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!).

:bulb: 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: UG: Application-Specific Processor Configuration

[back to top]

5. Software Framework and Tooling

• core libraries for high-level usage of the provided functions and peripherals
• application compilation based on GNU makefiles
• gcc-based toolchain (pre-compiled toolchains available)
• SVD file for advanced debugging and IDE integration
• bootloader with UART interface console
• runtime environment for handling traps
• several example programs to get started including CoreMark, FreeRTOS and Conway's Game of Life
• doxygen-based documentation, available on GitHub pages
• supports implementation using open source toolchains - both, software and hardware can be developed and debugged with open source tools (GHDL, Yosys, nextpnr, openOCD, gtkwave, ...)
• continuous integration is available for:
  • allowing users to see the expected execution/output of the tools
  • ensuring specification compliance
  • catching regressions
  • providing ready-to-use and up-to-date bitstreams and documentation

:bulb: Want to know more? Check out Data Sheet: Software Framework.

[back to top]

6. Getting Started

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

:interrobang: Rationale

• Rationale - NEORV32: Why? How come? What for?

:electric_plug: Hardware Overview

• 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 boot configurations
  • SoC Modules - IO/peripheral modules and memories
  • On-Chip Debugger - in-system debugging of the processor via JTAG

• NEORV32 CPU - the CPU

  • 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 Overview

• 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

:rocket: User Guide

• Toolchain Setup - install and setup the RISC-V GCC toolchain
• General Hardware Setup - setup a new NEORV32 FPGA project
• General Software Setup - configure the software framework
• Application Compilation - compile an application using make
• Upload via Bootloader - upload and execute executables
• Application-Specific Processor Configuration - tailor the processor to your needs
• Adding Custom Hardware Modules - add your custom hardware
• Debugging via the On-Chip Debugger - step through code online and in-system
• Simulation - simulate the whole SoC
• LiteX Integration - build a SoC using NEORV32 + LiteX

: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. Use this project in any way you like (as long as it complies to the permissive license). Please cite it appropriately. :+1:

[back to top]

:heart: A big shout-out to the community and all the contributors, who helped improving this project!