[![NEORV32](https://raw.githubusercontent.com/stnolting/neorv32/main/docs/figures/neorv32_logo_dark.png)](https://github.com/stnolting/neorv32)
|
[![NEORV32](https://raw.githubusercontent.com/stnolting/neorv32/main/docs/figures/neorv32_logo_front.png)](https://github.com/stnolting/neorv32)
|
|
|
# The NEORV32 RISC-V Processor
|
# The NEORV32 RISC-V Processor
|
|
|
[![datasheet (pdf)](https://img.shields.io/badge/data%20sheet-PDF-ffbd00?longCache=true&style=flat-square&logo=asciidoctor)](https://github.com/stnolting/neorv32/releases/tag/nightly)
|
[![datasheet (pdf)](https://img.shields.io/badge/data%20sheet-PDF-ffbd00?longCache=true&style=flat-square&logo=asciidoctor)](https://github.com/stnolting/neorv32/releases/tag/nightly)
|
[![datasheet (html)](https://img.shields.io/badge/-HTML-ffbd00?longCache=true&style=flat-square)](https://stnolting.github.io/neorv32)
|
[![datasheet (html)](https://img.shields.io/badge/-HTML-ffbd00?longCache=true&style=flat-square)](https://stnolting.github.io/neorv32)
|
[![userguide (pdf)](https://img.shields.io/badge/user%20guide-PDF-ffbd00?longCache=true&style=flat-square&logo=asciidoctor)](https://github.com/stnolting/neorv32/releases/tag/nightly)
|
[![userguide (pdf)](https://img.shields.io/badge/user%20guide-PDF-ffbd00?longCache=true&style=flat-square&logo=asciidoctor)](https://github.com/stnolting/neorv32/releases/tag/nightly)
|
[![userguide (html)](https://img.shields.io/badge/-HTML-ffbd00?longCache=true&style=flat-square)](https://stnolting.github.io/neorv32/ug)
|
[![userguide (html)](https://img.shields.io/badge/-HTML-ffbd00?longCache=true&style=flat-square)](https://stnolting.github.io/neorv32/ug)
|
[![doxygen](https://img.shields.io/badge/doxygen-HTML-ffbd00?longCache=true&style=flat-square&logo=Doxygen)](https://stnolting.github.io/neorv32/sw/files.html)
|
[![doxygen](https://img.shields.io/badge/doxygen-HTML-ffbd00?longCache=true&style=flat-square&logo=Doxygen)](https://stnolting.github.io/neorv32/sw/files.html)
|
[![Gitter](https://img.shields.io/badge/Chat-on%20gitter-4db797.svg?longCache=true&style=flat-square&logo=gitter&logoColor=e8ecef)](https://gitter.im/neorv32/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
[![Gitter](https://img.shields.io/badge/Chat-on%20gitter-4db797.svg?longCache=true&style=flat-square&logo=gitter&logoColor=e8ecef)](https://gitter.im/neorv32/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
1. [Overview](#1-Overview)
|
1. [Overview](#1-Overview)
|
* [Key Features](#Project-Key-Features)
|
* [Key Features](#Project-Key-Features)
|
* [Status](#status)
|
* [Status](#status)
|
2. [Processor/SoC Features](#2-NEORV32-Processor-Features)
|
2. [Features](#2-Features)
|
* [FPGA Implementation Results](#FPGA-Implementation-Results---Processor)
|
3. [FPGA Implementation Results](#3-FPGA-Implementation-Results)
|
3. [CPU Features](#3-NEORV32-CPU-Features)
|
4. [Performance](#4-Performance)
|
* [Available ISA Extensions](#Available-ISA-Extensions)
|
5. [Software Framework & Tooling](#5-Software-Framework-and-Tooling)
|
* [FPGA Implementation Results](#FPGA-Implementation-Results---CPU)
|
6. [**Getting Started**](#6-Getting-Started) :rocket:
|
* [Performance](#Performance)
|
|
4. [Software Framework & Tooling](#4-Software-Framework-and-Tooling)
|
|
5. [**Getting Started**](#5-Getting-Started) :rocket:
|
|
|
|
|
|
|
|
## 1. Overview
|
## 1. Overview
|
|
|
![neorv32 Overview](https://raw.githubusercontent.com/stnolting/neorv32/main/docs/figures/neorv32_processor.png)
|
![neorv32 Overview](https://raw.githubusercontent.com/stnolting/neorv32/main/docs/figures/neorv32_processor.png)
|
|
|
The NEORV32 Processor is a **customizable microcontroller-like system on chip (SoC)** that is based on the
|
The NEORV32 Processor is a **customizable microcontroller-like system on chip (SoC)** that is based on the
|
[RISC-V](https://riscv.org/) NEORV32 CPU.
|
[RISC-V](https://riscv.org/) NEORV32 CPU.
|
The project is intended as auxiliary processor in larger SoC designs or as *ready-to-go* stand-alone
|
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 FPGA running at 24 MHz.
|
custom microcontroller that even fits into a Lattice iCE40 UltraPlus 5k low-power FPGA running at 24 MHz.
|
|
|
Special focus is paid on **execution safety** to provide defined and predictable behavior at any time.
|
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
|
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.
|
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](https://stnolting.github.io/neorv32/#_rationale).
|
:interrobang: Want to know more? Check out the [project's rationale](https://stnolting.github.io/neorv32/#_rationale).
|
|
|
:books: For detailed information take a look at the [NEORV32 online documentation](https://stnolting.github.io/neorv32/).
|
:books: For detailed information take a look at the [NEORV32 online documentation](https://stnolting.github.io/neorv32/).
|
The latest _pdf_ versions can be found [here](https://github.com/stnolting/neorv32/releases/tag/nightly).
|
The latest _pdf_ versions can be found [here](https://github.com/stnolting/neorv32/releases/tag/nightly).
|
|
|
:label: The project's change log is available in [`CHANGELOG.md`](https://github.com/stnolting/neorv32/blob/main/CHANGELOG.md).
|
:label: The project's change log is available in [`CHANGELOG.md`](https://github.com/stnolting/neorv32/blob/main/CHANGELOG.md).
|
To see the changes between _official releases_ visit the project's [release page](https://github.com/stnolting/neorv32/releases).
|
To see the changes between _official releases_ visit the project's [release page](https://github.com/stnolting/neorv32/releases).
|
|
|
:package: [**Exemplary setups**](https://github.com/stnolting/neorv32-setups) targeting
|
:package: [**Exemplary setups**](https://github.com/stnolting/neorv32-setups) targeting
|
various FPGA boards and toolchains to get you started.
|
various FPGA boards and toolchains to get you started.
|
|
|
:kite: Supported by upstream [Zephyr OS](https://docs.zephyrproject.org/latest/boards/riscv/neorv32/doc/index.html) and FreeRTOS.
|
:kite: Supported by upstream [Zephyr OS](https://docs.zephyrproject.org/latest/boards/riscv/neorv32/doc/index.html) and FreeRTOS.
|
|
|
:bulb: Feel free to open a [new issue](https://github.com/stnolting/neorv32/issues) or start a
|
:bulb: Feel free to open a [new issue](https://github.com/stnolting/neorv32/issues) or start a
|
[new discussion](https://github.com/stnolting/neorv32/discussions) if you have questions, comments, ideas or if something is
|
[new discussion](https://github.com/stnolting/neorv32/discussions) if you have questions, comments, ideas or if something is
|
not working as expected. Or have a chat on our [gitter channel](https://gitter.im/neorv32/community).
|
not working as expected. Or have a chat on our [gitter channel](https://gitter.im/neorv32/community).
|
See how to [contribute](https://github.com/stnolting/neorv32/blob/main/CONTRIBUTING.md).
|
See how to [contribute](https://github.com/stnolting/neorv32/blob/main/CONTRIBUTING.md).
|
|
|
:rocket: Check out the [quick links below](#5-Getting-Started) or directly jump to the
|
:rocket: Check out the [quick links below](#5-Getting-Started) or directly jump to the
|
[*User Guide*](https://stnolting.github.io/neorv32/ug/) to get started
|
[*User Guide*](https://stnolting.github.io/neorv32/ug/) to get started
|
setting up your NEORV32 setup!
|
setting up your NEORV32 setup!
|
|
|
|
|
### Project Key Features
|
### Project Key Features
|
|
|
- [x] all-in-one package: **CPU** plus **SoC** plus **Software Framework & Tooling**
|
- [x] all-in-one package: **CPU** plus **SoC** plus **Software Framework & Tooling**
|
- [x] completely described in behavioral, platform-independent VHDL - no primitives, macros, etc.
|
- [x] completely described in behavioral, platform-independent VHDL - no primitives, macros, etc.
|
|
- [x] highly [extensible hardware](https://stnolting.github.io/neorv32/ug/#_comparative_summary) - on CPU, SoC and system level
|
- [x] be as small as possible while being as RISC-V-compliant as possible
|
- [x] be as small as possible while being as RISC-V-compliant as possible
|
- [x] from zero to `printf("hello world!");` - completely open source and documented
|
- [x] from zero to `printf("hello world!");` - completely open source and documented
|
- [x] easy to use even for FPGA/RISC-V starters – intended to work *out of the box*
|
- [x] easy to use even for FPGA/RISC-V starters – intended to work *out of the box*
|
|
|
|
|
### Status
|
### Status
|
|
|
[![release](https://img.shields.io/github/v/release/stnolting/neorv32?longCache=true&style=flat-square&logo=GitHub)](https://github.com/stnolting/neorv32/releases)
|
[![release](https://img.shields.io/github/v/release/stnolting/neorv32?longCache=true&style=flat-square&logo=GitHub)](https://github.com/stnolting/neorv32/releases)
|
[![GitHub Pages](https://img.shields.io/website.svg?label=stnolting.github.io%2Fneorv32&longCache=true&style=flat-square&url=http%3A%2F%2Fstnolting.github.io%2Fneorv32%2Findex.html&logo=GitHub)](https://stnolting.github.io/neorv32)
|
[![GitHub Pages](https://img.shields.io/website.svg?label=stnolting.github.io%2Fneorv32&longCache=true&style=flat-square&url=http%3A%2F%2Fstnolting.github.io%2Fneorv32%2Findex.html&logo=GitHub)](https://stnolting.github.io/neorv32)
|
\
|
\
|
[![Documentation](https://img.shields.io/github/workflow/status/stnolting/neorv32/Documentation/main?longCache=true&style=flat-square&label=Documentation&logo=Github%20Actions&logoColor=fff)](https://github.com/stnolting/neorv32/actions?query=workflow%3ADocumentation)
|
[![Documentation](https://img.shields.io/github/workflow/status/stnolting/neorv32/Documentation/main?longCache=true&style=flat-square&label=Documentation&logo=Github%20Actions&logoColor=fff)](https://github.com/stnolting/neorv32/actions?query=workflow%3ADocumentation)
|
[![riscv-arch-test](https://img.shields.io/github/workflow/status/stnolting/neorv32/riscv-arch-test/main?longCache=true&style=flat-square&label=riscv-arch-test&logo=Github%20Actions&logoColor=fff)](https://github.com/stnolting/neorv32/actions?query=workflow%3Ariscv-arch-test)
|
[![riscv-arch-test](https://img.shields.io/github/workflow/status/stnolting/neorv32-verif/riscv-arch-test/main?longCache=true&style=flat-square&label=riscv-arch-test&logo=Github%20Actions&logoColor=fff)](https://github.com/stnolting/neorv32-verif/actions?query=workflow%3Ariscv-arch-test)
|
[![Processor](https://img.shields.io/github/workflow/status/stnolting/neorv32/Processor/main?longCache=true&style=flat-square&label=Processor&logo=Github%20Actions&logoColor=fff)](https://github.com/stnolting/neorv32/actions?query=workflow%3AProcessor)
|
[![Processor](https://img.shields.io/github/workflow/status/stnolting/neorv32/Processor/main?longCache=true&style=flat-square&label=Processor&logo=Github%20Actions&logoColor=fff)](https://github.com/stnolting/neorv32/actions?query=workflow%3AProcessor)
|
|
|
|
The NEORV32 is fully operational.
|
|
The processor passes the official RISC-V architecture tests, which are checked by the
|
|
[neorv32-verif](https://github.com/stnolting/neorv32-verif) repository. It can successfully run _any_ C program
|
|
(for example from the [`sw/example`](https://github.com/stnolting/neorv32/tree/main/sw/example) folder) including CoreMark
|
|
and can be synthesized for _any_ target technology - tested on Intel, Xilinx and Lattice FPGAs.
|
|
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
|
|
|
|
## 2. NEORV32 Processor Features
|
|
|
|
The NEORV32 Processor provides a full-featured microcontroller-like SoC build around the NEORV32 CPU. It is highly configurable
|
## 2. Features
|
via generics to allow a flexible customization according to your needs. Note that all modules listed below are _optional_.
|
|
|
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. The following list shows all available SoC module. Note that all those
|
|
modules are _optional_.
|
|
|
|
**CPU**
|
|
|
|
* 32-bit little-endian RISC-V single-core, pipelined/multi-cycle Von-Neumann architecture
|
|
* configurable ISA extensions
|
|
* `RV32`
|
|
[[`I`](https://stnolting.github.io/neorv32/#_i_base_integer_isa)/
|
|
[`E`](https://stnolting.github.io/neorv32/#_e_embedded_cpu)]
|
|
[[`A`](https://stnolting.github.io/neorv32/#_a_atomic_memory_access)]
|
|
[[`B`](https://stnolting.github.io/neorv32/#_b_bit_manipulation_operations)]
|
|
[[`C`](https://stnolting.github.io/neorv32/#_c_compressed_instructions)]
|
|
[[`M`](https://stnolting.github.io/neorv32/#_m_integer_multiplication_and_division)]
|
|
[[`U`](https://stnolting.github.io/neorv32/#_u_less_privileged_user_mode)]
|
|
[[`X`](https://stnolting.github.io/neorv32/#_x_neorv32_specific_custom_extensions)]
|
|
[[`Zfinx`](https://stnolting.github.io/neorv32/#_zfinx_single_precision_floating_point_operations)]
|
|
[[`Zicsr`](https://stnolting.github.io/neorv32/#_zicsr_control_and_status_register_access_privileged_architecture)]
|
|
[[`Zicntr`](https://stnolting.github.io/neorv32/#_zicntr_cpu_base_counters)]
|
|
[[`Zihpm`](https://stnolting.github.io/neorv32/#_zihpm_hardware_performance_monitors)]
|
|
[[`Zifencei`](https://stnolting.github.io/neorv32/#_zifencei_instruction_stream_synchronization)]
|
|
[[`Zmmul`](https://stnolting.github.io/neorv32/#_zmmul_integer_multiplication)]
|
|
[[`Zxcfu`](https://stnolting.github.io/neorv32/#_zxcfu_custom_instructions_extension_cfu)]
|
|
[[`PMP`](https://stnolting.github.io/neorv32/#_pmp_physical_memory_protection)]
|
|
[[`DEBUG`](https://stnolting.github.io/neorv32/#_cpu_debug_mode)]
|
|
* compatible to subsets of the
|
|
*Unprivileged ISA Specification* [(Version 2.2)](https://github.com/stnolting/neorv32/blob/main/docs/references/riscv-spec.pdf)
|
|
and the *Privileged Architecture Specification* [(Version 1.12)](https://github.com/stnolting/neorv32/blob/main/docs/references/riscv-privileged.pdf).
|
|
* `machine` and `user` modes
|
|
* implements _all_ standard RISC-V exceptions/interrupts (including MTI, MEI & MSI)
|
|
* 16-fast interrupt requests as NEORV32-specific extensions
|
|
|
**Memory**
|
**Memory**
|
|
|
* processor-internal data and instruction memories ([DMEM](https://stnolting.github.io/neorv32/#_data_memory_dmem) /
|
* processor-internal data and instruction memories ([DMEM](https://stnolting.github.io/neorv32/#_data_memory_dmem) /
|
[IMEM](https://stnolting.github.io/neorv32/#_instruction_memory_imem)) &
|
[IMEM](https://stnolting.github.io/neorv32/#_instruction_memory_imem)) &
|
cache ([iCACHE](https://stnolting.github.io/neorv32/#_processor_internal_instruction_cache_icache))
|
cache ([iCACHE](https://stnolting.github.io/neorv32/#_processor_internal_instruction_cache_icache))
|
* pre-installed bootloader ([BOOTLDROM](https://stnolting.github.io/neorv32/#_bootloader_rom_bootrom)) with serial user interface
|
* pre-installed bootloader ([BOOTLDROM](https://stnolting.github.io/neorv32/#_bootloader_rom_bootrom)) with serial user interface
|
* allows booting application code via UART or from external SPI flash
|
* allows booting application code via UART or from external SPI flash
|
|
|
**Timers**
|
**Timers**
|
|
|
* machine system timer, 64-bit ([MTIME](https://stnolting.github.io/neorv32/#_machine_system_timer_mtime)), RISC-V spec. compatible
|
* machine system timer, 64-bit ([MTIME](https://stnolting.github.io/neorv32/#_machine_system_timer_mtime)), RISC-V spec. compatible
|
* general purpose 32-bit timer ([GPTMR](https://stnolting.github.io/neorv32/#_general_purpose_timer_gptmr))
|
* general purpose 32-bit timer ([GPTMR](https://stnolting.github.io/neorv32/#_general_purpose_timer_gptmr))
|
* watchdog timer ([WDT](https://stnolting.github.io/neorv32/#_watchdog_timer_wdt))
|
* watchdog timer ([WDT](https://stnolting.github.io/neorv32/#_watchdog_timer_wdt))
|
|
|
**Input/Output**
|
**Input / Output**
|
|
|
* standard serial interfaces
|
* standard serial interfaces
|
([UART](https://stnolting.github.io/neorv32/#_primary_universal_asynchronous_receiver_and_transmitter_uart0),
|
([UART](https://stnolting.github.io/neorv32/#_primary_universal_asynchronous_receiver_and_transmitter_uart0),
|
[SPI](https://stnolting.github.io/neorv32/#_serial_peripheral_interface_controller_spi),
|
[SPI](https://stnolting.github.io/neorv32/#_serial_peripheral_interface_controller_spi),
|
[TWI](https://stnolting.github.io/neorv32/#_two_wire_serial_interface_controller_twi))
|
[TWI](https://stnolting.github.io/neorv32/#_two_wire_serial_interface_controller_twi))
|
* general purpose [GPIO](https://stnolting.github.io/neorv32/#_general_purpose_input_and_output_port_gpio) and
|
* general purpose [GPIO](https://stnolting.github.io/neorv32/#_general_purpose_input_and_output_port_gpio) and
|
[PWM](https://stnolting.github.io/neorv32/#_pulse_width_modulation_controller_pwm)
|
[PWM](https://stnolting.github.io/neorv32/#_pulse_width_modulation_controller_pwm)
|
* smart LED interface ([NEOLED](https://stnolting.github.io/neorv32/#_smart_led_interface_neoled)) to directly control NeoPixel(TM) LEDs
|
* smart LED interface ([NEOLED](https://stnolting.github.io/neorv32/#_smart_led_interface_neoled)) to directly control NeoPixel(TM) LEDs
|
|
|
**SoC Connectivity**
|
**SoC Connectivity**
|
|
|
* 32-bit external bus interface, Wishbone b4 compatible
|
* 32-bit external bus interface, Wishbone b4 compatible
|
([WISHBONE](https://stnolting.github.io/neorv32/#_processor_external_memory_interface_wishbone_axi4_lite))
|
([WISHBONE](https://stnolting.github.io/neorv32/#_processor_external_memory_interface_wishbone_axi4_lite))
|
* [wrapper](https://github.com/stnolting/neorv32/blob/main/rtl/system_integration/neorv32_SystemTop_axi4lite.vhd) for AXI4-Lite host interface
|
* [wrappers](https://github.com/stnolting/neorv32/blob/main/rtl/system_integration) for AXI4-Lite and Avalon-MM host interfaces
|
* [wrapper](https://github.com/stnolting/neorv32/blob/main/rtl/system_integration/neorv32_SystemTop_AvalonMM.vhd) for Avalon-MM host interface
|
|
* 32-bit stream link interface with up to 8 independent RX and TX links
|
* 32-bit stream link interface with up to 8 independent RX and TX links
|
([SLINK](https://stnolting.github.io/neorv32/#_stream_link_interface_slink))
|
([SLINK](https://stnolting.github.io/neorv32/#_stream_link_interface_slink)) - AXI4-Stream compatible
|
* AXI4-Stream compatible
|
* external interrupts controller with up to 32 channels
|
* external interrupt controller with up to 32 channels
|
|
([XIRQ](https://stnolting.github.io/neorv32/#_external_interrupt_controller_xirq))
|
([XIRQ](https://stnolting.github.io/neorv32/#_external_interrupt_controller_xirq))
|
|
|
**Advanced**
|
**Advanced**
|
|
|
* on-chip debugger ([OCD](https://stnolting.github.io/neorv32/#_on_chip_debugger_ocd)) accessible via JTAG interface - compliant to
|
|
the "Minimal RISC-V Debug Specification Version 0.13.2" and compatible with **OpenOCD** + **gdb** and **Segger Embedded Studio**
|
|
* _true random_ number generator ([TRNG](https://stnolting.github.io/neorv32/#_true_random_number_generator_trng))
|
* _true random_ number generator ([TRNG](https://stnolting.github.io/neorv32/#_true_random_number_generator_trng))
|
* execute in place module ([XIP](https://stnolting.github.io/neorv32/#_execute_in_place_module_xip)) to directly execute code from SPI flash
|
* execute in place module ([XIP](https://stnolting.github.io/neorv32/#_execute_in_place_module_xip)) to directly execute code from SPI flash
|
* custom functions subsystem ([CFS](https://stnolting.github.io/neorv32/#_custom_functions_subsystem_cfs))
|
* custom functions subsystem ([CFS](https://stnolting.github.io/neorv32/#_custom_functions_subsystem_cfs))
|
for tightly-coupled custom accelerators and interfaces
|
for tightly-coupled custom accelerators and interfaces
|
* custom functions unit ([CFU](https://stnolting.github.io/neorv32/#_custom_functions_unit_cfu)) for up to 1024
|
* custom functions unit ([CFU](https://stnolting.github.io/neorv32/#_custom_functions_unit_cfu)) for up to 1024
|
_custom RISC-V instructions_
|
_custom RISC-V instructions_
|
|
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
**Debugging**
|
|
|
|
|
### FPGA Implementation Results - Processor
|
|
|
|
The hardware resources used by a specific processor setup is defined by the implemented CPU extensions,
|
|
the configuration of the peripheral modules and some "glue logic".
|
|
Section [_FPGA Implementation Results - Processor Modules_](https://stnolting.github.io/neorv32/#_processor_modules)
|
|
of the online datasheet shows the resource utilization of each optional processor module to allow an
|
|
estimation of the actual setup's hardware requirements.
|
|
|
|
:bulb: The [`neorv32-setups`](https://github.com/stnolting/neorv32-setups) repository provides exemplary FPGA
|
|
setups targeting various FPGA boards and toolchains. The latest bitstreams and utilization reports for those setups
|
|
can be found in the assets of the [Implementation Workflow](https://github.com/stnolting/neorv32-setups/actions/workflows/Implementation.yml).
|
|
|
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
|
|
|
|
|
|
* on-chip debugger ([OCD](https://stnolting.github.io/neorv32/#_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**
|
|
|
## 3. NEORV32 CPU Features
|
|
|
|
The NEORV32 CPU implements the RISC-V 32-bit `rv32i` ISA with optional extensions (see below). It is compatible to subsets of the
|
|
*Unprivileged ISA Specification* [(Version 2.2)](https://github.com/stnolting/neorv32/blob/main/docs/references/riscv-spec.pdf)
|
|
and the *Privileged Architecture Specification* [(Version 1.12)](https://github.com/stnolting/neorv32/blob/main/docs/references/riscv-privileged.pdf).
|
|
Compatibility is checked by passing the [official RISC-V architecture tests](https://github.com/riscv/riscv-arch-test).
|
|
|
|
The core is a little-endian Von-Neumann machine implemented as multi-cycle architecture.
|
|
However, the CPU's_front end (instruction fetch) and back end (instruction execution) can work independently to increase performance.
|
|
Currently, two privilege levels "machine-mode" and optional "user-mode" are supported. The CPU implements all three standard RISC-V machine
|
|
interrupts (MTI, MEI, MSI) plus 16 _fast interrupt requests_ as custom extensions.
|
|
It also supports **all** standard RISC-V exceptions (instruction/load/store misaligned address & bus access fault, illegal
|
|
instruction, breakpoint, environment calls).
|
|
|
|
:books: In-depth detailed information regarding the CPU can be found in the
|
|
[_Data Sheet: NEORV32 Central Processing Unit_](https://stnolting.github.io/neorv32/#_neorv32_central_processing_unit_cpu).
|
|
|
|
|
:warning: The `B`, `Zfinx` and `Zmmul` RISC-V ISA extensions are frozen and officially ratified but there is no
|
### Available ISA Extensions
|
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.
|
The following _optional_ RISC-V-compatible and NEORV32-specific ISA extensions are available (linked to the according
|
|
documentation section):
|
|
|
|
**RV32
|
|
[[`I`](https://stnolting.github.io/neorv32/#_i_base_integer_isa)/
|
|
[`E`](https://stnolting.github.io/neorv32/#_e_embedded_cpu)]
|
|
[[`A`](https://stnolting.github.io/neorv32/#_a_atomic_memory_access)]
|
|
[[`B`](https://stnolting.github.io/neorv32/#_b_bit_manipulation_operations)]
|
|
[[`C`](https://stnolting.github.io/neorv32/#_c_compressed_instructions)]
|
|
[[`M`](https://stnolting.github.io/neorv32/#_m_integer_multiplication_and_division)]
|
|
[[`U`](https://stnolting.github.io/neorv32/#_u_less_privileged_user_mode)]
|
|
[[`X`](https://stnolting.github.io/neorv32/#_x_neorv32_specific_custom_extensions)]
|
|
[[`Zfinx`](https://stnolting.github.io/neorv32/#_zfinx_single_precision_floating_point_operations)]
|
|
[[`Zicsr`](https://stnolting.github.io/neorv32/#_zicsr_control_and_status_register_access_privileged_architecture)]
|
|
[[`Zicntr`](https://stnolting.github.io/neorv32/#_zicntr_cpu_base_counters)]
|
|
[[`Zihpm`](https://stnolting.github.io/neorv32/#_zihpm_hardware_performance_monitors)]
|
|
[[`Zifencei`](https://stnolting.github.io/neorv32/#_zifencei_instruction_stream_synchronization)]
|
|
[[`Zmmul`](https://stnolting.github.io/neorv32/#_zmmul_integer_multiplication)]
|
|
[[`Zxcfu`](https://stnolting.github.io/neorv32/#_zxcfu_custom_instructions_extension_cfu)]
|
|
[[`PMP`](https://stnolting.github.io/neorv32/#_pmp_physical_memory_protection)]
|
|
[[`DEBUG`](https://stnolting.github.io/neorv32/#_cpu_debug_mode)]**
|
|
|
|
:warning: The `B`, `Zfinx` and `Zmmul` RISC-V are frozen and officially ratified but there is no
|
|
upstream gcc support yet. To circumvent this, the NEORV32 software framework provides _intrinsic libraries_ for the
|
|
`B` and `Zfinx` extensions.
|
|
|
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
|
|
|
|
### FPGA Implementation Results - CPU
|
## 3. FPGA Implementation Results
|
|
|
Implementation results for _exemplary_ CPU configuration generated for an **Intel Cyclone IV E** `EP4CE22F17C6` FPGA
|
Implementation results for exemplary **CPU-only** configuration generated for an Intel Cyclone IV E `EP4CE22F17C6` FPGA
|
using **Intel Quartus Prime Lite 21.1** (no timing constrains, _balanced optimization_, f_max from _Slow 1200mV 0C Model_).
|
using Intel Quartus Prime Lite 21.1 (no timing constrains, _balanced optimization_, f_max from _Slow 1200mV 0C Model_).
|
|
|
| CPU Configuration (version [1.6.8.3](https://github.com/stnolting/neorv32/blob/main/CHANGELOG.md)) | LEs | FFs | Memory bits | DSPs | f_max |
|
| CPU Configuration (version [1.6.9.8](https://github.com/stnolting/neorv32/blob/main/CHANGELOG.md)) | LEs | FFs | Memory bits | DSPs | f_max |
|
|:------------------------|:----:|:----:|:----:|:-:|:-------:|
|
|:------------------------|:----:|:----:|:----:|:-:|:-------:|
|
| `rv32i_Zicsr` | 1425 | 673 | 1024 | 0 | 118 MHz |
|
| `rv32i_Zicsr` | 1328 | 678 | 1024 | 0 | 128 MHz |
|
| `rv32i_Zicsr_Zicntr` | 1778 | 803 | 1024 | 0 | 118 MHz |
|
| `rv32i_Zicsr_Zicntr` | 1614 | 808 | 1024 | 0 | 128 MHz |
|
| `rv32imac_Zicsr_Zicntr` | 2453 | 994 | 1024 | 0 | 118 MHz |
|
| `rv32imac_Zicsr_Zicntr` | 2338 | 992 | 1024 | 0 | 128 MHz |
|
|
|
:bulb: An incremental list of the CPUs ISA extension's hardware utilization can found in the
|
:bulb: An incremental list of the CPUs ISA extension's hardware utilization can found in the
|
[_Data Sheet: FPGA Implementation Results - CPU_](https://stnolting.github.io/neorv32/#_cpu).
|
[_Data Sheet: FPGA Implementation Results - CPU_](https://stnolting.github.io/neorv32/#_cpu).
|
|
|
|
The hardware resources used by a specific **full-processor** setup is defined by the implemented CPU extensions,
|
|
the configuration of the peripheral modules and some "glue logic".
|
|
Section [_FPGA Implementation Results - Processor Modules_](https://stnolting.github.io/neorv32/#_processor_modules)
|
|
of the online datasheet shows the resource utilization of each optional processor module to allow an
|
|
estimation of the actual setup's hardware requirements.
|
|
|
|
:bulb: The [`neorv32-setups`](https://github.com/stnolting/neorv32-setups) repository provides exemplary FPGA
|
|
setups targeting various FPGA boards and toolchains. The latest bitstreams and utilization reports for those setups
|
|
can be found in the assets of the [Implementation Workflow](https://github.com/stnolting/neorv32-setups/actions/workflows/Implementation.yml).
|
|
|
|
:bulb: 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](https://stnolting.github.io/neorv32/ug/#_application_specific_processor_configuration)
|
|
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
|
|
|
|
### Performance
|
## 4. Performance
|
|
|
The NEORV32 CPU is based on a two-stages pipeline architecture (fetch and execute).
|
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
|
The average CPI (cycles per instruction) depends on the instruction mix of a specific applications and also on the
|
available CPU extensions.
|
available CPU extensions.
|
|
|
The following table shows the performance results (scores and average CPI) for exemplary CPU configurations (no caches) executing
|
The following table shows the performance results (scores and average CPI) for exemplary CPU configurations (no caches) executing
|
2000 iterations of the [CoreMark](https://github.com/stnolting/neorv32/blob/main/sw/example/coremark) CPU benchmark
|
2000 iterations of the [CoreMark](https://github.com/stnolting/neorv32/blob/main/sw/example/coremark) CPU benchmark
|
(using plain GCC10 rv32i built-in libraries only!).
|
(using plain GCC10 rv32i built-in libraries only!).
|
|
|
| CPU Configuration (version [1.5.7.10](https://github.com/stnolting/neorv32/blob/main/CHANGELOG.md)) | CoreMark Score | CoreMarks/MHz | Average CPI |
|
| CPU Configuration (version [1.5.7.10](https://github.com/stnolting/neorv32/blob/main/CHANGELOG.md)) | CoreMark Score | CoreMarks/MHz | Average CPI |
|
|:------------------------------------------------|:-----:|:----------:|:--------:|
|
|:------------------------------------------------|:-----:|:----------:|:--------:|
|
| _small_ (`rv32i_Zicsr`) | 33.89 | **0.3389** | **4.04** |
|
| _small_ (`rv32i_Zicsr`) | 33.89 | **0.3389** | **4.04** |
|
| _medium_ (`rv32imc_Zicsr`) | 62.50 | **0.6250** | **5.34** |
|
| _medium_ (`rv32imc_Zicsr`) | 62.50 | **0.6250** | **5.34** |
|
| _performance_ (`rv32imc_Zicsr` + perf. options) | 95.23 | **0.9523** | **3.54** |
|
| _performance_ (`rv32imc_Zicsr` + perf. options) | 95.23 | **0.9523** | **3.54** |
|
|
|
:bulb: More information regarding the CPU performance can be found in the
|
:bulb: More information regarding the CPU performance can be found in the
|
[_Data Sheet: CPU Performance_](https://stnolting.github.io/neorv32/#_cpu_performance).
|
[_Data Sheet: CPU Performance_](https://stnolting.github.io/neorv32/#_cpu_performance).
|
|
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
|
|
|
|
|
|
## 4. Software Framework and Tooling
|
## 5. Software Framework and Tooling
|
|
|
* [core libraries](https://github.com/stnolting/neorv32/tree/main/sw/lib) for high-level usage of the provided functions and peripherals
|
* [core libraries](https://github.com/stnolting/neorv32/tree/main/sw/lib) for high-level usage of the provided functions and peripherals
|
* application compilation based on GNU makefiles
|
* application compilation based on GNU makefiles
|
* gcc-based toolchain ([pre-compiled toolchains available](https://github.com/stnolting/riscv-gcc-prebuilt))
|
* gcc-based toolchain ([pre-compiled toolchains available](https://github.com/stnolting/riscv-gcc-prebuilt))
|
* [SVD file](https://github.com/stnolting/neorv32/tree/main/sw/svd) for advanced debugging and IDE integration
|
* [SVD file](https://github.com/stnolting/neorv32/tree/main/sw/svd) for advanced debugging and IDE integration
|
* bootloader with UART interface console
|
* bootloader with UART interface console
|
* runtime environment for handling traps
|
* runtime environment for handling traps
|
* several [example programs](https://github.com/stnolting/neorv32/tree/main/sw/example) to get started including CoreMark, FreeRTOS and Conway's Game of Life
|
* several [example programs](https://github.com/stnolting/neorv32/tree/main/sw/example) to get started including CoreMark, FreeRTOS and Conway's Game of Life
|
* doxygen-based documentation, available on [GitHub pages](https://stnolting.github.io/neorv32/sw/files.html)
|
* doxygen-based documentation, available on [GitHub pages](https://stnolting.github.io/neorv32/sw/files.html)
|
* supports implementation using open source tooling ([GHDL](https://github.com/ghdl/ghdl), Yosys, nextpnr, ...) - both, software and hardware can be
|
* supports implementation using open source tooling ([GHDL](https://github.com/ghdl/ghdl), Yosys, nextpnr, ...) - both, software and hardware can be
|
developed and debugged with open source tooling
|
developed and debugged with open source tooling
|
* [continuous integration](https://github.com/stnolting/neorv32/actions) is available for:
|
* [continuous integration](https://github.com/stnolting/neorv32/actions) is available for:
|
* allowing users to see the expected execution/output of the tools
|
* allowing users to see the expected execution/output of the tools
|
* ensuring specification compliance
|
* ensuring specification compliance
|
* catching regressions
|
* catching regressions
|
* providing ready-to-use and up-to-date bitstreams and documentation
|
* providing ready-to-use and up-to-date bitstreams and documentation
|
|
|
:books: Want to know more? Check out [_Data Sheet: Software Framework_](https://stnolting.github.io/neorv32/#_software_framework).
|
:books: Want to know more? Check out [_Data Sheet: Software Framework_](https://stnolting.github.io/neorv32/#_software_framework).
|
|
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
|
|
|
|
|
|
## 5. Getting Started
|
## 6. Getting Started
|
|
|
This overview provides some *quick links* to the most important sections of the
|
This overview provides some *quick links* to the most important sections of the
|
[online Data Sheet](https://stnolting.github.io/neorv32) and the
|
[online Data Sheet](https://stnolting.github.io/neorv32) and the
|
[online User Guide](https://stnolting.github.io/neorv32/ug).
|
[online User Guide](https://stnolting.github.io/neorv32/ug).
|
|
|
### :electric_plug: Hardware Overview
|
### :electric_plug: Hardware Overview
|
|
|
* [Rationale](https://stnolting.github.io/neorv32/#_rationale) - NEORV32: why? how come? what for?
|
* [Rationale](https://stnolting.github.io/neorv32/#_rationale) - NEORV32: why? how come? what for?
|
|
|
* [NEORV32 Processor](https://stnolting.github.io/neorv32/#_neorv32_processor_soc) - the SoC
|
* [NEORV32 Processor](https://stnolting.github.io/neorv32/#_neorv32_processor_soc) - the SoC
|
* [Top Entity - Signals](https://stnolting.github.io/neorv32/#_processor_top_entity_signals) - how to connect to the processor
|
* [Top Entity - Signals](https://stnolting.github.io/neorv32/#_processor_top_entity_signals) - how to connect to the processor
|
* [Top Entity - Generics](https://stnolting.github.io/neorv32/#_processor_top_entity_generics) - configuration options
|
* [Top Entity - Generics](https://stnolting.github.io/neorv32/#_processor_top_entity_generics) - configuration options
|
* [Address Space](https://stnolting.github.io/neorv32/#_address_space) - memory layout and boot configuration
|
* [Address Space](https://stnolting.github.io/neorv32/#_address_space) - memory layout and boot configuration
|
* [SoC Modules](https://stnolting.github.io/neorv32/#_processor_internal_modules) - available peripheral modules and memories
|
* [SoC Modules](https://stnolting.github.io/neorv32/#_processor_internal_modules) - available peripheral modules and memories
|
* [On-Chip Debugger](https://stnolting.github.io/neorv32/#_on_chip_debugger_ocd) - online & in-system debugging of the processor via JTAG
|
* [On-Chip Debugger](https://stnolting.github.io/neorv32/#_on_chip_debugger_ocd) - online & in-system debugging of the processor via JTAG
|
|
|
* [NEORV32 CPU](https://stnolting.github.io/neorv32/#_neorv32_central_processing_unit_cpu) - the CPU
|
* [NEORV32 CPU](https://stnolting.github.io/neorv32/#_neorv32_central_processing_unit_cpu) - the CPU
|
* [RISC-V compatibility](https://stnolting.github.io/neorv32/#_risc_v_compatibility) - what is compatible to the specs. and what is not
|
* [RISC-V compatibility](https://stnolting.github.io/neorv32/#_risc_v_compatibility) - what is compatible to the specs. and what is not
|
* [Full Virtualization](https://stnolting.github.io/neorv32/#_full_virtualization) - hardware execution safety
|
* [Full Virtualization](https://stnolting.github.io/neorv32/#_full_virtualization) - hardware execution safety
|
* [ISA and Extensions](https://stnolting.github.io/neorv32/#_instruction_sets_and_extensions) - available RISC-V ISA extensions
|
* [ISA and Extensions](https://stnolting.github.io/neorv32/#_instruction_sets_and_extensions) - available RISC-V ISA extensions
|
* [CSRs](https://stnolting.github.io/neorv32/#_control_and_status_registers_csrs) - control and status registers
|
* [CSRs](https://stnolting.github.io/neorv32/#_control_and_status_registers_csrs) - control and status registers
|
* [Traps](https://stnolting.github.io/neorv32/#_traps_exceptions_and_interrupts) - interrupts and exceptions
|
* [Traps](https://stnolting.github.io/neorv32/#_traps_exceptions_and_interrupts) - interrupts and exceptions
|
|
|
### :floppy_disk: Software Overview
|
### :floppy_disk: Software Overview
|
|
|
* [Example Programs](https://github.com/stnolting/neorv32/tree/main/sw/example) - test program execution on your setup
|
* [Example Programs](https://github.com/stnolting/neorv32/tree/main/sw/example) - test program execution on your setup
|
* [Core Libraries](https://stnolting.github.io/neorv32/#_core_libraries) - high-level functions for accessing the processor's peripherals
|
* [Core Libraries](https://stnolting.github.io/neorv32/#_core_libraries) - high-level functions for accessing the processor's peripherals
|
* [Software Framework Documentation](https://stnolting.github.io/neorv32/sw/files.html) - _doxygen_-based documentation
|
* [Software Framework Documentation](https://stnolting.github.io/neorv32/sw/files.html) - _doxygen_-based documentation
|
* [Application Makefiles](https://stnolting.github.io/neorv32/#_application_makefile) - turning your application into an executable
|
* [Application Makefiles](https://stnolting.github.io/neorv32/#_application_makefile) - turning your application into an executable
|
* [Bootloader](https://stnolting.github.io/neorv32/#_bootloader) - the build-in NEORV32 bootloader
|
* [Bootloader](https://stnolting.github.io/neorv32/#_bootloader) - the build-in NEORV32 bootloader
|
|
|
### :rocket: User Guide
|
### :rocket: User Guide
|
|
|
* [Toolchain Setup](https://stnolting.github.io/neorv32/ug/#_software_toolchain_setup) - install and setup RISC-V gcc
|
* [Toolchain Setup](https://stnolting.github.io/neorv32/ug/#_software_toolchain_setup) - install and setup RISC-V gcc
|
* [General Hardware Setup](https://stnolting.github.io/neorv32/ug/#_general_hardware_setup) - setup a new NEORV32 EDA project
|
* [General Hardware Setup](https://stnolting.github.io/neorv32/ug/#_general_hardware_setup) - setup a new NEORV32 EDA project
|
* [General Software Setup](https://stnolting.github.io/neorv32/ug/#_general_software_framework_setup) - configure the software framework
|
* [General Software Setup](https://stnolting.github.io/neorv32/ug/#_general_software_framework_setup) - configure the software framework
|
* [Application Compilation](https://stnolting.github.io/neorv32/ug/#_application_program_compilation) - compile an application using "make"
|
* [Application Compilation](https://stnolting.github.io/neorv32/ug/#_application_program_compilation) - compile an application using "make"
|
* [Upload via Bootloader](https://stnolting.github.io/neorv32/ug/#_uploading_and_starting_of_a_binary_executable_image_via_uart) - upload and execute executables
|
* [Upload via Bootloader](https://stnolting.github.io/neorv32/ug/#_uploading_and_starting_of_a_binary_executable_image_via_uart) - upload and execute executables
|
* [Application-Specific Processor Configuration](https://stnolting.github.io/neorv32/ug/#_application_specific_processor_configuration) - tailor the processor to your needs
|
* [Application-Specific Processor Configuration](https://stnolting.github.io/neorv32/ug/#_application_specific_processor_configuration) - tailor the processor to your needs
|
* [Adding Custom Hardware Modules](https://stnolting.github.io/neorv32/ug/#_adding_custom_hardware_modules) - add _your_ custom hardware
|
* [Adding Custom Hardware Modules](https://stnolting.github.io/neorv32/ug/#_adding_custom_hardware_modules) - add _your_ custom hardware
|
* [Debugging via the On-Chip Debugger](https://stnolting.github.io/neorv32/ug/#_debugging_using_the_on_chip_debugger) - step through code *online* and *in-system*
|
* [Debugging via the On-Chip Debugger](https://stnolting.github.io/neorv32/ug/#_debugging_using_the_on_chip_debugger) - step through code *online* and *in-system*
|
* [Simulation](https://stnolting.github.io/neorv32/ug/#_simulating_the_processor) - simulate the whole SoC
|
* [Simulation](https://stnolting.github.io/neorv32/ug/#_simulating_the_processor) - simulate the whole SoC
|
* [Hello World!](https://stnolting.github.io/neorv32/ug/index.html#_hello_world) - run a quick _"hello world"_ simulation
|
* [Hello World!](https://stnolting.github.io/neorv32/ug/index.html#_hello_world) - run a quick _"hello world"_ simulation
|
|
|
### :copyright: Legal
|
### :copyright: Legal
|
|
|
[![license](https://img.shields.io/github/license/stnolting/neorv32?longCache=true&style=flat)](https://github.com/stnolting/neorv32/blob/main/LICENSE)
|
[![license](https://img.shields.io/github/license/stnolting/neorv32?longCache=true&style=flat)](https://github.com/stnolting/neorv32/blob/main/LICENSE)
|
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5018888.svg)](https://doi.org/10.5281/zenodo.5018888)
|
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5018888.svg)](https://doi.org/10.5281/zenodo.5018888)
|
|
|
* [Overview](https://stnolting.github.io/neorv32/#_legal) - license, disclaimer, limitation of liability for external links, proprietary notice, ...
|
* [Overview](https://stnolting.github.io/neorv32/#_legal) - license, disclaimer, limitation of liability for external links, proprietary notice, ...
|
* [Citing](https://stnolting.github.io/neorv32/#_citing) - citing information
|
* [Citing](https://stnolting.github.io/neorv32/#_citing) - citing information
|
* [Impressum](https://github.com/stnolting/neorv32/blob/main/docs/impressum.md) - imprint
|
|
|
|
This is an open-source project that is free of charge. Use this project in any way you like
|
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](https://github.com/stnolting/neorv32/blob/main/LICENSE)).
|
(as long as it complies to the permissive [license](https://github.com/stnolting/neorv32/blob/main/LICENSE)).
|
Please quote it appropriately. :+1:
|
Please quote it appropriately. :+1:
|
|
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
|
|
|
|
---------------------------------------
|
---------------------------------------
|
|
|
**:heart: A big shout-out goes to the community and all the [contributors](https://github.com/stnolting/neorv32/graphs/contributors), who helped improving this project!**
|
**:heart: A big shout-out goes to the community and all the [contributors](https://github.com/stnolting/neorv32/graphs/contributors), who helped improving this project!**
|
|
|