1 |
74 |
zero_gravi |
[![NEORV32](https://raw.githubusercontent.com/stnolting/neorv32/main/docs/figures/neorv32_logo_front.png)](https://github.com/stnolting/neorv32)
|
2 |
2 |
zero_gravi |
|
3 |
37 |
zero_gravi |
# The NEORV32 RISC-V Processor
|
4 |
|
|
|
5 |
59 |
zero_gravi |
[![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)
|
6 |
60 |
zero_gravi |
[![datasheet (html)](https://img.shields.io/badge/-HTML-ffbd00?longCache=true&style=flat-square)](https://stnolting.github.io/neorv32)
|
7 |
|
|
[![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)
|
8 |
|
|
[![userguide (html)](https://img.shields.io/badge/-HTML-ffbd00?longCache=true&style=flat-square)](https://stnolting.github.io/neorv32/ug)
|
9 |
59 |
zero_gravi |
[![doxygen](https://img.shields.io/badge/doxygen-HTML-ffbd00?longCache=true&style=flat-square&logo=Doxygen)](https://stnolting.github.io/neorv32/sw/files.html)
|
10 |
67 |
zero_gravi |
[![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)
|
11 |
2 |
zero_gravi |
|
12 |
64 |
zero_gravi |
1. [Overview](#1-Overview)
|
13 |
69 |
zero_gravi |
* [Key Features](#Project-Key-Features)
|
14 |
|
|
* [Status](#status)
|
15 |
74 |
zero_gravi |
2. [Features](#2-Features)
|
16 |
|
|
3. [FPGA Implementation Results](#3-FPGA-Implementation-Results)
|
17 |
|
|
4. [Performance](#4-Performance)
|
18 |
|
|
5. [Software Framework & Tooling](#5-Software-Framework-and-Tooling)
|
19 |
|
|
6. [**Getting Started**](#6-Getting-Started) :rocket:
|
20 |
2 |
zero_gravi |
|
21 |
|
|
|
22 |
60 |
zero_gravi |
|
23 |
64 |
zero_gravi |
## 1. Overview
|
24 |
2 |
zero_gravi |
|
25 |
72 |
zero_gravi |
![neorv32 Overview](https://raw.githubusercontent.com/stnolting/neorv32/main/docs/figures/neorv32_processor.png)
|
26 |
54 |
zero_gravi |
|
27 |
71 |
zero_gravi |
The NEORV32 Processor is a **customizable microcontroller-like system on chip (SoC)** that is based on the
|
28 |
|
|
[RISC-V](https://riscv.org/) NEORV32 CPU.
|
29 |
59 |
zero_gravi |
The project is intended as auxiliary processor in larger SoC designs or as *ready-to-go* stand-alone
|
30 |
69 |
zero_gravi |
custom microcontroller that even fits into a Lattice iCE40 UltraPlus 5k low-power FPGA running at 24 MHz.
|
31 |
2 |
zero_gravi |
|
32 |
66 |
zero_gravi |
Special focus is paid on **execution safety** to provide defined and predictable behavior at any time.
|
33 |
|
|
Therefore, the CPU ensures that all memory access are acknowledged and no invalid/malformed instructions
|
34 |
69 |
zero_gravi |
are executed. Whenever an unexpected situation occurs the application code is informed via precise and resumable hardware exceptions.
|
35 |
66 |
zero_gravi |
|
36 |
70 |
zero_gravi |
:interrobang: Want to know more? Check out the [project's rationale](https://stnolting.github.io/neorv32/#_rationale).
|
37 |
61 |
zero_gravi |
|
38 |
72 |
zero_gravi |
:books: For detailed information take a look at the [NEORV32 online documentation](https://stnolting.github.io/neorv32/).
|
39 |
|
|
The latest _pdf_ versions can be found [here](https://github.com/stnolting/neorv32/releases/tag/nightly).
|
40 |
45 |
zero_gravi |
|
41 |
72 |
zero_gravi |
:label: The project's change log is available in [`CHANGELOG.md`](https://github.com/stnolting/neorv32/blob/main/CHANGELOG.md).
|
42 |
69 |
zero_gravi |
To see the changes between _official releases_ visit the project's [release page](https://github.com/stnolting/neorv32/releases).
|
43 |
11 |
zero_gravi |
|
44 |
71 |
zero_gravi |
:package: [**Exemplary setups**](https://github.com/stnolting/neorv32-setups) targeting
|
45 |
69 |
zero_gravi |
various FPGA boards and toolchains to get you started.
|
46 |
56 |
zero_gravi |
|
47 |
69 |
zero_gravi |
:kite: Supported by upstream [Zephyr OS](https://docs.zephyrproject.org/latest/boards/riscv/neorv32/doc/index.html) and FreeRTOS.
|
48 |
65 |
zero_gravi |
|
49 |
59 |
zero_gravi |
:bulb: Feel free to open a [new issue](https://github.com/stnolting/neorv32/issues) or start a
|
50 |
62 |
zero_gravi |
[new discussion](https://github.com/stnolting/neorv32/discussions) if you have questions, comments, ideas or if something is
|
51 |
67 |
zero_gravi |
not working as expected. Or have a chat on our [gitter channel](https://gitter.im/neorv32/community).
|
52 |
72 |
zero_gravi |
See how to [contribute](https://github.com/stnolting/neorv32/blob/main/CONTRIBUTING.md).
|
53 |
47 |
zero_gravi |
|
54 |
68 |
zero_gravi |
:rocket: Check out the [quick links below](#5-Getting-Started) or directly jump to the
|
55 |
60 |
zero_gravi |
[*User Guide*](https://stnolting.github.io/neorv32/ug/) to get started
|
56 |
59 |
zero_gravi |
setting up your NEORV32 setup!
|
57 |
51 |
zero_gravi |
|
58 |
2 |
zero_gravi |
|
59 |
59 |
zero_gravi |
### Project Key Features
|
60 |
15 |
zero_gravi |
|
61 |
70 |
zero_gravi |
- [x] all-in-one package: **CPU** plus **SoC** plus **Software Framework & Tooling**
|
62 |
64 |
zero_gravi |
- [x] completely described in behavioral, platform-independent VHDL - no primitives, macros, etc.
|
63 |
74 |
zero_gravi |
- [x] highly [extensible hardware](https://stnolting.github.io/neorv32/ug/#_comparative_summary) - on CPU, SoC and system level
|
64 |
69 |
zero_gravi |
- [x] be as small as possible while being as RISC-V-compliant as possible
|
65 |
70 |
zero_gravi |
- [x] from zero to `printf("hello world!");` - completely open source and documented
|
66 |
64 |
zero_gravi |
- [x] easy to use even for FPGA/RISC-V starters – intended to work *out of the box*
|
67 |
22 |
zero_gravi |
|
68 |
69 |
zero_gravi |
|
69 |
|
|
### Status
|
70 |
|
|
|
71 |
|
|
[![release](https://img.shields.io/github/v/release/stnolting/neorv32?longCache=true&style=flat-square&logo=GitHub)](https://github.com/stnolting/neorv32/releases)
|
72 |
|
|
[![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)
|
73 |
71 |
zero_gravi |
\
|
74 |
72 |
zero_gravi |
[![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)
|
75 |
74 |
zero_gravi |
[![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)
|
76 |
72 |
zero_gravi |
[![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)
|
77 |
69 |
zero_gravi |
|
78 |
74 |
zero_gravi |
The NEORV32 is fully operational.
|
79 |
|
|
The processor passes the official RISC-V architecture tests, which are checked by the
|
80 |
|
|
[neorv32-verif](https://github.com/stnolting/neorv32-verif) repository. It can successfully run _any_ C program
|
81 |
|
|
(for example from the [`sw/example`](https://github.com/stnolting/neorv32/tree/main/sw/example) folder) including CoreMark
|
82 |
|
|
and can be synthesized for _any_ target technology - tested on Intel, Xilinx and Lattice FPGAs.
|
83 |
|
|
|
84 |
59 |
zero_gravi |
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
85 |
2 |
zero_gravi |
|
86 |
|
|
|
87 |
3 |
zero_gravi |
|
88 |
74 |
zero_gravi |
## 2. Features
|
89 |
2 |
zero_gravi |
|
90 |
74 |
zero_gravi |
The NEORV32 Processor provides a full-featured microcontroller-like SoC build around the NEORV32 CPU.
|
91 |
|
|
By using generics the design is highly configurable and allows a flexible customization to tailor the
|
92 |
|
|
setup according to your needs. The following list shows all available SoC module. Note that all those
|
93 |
|
|
modules are _optional_.
|
94 |
|
|
|
95 |
|
|
**CPU**
|
96 |
|
|
|
97 |
|
|
* 32-bit little-endian RISC-V single-core, pipelined/multi-cycle Von-Neumann architecture
|
98 |
|
|
* configurable ISA extensions
|
99 |
|
|
* `RV32`
|
100 |
|
|
[[`I`](https://stnolting.github.io/neorv32/#_i_base_integer_isa)/
|
101 |
|
|
[`E`](https://stnolting.github.io/neorv32/#_e_embedded_cpu)]
|
102 |
|
|
[[`A`](https://stnolting.github.io/neorv32/#_a_atomic_memory_access)]
|
103 |
|
|
[[`B`](https://stnolting.github.io/neorv32/#_b_bit_manipulation_operations)]
|
104 |
|
|
[[`C`](https://stnolting.github.io/neorv32/#_c_compressed_instructions)]
|
105 |
|
|
[[`M`](https://stnolting.github.io/neorv32/#_m_integer_multiplication_and_division)]
|
106 |
|
|
[[`U`](https://stnolting.github.io/neorv32/#_u_less_privileged_user_mode)]
|
107 |
|
|
[[`X`](https://stnolting.github.io/neorv32/#_x_neorv32_specific_custom_extensions)]
|
108 |
|
|
[[`Zfinx`](https://stnolting.github.io/neorv32/#_zfinx_single_precision_floating_point_operations)]
|
109 |
|
|
[[`Zicsr`](https://stnolting.github.io/neorv32/#_zicsr_control_and_status_register_access_privileged_architecture)]
|
110 |
|
|
[[`Zicntr`](https://stnolting.github.io/neorv32/#_zicntr_cpu_base_counters)]
|
111 |
|
|
[[`Zihpm`](https://stnolting.github.io/neorv32/#_zihpm_hardware_performance_monitors)]
|
112 |
|
|
[[`Zifencei`](https://stnolting.github.io/neorv32/#_zifencei_instruction_stream_synchronization)]
|
113 |
|
|
[[`Zmmul`](https://stnolting.github.io/neorv32/#_zmmul_integer_multiplication)]
|
114 |
|
|
[[`Zxcfu`](https://stnolting.github.io/neorv32/#_zxcfu_custom_instructions_extension_cfu)]
|
115 |
|
|
[[`PMP`](https://stnolting.github.io/neorv32/#_pmp_physical_memory_protection)]
|
116 |
|
|
[[`DEBUG`](https://stnolting.github.io/neorv32/#_cpu_debug_mode)]
|
117 |
|
|
* compatible to subsets of the
|
118 |
|
|
*Unprivileged ISA Specification* [(Version 2.2)](https://github.com/stnolting/neorv32/blob/main/docs/references/riscv-spec.pdf)
|
119 |
|
|
and the *Privileged Architecture Specification* [(Version 1.12)](https://github.com/stnolting/neorv32/blob/main/docs/references/riscv-privileged.pdf).
|
120 |
|
|
* `machine` and `user` modes
|
121 |
|
|
* implements _all_ standard RISC-V exceptions/interrupts (including MTI, MEI & MSI)
|
122 |
|
|
* 16-fast interrupt requests as NEORV32-specific extensions
|
123 |
|
|
|
124 |
60 |
zero_gravi |
**Memory**
|
125 |
2 |
zero_gravi |
|
126 |
60 |
zero_gravi |
* processor-internal data and instruction memories ([DMEM](https://stnolting.github.io/neorv32/#_data_memory_dmem) /
|
127 |
|
|
[IMEM](https://stnolting.github.io/neorv32/#_instruction_memory_imem)) &
|
128 |
|
|
cache ([iCACHE](https://stnolting.github.io/neorv32/#_processor_internal_instruction_cache_icache))
|
129 |
70 |
zero_gravi |
* pre-installed bootloader ([BOOTLDROM](https://stnolting.github.io/neorv32/#_bootloader_rom_bootrom)) with serial user interface
|
130 |
68 |
zero_gravi |
* allows booting application code via UART or from external SPI flash
|
131 |
11 |
zero_gravi |
|
132 |
60 |
zero_gravi |
**Timers**
|
133 |
11 |
zero_gravi |
|
134 |
67 |
zero_gravi |
* machine system timer, 64-bit ([MTIME](https://stnolting.github.io/neorv32/#_machine_system_timer_mtime)), RISC-V spec. compatible
|
135 |
|
|
* general purpose 32-bit timer ([GPTMR](https://stnolting.github.io/neorv32/#_general_purpose_timer_gptmr))
|
136 |
60 |
zero_gravi |
* watchdog timer ([WDT](https://stnolting.github.io/neorv32/#_watchdog_timer_wdt))
|
137 |
11 |
zero_gravi |
|
138 |
74 |
zero_gravi |
**Input / Output**
|
139 |
56 |
zero_gravi |
|
140 |
60 |
zero_gravi |
* standard serial interfaces
|
141 |
|
|
([UART](https://stnolting.github.io/neorv32/#_primary_universal_asynchronous_receiver_and_transmitter_uart0),
|
142 |
|
|
[SPI](https://stnolting.github.io/neorv32/#_serial_peripheral_interface_controller_spi),
|
143 |
70 |
zero_gravi |
[TWI](https://stnolting.github.io/neorv32/#_two_wire_serial_interface_controller_twi))
|
144 |
60 |
zero_gravi |
* general purpose [GPIO](https://stnolting.github.io/neorv32/#_general_purpose_input_and_output_port_gpio) and
|
145 |
|
|
[PWM](https://stnolting.github.io/neorv32/#_pulse_width_modulation_controller_pwm)
|
146 |
70 |
zero_gravi |
* smart LED interface ([NEOLED](https://stnolting.github.io/neorv32/#_smart_led_interface_neoled)) to directly control NeoPixel(TM) LEDs
|
147 |
2 |
zero_gravi |
|
148 |
69 |
zero_gravi |
**SoC Connectivity**
|
149 |
47 |
zero_gravi |
|
150 |
59 |
zero_gravi |
* 32-bit external bus interface, Wishbone b4 compatible
|
151 |
|
|
([WISHBONE](https://stnolting.github.io/neorv32/#_processor_external_memory_interface_wishbone_axi4_lite))
|
152 |
74 |
zero_gravi |
* [wrappers](https://github.com/stnolting/neorv32/blob/main/rtl/system_integration) for AXI4-Lite and Avalon-MM host interfaces
|
153 |
64 |
zero_gravi |
* 32-bit stream link interface with up to 8 independent RX and TX links
|
154 |
74 |
zero_gravi |
([SLINK](https://stnolting.github.io/neorv32/#_stream_link_interface_slink)) - AXI4-Stream compatible
|
155 |
|
|
* external interrupts controller with up to 32 channels
|
156 |
61 |
zero_gravi |
([XIRQ](https://stnolting.github.io/neorv32/#_external_interrupt_controller_xirq))
|
157 |
60 |
zero_gravi |
|
158 |
|
|
**Advanced**
|
159 |
|
|
|
160 |
|
|
* _true random_ number generator ([TRNG](https://stnolting.github.io/neorv32/#_true_random_number_generator_trng))
|
161 |
70 |
zero_gravi |
* execute in place module ([XIP](https://stnolting.github.io/neorv32/#_execute_in_place_module_xip)) to directly execute code from SPI flash
|
162 |
|
|
* custom functions subsystem ([CFS](https://stnolting.github.io/neorv32/#_custom_functions_subsystem_cfs))
|
163 |
72 |
zero_gravi |
for tightly-coupled custom accelerators and interfaces
|
164 |
|
|
* custom functions unit ([CFU](https://stnolting.github.io/neorv32/#_custom_functions_unit_cfu)) for up to 1024
|
165 |
|
|
_custom RISC-V instructions_
|
166 |
47 |
zero_gravi |
|
167 |
74 |
zero_gravi |
**Debugging**
|
168 |
|
|
|
169 |
|
|
* on-chip debugger ([OCD](https://stnolting.github.io/neorv32/#_on_chip_debugger_ocd)) accessible via standard JTAG interface
|
170 |
|
|
* compliant to the "Minimal RISC-V Debug Specification Version 0.13.2"
|
171 |
|
|
* compatible with **OpenOCD** + **gdb** and **Segger Embedded Studio**
|
172 |
|
|
|
173 |
|
|
|
174 |
|
|
:warning: The `B`, `Zfinx` and `Zmmul` RISC-V ISA extensions are frozen and officially ratified but there is no
|
175 |
|
|
upstream gcc support yet (will be available with GCC12). To circumvent this, the NEORV32 software framework provides
|
176 |
|
|
_intrinsic libraries_ for the `B` and `Zfinx` extensions.
|
177 |
|
|
|
178 |
56 |
zero_gravi |
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
179 |
47 |
zero_gravi |
|
180 |
56 |
zero_gravi |
|
181 |
74 |
zero_gravi |
## 3. FPGA Implementation Results
|
182 |
47 |
zero_gravi |
|
183 |
74 |
zero_gravi |
Implementation results for exemplary **CPU-only** configuration generated for an Intel Cyclone IV E `EP4CE22F17C6` FPGA
|
184 |
|
|
using Intel Quartus Prime Lite 21.1 (no timing constrains, _balanced optimization_, f_max from _Slow 1200mV 0C Model_).
|
185 |
|
|
|
186 |
|
|
| CPU Configuration (version [1.6.9.8](https://github.com/stnolting/neorv32/blob/main/CHANGELOG.md)) | LEs | FFs | Memory bits | DSPs | f_max |
|
187 |
|
|
|:------------------------|:----:|:----:|:----:|:-:|:-------:|
|
188 |
|
|
| `rv32i_Zicsr` | 1328 | 678 | 1024 | 0 | 128 MHz |
|
189 |
|
|
| `rv32i_Zicsr_Zicntr` | 1614 | 808 | 1024 | 0 | 128 MHz |
|
190 |
|
|
| `rv32imac_Zicsr_Zicntr` | 2338 | 992 | 1024 | 0 | 128 MHz |
|
191 |
|
|
|
192 |
|
|
:bulb: An incremental list of the CPUs ISA extension's hardware utilization can found in the
|
193 |
|
|
[_Data Sheet: FPGA Implementation Results - CPU_](https://stnolting.github.io/neorv32/#_cpu).
|
194 |
|
|
|
195 |
|
|
The hardware resources used by a specific **full-processor** setup is defined by the implemented CPU extensions,
|
196 |
68 |
zero_gravi |
the configuration of the peripheral modules and some "glue logic".
|
197 |
|
|
Section [_FPGA Implementation Results - Processor Modules_](https://stnolting.github.io/neorv32/#_processor_modules)
|
198 |
64 |
zero_gravi |
of the online datasheet shows the resource utilization of each optional processor module to allow an
|
199 |
62 |
zero_gravi |
estimation of the actual setup's hardware requirements.
|
200 |
2 |
zero_gravi |
|
201 |
71 |
zero_gravi |
:bulb: The [`neorv32-setups`](https://github.com/stnolting/neorv32-setups) repository provides exemplary FPGA
|
202 |
72 |
zero_gravi |
setups targeting various FPGA boards and toolchains. The latest bitstreams and utilization reports for those setups
|
203 |
|
|
can be found in the assets of the [Implementation Workflow](https://github.com/stnolting/neorv32-setups/actions/workflows/Implementation.yml).
|
204 |
56 |
zero_gravi |
|
205 |
74 |
zero_gravi |
:bulb: The CPU & SoC provide further "tuning" options to optimize the design for maximum performance, maximum clock speed, minimal area
|
206 |
|
|
or minimal power consumption:
|
207 |
|
|
[UG: Application-Specific Processor Configuration](https://stnolting.github.io/neorv32/ug/#_application_specific_processor_configuration)
|
208 |
47 |
zero_gravi |
|
209 |
56 |
zero_gravi |
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
210 |
39 |
zero_gravi |
|
211 |
56 |
zero_gravi |
|
212 |
74 |
zero_gravi |
## 4. Performance
|
213 |
23 |
zero_gravi |
|
214 |
69 |
zero_gravi |
The NEORV32 CPU is based on a two-stages pipeline architecture (fetch and execute).
|
215 |
61 |
zero_gravi |
The average CPI (cycles per instruction) depends on the instruction mix of a specific applications and also on the
|
216 |
|
|
available CPU extensions.
|
217 |
2 |
zero_gravi |
|
218 |
73 |
zero_gravi |
The following table shows the performance results (scores and average CPI) for exemplary CPU configurations (no caches) executing
|
219 |
72 |
zero_gravi |
2000 iterations of the [CoreMark](https://github.com/stnolting/neorv32/blob/main/sw/example/coremark) CPU benchmark
|
220 |
|
|
(using plain GCC10 rv32i built-in libraries only!).
|
221 |
2 |
zero_gravi |
|
222 |
72 |
zero_gravi |
| CPU Configuration (version [1.5.7.10](https://github.com/stnolting/neorv32/blob/main/CHANGELOG.md)) | CoreMark Score | CoreMarks/MHz | Average CPI |
|
223 |
69 |
zero_gravi |
|:------------------------------------------------|:-----:|:----------:|:--------:|
|
224 |
|
|
| _small_ (`rv32i_Zicsr`) | 33.89 | **0.3389** | **4.04** |
|
225 |
|
|
| _medium_ (`rv32imc_Zicsr`) | 62.50 | **0.6250** | **5.34** |
|
226 |
|
|
| _performance_ (`rv32imc_Zicsr` + perf. options) | 95.23 | **0.9523** | **3.54** |
|
227 |
42 |
zero_gravi |
|
228 |
71 |
zero_gravi |
:bulb: More information regarding the CPU performance can be found in the
|
229 |
68 |
zero_gravi |
[_Data Sheet: CPU Performance_](https://stnolting.github.io/neorv32/#_cpu_performance).
|
230 |
2 |
zero_gravi |
|
231 |
56 |
zero_gravi |
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
232 |
34 |
zero_gravi |
|
233 |
56 |
zero_gravi |
|
234 |
2 |
zero_gravi |
|
235 |
74 |
zero_gravi |
## 5. Software Framework and Tooling
|
236 |
60 |
zero_gravi |
|
237 |
72 |
zero_gravi |
* [core libraries](https://github.com/stnolting/neorv32/tree/main/sw/lib) for high-level usage of the provided functions and peripherals
|
238 |
60 |
zero_gravi |
* application compilation based on GNU makefiles
|
239 |
|
|
* gcc-based toolchain ([pre-compiled toolchains available](https://github.com/stnolting/riscv-gcc-prebuilt))
|
240 |
72 |
zero_gravi |
* [SVD file](https://github.com/stnolting/neorv32/tree/main/sw/svd) for advanced debugging and IDE integration
|
241 |
60 |
zero_gravi |
* bootloader with UART interface console
|
242 |
|
|
* runtime environment for handling traps
|
243 |
72 |
zero_gravi |
* several [example programs](https://github.com/stnolting/neorv32/tree/main/sw/example) to get started including CoreMark, FreeRTOS and Conway's Game of Life
|
244 |
69 |
zero_gravi |
* doxygen-based documentation, available on [GitHub pages](https://stnolting.github.io/neorv32/sw/files.html)
|
245 |
71 |
zero_gravi |
* supports implementation using open source tooling ([GHDL](https://github.com/ghdl/ghdl), Yosys, nextpnr, ...) - both, software and hardware can be
|
246 |
60 |
zero_gravi |
developed and debugged with open source tooling
|
247 |
69 |
zero_gravi |
* [continuous integration](https://github.com/stnolting/neorv32/actions) is available for:
|
248 |
60 |
zero_gravi |
* allowing users to see the expected execution/output of the tools
|
249 |
|
|
* ensuring specification compliance
|
250 |
|
|
* catching regressions
|
251 |
|
|
* providing ready-to-use and up-to-date bitstreams and documentation
|
252 |
|
|
|
253 |
69 |
zero_gravi |
:books: Want to know more? Check out [_Data Sheet: Software Framework_](https://stnolting.github.io/neorv32/#_software_framework).
|
254 |
|
|
|
255 |
60 |
zero_gravi |
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
256 |
|
|
|
257 |
|
|
|
258 |
|
|
|
259 |
74 |
zero_gravi |
## 6. Getting Started
|
260 |
2 |
zero_gravi |
|
261 |
60 |
zero_gravi |
This overview provides some *quick links* to the most important sections of the
|
262 |
61 |
zero_gravi |
[online Data Sheet](https://stnolting.github.io/neorv32) and the
|
263 |
60 |
zero_gravi |
[online User Guide](https://stnolting.github.io/neorv32/ug).
|
264 |
2 |
zero_gravi |
|
265 |
59 |
zero_gravi |
### :electric_plug: Hardware Overview
|
266 |
2 |
zero_gravi |
|
267 |
72 |
zero_gravi |
* [Rationale](https://stnolting.github.io/neorv32/#_rationale) - NEORV32: why? how come? what for?
|
268 |
61 |
zero_gravi |
|
269 |
59 |
zero_gravi |
* [NEORV32 Processor](https://stnolting.github.io/neorv32/#_neorv32_processor_soc) - the SoC
|
270 |
|
|
* [Top Entity - Signals](https://stnolting.github.io/neorv32/#_processor_top_entity_signals) - how to connect to the processor
|
271 |
|
|
* [Top Entity - Generics](https://stnolting.github.io/neorv32/#_processor_top_entity_generics) - configuration options
|
272 |
61 |
zero_gravi |
* [Address Space](https://stnolting.github.io/neorv32/#_address_space) - memory layout and boot configuration
|
273 |
69 |
zero_gravi |
* [SoC Modules](https://stnolting.github.io/neorv32/#_processor_internal_modules) - available peripheral modules and memories
|
274 |
61 |
zero_gravi |
* [On-Chip Debugger](https://stnolting.github.io/neorv32/#_on_chip_debugger_ocd) - online & in-system debugging of the processor via JTAG
|
275 |
2 |
zero_gravi |
|
276 |
63 |
zero_gravi |
* [NEORV32 CPU](https://stnolting.github.io/neorv32/#_neorv32_central_processing_unit_cpu) - the CPU
|
277 |
59 |
zero_gravi |
* [RISC-V compatibility](https://stnolting.github.io/neorv32/#_risc_v_compatibility) - what is compatible to the specs. and what is not
|
278 |
66 |
zero_gravi |
* [Full Virtualization](https://stnolting.github.io/neorv32/#_full_virtualization) - hardware execution safety
|
279 |
59 |
zero_gravi |
* [ISA and Extensions](https://stnolting.github.io/neorv32/#_instruction_sets_and_extensions) - available RISC-V ISA extensions
|
280 |
|
|
* [CSRs](https://stnolting.github.io/neorv32/#_control_and_status_registers_csrs) - control and status registers
|
281 |
|
|
* [Traps](https://stnolting.github.io/neorv32/#_traps_exceptions_and_interrupts) - interrupts and exceptions
|
282 |
34 |
zero_gravi |
|
283 |
59 |
zero_gravi |
### :floppy_disk: Software Overview
|
284 |
12 |
zero_gravi |
|
285 |
72 |
zero_gravi |
* [Example Programs](https://github.com/stnolting/neorv32/tree/main/sw/example) - test program execution on your setup
|
286 |
59 |
zero_gravi |
* [Core Libraries](https://stnolting.github.io/neorv32/#_core_libraries) - high-level functions for accessing the processor's peripherals
|
287 |
72 |
zero_gravi |
* [Software Framework Documentation](https://stnolting.github.io/neorv32/sw/files.html) - _doxygen_-based documentation
|
288 |
59 |
zero_gravi |
* [Application Makefiles](https://stnolting.github.io/neorv32/#_application_makefile) - turning your application into an executable
|
289 |
|
|
* [Bootloader](https://stnolting.github.io/neorv32/#_bootloader) - the build-in NEORV32 bootloader
|
290 |
22 |
zero_gravi |
|
291 |
68 |
zero_gravi |
### :rocket: User Guide
|
292 |
31 |
zero_gravi |
|
293 |
69 |
zero_gravi |
* [Toolchain Setup](https://stnolting.github.io/neorv32/ug/#_software_toolchain_setup) - install and setup RISC-V gcc
|
294 |
60 |
zero_gravi |
* [General Hardware Setup](https://stnolting.github.io/neorv32/ug/#_general_hardware_setup) - setup a new NEORV32 EDA project
|
295 |
|
|
* [General Software Setup](https://stnolting.github.io/neorv32/ug/#_general_software_framework_setup) - configure the software framework
|
296 |
72 |
zero_gravi |
* [Application Compilation](https://stnolting.github.io/neorv32/ug/#_application_program_compilation) - compile an application using "make"
|
297 |
60 |
zero_gravi |
* [Upload via Bootloader](https://stnolting.github.io/neorv32/ug/#_uploading_and_starting_of_a_binary_executable_image_via_uart) - upload and execute executables
|
298 |
63 |
zero_gravi |
* [Application-Specific Processor Configuration](https://stnolting.github.io/neorv32/ug/#_application_specific_processor_configuration) - tailor the processor to your needs
|
299 |
64 |
zero_gravi |
* [Adding Custom Hardware Modules](https://stnolting.github.io/neorv32/ug/#_adding_custom_hardware_modules) - add _your_ custom hardware
|
300 |
60 |
zero_gravi |
* [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*
|
301 |
63 |
zero_gravi |
* [Simulation](https://stnolting.github.io/neorv32/ug/#_simulating_the_processor) - simulate the whole SoC
|
302 |
|
|
* [Hello World!](https://stnolting.github.io/neorv32/ug/index.html#_hello_world) - run a quick _"hello world"_ simulation
|
303 |
56 |
zero_gravi |
|
304 |
60 |
zero_gravi |
### :copyright: Legal
|
305 |
|
|
|
306 |
72 |
zero_gravi |
[![license](https://img.shields.io/github/license/stnolting/neorv32?longCache=true&style=flat)](https://github.com/stnolting/neorv32/blob/main/LICENSE)
|
307 |
69 |
zero_gravi |
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5018888.svg)](https://doi.org/10.5281/zenodo.5018888)
|
308 |
60 |
zero_gravi |
|
309 |
69 |
zero_gravi |
* [Overview](https://stnolting.github.io/neorv32/#_legal) - license, disclaimer, limitation of liability for external links, proprietary notice, ...
|
310 |
|
|
* [Citing](https://stnolting.github.io/neorv32/#_citing) - citing information
|
311 |
|
|
|
312 |
70 |
zero_gravi |
This is an open-source project that is free of charge. Use this project in any way you like
|
313 |
72 |
zero_gravi |
(as long as it complies to the permissive [license](https://github.com/stnolting/neorv32/blob/main/LICENSE)).
|
314 |
70 |
zero_gravi |
Please quote it appropriately. :+1:
|
315 |
|
|
|
316 |
56 |
zero_gravi |
[[back to top](#The-NEORV32-RISC-V-Processor)]
|
317 |
36 |
zero_gravi |
|
318 |
56 |
zero_gravi |
|
319 |
71 |
zero_gravi |
---------------------------------------
|
320 |
22 |
zero_gravi |
|
321 |
73 |
zero_gravi |
**: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!**
|