Merge pull request #98 from fhoedemakers/riscv

Binaries can be build for Risc-V and other changes

Author: fhoedemakers

.github/workflows/BuildAndRelease.yml

@@ -101,6 +101,8 @@ jobs:
                        releases/${{ env.APP_NAME }}WsRP2040PiZero.uf2
                        releases/pico2_${{ env.APP_NAME }}AdaFruitDVISD.uf2
                        releases/pico2_${{ env.APP_NAME }}PimoroniDV.uf2 
+                       releases/pico2_riscv_${{ env.APP_NAME }}AdaFruitDVISD.uf2
+                       releases/pico2_riscv_${{ env.APP_NAME }}PimoroniDV.uf2 
                        PCB/pico_nesPCB_v2.1.zip
                 body_path: CHANGELOG.md
 

CHANGELOG.md

@@ -5,7 +5,7 @@
 Binaries for each configuration and PCB design are at the end of this page.
 
 >[!NOTE]
->For Raspberry Pi Pico 2 you need to download the .uf2 files starting with pico2_
+>For Raspberry Pi Pico 2 you need to download the .uf2 files starting with pico2_ or pico2_riscv_ for Risc-V.
 
 [See setup section in readme how to install and wire up](https://github.com/fhoedemakers/pico-infonesPlus#pico-setup)
 
@@ -22,13 +22,36 @@ For the latest two player PCB 2.0, you need:
 
 # Release notes
 
-## v0.21 ( To Be Released )
+## v0.21
 
 ### Features
 
+- For RP2350, Risc-V binaries can be build and are included in the release. In Risc-V there is one display mode missing because the Risc-V assembly code for that display mode is not implemented. The following Risc-V binaries are included in the release:
+  - pico2_riscv_piconesPlusAdaFruitDVISD.uf2
+  - pico2_riscv_piconesPlusPimoroniDV.uf2
+- Displays the hardware type in the menu.
+- updated bld.sh and buildAll.sh scripts to include the Risc-V build. For this to work, you need to have the Risc-V toolchain installed. Depending on your development environment you need to download:
+  - Raspberry Pi OS: https://github.com/raspberrypi/pico-sdk-tools/releases/download/v2.0.0-5/riscv-toolchain-14-aarch64-lin.tar.gz
+  - Linux x86/x64: https://github.com/raspberrypi/pico-sdk-tools/releases/download/v2.0.0-5/riscv-toolchain-14-x86_64-lin.tar.gz
+    
+  and extract it to $PICO_SDK_PATH/toolchain/RISCV_RPI_2_0_0_2 (create the directory tree if needed)
+
+  To build run:
+  - ./bld.sh -c1 -r -t $PICO_SDK_PATH/toolchain/RISCV_RPI_2_0_0_2/bin
+  - ./bld.sh -c2 -r -t $PICO_SDK_PATH/toolchain/RISCV_RPI_2_0_0_2/bin
+ 
+  The first command builds a Risc-V binary for the Pimoroni DV Demo base, the second for the PCB or breadboard with Adafruit hardware.
+- The colors in the menu can be changed and saved:
+  - Select + Up/Down changes the foreground color.
+  - Select + Left/Right changes the background color.
+  - Select + A saves the colors. Screen will flicker when saved.
+  - Select + B resets the colors to default. (Black on white)
+
 ### Fixes
 
 - Fix scroll in highlighted menu item.
+- Fix Splash screen shown when exiting a game.
+- Fix in game reset boots back to game in stead of menu.
 
 ## v0.20
 

README.md

@@ -659,22 +659,30 @@ Gavin Knight ([DynaMight1124](https://github.com/DynaMight1124)) designed a NES-
 
 ***
 
+# Gamepad and keyboard usage
 
-# Menu Usage
+## Menu Usage
 Gamepad buttons:
 - UP/DOWN: Next/previous item in the menu.
 - LEFT/RIGHT: next/previous page.
 - A (Circle): Open folder/flash and start game.
 - B (X): Back to parent folder.
 - START: Starts game currently loaded in flash.
 
+The colors in the menu can be changed and saved:
+  - Select + Up/Down changes the foreground color.
+  - Select + Left/Right changes the background color.
+  - Select + A saves the colors. Screen will flicker when saved.
+  - Select + B resets the colors to default. (Black on white)
+
 When using an USB-Keyboard:
 - Cursor keys: Up, Down, left, right
 - Z: Back to parent folder
 - X: Open Folder/flash and start a game
 - S: Starts game currently loaded in flash.
+- A: acts as the select button.
 
-# Emulator (in game)
+## Emulator (in game)
 Gamepad buttons:
 - SELECT + START, Xbox button: Resets back to the SD Card menu. Game saves are saved to the SD card.
 - SELECT + UP/SELECT + DOWN: switches screen modes.
@@ -782,10 +790,12 @@ Alternatively, you can use the [bld.sh](bld.sh) shell script:
 ```
 Build script for the pico-InfoNESPlus project
 
-Usage: ./bld.sh [-d] [-2] [-c <hwconfig>]
+Usage: ./bld.sh [-d] [-2 | -r] [-t path to toolchain] [-c <hwconfig>]
 Options:
   -d: build in DEBUG configuration
-  -2: build for Pico 2 board
+  -2: build for Pico 2 board (RP2350)
+  -r: build for Pico 2 board (RP2350) with riscv core
+  -t <path to toolchain>: only needed for riscv, specify the path to the riscv toolchain bin folder
   -c <hwconfig>: specify the hardware configuration
      1: Pimoroni Pico DV Demo Base (Default)
      2: Breadboard with Adafruit AdaFruit DVI Breakout Board and AdaFruit MicroSD card breakout board
@@ -794,6 +804,24 @@ Options:
      4: Waveshare RP2040-PiZero
      hwconfig 3 and 4 are RP2040-based boards, so they cannot be built for Pico 2
   -h: display this help
+
+To install the RISC-V toolchain:
+ - Raspberry Pi: https://github.com/raspberrypi/pico-sdk-tools/releases/download/v2.0.0-5/riscv-toolchain-14-aarch64-lin.tar.gz
+ - X86/64 Linux: https://github.com/raspberrypi/pico-sdk-tools/releases/download/v2.0.0-5/riscv-toolchain-14-x86_64-lin.tar.gz
+and extract it to $PICO_SDK_PATH/toolchain/RISCV_RPI_2_0_0_2
+
+Example riscv toolchain install for Raspberry Pi OS:
+
+        cd
+        sudo apt-get install wget
+        wget https://github.com/raspberrypi/pico-sdk-tools/releases/download/v2.0.0-5/riscv-toolchain-14-aarch64-lin.tar.gz
+        mkdir -p $PICO_SDK_PATH/toolchain/RISCV_RPI_2_0_0_2
+        tar -xzvf riscv-toolchain-14-aarch64-lin.tar.gz -C $PICO_SDK_PATH/toolchain/RISCV_RPI_2_0_0_2
+
+To build for riscv:
+
+        ./bld.sh -c <hwconfig> -r -t $PICO_SDK_PATH/toolchain/RISCV_RPI_2_0_0_2/bin
+
 ```
 
 

bld.sh

@@ -6,10 +6,12 @@ PROJECT="pico-InfoNESPlus"
 function usage() {
 	echo "Build script for the ${PROJECT} project"
 	echo  ""
-	echo "Usage: $0 [-d] [-2] [-c <hwconfig>]"
+	echo "Usage: $0 [-d] [-2 | -r] [-t path to toolchain] [-c <hwconfig>]"
 	echo "Options:"
 	echo "  -d: build in DEBUG configuration"
-	echo "  -2: build for Pico 2 board"
+	echo "  -2: build for Pico 2 board (RP2350)"
+	echo "  -r: build for Pico 2 board (RP2350) with riscv core"
+	echo "  -t <path to toolchain>: only needed for riscv, specify the path to the riscv toolchain bin folder"
 	echo "  -c <hwconfig>: specify the hardware configuration"
 	echo "     1: Pimoroni Pico DV Demo Base (Default)"
 	echo "     2: Breadboard with Adafruit AdaFruit DVI Breakout Board and AdaFruit MicroSD card breakout board"
@@ -18,9 +20,27 @@ function usage() {
 	echo "     4: Waveshare RP2040-PiZero"
 	echo "     hwconfig 3 and 4 are RP2040-based boards, so they cannot be built for Pico 2"
 	echo "  -h: display this help"
+	echo ""
+	echo "To install the RISC-V toolchain:"
+	echo " - Raspberry Pi: https://github.com/raspberrypi/pico-sdk-tools/releases/download/v2.0.0-5/riscv-toolchain-14-aarch64-lin.tar.gz"
+	echo " - X86/64 Linux: https://github.com/raspberrypi/pico-sdk-tools/releases/download/v2.0.0-5/riscv-toolchain-14-x86_64-lin.tar.gz"
+	echo "and extract it to \$PICO_SDK_PATH/toolchain/RISCV_RPI_2_0_0_2"	
+	echo ""
+	echo "Example riscv toolchain install for Raspberry Pi OS:"
+	echo ""
+	echo -e "\tcd"
+	echo -e "\tsudo apt-get install wget"
+	echo -e "\twget https://github.com/raspberrypi/pico-sdk-tools/releases/download/v2.0.0-5/riscv-toolchain-14-aarch64-lin.tar.gz"
+	echo -e "\tmkdir -p \$PICO_SDK_PATH/toolchain/RISCV_RPI_2_0_0_2"
+	echo -e "\ttar -xzvf riscv-toolchain-14-aarch64-lin.tar.gz -C \$PICO_SDK_PATH/toolchain/RISCV_RPI_2_0_0_2"
+	echo ""
+	echo "To build for riscv:"
+	echo ""
+	echo -e "\t./bld.sh -c <hwconfig> -r -t \$PICO_SDK_PATH/toolchain/RISCV_RPI_2_0_0_2/bin"
+	echo ""
 } 
 
-PICO_BOARD=pico
+PICO_PLATFORM=rp2040
 BUILD=RELEASE
 HWCONFIG=1
 UF2="${APP}PimoroniDV.uf2"
@@ -35,7 +55,10 @@ if [ ! -d "$PICO_SDK_PATH" ] ; then
 	exit 1
 fi
 SDKVERSION=`cat $PICO_SDK_PATH/pico_sdk_version.cmake | grep "set(PICO_SDK_VERSION_MAJOR" | cut -f2  -d" " | cut -f1 -d\)`
-while getopts "hd2c:" opt; do
+TOOLCHAIN_PATH=
+picoarmIsSet=0
+picoRiscIsSet=0
+while getopts "hd2rc:t:" opt; do
   case $opt in
     d)
       BUILD=DEBUG
@@ -44,12 +67,20 @@ while getopts "hd2c:" opt; do
       HWCONFIG=$OPTARG
       ;;
 	2) 
-	  PICO_BOARD=pico2
+	  PICO_PLATFORM=rp2350-arm-s
+	  picoarmIsSet=1
+	  ;;
+	r)
+	  picoriscIsSet=1
+	  PICO_PLATFORM=rp2350-riscv
+	  ;;	
+	t) TOOLCHAIN_PATH=$OPTARG
 	  ;;
 	h)
 	  usage
 	  exit 0
 	  ;;
+
     \?)
       #echo "Invalid option: -$OPTARG" >&2
 	  usage
@@ -66,7 +97,19 @@ while getopts "hd2c:" opt; do
 	  ;;
   esac
 done
-
+# -2 and -r are mutually exclusive
+if [[ $picoarmIsSet -eq 1 && $picoriscIsSet -eq 1 ]] ; then
+	echo "Options -2 and -r are mutually exclusive"
+	usage
+	exit 1
+fi	
+# TOOLCHAIN_PATH is set, check if it is a valid path
+if [ ! -z "$TOOLCHAIN_PATH" ] ; then
+	if [ ! -d "$TOOLCHAIN_PATH" ] ; then
+		echo "Toolchain path $TOOLCHAIN_PATH not found"
+		exit 1
+	fi
+fi
 case $HWCONFIG in
 	1)
 		UF2="${APP}PimoroniDV.uf2"
@@ -86,20 +129,27 @@ case $HWCONFIG in
 		exit 1
 		;;
 esac
-if [ "$PICO_BOARD" = "pico2" ] ; then
+
+if [ "$PICO_PLATFORM" = "rp2350-arm-s" ] ; then
 	UF2="pico2_$UF2"
 fi	
+if [ "$PICO_PLATFORM" = "rp2350-riscv" ] ; then
+	UF2="pico2_riscv_$UF2"
+fi	
 echo "Building $PROJECT"
 echo "Using Pico SDK version: $SDKVERSION"
 echo "Building for $PICO_BOARD with $BUILD configuration and HWCONFIG=$HWCONFIG"
+echo "Toolchain path: $TOOLCHAIN_PATH"
 echo "UF2 file: $UF2"
-if [ $SDKVERSION -lt 2 -a $PICO_BOARD = "pico2" ] ; then
-		echo "Pico SDK version $SDKVERSION does not support Pico 2. Please update the SDK to version 2 or higher"
+
+# if PICO_PLATFORM starts with rp2350, check if the SDK version is 2 or higher
+if [[ $SDKVERSION -lt 2 && $PICO_PLATFORM == rp2350* ]] ; then
+		echo "Pico SDK version $SDKVERSION does not support RP2350 (pico2). Please update the SDK to version 2 or higher"
 		echo ""
 		exit 1
 fi
 # pico2 board not compatible with HWCONFIG > 2
-if [ $HWCONFIG -gt 2 -a $PICO_BOARD = "pico2" ] ; then
+if [[ $HWCONFIG -gt 2 && $PICO_PLATFORM == rp2350* ]] ; then
 	echo "HW configuration $HWCONFIG is a RP2040 based board, not compatible with Pico 2"
 	exit 1
 fi
@@ -110,7 +160,11 @@ if [ -d build ] ; then
 fi
 mkdir build || exit 1
 cd build || exit 1
-cmake -DCMAKE_BUILD_TYPE=$BUILD -DHW_CONFIG=$HWCONFIG -DPICO_BOARD=$PICO_BOARD ..
+if [ -z "$TOOLCHAIN_PATH" ] ; then
+	cmake -DCMAKE_BUILD_TYPE=$BUILD -DHW_CONFIG=$HWCONFIG -DPICO_PLATFORM=$PICO_PLATFORM ..
+else
+	cmake -DCMAKE_BUILD_TYPE=$BUILD -DHW_CONFIG=$HWCONFIG -DPICO_PLATFORM=$PICO_PLATFORM -DPICO_TOOLCHAIN_PATH=$TOOLCHAIN_PATH ..
+fi
 make -j 4
 cd ..
 echo ""

buildAll.sh

@@ -20,12 +20,23 @@ for HWCONFIG in $HWCONFIGS
 do	
 	./bld.sh -c $HWCONFIG
 done
-# build for Pico 2
+# build for Pico 2 -arm-s
 HWCONFIGS="1 2"
 for HWCONFIG in $HWCONFIGS
 do
 	./bld.sh -c $HWCONFIG -2
 done
+# build for Pico 2 -riscv
+HWCONFIGS="1 2"
+if [ ! -d $PICO_SDK_PATH/toolchain/RISCV_RPI_2_0_0_2/bin ] ; then
+	echo "RISC-V toolchain not found in $PICO_SDK_PATH/toolchain/RISCV_RPI_2_0_0_2/bin"	
+	echo "To install the RISC-V toolchain, execute \"bld.sh -h\" for instructions"
+else 
+	for HWCONFIG in $HWCONFIGS
+	do
+		./bld.sh -c $HWCONFIG -r -t $PICO_SDK_PATH/toolchain/RISCV_RPI_2_0_0_2/bin
+	done	
+fi
 if [ -z "$(ls -A releases)" ]; then
 	echo "No UF2 files found in releases folder"
 	exit

main.cpp

@@ -145,6 +145,7 @@ const WORD __not_in_flash_func(NesPalette)[64] = {
     CC(0x7ae7), CC(0x4342), CC(0x2769), CC(0x2ff3), CC(0x03bb), CC(0x0000), CC(0x0000), CC(0x0000),
     CC(0x7fff), CC(0x579f), CC(0x635f), CC(0x6b3f), CC(0x7f1f), CC(0x7f1b), CC(0x7ef6), CC(0x7f75),
     CC(0x7f94), CC(0x73f4), CC(0x57d7), CC(0x5bf9), CC(0x4ffe), CC(0x0000), CC(0x0000), CC(0x0000)};
+int nesPaletteItems  = sizeof(NesPalette) / sizeof(NesPalette[0]);
 
 uint32_t getCurrentNVRAMAddr()
 {
@@ -849,17 +850,20 @@ int main()
     gpio_set_dir(LED_GPIO_PIN, GPIO_OUT);
     gpio_put(LED_GPIO_PIN, 1);
 #endif
+    // reset settings to default in case SD card could not be mounted
+    resetsettings();
     tusb_init();
     isFatalError = !initSDCard();
     if (isFatalError  == false)
     {
        loadsettings();
-    }
-    
-
+    }   
     // When a game is started from the menu, the menu will reboot the device.
     // After reboot the emulator will start the selected game.
-    if (watchdog_caused_reboot() && isFatalError == false)
+    // The watchdog timer is used to detect if the reboot was caused by the menu.
+    // Use watchdog_enable_caused_reboot in stead of watchdog_caused_reboot because
+    // when reset is pressed while in game, the watchdog will also be triggered.
+    if (watchdog_enable_caused_reboot() && isFatalError == false)
     {
         // Determine loaded rom
         printf("Rebooted by menu\n");
@@ -1036,18 +1040,19 @@ int main()
     dvi_->getAudioRingBuffer().advanceWritePointer(255);
 
     multicore_launch_core1(core1_main);
-
+    bool showSplash = true;
     while (true)
     {
         if (strlen(selectedRom) == 0)
         {
             applyScreenMode(ScreenMode::NOSCANLINE_8_7);
-            menu(NES_FILE_ADDR, ErrorMessage, isFatalError); // never returns, but reboots upon selecting a game
+            menu(NES_FILE_ADDR, ErrorMessage, isFatalError, showSplash); // never returns, but reboots upon selecting a game
         }
         printf("Now playing: %s\n", selectedRom);
         romSelector_.init(NES_FILE_ADDR);
         InfoNES_Main();
         selectedRom[0] = 0;
+        showSplash = false;
     }
 
     return 0;