| Line 1... |
Line 1... |
[](https://stnolting.github.io/neorv32)
|
|
[](https://github.com/stnolting/neorv32/actions?query=workflow%3ADocumentation)
|
|
\
|
|
[](https://github.com/stnolting/neorv32/actions?query=workflow%3Ariscv-arch-test)
|
|
[](https://github.com/stnolting/neorv32/actions?query=workflow%3AProcessor)
|
|
[](https://github.com/stnolting/neorv32/actions?query=workflow%3AImplementation)
|
|
[](https://github.com/stnolting/neorv32/actions?query=workflow%3AWindows)
|
|
|
|
[](https://github.com/stnolting/neorv32)
|
[](https://github.com/stnolting/neorv32)
|
|
|
# The NEORV32 RISC-V Processor
|
# The NEORV32 RISC-V Processor
|
|
|
[](https://github.com/stnolting/neorv32/blob/master/LICENSE)
|
|
[](https://github.com/stnolting/neorv32/releases)
|
|
[](https://doi.org/10.5281/zenodo.5018888)
|
|
\
|
|
[](https://github.com/stnolting/neorv32/releases/tag/nightly)
|
[](https://github.com/stnolting/neorv32/releases/tag/nightly)
|
[](https://stnolting.github.io/neorv32)
|
[](https://stnolting.github.io/neorv32)
|
[](https://github.com/stnolting/neorv32/releases/tag/nightly)
|
[](https://github.com/stnolting/neorv32/releases/tag/nightly)
|
[](https://stnolting.github.io/neorv32/ug)
|
[](https://stnolting.github.io/neorv32/ug)
|
[](https://stnolting.github.io/neorv32/sw/files.html)
|
[](https://stnolting.github.io/neorv32/sw/files.html)
|
[](https://gitter.im/neorv32/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
[](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)
|
1. [Key Features](#Project-Key-Features)
|
* [Key Features](#Project-Key-Features)
|
|
* [Status](#status)
|
2. [Processor/SoC Features](#2-NEORV32-Processor-Features)
|
2. [Processor/SoC Features](#2-NEORV32-Processor-Features)
|
1. [FPGA Implementation Results](#FPGA-Implementation-Results---Processor)
|
* [FPGA Implementation Results](#FPGA-Implementation-Results---Processor)
|
3. [CPU Features](#3-NEORV32-CPU-Features)
|
3. [CPU Features](#3-NEORV32-CPU-Features)
|
1. [Available ISA Extensions](#Available-ISA-Extensions)
|
* [Available ISA Extensions](#Available-ISA-Extensions)
|
2. [FPGA Implementation Results](#FPGA-Implementation-Results---CPU)
|
* [FPGA Implementation Results](#FPGA-Implementation-Results---CPU)
|
3. [Performance](#Performance)
|
* [Performance](#Performance)
|
4. [Software Framework & Tooling](#4-Software-Framework-and-Tooling)
|
4. [Software Framework & Tooling](#4-Software-Framework-and-Tooling)
|
5. [**Getting Started**](#5-Getting-Started) :rocket:
|
5. [**Getting Started**](#5-Getting-Started) :rocket:
|
|
|
|
|
|
|
## 1. Overview
|
## 1. Overview
|
|
|
|
|
|
|
The NEORV32 Processor is a customizable microcontroller-like system on chip (SoC) that is based on the RISC-V NEORV32 CPU.
|
The NEORV32 Processor is a **customizable microcontroller-like system on chip (SoC)** that is based on the RISC-V 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 / customizable microcontroller.
|
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 hardware exceptions.
|
are executed. Whenever an unexpected situation occurs the application code is informed via precise and resumable hardware exceptions.
|
|
|
:thinking: Want to know more? Check out the [project's rationale](https://stnolting.github.io/neorv32/#_rationale).
|
:thinking: 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 documentation (online at GitHub-pages)](https://stnolting.github.io/neorv32/).
|
:books: For detailed information take a look at the [NEORV32 documentation](https://stnolting.github.io/neorv32/) (online at GitHub-pages).
|
The *doxygen*-based documentation of the *software framework* is also available online
|
|
at [GitHub-pages](https://stnolting.github.io/neorv32/sw/files.html).
|
|
|
|
:label: The project's change log is available in [`CHANGELOG.md`](https://github.com/stnolting/neorv32/blob/master/CHANGELOG.md).
|
:label: The project's change log is available in [`CHANGELOG.md`](https://github.com/stnolting/neorv32/blob/master/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: The [`setups`](https://github.com/stnolting/neorv32/tree/master/setups) folder provides exemplary setups targeting
|
:package: [Exemplary setups](https://github.com/stnolting/neorv32/tree/master/setups) targeting
|
various FPGA boards and toolchains to get you started. Several example programs (including a FreeRTOS port) to be run on your setup
|
various FPGA boards and toolchains to get you started.
|
can be found in [`sw/example`](https://github.com/stnolting/neorv32/tree/master/sw/example).
|
|
|
|
:kite: Supported by upstream [Zephyr OS](https://docs.zephyrproject.org/latest/boards/riscv/neorv32/doc/index.html).
|
: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/master/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: [CPU](#3-NEORV32-CPU-Features) plus [SoC](#2-NEORV32-Processor-Features) plus [Software Framework & Tooling](#4-Software-Framework-and-Tooling)
|
- [x] all-in-one package: [CPU](#3-NEORV32-CPU-Features) plus [SoC](#2-NEORV32-Processor-Features) plus [Software Framework & Tooling](#4-Software-Framework-and-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] fully synchronous design, no latches, no gated clocks
|
- [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 – but with a reasonable size-performance trade-off:
|
- [x] from zero to *printf("hello world!");* - completely open source and documented
|
the processor (CPU _including_ privileged architecture) fits into a Lattice iCE40 UltraPlus 5k low-power FPGA running at 24 MHz
|
|
- [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*
|
|
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
|
|
|
|
### Status
|
|
|
|
[](https://github.com/stnolting/neorv32/releases)
|
|
[](https://stnolting.github.io/neorv32)
|
|
[](https://github.com/stnolting/neorv32/actions?query=workflow%3ADocumentation)
|
|
\
|
|
[](https://github.com/stnolting/neorv32/actions?query=workflow%3Ariscv-arch-test)
|
|
[](https://github.com/stnolting/neorv32/actions?query=workflow%3AProcessor)
|
|
[](https://github.com/stnolting/neorv32/actions?query=workflow%3AImplementation)
|
|
[](https://github.com/stnolting/neorv32/actions?query=workflow%3AWindows)
|
|
|
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
|
|
|
|
## 2. NEORV32 Processor Features
|
## 2. NEORV32 Processor Features
|
|
|
The NEORV32 Processor (top entity: [`rtl/core/neorv32_top.vhd`](https://github.com/stnolting/neorv32/blob/master/rtl/core/neorv32_top.vhd))
|
The NEORV32 Processor (top entity: [`rtl/core/neorv32_top.vhd`](https://github.com/stnolting/neorv32/blob/master/rtl/core/neorv32_top.vhd))
|
| Line 102... |
Line 98... |
|
|
* 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))
|
|
|
**IO**
|
**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 / I²C](https://stnolting.github.io/neorv32/#_two_wire_serial_interface_controller_twi))
|
[TWI / I²C](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 drive _NeoPixel(TM)_ LEDs
|
* smart LED interface ([NEOLED](https://stnolting.github.io/neorv32/#_smart_led_interface_neoled)) to directly drive _NeoPixel(TM)_ LEDs
|
|
|
**SoC Connectivity and Integration**
|
**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/master/rtl/system_integration/neorv32_SystemTop_axi4lite.vhd) for AXI4-Lite master interface
|
* [wrapper](https://github.com/stnolting/neorv32/blob/master/rtl/system_integration/neorv32_SystemTop_axi4lite.vhd) for AXI4-Lite master interface
|
* [wrapper](https://github.com/stnolting/neorv32/blob/master/rtl/system_integration/neorv32_SystemTop_AvalonMM.vhd) for Avalon-MM master interface
|
* [wrapper](https://github.com/stnolting/neorv32/blob/master/rtl/system_integration/neorv32_SystemTop_AvalonMM.vhd) for Avalon-MM master interface
|
| Line 145... |
Line 141... |
the configuration of the peripheral modules and some "glue logic".
|
the configuration of the peripheral modules and some "glue logic".
|
Section [_FPGA Implementation Results - Processor Modules_](https://stnolting.github.io/neorv32/#_processor_modules)
|
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
|
of the online datasheet shows the resource utilization of each optional processor module to allow an
|
estimation of the actual setup's hardware requirements.
|
estimation of the actual setup's hardware requirements.
|
|
|
:information_source: The [`setups`](https://github.com/stnolting/neorv32/tree/master/setups) folder provides exemplary FPGA
|
The [`setups`](https://github.com/stnolting/neorv32/tree/master/setups) folder provides exemplary FPGA
|
setups targeting various FPGA boards and toolchains. These setups also provide resource utilization reports for different
|
setups targeting various FPGA boards and toolchains. These setups also provide resource utilization reports for different
|
SoC configurations
|
SoC configurations. The latest utilization reports for those setups can be found in the report of the
|
|
[Implementation Workflow](https://github.com/stnolting/neorv32/actions/workflows/Implementation.yml).
|
|
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
|
|
|
|
|
|
| Line 197... |
Line 194... |
[[`Zmmul`](https://stnolting.github.io/neorv32/#_zmmul_integer_multiplication)]
|
[[`Zmmul`](https://stnolting.github.io/neorv32/#_zmmul_integer_multiplication)]
|
[[`PMP`](https://stnolting.github.io/neorv32/#_pmp_physical_memory_protection)]
|
[[`PMP`](https://stnolting.github.io/neorv32/#_pmp_physical_memory_protection)]
|
[[`DEBUG`](https://stnolting.github.io/neorv32/#_cpu_debug_mode)]**
|
[[`DEBUG`](https://stnolting.github.io/neorv32/#_cpu_debug_mode)]**
|
|
|
:warning: The `B`, `Zfinx` and `Zmmul` RISC-V extensions are frozen but not officially ratified yet. Hence, there is no
|
:warning: The `B`, `Zfinx` and `Zmmul` RISC-V extensions are frozen but not officially ratified yet. Hence, there is no
|
upstream gcc support. To circumvent this, the NEORV32 software framework provides _intrinsic_ libraries for these extensions.
|
upstream gcc support. To circumvent this, the NEORV32 software framework provides _intrinsic libraries_ for these extensions.
|
|
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
|
|
|
|
### FPGA Implementation Results - CPU
|
### FPGA Implementation Results - CPU
|
|
|
Implementation results for _exemplary_ CPU configuration generated for an **Intel Cyclone IV EP4CE22F17C6N FPGA**
|
Implementation results for _exemplary_ CPU configuration generated for an **Intel Cyclone IV EP4CE22F17C6N FPGA**
|
using **Intel Quartus Prime Lite 20.1** ("balanced implementation"). The timing information is derived
|
using **Intel Quartus Prime Lite 20.1** ("balanced implementation, Slow 1200mV 0C Model").
|
from the Timing Analyzer / Slow 1200mV 0C Model. No constraints were used at all.
|
|
|
|
Results generated for hardware version [`1.5.7.10`](https://github.com/stnolting/neorv32/blob/master/CHANGELOG.md).
|
| CPU Configuration (version [1.5.7.10](https://github.com/stnolting/neorv32/blob/master/CHANGELOG.md)) | LEs | FFs | Memory bits | DSPs (9-bit) | f_max |
|
|
|:------------------------|:----:|:----:|:----:|:-:|:-------:|
|
| CPU Configuration | LEs | FFs | Memory bits | DSPs (9-bit) | f_max |
|
|
|:--------------------------------------------------|:----:|:----:|:-----------:|:------------:|:-------:|
|
|
| `rv32i` | 806 | 359 | 1024 | 0 | 125 MHz |
|
| `rv32i` | 806 | 359 | 1024 | 0 | 125 MHz |
|
| `rv32i_Zicsr_Zicntr` | 1729 | 813 | 1024 | 0 | 124 MHz |
|
| `rv32i_Zicsr_Zicntr` | 1729 | 813 | 1024 | 0 | 124 MHz |
|
| `rv32imac_Zicsr_Zicntr` | 2511 | 1074 | 1024 | 0 | 124 MHz |
|
| `rv32imac_Zicsr_Zicntr` | 2511 | 1074 | 1024 | 0 | 124 MHz |
|
|
|
:information_source: An incremental list of CPU extension's hardware utilization can found in the
|
:information_source: An incremental list of CPU 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).
|
|
|
:information_source: The CPU (and also the SoC) provides advanced options to optimize for performance, area or energy.
|
:information_source: The CPU and SoC provide advanced options to optimize for performance, area or energy.
|
See [_User Guide: Application-Specific Processor Configuration_](https://stnolting.github.io/neorv32/ug/#_application_specific_processor_configuration)
|
See [_User Guide: Application-Specific Processor Configuration_](https://stnolting.github.io/neorv32/ug/#_application_specific_processor_configuration)
|
for more information.
|
for more information.
|
|
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
|
|
|
|
### Performance
|
### Performance
|
|
|
The NEORV32 CPU is based on a two-stages pipelined architecture. Since both stage use a multi-cycle processing scheme,
|
The NEORV32 CPU is based on a two-stages pipeline architecture (fetch and execute).
|
each instruction requires several clock cycles to execute (2 cycles for ALU operations, up to 40 cycles for divisions).
|
|
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 (relative CoreMark score and average cycles per instruction) for
|
The following table shows the performance results (scores and average CPI) for _exemplary_ CPU configurations executing
|
_exemplary_ CPU configuration running 2000 iterations of the CoreMark CPU benchmark.
|
2000 iterations of the [CoreMark](https://github.com/stnolting/neorv32/blob/master/sw/example/coremark) CPU benchmark.
|
The source files are available in [`sw/example/coremark`](https://github.com/stnolting/neorv32/blob/master/sw/example/coremark).
|
|
A simple(!) port of the **Dhrystone** benchmark is also available in
|
|
[`sw/example/dhrystone`](https://github.com/stnolting/neorv32/blob/master/sw/example/dhrystone).
|
|
|
|
Results generated for hardware version [`1.5.7.10`](https://github.com/stnolting/neorv32/blob/master/CHANGELOG.md).
|
|
|
|
| CPU Configuration | CoreMark Score | CoreMarks/MHz | Average CPI |
|
| CPU Configuration (version [1.5.7.10](https://github.com/stnolting/neorv32/blob/master/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** |
|
|
|
:information_source: More information regarding the CPU performance can be found in the
|
:information_source: More information regarding the CPU performance can be found in the
|
| Line 256... |
Line 244... |
|
|
|
|
|
|
## 4. Software Framework and Tooling
|
## 4. Software Framework and Tooling
|
|
|
:books: In-depth detailed information regarding the software framework can be found in the
|
|
[_Data Sheet: Software Framework_](https://stnolting.github.io/neorv32/#_software_framework).
|
|
|
|
* [core libraries](https://github.com/stnolting/neorv32/tree/master/sw/lib) for high-level usage of the provided functions and peripherals
|
* [core libraries](https://github.com/stnolting/neorv32/tree/master/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/master/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/master/sw/example) to get started including CoreMark, FreeRTOS and Conway's Game of Life
|
* several [example programs](https://github.com/stnolting/neorv32/tree/master/sw/example) to get started including CoreMark, FreeRTOS and Conway's Game of Life
|
* `doxygen`-based documentation, available on :books: [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, Yosys and nextpnr; in the future Verilog-to-Routing); both, software and hardware can be
|
* supports implementation using open source tooling (GHDL, Yosys and nextpnr; in the future: "Verilog-to-Routing") - 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) :octocat: 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).
|
|
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
|
|
|
|
|
|
## 5. Getting Started
|
## 5. Getting Started
|
| Line 292... |
Line 280... |
|
|
* [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 IO/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
|
| Line 304... |
Line 292... |
* [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/master/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/#_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
|
| Line 324... |
Line 313... |
* [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
|
|
|
* [Overview](https://stnolting.github.io/neorv32/#_legal) - license, disclaimer, proprietary notice, ...
|
[](https://github.com/stnolting/neorv32/blob/master/LICENSE)
|
* [Citing](https://stnolting.github.io/neorv32/#_citing) - citing information (DOI)
|
[](https://doi.org/10.5281/zenodo.5018888)
|
* [Impressum](https://github.com/stnolting/neorv32/blob/master/docs/impressum.md) - imprint (:de:)
|
|
|
* [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
|
|
* [Impressum](https://github.com/stnolting/neorv32/blob/master/docs/impressum.md) - imprint
|
|
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
|
|
|
|
|
|
## Acknowledgements
|
## Acknowledgements
|
|
|
**A big shout-out to the community and all [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! :heart:**
|
|
|
[RISC-V](https://riscv.org/) - Instruction Sets Want To Be Free!
|
[RISC-V](https://riscv.org/) - Instruction Sets Want To Be Free!
|
|
|
Continuous integration provided by [:octocat: GitHub Actions](https://github.com/features/actions) and powered by [GHDL](https://github.com/ghdl/ghdl).
|
Continuous integration provided by [:octocat: GitHub Actions](https://github.com/features/actions) and powered by [GHDL](https://github.com/ghdl/ghdl).
|
