Merge pull request #122 from fhoedemakers/i2s_audio

Audio can be played through audio jack of Pimoroni Pico DV Demo base

Author: fhoedemakers

.github/workflows/BuildAndRelease.yml

@@ -9,6 +9,8 @@ on:
           - "v*.*-alpha"
           - "v*.*.*"
           - "v*.*"
+    workflow_dispatch:
+  
     #     branches: [ main ]
     # pull_request:
     #     branches: [ main ] 
@@ -92,7 +94,7 @@ jobs:
 
           - name: Create release
             uses: softprops/action-gh-release@v2
-            if: startsWith(github.ref, 'refs/tags/')
+            if: startsWith(github.ref, 'refs/tags/')  && github.event_name == 'push'
             with:
                 files: |
                        releases/*.uf2

.github/workflows/TEST.yml

@@ -1,5 +1,6 @@
 *Zone.Identifier
 fh.log
+CMakePresets.json
 /pimoroni-pico/
 # Prerequisites
 *.d

.gitignore

@@ -4,10 +4,10 @@
 
 Binaries for each configuration and PCB design are at the end of this page.
 
-- For Raspberry Pi Pico (RP2040) you need to download the .uf2 files starting with pico_piconesPlus.
-- For Raspberry Pi Pico w (rp2040) you can download the .uf2 files starting with pico_w_piconesPlus. Although you can also use the pico_piconesPlus binaries on the Pico w if you don't mind the blinking led.
-- For Raspberry Pi Pico 2 (RP2350) you need to download the .uf2 files starting with pico2_piconesPlus for ARM or pico2_riscv_piconesPlus  for Risc-V. 
-- For Raspberry Pi Pico 2 w (RP2350) you can download the .uf2 files starting with pico2_w_piconesPlus for ARM or pico2_w_riscv_piconesPlus for Risc-V Although you can also use the pico2_piconesPlus binaries on the Pico w if you don't mind the blinking led.
+- For Raspberry Pi Pico (RP2040): Download the .uf2 files that start with pico_piconesPlus.
+- For Raspberry Pi Pico W (RP2040 with WiFi): Download the .uf2 files that start with pico_w_piconesPlus. You can also use the regular pico_piconesPlus files if you don’t mind the WiFi LED blinking.
+- For Raspberry Pi Pico 2 (RP2350): Download the .uf2 files that start with pico2_piconesPlus (for ARM) or pico2_riscv_piconesPlus (for RISC-V).
+- For Raspberry Pi Pico 2 W (RP2350 with WiFi): Download the .uf2 files that start with pico2_w_piconesPlus (for ARM) or pico2_w_riscv_piconesPlus (for RISC-V). You can also use the non-W files if you don’t mind the WiFi LED blinking.
 
 [Click here for tested configurations](testresults.md).
 
@@ -34,19 +34,13 @@ For the latest two player PCB 2.0, you need:
 
 [https://www.thingiverse.com/thing:6758682](https://www.thingiverse.com/thing:6758682)
 
-# v0.27 release notes 
-
-- Added second PCB design for use with Waveshare [RP2040-Zero](https://www.waveshare.com/rp2040-zero.htm) or [RP2350-Zero](https://www.waveshare.com/rp2350-zero.htm) mini development board. The PCB is designed to fit in a 3D-printed case. PCB and Case design by [@DynaMight1124](https://github.com/DynaMight1124).
-Based around cheaper but harder to solder components for those that fancy a bigger challenge. It also allows the design to be smaller.
-- Added new configuration to BoardConfigs.cmake and bld.sh to support the new configuration for this PCB.
-
-| | |
-| ---- | ---- |
-| ![NESMiniPCB](https://github.com/user-attachments/assets/64696de1-2896-4a9c-94e9-692f125c55b6) | ![NESMiniCase](https://github.com/user-attachments/assets/a68f31ff-529f-49fb-9ec4-f3512c8e9e38) |
+# v0.28 release notes 
 
+- Enable I2S audio on the Pimoroni Pico DV Demo Base. This allows audio output through external speakers connected to the line-out jack of the Pimoroni Pico DV Demo Base. You can toggle audio output to this jack with SELECT + LEFT. Thanks to [Layer812](https://github.com/Layer812) for testing and providing feedback.
 
 ## Fixes
-- Pico 2 W executables added to the release.
+- improved error handling in build scripts.
+- Github action can be started manual.
 
 All changes are in the pico_shared submodule. When building from source, make sure you do a **git submodule update --init** from within the source folder to get the latest pico_shared module.
 

CHANGELOG.md

@@ -44,20 +44,16 @@ IF(NOT CMAKE_BUILD_TYPE)
        FORCE)
 ENDIF(NOT CMAKE_BUILD_TYPE)
 message("* Current build type is : ${CMAKE_BUILD_TYPE}")
-
+if (NOT PICO_BOARD )
+    set(PICO_BOARD pico CACHE STRING "Board type")
+endif()
 add_definitions( -DNDEBUG )
 include(pico_sdk_import.cmake)
-
 project(${projectname} C CXX ASM)
 pico_sdk_init()
-# IF(EXISTS "${PICO_SDK_PATH}/lib/mbedtls")
-#     message(FATAL_ERROR "\nPico SDK 1.5.0 or higher cannot be used to build this project.\n"
-#                         "Remove build subdirectory and use SDK 1.4.0 to build this project.\n"
-#                         "See https://github.com/fhoedemakers/pico-infonesPlus/issues/7")
-# ENDIF()
 
 if (NOT HW_CONFIG)
-    set(HW_CONFIG 2 CACHE STRING "Select the hardware configuration for your board")      
+    set(HW_CONFIG 1 CACHE STRING "Select the hardware configuration for your board")      
 endif()
 # Although Pico 2 has enough memory, mapper 5 games do not work properly. (sound and screen glitches)
 # if (PICO_BOARD STREQUAL "pico2" OR PICO_BOARD STREQUAL "pico2_w")
@@ -124,6 +120,12 @@ target_compile_definitions(${projectname} PRIVATE
     NES_MAPPER_5_ENABLED=${INFONES_MAPPER_5_ENABLED}
     HW_CONFIG=${HW_CONFIG}
     WIIPAD_I2C=${WIIPAD_I2C}
+    USE_I2S_AUDIO=${USE_I2S_AUDIO}
+    PICO_AUDIO_I2S_DATA_PIN=${PICO_AUDIO_I2S_DATA_PIN}
+    PICO_AUDIO_I2S_CLOCK_PIN_BASE=${PICO_AUDIO_I2S_CLOCK_PIN_BASE}
+    PICO_AUDIO_I2S_PIO=${PICO_AUDIO_I2S_PIO}
+    PICO_AUDIO_I2S_DMA_IRQ=1
+    PICO_AUDIO_I2S_CLOCK_PINS_SWAPPED=${PICO_AUDIO_I2S_CLOCK_PINS_SWAPPED}
 )
 target_link_libraries(${projectname} PRIVATE
     pico_stdlib
@@ -164,6 +166,7 @@ endif()
     add_subdirectory(pico_lib/util)
     add_subdirectory(pico_shared)
     add_subdirectory(tusb_xinput xinput_host)
+    target_link_options(${projectname} PRIVATE -Xlinker --print-memory-usage --data-sections)
     pico_add_extra_outputs(${projectname})
 
 

CMakeLists.txt

@@ -170,6 +170,8 @@ Click on the link below for your specific board configuration:
 - USB C to USB data cable when using the Sony Dual Sense controller.
 - FAT32 or exFAT formatted Micro SD card with roms you legally own. Roms must have the .nes extension. You can organise your roms into different folders.
 
+> [!NOTE]
+> An external speaker can be connected to the audio jack of the Pimoroni Pico DV Demo Base. You can toggle audio output to this jack with SELECT + LEFT. 
 
 ### flashing the Pico
 - When using a Pico / Pico W, download **pico_piconesPlusPimoroniDV.uf2** / **pico_w_piconesPlusPimoroniDV.uf2** from the [releases page](https://github.com/fhoedemakers/pico-infonesPlus/releases/latest).
@@ -796,6 +798,7 @@ Gamepad buttons:
 - SELECT + UP/SELECT + DOWN: switches screen modes.
 - SELECT + A/B: toggle rapid-fire.
 - START + A : Toggle framerate display
+- SELECT + LEFT: Switch audio output to the connected speakers on the line-out jack of the Pimoroni Pico DV Demo Base. The speaker setting will be remembered when the emulator is restarted.
 
 When using a Genesis Mini controller, press C for SELECT.
 
@@ -875,12 +878,9 @@ Some displays need 5V connected to the HDMI breakout in order to work:
 ***
 
 # Known Issues and limitations
-- Pimoroni Pico DV: 
-  - Audio through the audio out jack is not supported, audio only works over hdmi.
-  - Debug printf statements over UART (GPIO0 and GPIO1) are disabled because GPIO1 is used for second nes controller port.
+
 - Due to the Pico's memory limitations, not all games will work. Games not working will show a "Mapper n is unsupported." (n is a number). For example starting Castlevania III will show the "Mapper 5 is unsupported." message.
 - tar file support is removed.
-- Pico2 W: Blinking the onboard led causes display issues and ioctl timeout errors on the uart console.
 
 ***
 

README.md

@@ -12,28 +12,28 @@ if ! command -v picotool &> /dev/null
 then
 	echo "picotool could not be found"
 	echo "Please install picotool from https://github.com/raspberrypi/picotool.git" 
-	exit
+	exit 1
 fi
 # build for Pico
 HWCONFIGS="1 2 3 4 6"
 for HWCONFIG in $HWCONFIGS
 do	
-	./bld.sh -c $HWCONFIG
+	./bld.sh -c $HWCONFIG || exit 1
 done
 # build for Pico w
 HWCONFIGS="1 2"
 for HWCONFIG in $HWCONFIGS
 do	
-	./bld.sh -c $HWCONFIG -w
+	./bld.sh -c $HWCONFIG -w || exit 1
 done
 # build for Pico 2 (w) -arm-s
 HWCONFIGS="1 2 5 6"
 for HWCONFIG in $HWCONFIGS
 do
-	./bld.sh -c $HWCONFIG -2
+	./bld.sh -c $HWCONFIG -2 || exit 1
 	# don't build for w when HWCONFIG=5 and 6
 	if [[ $HWCONFIG -ne 5 && $HWCONFIG -ne 6 ]]; then
-		./bld.sh -c $HWCONFIG -2 -w
+		./bld.sh -c $HWCONFIG -2 -w || exit 1
 	fi
 done
 # build for Pico 2 -riscv, Metro RP2350 has no risc support because sd card not working
@@ -45,16 +45,16 @@ if [ ! -d $PICO_SDK_PATH/toolchain/RISCV_RPI_2_0_0_2/bin ] ; then
 else 
 	for HWCONFIG in $HWCONFIGS
 	do
-		./bld.sh -c $HWCONFIG -r -t $PICO_SDK_PATH/toolchain/RISCV_RPI_2_0_0_2/bin
+		./bld.sh -c $HWCONFIG -r -t $PICO_SDK_PATH/toolchain/RISCV_RPI_2_0_0_2/bin || exit 1
 		# don't build for w when HWCONFIG=5 or 6
 		if [[ $HWCONFIG -ne 5 && $HWCONFIG -ne 6 ]]; then
-			./bld.sh -c $HWCONFIG -r -t $PICO_SDK_PATH/toolchain/RISCV_RPI_2_0_0_2/bin -w
+			./bld.sh -c $HWCONFIG -r -t $PICO_SDK_PATH/toolchain/RISCV_RPI_2_0_0_2/bin -w || exit 1
 		fi
 	done	
 fi
 if [ -z "$(ls -A releases)" ]; then
 	echo "No UF2 files found in releases folder"
-	exit
+	exit 1
 fi
 for UF2 in releases/*.uf2
 do