Minor code cleanups (#925)

stnolting · Jun 14, 2024 · a8c6555 · a8c6555
2 parents 86ada21 + 689baa4
commit a8c6555
Show file tree

Hide file tree

Showing 21 changed files with 258 additions and 324 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -29,6 +29,7 @@ mimpid = 0x01040312 -> Version 01.04.03.12 -> v1.4.3.12
 
 | Date | Version | Comment | Ticket |
 |:----:|:-------:|:--------|:------:|
+| 14.06.2024 | 1.9.9.8 | minor rtl edits/cleanups; increase bootloader's auto-boot timeout from 8s to 10s | [#925](https://github.com/stnolting/neorv32/pull/925) |
 | 07.06.2024 | 1.9.9.7 | :sparkles: re-add TRNG "data available" interrupt | [#922](https://github.com/stnolting/neorv32/pull/922) |
 | 31.05.2024 | 1.9.9.6 | add "tag" signal to XBUS to provide additional access information (compatible to the AXI4 _ARPROT_ and _AWPROT_ signals) | [#917](https://github.com/stnolting/neorv32/pull/917) |
 | 30.05.2024 | 1.9.9.5 | :bug: fix uncached-vs-cached memory accesses (do not interrupt cache bursts by direct/uncached memory accesses) | [#915](https://github.com/stnolting/neorv32/pull/915) |

diff --git a/docs/datasheet/software_bootloader.adoc b/docs/datasheet/software_bootloader.adoc
@@ -3,7 +3,7 @@
 
 .Pre-Built Bootloader Image
 [IMPORTANT]
-This section refers to the **default** NEORV32 bootloader. A pre-compiled memory image for the processor-internal 
+This section refers to the **default** NEORV32 bootloader. A pre-compiled memory image for the processor-internal
 <<_bootloader_rom_bootrom>> is available in the project's +rtl+ folder: `rtl/core/neorv32_bootloader_image.vhd`.
 This image is automatically inserted into the boot ROM when synthesizing the processor with the bootloader being
 enabled. **Note that the default bootloader image was compiled for a minimal `rv32i` + priv. ISA!**
@@ -99,7 +99,7 @@ SOC:  0xffff402f
 IMEM: 0x00008000
 DMEM: 0x00002000
 
-Autoboot in 8s. Press any key to abort.
+Autoboot in 10s. Press any key to abort.
 ----
 
 The start-up screen gives some brief information about the bootloader and several system configuration parameters:
@@ -117,8 +117,8 @@ The start-up screen gives some brief information about the bootloader and severa
 | `DMEM` | Internal DMEM size in byte (via the `MEM` register from the <<_system_configuration_information_memory_sysinfo>>.
 |=======================
 
-Now you have 8 seconds to press _any_ key. Otherwise, the bootloader starts the <<_auto_boot_sequence>>. When
-you press any key within the 8 seconds, the actual bootloader user console starts:
+Now you have 10 seconds to press _any_ key. Otherwise, the bootloader starts the <<_auto_boot_sequence>>. When
+you press any key within the 10 seconds, the actual bootloader user console starts:
 
 [source]
 ----
@@ -133,7 +133,7 @@ SOC:  0xffff402f
 IMEM: 0x00008000
 DMEM: 0x00002000
 
-Autoboot in 8s. Press any key to abort. <1>
+Autoboot in 10s. Press any key to abort. <1>
 Aborted.
 
 Available CMDs:

diff --git a/docs/userguide/customizing_the_bootloader.adoc b/docs/userguide/customizing_the_bootloader.adoc
@@ -22,14 +22,14 @@ minimal base & privileged ISA `rv32i_zicsr_zifencei` only to ensure it can work
 4+^| Memory layout
 | `EXE_BASE_ADDR` | `0x00000000` | _any_ | Base address / boot address for the executable (see section "Address Space" in the NEORV32 data sheet)
 4+^| Serial console interface
-| `UART_EN`   | `1` | `0`, `1` | Set to `0` to disable UART0 (no serial console at all)
-| `UART_BAUD` | `19200` | _any_ | Baud rate of UART0
+| `UART_EN`   | `1`     | `0`, `1` | Set to `0` to disable UART0 (no serial console at all)
+| `UART_BAUD` | `19200` | _any_    | Baud rate of UART0
 | `UART_HW_HANDSHAKE_EN`   | `0` | `0`, `1` | Set to `1` to enable UART0 hardware flow control
 4+^| Status LED
 | `STATUS_LED_EN`  | `1` | `0`, `1`     | Enable bootloader status led ("heart beat") at `GPIO` output port pin #`STATUS_LED_PIN` when `1`
 | `STATUS_LED_PIN` | `0` | `0` ... `31` | `GPIO` output pin used for the high-active status LED
 4+^| Auto-boot configuration
-| `AUTO_BOOT_TIMEOUT` | `8` | _any_    | Time in seconds after the auto-boot sequence starts (if there is no UART input by the user); set to 0 to disabled auto-boot sequence
+| `AUTO_BOOT_TIMEOUT` | `10` | _any_  | Time in seconds after the auto-boot sequence starts (if there is no UART input by the user); set to 0 to disabled auto-boot sequence
 4+^| SPI configuration
 | `SPI_EN`                | `1` | `0`, `1`      | Set `1` to enable the usage of the SPI module (including load/store executables from/to SPI flash options)
 | `SPI_FLASH_CS`          | `0` | `0` ... `7`   | SPI chip select output (`spi_csn_o`) for selecting flash

diff --git a/docs/userguide/executable_upload.adoc b/docs/userguide/executable_upload.adoc
@@ -39,7 +39,7 @@ following parameters:
 [start=4]
 . Also make sure that single chars are send from your computer _without_ any consecutive "new line" or "carriage
 return" commands. This is highly dependent on your terminal application of choice, TeraTerm only
-sends the raw chars by default. In `cutecom`, change `LF` to `None` in the dropdown menu 
+sends the raw chars by default. In `cutecom`, change `LF` to `None` in the dropdown menu
 next to the input text box.
 . Press the NEORV32 reset button to restart the bootloader. The status LED starts blinking and the
 bootloader intro screen appears in your console. Hurry up and press any key (hit space!) to abort the
@@ -60,7 +60,7 @@ SOC:  0xffff402f
 IMEM: 0x00008000 bytes @0x00000000
 DMEM: 0x00002000 bytes @0x80000000
 
-Autoboot in 8s. Press any key to abort.
+Autoboot in 10s. Press any key to abort.
 Aborted.
 
 Available CMDs: