Projet_SETI_RISC-V/neorv32

The NEORV32 RISC-V Processor

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

1. Overview

The NEORV32 Processor is a customizable microcontroller-like system on chip (SoC) built around the NEORV32 RISC-V CPU and written in platform-independent VHDL. The processor is intended as auxiliary controller in larger SoC designs or as ready-to-go stand-alone custom 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. Therefore, the CPU ensures that all memory accesses are properly acknowledged and that all invalid/malformed instructions are always detected as such. Whenever an unexpected situation occurs the application software is informed via precise and resumable hardware exceptions.

• ⁉️ Want to know more? Check out the project's rationale.
• 📚 For detailed information see the NEORV32 online documentation.
• ♻️ Looking for an all-Verilog version? Have a look at neorv32-verilog.
• ✔️ Continuous integration to check for regressions (including RISC-V ISA compatibility test using RISCOF).
• 📦 Exemplary setups and community projects targeting various FPGA boards and toolchains to get started.
• 🪁 Support for Zephyr & FreeRTOS operating systems and LiteX SoC Builder Framework.
• 🏷️ The project's change log is available in CHANGELOG.md.
• 🚀 Check out the quick links below and the User Guide to get started setting up your NEORV32 processor!

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

Key Features

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

Project Status

	Repository	CI Status
GitHub Pages (docs)	neorv32
Build documentation	neorv32
Processor (SoC) verification	neorv32
RISCOF core verification	neorv32-riscof
FPGA implementations	neorv32-setups
All-Verilog "version"	neorv32-verilog
Prebuilt GCC toolchains	riscv-gcc-prebuilt

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 Intel, Xilinx and Lattice FPGAs. The conversion into a plain-Verilog netlist module is automatically checked by the neorv32-verilog repository.

[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

• - see the open-source architecture ID list in the official RISC-V ISA manual repository
• 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] [Zicsr] [Zicntr] [Zihpm] [Zifencei] [Zfinx] [Zmmul] [Zxcfu] [PMP] [Sdext] [Sdtrig]
• 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
• custom functions unit (CFU as Zxcfu ISA extension) for custom RISC-V instructions (R3-type, R4-type and R5-type);
• intrinsic libraries for the Zxcfu and Zfinx ISA extensions

Memories

• 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 and Counters

• 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/I²C), ONEWIRE/1-Wire)
• 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

Debugging

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

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

CPU Configuration (version 1.7.8.5)	LEs	FFs	Memory bits	DSPs	f_max
rv32i_Zicsr	1223	607	1024	0	130 MHz
rv32i_Zicsr_Zicntr	1578	773	1024	0	130 MHz
rv32imc_Zicsr_Zicntr	2338	992	1024	0	130 MHz

Implementation results for an exemplary SoC/Processor configurations generated for a Xilinx Artix-7 xc7a35ticsg324-1L FPGA using Xilinx Vivado 2019.2 (no constraints except for clock speed).

SoC Configuration (version 1.7.7.3)	LUTs	FFs	BRAMs	DSPs	Clock
CPU: rv32imcu_Zicsr_Zicnt_DEBUG + FST_MUL + FAST_SHIFT; Peripherals: UART0 + MTIME + GPIO	2488	1807	7	4	150 MHz

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

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

CPU Configuration (version 1.5.7.10)	CoreMark Score	CoreMarks/MHz	Average CPI
small (rv32i_Zicsr)	33.89	0.3389	4.04
medium (rv32imc_Zicsr)	62.50	0.6250	5.34
performance (rv32imc_Zicsr + perf. options)	95.23	0.9523	3.54

💡 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 RISC-V specification compatibility using RISCOF
  • catching regressions
  • providing ready-to-use and up-to-date bitstreams and documentation

💡 Want to know more? Check out the 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.

🔍 Project Overview

• NEORV32 Project - introduction
  • Rationale - why? how come? what for?
  • Key Features - what makes it special
  • Structure - folders and RTL files
  • Metrics - FPGA implementation and performance evaluation

🔌 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 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

💾 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

🚀 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
• Convert to Verilog - turn the NEORV32 into an all-Verilog design

©️ 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. 👍

[back to top]

---

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