Game ID Support + Refactoring

.github/workflows/cmake.yml

@@ -2,9 +2,9 @@ name: CMake
 
 on:
   push:
-    branches: [ "main", "develop" ]
+    branches: '*'
   pull_request:
-    branches: [ "main", "develop" ]
+    branches: 'v*'
 
 env:
   # Customize the CMake build type here (Release, Debug, RelWithDebInfo, etc.)
@@ -62,15 +62,22 @@ jobs:
     - name: Rename Debug USB uf2
       run: mv build_usb/sd2psx.uf2 build/sd2psx_usb_debug.uf2
 
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v3
+      with:
+        name: SD2PSX-${{ github.sha }}
+        path: |
+          build/*.uf2
+
     - uses: marvinpinto/action-automatic-releases@v1.2.1
-      if: github.event_name != 'pull_request'
+      if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v') #only release on tag or master branch
       # uses: marvinpinto/action-automatic-releases@919008cf3f741b179569b7a6fb4d8860689ab7f0
       with:
         # GitHub secret token
         title:  "${{ env.SD2PSX_VERSION }}"
         repo_token: "${{ secrets.GITHUB_TOKEN }}"
         automatic_release_tag: ${{ env.SD2PSX_RLS_TAG }}
-        prerelease: true
+        prerelease: ${{ !startsWith(github.ref, 'refs/tags/v') }}
         # Assets to upload to the release
         files: |
           build/*.uf2

CMakeLists.txt

@@ -1,145 +1,107 @@
 cmake_minimum_required(VERSION 3.12)
-
 set(PICO_SDK_PATH ${CMAKE_CURRENT_SOURCE_DIR}/ext/pico-sdk)
 include(pico_sdk_import.cmake)
 
-project(pico_examples C CXX ASM)
+project(SD2PSX LANGUAGES C CXX ASM)
+
 set(CMAKE_C_STANDARD 11)
 set(CMAKE_CXX_STANDARD 17)
 # set(PICO_COPY_TO_RAM 1)
 
 pico_sdk_init()
 
-set(LV_CONF_PATH ${CMAKE_CURRENT_SOURCE_DIR}/src/lv_conf.h CACHE STRING "" FORCE)
-add_subdirectory(ext/lvgl EXCLUDE_FROM_ALL)
+# Add all subdirectories for sub-targets
 
 add_subdirectory(database)
 add_subdirectory(ps2boot)
 add_subdirectory(src/version)
+add_subdirectory(src/ps2)
+add_subdirectory(src/ps1)
+add_subdirectory(ext/)
+
+# SD2PSX Main Lib
 
 add_executable(sd2psx
     src/main.c
-    src/debug.c
-    src/gui.c
-    src/input.c
-    src/ui_menu.c
-    src/ui_theme_mono.c
-    src/des.c
-    src/keystore.c
-    src/settings.c
-    src/bigmem.c
-    src/oled.c
-
-    src/ps1/ps1_cardman.c
-    src/ps1/ps1_dirty.c
-    src/ps1/ps1_memory_card.c
-    src/ps1/ps1_empty_card.c
-    src/ps1/ps1_odeman.c
-
-    src/ps2/ps2_memory_card.c
-    src/ps2/ps2_dirty.c
-    src/ps2/ps2_cardman.c
-    src/ps2/ps2_pio_qspi.c
-    src/ps2/ps2_psram.c
-    src/ps2/ps2_exploit.c
 
+    src/game_names/game_names.c
     src/wear_leveling/wear_leveling.c
     src/wear_leveling/wear_leveling_rp2040_flash.c
 
-    src/arduino_wrapper/sd.cpp
-    src/arduino_wrapper/SPI.cpp
-
-    ext/ESP8266SdFat/src/common/FmtNumber.cpp
-    ext/ESP8266SdFat/src/common/FsCache.cpp
-    ext/ESP8266SdFat/src/common/FsDateTime.cpp
-    ext/ESP8266SdFat/src/common/FsName.cpp
-    ext/ESP8266SdFat/src/common/FsStructs.cpp
-    ext/ESP8266SdFat/src/common/FsUtf.cpp
-    ext/ESP8266SdFat/src/common/upcase.cpp
-    ext/ESP8266SdFat/src/ExFatLib/ExFatDbg.cpp
-    ext/ESP8266SdFat/src/ExFatLib/ExFatFile.cpp
-    ext/ESP8266SdFat/src/ExFatLib/ExFatFilePrint.cpp
-    ext/ESP8266SdFat/src/ExFatLib/ExFatFileWrite.cpp
-    ext/ESP8266SdFat/src/ExFatLib/ExFatFormatter.cpp
-    ext/ESP8266SdFat/src/ExFatLib/ExFatName.cpp
-    ext/ESP8266SdFat/src/ExFatLib/ExFatPartition.cpp
-    ext/ESP8266SdFat/src/ExFatLib/ExFatVolume.cpp
-    ext/ESP8266SdFat/src/FatLib/FatDbg.cpp
-    ext/ESP8266SdFat/src/FatLib/FatFile.cpp
-    ext/ESP8266SdFat/src/FatLib/FatFileLFN.cpp
-    ext/ESP8266SdFat/src/FatLib/FatFilePrint.cpp
-    ext/ESP8266SdFat/src/FatLib/FatFileSFN.cpp
-    ext/ESP8266SdFat/src/FatLib/FatFormatter.cpp
-    ext/ESP8266SdFat/src/FatLib/FatName.cpp
-    ext/ESP8266SdFat/src/FatLib/FatPartition.cpp
-    ext/ESP8266SdFat/src/FatLib/FatVolume.cpp
-    ext/ESP8266SdFat/src/FreeStack.cpp
-    ext/ESP8266SdFat/src/FsLib/FsFile.cpp
-    ext/ESP8266SdFat/src/FsLib/FsNew.cpp
-    ext/ESP8266SdFat/src/FsLib/FsVolume.cpp
-    ext/ESP8266SdFat/src/iostream/istream.cpp
-    ext/ESP8266SdFat/src/iostream/ostream.cpp
-    ext/ESP8266SdFat/src/iostream/StdioStream.cpp
-    ext/ESP8266SdFat/src/iostream/StreamBaseClass.cpp
-    ext/ESP8266SdFat/src/MinimumSerial.cpp
-    ext/ESP8266SdFat/src/SdCard/SdCardInfo.cpp
-    ext/ESP8266SdFat/src/SdCard/SdSpiCard.cpp
-
     ext/fnv/hash_64a.c
 )
 
-add_library(ssd1306 STATIC ext/pico-ssd1306/ssd1306.c)
-target_link_libraries(ssd1306 pico_stdlib hardware_i2c)
-
 target_compile_definitions(
     sd2psx PUBLIC
     PICO_XOSC_STARTUP_DELAY_MULTIPLIER=64
     PICO_FLASH_SIZE_BYTES=16777216
-    USE_SPI_ARRAY_TRANSFER=1
-)
-
-target_compile_options(
-    sd2psx PRIVATE
-    -Wall -Wextra
-    -fno-jump-tables
 )
 
 target_include_directories(sd2psx PUBLIC
-    src/arduino_wrapper
-
-    ext/pico-ssd1306
-    ext/ESP8266SdFat/src
-    ext/ESP8266SdFat/extras/attic
     ext/fnv
 )
 
-pico_generate_pio_header(sd2psx ${CMAKE_CURRENT_LIST_DIR}/src/ps1/ps1_mc_spi.pio)
-pico_generate_pio_header(sd2psx ${CMAKE_CURRENT_LIST_DIR}/src/ps2/ps2_mc_spi.pio)
-pico_generate_pio_header(sd2psx ${CMAKE_CURRENT_LIST_DIR}/src/ps2/ps2_qspi.pio)
-
 target_link_libraries(sd2psx
-    ssd1306
-    pico_stdlib
-    pico_multicore
-    hardware_pio
-    hardware_spi
-    hardware_i2c
-    hardware_flash
-    hardware_dma
-    lvgl::lvgl
-    gamedb
-    ps2boot
-    sd2psx_version
+    PRIVATE
+        pico_stdlib
+        pico_multicore
+        hardware_pio
+        hardware_i2c
+        hardware_flash
+        gamedb
+        ps2boot
+        sd2psx_version
+        sd2psx_common
+        ps1_card
+        ps2_card
+        sd_fat
 )
 
 add_dependencies(sd2psx gamedb ps2boot)
 set_target_properties(sd2psx PROPERTIES PICO_TARGET_LINKER_SCRIPT ${CMAKE_SOURCE_DIR}/memmap_custom.ld)
 
+# Common Lib
+
+add_library(sd2psx_common STATIC     
+                ${CMAKE_CURRENT_SOURCE_DIR}/src/debug.c
+                ${CMAKE_CURRENT_SOURCE_DIR}/src/gui.c
+                ${CMAKE_CURRENT_SOURCE_DIR}/src/input.c
+                ${CMAKE_CURRENT_SOURCE_DIR}/src/ui_menu.c
+                ${CMAKE_CURRENT_SOURCE_DIR}/src/ui_theme_mono.c
+                ${CMAKE_CURRENT_SOURCE_DIR}/src/des.c
+                ${CMAKE_CURRENT_SOURCE_DIR}/src/keystore.c
+                ${CMAKE_CURRENT_SOURCE_DIR}/src/settings.c
+                ${CMAKE_CURRENT_SOURCE_DIR}/src/bigmem.c
+                ${CMAKE_CURRENT_SOURCE_DIR}/src/oled.c)
+
+target_include_directories(sd2psx_common 
+                PUBLIC 
+                    ${CMAKE_CURRENT_SOURCE_DIR}/src
+                PRIVATE )
+
+target_link_libraries(sd2psx_common 
+                    PUBLIC
+                        lvgl::lvgl
+                    PRIVATE 
+                        pico_platform_headers
+                        ssd1306
+                        hardware_flash)
+
+target_compile_options(sd2psx_common
+                        PUBLIC
+                            -Wall -Wextra
+                            -fno-jump-tables)
+
+target_compile_definitions(sd2psx_common PUBLIC 
+                            USE_SPI_ARRAY_TRANSFER=1)
+
+set_target_properties(sd2psx_common PROPERTIES PICO_TARGET_LINKER_SCRIPT ${CMAKE_SOURCE_DIR}/memmap_custom.ld)
+
 pico_add_extra_outputs(sd2psx)
 
 set(DEBUG_USB_UART OFF CACHE BOOL "Activate UART over USB for debugging")
 
 if(DEBUG_USB_UART)
-    add_definitions(-DDEBUG_USB_UART)
-    pico_enable_stdio_usb(sd2psx ENABLED)
+    target_compile_definitions(sd2psx_common PUBLIC -DDEBUG_USB_UART)
+    pico_enable_stdio_usb(sd2psx ON)
 endif()

database/CMakeLists.txt

@@ -1,6 +1,7 @@
+# PS1
 set(GAMEDB_PS1_OBJ "${CMAKE_CURRENT_BINARY_DIR}/gamedbps1.o")
 
-add_custom_target(gamedbobjs ALL 
+add_custom_target(gamedbobjs_ps1 ALL 
                     COMMAND ${CMAKE_COMMAND}
                         -D OUTPUT_DIR=${CMAKE_CURRENT_BINARY_DIR}
                         -D PYTHON_SCRIPT=${CMAKE_CURRENT_SOURCE_DIR}/parse_db.py
@@ -11,6 +12,24 @@ add_custom_target(gamedbobjs ALL
                     BYPRODUCTS ${GAMEDB_PS1_OBJ})
 
 add_library(gamedb INTERFACE)
-add_dependencies(gamedb gamedbobjs)
+add_dependencies(gamedb gamedbobjs_ps1)
 
 target_link_libraries(gamedb INTERFACE ${GAMEDB_PS1_OBJ})
+
+# PS2
+
+set(GAMEDB_PS2_OBJ "${CMAKE_CURRENT_BINARY_DIR}/gamedbps2.o")
+
+add_custom_target(gamedbobjs_ps2 ALL 
+                    COMMAND ${CMAKE_COMMAND}
+                        -D OUTPUT_DIR=${CMAKE_CURRENT_BINARY_DIR}
+                        -D PYTHON_SCRIPT=${CMAKE_CURRENT_SOURCE_DIR}/get_and_parse_hdldb.py
+                        -D CMAKE_OBJCOPY=${CMAKE_OBJCOPY}
+                        -D SYSTEM=ps2
+                        -P ${CMAKE_CURRENT_SOURCE_DIR}/db_obj_builder.cmake
+                    VERBATIM
+                    BYPRODUCTS ${GAMEDB_PS1_OBJ})
+
+add_dependencies(gamedb gamedbobjs_ps2)
+
+target_link_libraries(gamedb INTERFACE ${GAMEDB_PS2_OBJ})

database/db_obj_builder.cmake

@@ -2,7 +2,18 @@ string(TIMESTAMP date "%Y%m%d")
 
 if(NOT EXISTS "${OUTPUT_DIR}/gamedb${SYSTEM}_${date}.o")
 
-find_package (Python COMPONENTS Interpreter)
+find_package (Python3 COMPONENTS Interpreter)
+execute_process (COMMAND "${Python3_EXECUTABLE}" -m venv "${OUTPUT_DIR}/db_builder")
+
+# Here is the trick
+## update the environment with VIRTUAL_ENV variable (mimic the activate script)
+set (ENV{VIRTUAL_ENV} "${OUTPUT_DIR}/db_builder")
+## change the context of the search
+set (Python3_FIND_VIRTUALENV FIRST)
+## unset Python3_EXECUTABLE because it is also an input variable (see documentation, Artifacts Specification section)
+unset (Python3_EXECUTABLE)
+## Launch a new search
+find_package (Python3 COMPONENTS Interpreter Development)
 
 file(GLOB files "${OUTPUT_DIR}/gamedb${SYSTEM}_*")
 foreach(file ${files})
@@ -14,7 +25,12 @@ set(GAMEDB_${SYSTEM}_BIN "gamedb${SYSTEM}.dat")
 set(GAMEDB_${SYSTEM}_OBJ "${OUTPUT_DIR}/gamedb${SYSTEM}_${date}.o")
 
 execute_process(
-    COMMAND ${Python_EXECUTABLE} ${PYTHON_SCRIPT} ${SYSTEM} ${OUTPUT_DIR}
+    COMMAND ${Python3_EXECUTABLE} -m pip install requests unidecode
+    WORKING_DIRECTORY ${OUTPUT_DIR}
+    OUTPUT_QUIET
+)
+execute_process(
+    COMMAND ${Python3_EXECUTABLE} ${PYTHON_SCRIPT} ${SYSTEM} ${OUTPUT_DIR}
     WORKING_DIRECTORY ${OUTPUT_DIR}
     OUTPUT_QUIET
 )