github-mirrors/neorv32
1
0
Fork 0
mirror of https://github.com/stnolting/neorv32.git synced 2025-04-24 06:07:52 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

[docs] minor edits

Browse source
This commit is contained in:
stnolting 2025-01-11 06:33:18 +01:00
parent 006829953b
commit 9b68c61e4c
2 changed files with 10 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

4
docs/datasheet/software.adoc
View file

@ -93,7 +93,7 @@ The NEORV32 HAL consists of the following files.
| `neorv32_newlib.c` | - | Platform-specific system calls for _newlib_
|=======================
.Core Library Documentation
.Core Libraries Documentation
[TIP]
The Doxygen-based documentation of the software framework including all core libraries is available online at
https://stnolting.github.io/neorv32/sw/files.html.
@ -171,7 +171,7 @@ NEORV32_HOME ?= ../../..
include $(NEORV32_HOME)/sw/common/common.mk
```
.New Project
.Setup of a New Project
[TIP]
When creating a new project, copy an existing project folder or at least the makefile to the new project folder.
It is recommended to create new projects also in `sw/example` to keep the file dependencies. However, these

13
docs/datasheet/software_bootloader.adoc
View file

@ -29,6 +29,11 @@ An "auto boot" feature can optionally fetch this executable right after reset if
via UART. This allows to build processor setups with _non-volatile application storage_ while maintaining the option
to update the application software at any timer.
.Software Documentation
[TIP]
The Doxygen-based documentation of the bootloader's software is available online:
https://stnolting.github.io/neorv32/sw/bootloader_8c.html
:sectnums:
==== Bootloader SoC/CPU Requirements
@ -232,8 +237,10 @@ is no valid boot image found, and error code will be shown.
If something goes wrong during bootloader operation an error code and a short message is shown. In this case the processor
is halted (entering <<_sleep_mode>>), the bootloader status LED is permanently activated and the processor has to be reset manually.
.Debugging Information
[TIP]
In many cases the error source is just _temporary_ (like some HF spike during an UART upload). Just try again.
If an unexpected exception has been raised, the bootloader prints hexadecimal debug information showing
the <<_mcause>>, <<_mepc>> and <<_mtval>> CSR values.
[cols="<2,<8"]
[grid="rows"]
@ -245,7 +252,3 @@ In many cases the error source is just _temporary_ (like some HF spike during an
| **`ERR_EXC`** | The bootloader encountered an unexpected exception during operation. This might be caused when it tries to access peripherals that were not implemented during synthesis. Example: executing commands `l` or `s` (SPI flash operations) without the SPI module being implemented.
| **`ERR_TWI`** | The TWI received an unexpected NACK while reading the external memory. Are the address and speed settings correct?
|=======================
[TIP]
If an unexpected exception has been raised, the bootloader prints hexadecimal debug information showing
the <<_mcause>>, <<_mepc>> and <<_mtval>> CSR values.