Skip to content

Commit

Permalink
[docs] bootloader: added notes regarding 4kB upload issue
Browse files Browse the repository at this point in the history
-> #215
  • Loading branch information
stnolting committed Dec 18, 2021
1 parent 26bbea5 commit eb58b7f
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
6 changes: 6 additions & 0 deletions docs/datasheet/software.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -448,6 +448,12 @@ Terminal console settings (`19200-8-N-1`):
* newline on `\r\n` (carriage return, newline)
* no transfer protocol / control flow protocol - just the raw byte stuff
[IMPORTANT]
_Any_ terminal program that can connect to a serial port should work. However, make sure the program
can transfer data in _raw_ byte mode without any protocol overhead around it. Some terminal programs struggle with
transmitting files larger than 4kB (see https://github.com/stnolting/neorv32/pull/215). Try a different program
if uploading a binary does not work (terminal stall).

The bootloader uses the LSB of the top entity's `gpio_o` output port as high-active status LED (all other
output pin are set to low level by the bootloader). After reset, this LED will start blinking at ~2Hz and the
following intro screen should show up in your terminal:
Expand Down
7 changes: 4 additions & 3 deletions docs/userguide/executable_upload.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,11 @@ run custom programs on your FPGA setup without having a UART.
from https://ttssh2.osdn.jp/index.html.en . On Linux you could use GTKTerm, which you can get here
https://github.com/Jeija/gtkterm.git (or install via your package manager).
[NOTE]
[IMPORTANT]
_Any_ terminal program that can connect to a serial port should work. However, make sure the program
can transfer data in _raw_ byte mode without any protocol overhead around it.
can transfer data in _raw_ byte mode without any protocol overhead around it. Some terminal programs struggle with
transmitting files larger than 4kB (see https://github.com/stnolting/neorv32/pull/215). Try a different program
if uploading a binary does not work (terminal stall).

[start=3]
. Open a connection to the the serial port your UART is connected to. Configure the terminal setting according to the
Expand Down

0 comments on commit eb58b7f

Please sign in to comment.